Share via

az appservice kube

  • Preview
  • Reference

Note

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

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

Manage Kubernetes Environments.

Commands

Name Description Type Status
az appservice kube create

Create a Kubernetes Environment.

 Extension Preview
az appservice kube delete

Delete kubernetes environment.

 Extension Preview
az appservice kube list

List kubernetes environments by subscription or resource group.

 Extension Preview
az appservice kube show

Show the details of a kubernetes environment.

 Extension Preview
az appservice kube update

Update a Kubernetes Environment. Currently not supported.

 Extension Preview
az appservice kube wait

Wait for a Kubernetes Environment to reach a desired state.

 Extension Preview

az appservice kube create

Preview

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

Create a Kubernetes Environment.

az appservice kube create --custom-location
                          --name
                          --resource-group
                          [--location]
                          [--no-wait]
                          [--static-ip]
                          [--tags]

Examples

Create Kubernetes Environment with a custom location in the same resource group

az appservice kube create -n MyKubeEnvironment -g MyResourceGroup --static-ip 0.0.0.0 --custom-location custom_location_name

Create Kubernetes Environment

az appservice kube create -n MyKubeEnvironment -g MyResourceGroup --static-ip 0.0.0.0 --custom-location /subscriptions/sub_id/resourcegroups/group_name/providers/microsoft.extendedlocation/customlocations/custom_location_name

Required Parameters

--custom-location -c

ID of the custom location.

--name -n

Name of the kubernetes environment.

--resource-group -g

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

Optional Parameters

--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 create to complete, and return immediately after queuing the create.

Default value: False
--static-ip

Static IP Address. This is required if an AKS resource ID is specified.

--tags

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

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 appservice kube delete

Preview

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

Delete kubernetes environment.

az appservice kube delete --name
                          --resource-group
                          [--no-wait]
                          [--yes]

Examples

Delete Kubernetes Environment.

az appservice kube delete -g MyResourceGroup -n MyKubeEnvironment

Required Parameters

--name -n

Name of the Kubernetes Environment.

--resource-group -g

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

Optional Parameters

--no-wait

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

Default value: False
--yes -y

Do not prompt for confirmation.

Default value: False
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 appservice kube list

Preview

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

List kubernetes environments by subscription or resource group.

az appservice kube list [--resource-group]

Examples

List Kubernetes Environments by subscription.

az appservice kube list

List Kubernetes Environments by resource group.

az appservice kube list -g MyResourceGroup

Optional Parameters

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

az appservice kube show

Preview

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

Show the details of a kubernetes environment.

az appservice kube show --name
                        --resource-group

Examples

Show the details of a Kubernetes Environment.

az appservice kube show -n MyKubeEnvironment -g MyResourceGroup

Required Parameters

--name -n

Name of the Kubernetes Environment.

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

az appservice kube update

Preview

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

Update a Kubernetes Environment. Currently not supported.

az appservice kube update --name
                          --resource-group
                          [--custom-location]
                          [--no-wait]
                          [--static-ip]
                          [--tags]

Examples

Update Kubernetes Environment

az appservice kube update --name MyKubeEnvironment -g MyResourceGroup --static-ip 0.0.0.0

Required Parameters

--name -n

Name of the kubernetes environment.

--resource-group -g

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

Optional Parameters

--custom-location -c

ID of the custom location.

--no-wait

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

Default value: False
--static-ip

New Static IP Address.

--tags

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

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 appservice kube wait

Preview

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

Wait for a Kubernetes Environment to reach a desired state.

az appservice kube wait --name
                        --resource-group
                        [--created]
                        [--custom]
                        [--deleted]
                        [--exists]
                        [--interval]
                        [--timeout]
                        [--updated]

Examples

Wait for a Kubernetes Environment to be provisioned, polling every 60 seconds.

az appservice kube wait -g MyResourceGroup -n MyKubeEnvironment \
    --created --interval 60

Required Parameters

--name -n

Name of the Kubernetes Environment.

--resource-group -g

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

Optional Parameters

--created

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

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--interval

Polling interval in seconds.

Default value: 30
--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.