az appservice kube

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.

Manage Kubernetes Environments.

Commands

az appservice kube create

Create a Kubernetes Environment.

az appservice kube delete

Delete kubernetes environment.

az appservice kube list

List kubernetes environments by subscription or resource group.

az appservice kube show

Show the details of a kubernetes environment.

az appservice kube update

Update a Kubernetes Environment. Currently not supported.

az appservice kube wait

Wait for a Kubernetes Environment to reach a desired state.

az appservice kube create

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.

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

az appservice kube delete

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.

--yes -y

Do not prompt for confirmation.

az appservice kube list

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

az appservice kube show

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

az appservice kube update

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.

--static-ip

New Static IP Address.

--tags

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

az appservice kube wait

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30
--timeout

Maximum wait in seconds.

default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.