az appservice kube
Note
This reference is part of the appservice-kube extension for the Azure CLI (version 2.60.0 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
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
ID of the custom location.
Name of the kubernetes environment.
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.
Location. Values from: az account list-locations
. You can configure the default location using az configure --defaults location=<location>
.
Do not wait for the create to complete, and return immediately after queuing the create.
Property | Value |
---|---|
Default value: | False |
Static IP Address. This is required if an AKS resource ID is specified.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice kube delete
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 of the Kubernetes Environment.
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.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice kube list
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice kube show
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 of the Kubernetes Environment.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice kube update
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 of the kubernetes environment.
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.
ID of the custom location.
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Default value: | False |
New Static IP Address.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az appservice kube wait
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 of the Kubernetes Environment.
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.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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 |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |