az aks prepared-image-specification

Note

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

Commands to manage prepared image specifications.

Commands

Name	Description	Type	Status
az aks prepared-image-specification create	Create a new prepared image specification.	Extension	GA
az aks prepared-image-specification delete	Delete a prepared image specification.	Extension	GA
az aks prepared-image-specification list	List prepared image specifications.	Extension	GA
az aks prepared-image-specification show	Show a prepared image specification.	Extension	GA
az aks prepared-image-specification update	Update a prepared image specification.	Extension	GA
az aks prepared-image-specification version	Commands to manage prepared image specification versions.	Extension	GA
az aks prepared-image-specification version delete	Delete a prepared image specification version.	Extension	GA
az aks prepared-image-specification version list	List prepared image specification versions.	Extension	GA
az aks prepared-image-specification version show	Show a prepared image specification version.	Extension	GA

az aks prepared-image-specification create

Create a new prepared image specification.

az aks prepared-image-specification create --name
                                           --resource-group
                                           --version
                                           [--acquire-policy-token]
                                           [--assign-identity]
                                           [--change-reference]
                                           [--container-images]
                                           [--customization-scripts]
                                           [--location]
                                           [--no-wait]
                                           [--tags]

Examples

Create a new prepared image specification specifying a container image.

az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --container-images myacr.azurecr.io/myimage:latest

Create a new prepared image specification specifying a customization script.

az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --customization-scripts '[{"name":"myscript","script":"/bin/true","scriptType":"Bash","executionPoint":"NodeImageBuildTime"}]'

Create a new prepared image specification specifying a managed identity.

az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --assign-identity /subscriptions/MySubscription/resourceGroups/AnotherResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/MyIdentity

Create a new prepared image specification specifying tags.

az aks prepared-image-specification create -g MyResourceGroup -n MyPIS --version MyVersion --tags k1=v1 k2=v2

Required Parameters

--name -n

The prepared image specification name.

--resource-group -g

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

--version

The prepared image specification version.

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

--assign-identity

Specify an existing user assigned identity.

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--container-images

Container images.

--customization-scripts

Customization scripts. Expected value: json-string/@json-file.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--no-wait

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

Property	Value
Default value:	False

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 aks prepared-image-specification delete

Delete a prepared image specification.

az aks prepared-image-specification delete --name
                                           --resource-group
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--no-wait]
                                           [--yes]

Required Parameters

--name -n

The prepared image specification 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.

--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 aks prepared-image-specification list

List prepared image specifications.

az aks prepared-image-specification list [--resource-group]

Optional Parameters

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

--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 aks prepared-image-specification show

Show a prepared image specification.

az aks prepared-image-specification show --name
                                         --resource-group

Required Parameters

--name -n

The prepared image specification 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 aks prepared-image-specification update

Update a prepared image specification.

az aks prepared-image-specification update --name
                                           --resource-group
                                           [--acquire-policy-token]
                                           [--change-reference]
                                           [--tags]

Required Parameters

--name -n

The prepared image specification 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.

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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

Feedback

Was this page helpful?