az fleet identitybindingprofile

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 identitybindingprofile command. Learn more about extensions.

This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage identity binding profiles.

Commands

Name Description Type Status
az fleet identitybindingprofile apply

Apply the identity binding profile to selected fleet members.

Extension Preview
az fleet identitybindingprofile create

Create or update an identity binding profile.

Extension Preview
az fleet identitybindingprofile delete

Delete an identity binding profile. The identity binding must be removed from all members before the profile can be deleted.

Extension Preview
az fleet identitybindingprofile list

List all identity binding profiles for a fleet.

Extension Preview
az fleet identitybindingprofile list-members

List fleet members for an identity binding profile.

Extension Preview
az fleet identitybindingprofile show

Get an identity binding profile.

Extension Preview
az fleet identitybindingprofile wait

Wait for an identity binding profile to reach a desired state.

Extension Preview

az fleet identitybindingprofile apply

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Apply the identity binding profile to selected fleet members.

az fleet identitybindingprofile apply --fleet-name
                                      --name
                                      --resource-group
                                      [--acquire-policy-token]
                                      [--change-reference]
                                      [--no-wait]
                                      [--what-if]

Examples

Apply an identity binding profile.

az fleet identitybindingprofile apply -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile

Preview what changes would be made without actually applying.

az fleet identitybindingprofile apply -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile --what-if --output table

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the identity binding profile.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--no-wait

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

Property Value
Default value: False
--what-if

Show what changes would be made by the apply operation without actually performing it.

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 identitybindingprofile create

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Create or update an identity binding profile.

Running create against an existing profile replaces the whole profile. Any optional argument that is omitted is cleared, including --allowed-subjects-from-file, which removes existing subject restrictions. Pass every setting you want to keep.

az fleet identitybindingprofile create --fleet-name
                                       --managed-identity-resource-id
                                       --name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--allowed-subjects-from-file]
                                       [--change-reference]
                                       [--member-selector --selector]
                                       [--no-wait]

Examples

Create an identity binding profile for members labelled env=production.

az fleet identitybindingprofile create -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile \
  --selector "env=production" \
  --managed-identity-resource-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity"

Create an identity binding profile restricted to specific subjects.

az fleet identitybindingprofile create -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile \
  --selector "env=production" \
  --managed-identity-resource-id "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyRG/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity" \
  --allowed-subjects-from-file allowed-subjects.json

Required Parameters

--fleet-name -f

Specify the fleet name.

--managed-identity-resource-id

The resource ID of the managed identity to use.

--name -n

Specify name for the identity binding profile.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--allowed-subjects-from-file

Path to a JSON file with the list of subjects authorized to use this identity binding for token exchange.

The file must contain a JSON array (max 100 entries). Each entry has a required 'namespaceSelector' and an optional 'serviceAccountSelector', each a Kubernetes label selector supporting 'matchLabels' (an array of "key=value" strings) and/or 'matchExpressions'. Use the built-in 'kubernetes.io/metadata.name' label to target specific namespaces by name. When omitted, authorization falls back to ClusterRole/ClusterRoleBinding evaluation on the member clusters, and any subjects already set on an existing profile are removed.

--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--member-selector --selector -s

Kubernetes-style label selector for selecting Fleet members, e.g. 'env=production'.

--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 identitybindingprofile delete

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete an identity binding profile. The identity binding must be removed from all members before the profile can be deleted.

az fleet identitybindingprofile delete --fleet-name
                                       --name
                                       --resource-group
                                       [--acquire-policy-token]
                                       [--change-reference]
                                       [--no-wait]
                                       [--yes]

Examples

Delete an identity binding profile.

az fleet identitybindingprofile delete -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the identity binding profile.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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 identitybindingprofile list

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List all identity binding profiles for a fleet.

az fleet identitybindingprofile list --fleet-name
                                     --resource-group

Examples

List the identity binding profiles of a fleet.

az fleet identitybindingprofile 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 identitybindingprofile list-members

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

List fleet members for an identity binding profile.

Without --selector, lists members the profile is currently applied to. With --selector, lists members that would match the profile's label selector (i.e. candidates for the next apply).

az fleet identitybindingprofile list-members --fleet-name
                                             --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]
                                             [--selector]

Examples

List members the profile is currently applied to.

az fleet identitybindingprofile list-members -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile

List members that would match the profile's selector.

az fleet identitybindingprofile list-members -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile --selector

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the identity binding profile.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--selector

Filter by the profile's label selector (members that would match after apply) instead of currently applied members.

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 identitybindingprofile show

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Get an identity binding profile.

az fleet identitybindingprofile show --fleet-name
                                     --name
                                     --resource-group

Examples

Show the details of an identity binding profile.

az fleet identitybindingprofile show -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile

Required Parameters

--fleet-name -f

Specify the fleet name.

--name -n

Specify name for the identity binding profile.

--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 identitybindingprofile wait

Preview

Command group 'fleet identitybindingprofile' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Wait for an identity binding profile to reach a desired state.

az fleet identitybindingprofile wait --fleet-name
                                     --identity-binding-profile-name --name
                                     --resource-group
                                     [--acquire-policy-token]
                                     [--change-reference]
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--interval]
                                     [--timeout]
                                     [--updated]

Examples

Wait for the identity binding profile to finish applying.

az fleet identitybindingprofile wait -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile --custom "properties.provisioningState=='Succeeded'"

Wait for the identity binding profile to be created.

az fleet identitybindingprofile wait -g MyFleetResourceGroup -f MyFleetName -n MyIdentityBindingProfile --created

Required Parameters

--fleet-name -f

Specify the fleet name.

--identity-binding-profile-name --name -n

Specify name for the identity binding profile.

--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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--change-reference

The related change reference ID for this resource operation.

Property Value
Parameter group: Global Policy Arguments
--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