Share via

az fleet member

Note

This reference is part of the fleet extension for the Azure CLI (version 2.61.0 or higher). The extension will automatically install the first time you run an az fleet member command. Learn more about extensions.

Commands to manage members.

Commands

Name Description Type Status
az fleet member create

Creates or updates a member.

 Extension GA
az fleet member delete

Deletes a fleet member.

 Extension GA
az fleet member list

Lists a fleet's members.

 Extension GA
az fleet member reconcile

Reconciles a member.

 Extension GA
az fleet member show

Gets a fleet member.

 Extension GA
az fleet member update

Update a member.

 Extension GA
az fleet member wait

Wait for a member resource to reach a desired state.

 Extension GA

az fleet member create

Creates or updates a member.

az fleet member create --fleet-name
                       --member-cluster-id
                       --name
                       --resource-group
                       [--labels --member-labels]
                       [--no-wait]
                       [--update-group]

Examples

Create a member and assign it to an update group.

az fleet member create -g MyFleetResourceGroup -f MyFleetName -n NameOfMember --update-group group1 --member-cluster-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyFleetResourceGroup/providers/Microsoft.ContainerService/managedClusters/MyManagedCluster"

Required Parameters

--fleet-name -f

Specify the fleet name.

--member-cluster-id

ID of the managed cluster.

--name -n

Specify the fleet member name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--labels --member-labels

Space-separated labels in key=value format. Example: env=production region=us-west team=devops.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--update-group

Update group of the member.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az fleet member delete

Deletes a fleet member.

az fleet member delete --fleet-name
                       --name
                       --resource-group
                       [--no-wait]
                       [--yes]

Examples

Delete a specific fleet member.

az fleet member delete -g MyFleetResourceGroup -f MyFleetName -n NameOfMember

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify the fleet member name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az fleet member list

Lists a fleet's members.

az fleet member list --fleet-name
                     --resource-group

Examples

List all members for a given fleet.

az fleet member list -g MyFleetResourceGroup -f MyFleetName

Required Parameters

--fleet-name -f

Specify the fleet name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az fleet member reconcile

Reconciles a member.

az fleet member reconcile --fleet-name
                          --name
                          --resource-group
                          [--no-wait]

Examples

Reconcile a member.

az fleet member reconcile -g MyFleetResourceGroup -f MyFleetName -n NameOfMember

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify the fleet member name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--no-wait

Do not wait for the long-running operation to finish.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az fleet member show

Gets a fleet member.

az fleet member show --fleet-name
                     --name
                     --resource-group

Examples

Show the details of a specific fleet member.

az fleet member show -g MyFleetResourceGroup -f MyFleetName -n NameOfMember

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify the fleet member name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az fleet member update

Update a member.

az fleet member update --fleet-name
                       --name
                       --resource-group
                       [--labels --member-labels]
                       [--update-group]

Examples

Update an existing member's update group.

az fleet member update -g MyFleetResourceGroup -f MyFleetName -n NameOfMember --update-group group2

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify the fleet member name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--labels --member-labels

Space-separated labels in key=value format. Example: env=production region=us-west team=devops.

--update-group

Update group of the member.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az fleet member wait

Wait for a member resource to reach a desired state.

If an operation on member was interrupted or was started with --no-wait, use this command to wait for it to complete.

az fleet member wait --fleet-member-name
                     --fleet-name
                     --resource-group
                     [--created]
                     [--custom]
                     [--deleted]
                     [--exists]
                     [--interval]
                     [--timeout]
                     [--updated]

Required Parameters

--fleet-member-name

The name of the Fleet member resource. Required.

--fleet-name -f

Specify the fleet name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

Property Value
Parameter group: Wait Condition Arguments
--deleted

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--timeout

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False