az vmss extension
Manage extensions on a VM scale set.
Commands
az vmss extension delete |
Delete an extension from a VMSS. |
az vmss extension image |
Find the available VM extensions for a subscription and region. |
az vmss extension image list |
List the information on available extensions. |
az vmss extension image list-names |
Gets a list of virtual machine extension image types. |
az vmss extension image list-versions |
Gets a list of virtual machine extension image versions. |
az vmss extension image show |
Gets a virtual machine extension image. |
az vmss extension list |
List extensions associated with a VMSS. |
az vmss extension set |
Add an extension to a VMSS or update an existing extension. |
az vmss extension show |
Show details on a VMSS extension. |
az vmss extension delete
Delete an extension from a VMSS.
az vmss extension delete --name
--resource-group
--vmss-name
[--no-wait]
[--subscription]
Examples
Delete an extension from a VMSS. (autogenerated)
az vmss extension delete --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss
Required Parameters
Name of the extension.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Scale set name. You can configure the default using az configure --defaults vmss=<name>
.
Optional Parameters
Do not wait for the long-running operation to finish.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az vmss extension list
List extensions associated with a VMSS.
az vmss extension list --resource-group
--vmss-name
[--query-examples]
[--subscription]
Examples
List extensions associated with a VMSS. (autogenerated)
az vmss extension list --resource-group MyResourceGroup --vmss-name MyVmss
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Scale set name. You can configure the default using az configure --defaults vmss=<name>
.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az vmss extension set
Add an extension to a VMSS or update an existing extension.
Get extension details from az vmss extension image list
.
az vmss extension set --name
--publisher
--resource-group
--vmss-name
[--extension-instance-name]
[--force-update]
[--no-auto-upgrade {false, true}]
[--no-wait]
[--protected-settings]
[--provision-after-extensions]
[--settings]
[--subscription]
[--version]
Examples
Set an extension which depends on two previously set extensions. That is, When a VMSS instance is created or reimaged, the customScript extension will be provisioned only after all extensions that it depends on have been provisioned. The extension need not depend on the other extensions for pre-requisite configurations.
az vmss extension set --vmss-name my-vmss --name customScript --resource-group my-group \
--version 2.0 --publisher Microsoft.Azure.Extensions \
--provision-after-extensions NetworkWatcherAgentLinux VMAccessForLinux \
--settings '{"commandToExecute": "echo testing"}'
Required Parameters
Name of the extension.
The name of the extension publisher.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Scale set name. You can configure the default using az configure --defaults vmss=<name>
.
Optional Parameters
Name of extension instance, which can be customized. Default: name of the extension.
Force to update even if the extension configuration has not changed.
If set, the extension service will not automatically pick or upgrade to the latest minor version, even if the extension is redeployed.
Do not wait for the long-running operation to finish.
Protected settings in JSON format for sensitive information like credentials. A JSON file path is also accepted.
Space-separated list of extension names after which this extension should be provisioned. These extensions must already be set on the vm.
Extension settings in JSON format. A JSON file path is also accepted.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The version of the extension. To pin extension version to this value, please specify --no-auto-upgrade.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
az vmss extension show
Show details on a VMSS extension.
az vmss extension show --name
--resource-group
--vmss-name
[--query-examples]
[--subscription]
Examples
Show details on a VMSS extension. (autogenerated)
az vmss extension show --name MyExtension --resource-group MyResourceGroup --vmss-name MyVmss
Required Parameters
Name of the extension.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Scale set name. You can configure the default using az configure --defaults vmss=<name>
.
Optional Parameters
Recommend JMESPath string for you. You can copy one of the query and paste it after --query parameter within double quotation marks to see the results. You can add one or more positional keywords so that we can give suggestions based on these key words.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.