az aks pod-identity

  • Reference

Note

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

Commands to manage pod identities in managed Kubernetes cluster.

Commands

Name Description Type Status
az aks pod-identity add

Add a pod identity to a managed Kubernetes cluster.

 Extension GA
az aks pod-identity delete

Remove a pod identity from a managed Kubernetes cluster.

 Extension GA
az aks pod-identity exception

Commands to manage pod identity exceptions in managed Kubernetes cluster.

 Extension GA
az aks pod-identity exception add

Add a pod identity exception to a managed Kubernetes cluster.

 Extension GA
az aks pod-identity exception delete

Remove a pod identity exception from a managed Kubernetes cluster.

 Extension GA
az aks pod-identity exception list

List pod identity exceptions in a managed Kubernetes cluster.

 Extension GA
az aks pod-identity exception update

Update a pod identity exception in a managed Kubernetes cluster.

 Extension GA
az aks pod-identity list

List pod identities in a managed Kubernetes cluster.

 Extension GA

az aks pod-identity add

Add a pod identity to a managed Kubernetes cluster.

az aks pod-identity add --cluster-name
                        --identity-resource-id
                        --namespace
                        --resource-group
                        [--aks-custom-headers]
                        [--binding-selector]
                        [--name]

Examples

Add pod identity

az aks pod-identity add --cluster-name MyManagedCluster --resource-group MyResourceGroup --namespace my-namespace --name my-identity --identity-resource-id <my-identity-resource-id>

Required Parameters

--cluster-name

The cluster name.

--identity-resource-id

Resource id of the identity to use.

--namespace

The pod identity namespace.

--resource-group -g

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

Optional Parameters

--aks-custom-headers

Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.

--binding-selector

Optional binding selector to use.

--name -n

The pod identity name. Generate if not specified.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az aks pod-identity delete

Remove a pod identity from a managed Kubernetes cluster.

az aks pod-identity delete --cluster-name
                           --name
                           --namespace
                           --resource-group
                           [--aks-custom-headers]

Required Parameters

--cluster-name

The cluster name.

--name -n

The pod identity name.

--namespace

The pod identity namespace.

--resource-group -g

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

Optional Parameters

--aks-custom-headers

Send custom headers. When specified, format should be Key1=Value1,Key2=Value2.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.

az aks pod-identity list

List pod identities in a managed Kubernetes cluster.

az aks pod-identity list --cluster-name
                         --resource-group

Required Parameters

--cluster-name

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

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.