Share via

az vme

Note

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

Commands to manage version managed extensions on connected kubernetes clusters.

Commands

Name Description Type Status
az vme install

Install version managed extensions.

 Extension GA
az vme list

List version managed extensions.

 Extension GA
az vme uninstall

Uninstall version managed extensions.

 Extension GA
az vme upgrade

Check version managed extensions' upgrade status.

 Extension GA

az vme install

Install version managed extensions.

az vme install --cluster-name
               --include {all, microsoft.arc.containerstorage, microsoft.azure.secretstore}
               --resource-group
               [--kube-config]
               [--kube-context]

Examples

Install all version managed extensions

az vme install --resource-group my-resource-group --cluster-name my-cluster --include all

Install specific version managed extension

az vme install --resource-group my-resource-group --cluster-name my-cluster --include microsoft.azure.secretstore

Enable feature flag and then install specific version managed extension

az vme install --resource-group my-resource-group --cluster-name my-cluster --include microsoft.arc.containerstorage --kube-config /path/to/kubeconfig.yaml --kube-context my-context

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--include -i

Extension types to be installed.

Property Value
Accepted values: all, microsoft.arc.containerstorage, microsoft.azure.secretstore
--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.

--kube-config

Path to the kube config file. Optional if the cluster has the feature flag enabled or the current Kubernetes config/context is set to this cluster.

--kube-context

Kube context from current machine. Optional if the cluster has the feature flag enabled or the current Kubernetes config/context is set to this cluster.

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

List version managed extensions.

az vme list --cluster-name
            --resource-group

Examples

List version managed extensions

az vme list --resource-group my-resource-group --cluster-name my-cluster

List version managed extensions with table format

az vme list --resource-group my-resource-group --cluster-name my-cluster --output table

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

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

Uninstall version managed extensions.

az vme uninstall --cluster-name
                 --include {all, microsoft.arc.containerstorage, microsoft.azure.secretstore}
                 --resource-group
                 [--force]

Examples

Uninstall all version managed extensions

az vme uninstall --resource-group my-resource-group --cluster-name my-cluster --include all

Uninstall specific version managed extension

az vme uninstall --resource-group my-resource-group --cluster-name my-cluster --include microsoft.azure.secretstore

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

--include -i

Extension types to be uninstalled.

Property Value
Accepted values: all, microsoft.arc.containerstorage, microsoft.azure.secretstore
--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.

--force

Specify whether to force delete the extension from the cluster.

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

Check version managed extensions' upgrade status.

az vme upgrade --cluster-name
               --resource-group
               [--kube-config]
               [--kube-context]
               [--timeout]
               [--wait]

Examples

Check version managed extensions' upgrade status

az vme upgrade --resource-group my-resource-group --cluster-name my-cluster --wait

Required Parameters

--cluster-name -c

Name of the Kubernetes cluster.

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

--kube-config

Path to the kube config file. Optional if the cluster has the feature flag enabled or the current Kubernetes config/context is set to this cluster.

--kube-context

Kube context from current machine. Optional if the cluster has the feature flag enabled or the current Kubernetes config/context is set to this cluster.

--timeout

Time required (in seconds) for the bundle upgrade to finish.

Property Value
Default value: 3600
--wait

Wait for the bundle upgrade to finish.

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