az agentfabric aks

Note

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

Manage Agent Fabric compute enrollment.

Manage compute-resource enrollment through ClusterAssociation resources under an Agent Fabric. This AKS-oriented command surface also preserves the REST API's support for ACI SandboxGroup resource IDs. Association names are independent from target resource names; --cluster-name is retained as a compatibility alias for the association name.

Commands

Name	Description	Type	Status
az agentfabric aks attach	Attach a compute resource to an Agent Fabric.	Extension	GA
az agentfabric aks detach	Delete an Agent Fabric compute association.	Extension	GA
az agentfabric aks list	List compute associations under an Agent Fabric.	Extension	GA
az agentfabric aks show	Show an Agent Fabric compute association.	Extension	GA
az agentfabric aks update	Patch enrollment tags, SKU, or gateway IP.	Extension	GA
az agentfabric aks wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az agentfabric aks attach

Attach a compute resource to an Agent Fabric.

AKS targets require managed Microsoft Entra ID authentication. Create the cluster with az aks create --enable-aad, or enable it on an existing cluster with az aks update --enable-aad, before attaching. Managed identity alone does not enable Microsoft Entra ID authentication. The association name is independent of the target resource name.

az agentfabric aks attach --cluster-resource-id
                          [--acquire-policy-token]
                          [--association-name --cluster-name --name]
                          [--change-reference]
                          [--fabric-name]
                          [--ids]
                          [--location]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--sku {Premium, Standard}]
                          [--subscription]
                          [--tags]

Examples

Attach a Microsoft Entra ID-enabled AKS cluster

az agentfabric aks attach -g myResourceGroup --fabric-name myFabric -n myEnrollment
--location centraluseuap --cluster-resource-id <aks-resource-id>
--sku Standard

Required Parameters

--cluster-resource-id

The AKS managed cluster or ACI SandboxGroup to enroll. The resource must be in the same subscription as the AgentFabric; a different resource group is allowed. Set at creation and immutable thereafter; to enroll a different resource, delete and recreate the association. AF rejects the request if the resource is already associated with another fabric.

Property	Value
Parameter group:	Properties Arguments

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

--association-name --cluster-name --name -n

Name of the ClusterAssociation child resource. --cluster-name is retained as a compatibility alias.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--fabric-name

Name of the parent Agent Fabric.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	Resource Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sku

Determines which AgentFabric components are deployed to the cluster. Defaults to Standard when omitted at creation. An update may upgrade Standard to Premium but cannot downgrade Premium to Standard. The SKU remains unchanged when omitted during an update.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Premium, Standard

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Resource Arguments

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.

--verbose

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

Property	Value
Default value:	False

az agentfabric aks detach

Delete an Agent Fabric compute association.

Manage compute-resource enrollment through ClusterAssociation resources under an Agent Fabric. This AKS-oriented command surface also preserves the REST API's support for ACI SandboxGroup resource IDs. Association names are independent from target resource names; --cluster-name is retained as a compatibility alias for the association name.

az agentfabric aks detach [--acquire-policy-token]
                          [--association-name --cluster-name --name]
                          [--change-reference]
                          [--fabric-name]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--subscription]
                          [--yes]

Examples

Detach a compute association

az agentfabric aks detach --resource-group rgnetworksecurity --fabric-name testAIFabric --association-name testAssociation

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

--association-name --cluster-name --name -n

Name of the ClusterAssociation child resource. --cluster-name is retained as a compatibility alias.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--fabric-name

Name of the parent Agent Fabric.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

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

Property	Value
Default value:	False

az agentfabric aks list

List compute associations under an Agent Fabric.

Manage compute-resource enrollment through ClusterAssociation resources under an Agent Fabric. This AKS-oriented command surface also preserves the REST API's support for ACI SandboxGroup resource IDs. Association names are independent from target resource names; --cluster-name is retained as a compatibility alias for the association name.

az agentfabric aks list --fabric-name
                        --resource-group
                        [--max-items]
                        [--next-token]

Examples

List compute associations

az agentfabric aks list --resource-group rgnetworksecurity --fabric-name testAIFabric

Required Parameters

--fabric-name

Name of the parent Agent Fabric.

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

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

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 agentfabric aks show

Show an Agent Fabric compute association.

Manage compute-resource enrollment through ClusterAssociation resources under an Agent Fabric. This AKS-oriented command surface also preserves the REST API's support for ACI SandboxGroup resource IDs. Association names are independent from target resource names; --cluster-name is retained as a compatibility alias for the association name.

az agentfabric aks show [--association-name --cluster-name --name]
                        [--fabric-name]
                        [--ids]
                        [--resource-group]
                        [--subscription]

Examples

Show a compute association

az agentfabric aks show --resource-group rgnetworksecurity --fabric-name testAIFabric --association-name testAssociation

Optional Parameters

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

--association-name --cluster-name --name -n

Name of the ClusterAssociation child resource. --cluster-name is retained as a compatibility alias.

Property	Value
Parameter group:	Resource Id Arguments

--fabric-name

Name of the parent Agent Fabric.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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.

--verbose

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

Property	Value
Default value:	False

az agentfabric aks update

Patch enrollment tags, SKU, or gateway IP.

Reads the existing target resource ID for ARM linked authorization before sending PATCH. Standard-to-Premium upgrades are supported; Premium-to-Standard downgrades are rejected by the service.

az agentfabric aks update [--acquire-policy-token]
                          [--association-name --cluster-name --name]
                          [--change-reference]
                          [--fabric-name]
                          [--gateway-ip --workload-cluster-gateway-ip]
                          [--ids]
                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                          [--resource-group]
                          [--sku {Premium, Standard}]
                          [--subscription]
                          [--tags]

Examples

Upgrade an enrollment SKU

az agentfabric aks update -g myResourceGroup --fabric-name myFabric -n myAssociation --sku Premium

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

--association-name --cluster-name --name -n

Name of the ClusterAssociation child resource. --cluster-name is retained as a compatibility alias.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--fabric-name

Name of the parent Agent Fabric.

Property	Value
Parameter group:	Resource Id Arguments

--gateway-ip --workload-cluster-gateway-ip -i

The IPv4 or IPv6 address of the workload cluster gateway used for internal Agent Fabric routing. The resource provider validates the value.

Property	Value
Parameter group:	Properties Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--sku

Determines which AgentFabric components are deployed to the cluster. Only an upgrade from Standard to Premium is supported; Premium cannot be downgraded to Standard. When omitted, the PATCH request is an authorized no-op and the existing SKU remains unchanged.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Premium, Standard

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

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.

--verbose

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

Property	Value
Default value:	False

az agentfabric aks wait

Place the CLI in a waiting state until a condition is met.

az agentfabric aks wait [--acquire-policy-token]
                        [--association-name --cluster-name --name]
                        [--change-reference]
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--fabric-name]
                        [--ids]
                        [--interval]
                        [--resource-group]
                        [--subscription]
                        [--timeout]
                        [--updated]

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

--association-name --cluster-name --name -n

Name of the ClusterAssociation child resource. --cluster-name is retained as a compatibility alias.

Property	Value
Parameter group:	Resource Id 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

--fabric-name

Name of the parent Agent Fabric.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

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

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

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

--verbose

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

Property	Value
Default value:	False