az connectedvmware vm extension
Note
This reference is part of the connectedvmware extension for the Azure CLI (version 2.0.67 or higher). The extension will automatically install the first time you run an az connectedvmware vm extension command. Learn more about extensions.
Manage vm extension with connectedvmware.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az connectedvmware vm extension create |
The operation to create the extension. |
Extension | GA |
| az connectedvmware vm extension delete |
The operation to delete the extension. |
Extension | GA |
| az connectedvmware vm extension list |
The operation to get all extensions of a non-Azure vm. |
Extension | GA |
| az connectedvmware vm extension show |
The operation to get the extension. |
Extension | GA |
| az connectedvmware vm extension update |
The operation to update the extension. |
Extension | GA |
az connectedvmware vm extension create
The operation to create the extension.
az connectedvmware vm extension create --location
--name
--resource-group
--vm-name
[--auto-upgrade-minor {false, true}]
[--enable-auto-upgrade {false, true}]
[--force-update-tag]
[--no-wait]
[--protected-settings]
[--publisher]
[--settings]
[--tags]
[--type]
[--type-handler-version]Examples
Create a VM Extension
az connectedvmware vm extension create --name "CustomScriptExtension" --location "eastus2euap" --type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -gt 10000 }\\\"\"}" --type-handler-version "1.10" --vm-name "vm name" --resource-group "myResourceGroup"Required Parameters
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
The name of the vm extension.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the vm where the extension should be created or updated.
Optional Parameters
Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
How the extension handler should be forced to update even if the extension configuration has not changed.
Do not wait for the long-running operation to finish.
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file.
The name of the extension handler publisher.
Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Specify the type of the extension; an example is "CustomScriptExtension".
Specifies the version of the script handler.
Global Parameters
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.
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.
az connectedvmware vm extension delete
The operation to delete the extension.
az connectedvmware vm extension delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--vm-name]
[--yes]Examples
Delete a VM Extension
az connectedvmware vm extension delete --name "vm extension name" --vm-name "vm name" --resource-group "myResourceGroup"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the vm extension.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the vm where the extension should be deleted.
Do not prompt for confirmation.
Global Parameters
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.
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.
az connectedvmware vm extension list
The operation to get all extensions of a non-Azure vm.
az connectedvmware vm extension list --resource-group
--vm-name
[--expand]Examples
Get all VM Extensions
az connectedvmware vm extension list --vm-name "vm name" --resource-group "myResourceGroup"Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the vm containing the extension.
Optional Parameters
The expand expression to apply on the operation.
Global Parameters
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.
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.
az connectedvmware vm extension show
The operation to get the extension.
az connectedvmware vm extension show [--ids]
[--name]
[--resource-group]
[--subscription]
[--vm-name]Examples
Get VM Extension
az connectedvmware vm extension show --name "CustomScriptExtension" --vm-name "vm name" --resource-group "myResourceGroup"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the vm extension.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
The name of the vm containing the extension.
Global Parameters
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.
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.
az connectedvmware vm extension update
The operation to update the extension.
az connectedvmware vm extension update --name
--resource-group
--vm-name
[--auto-upgrade-minor {false, true}]
[--enable-auto-upgrade {false, true}]
[--force-update-tag]
[--no-wait]
[--protected-settings]
[--publisher]
[--settings]
[--tags]
[--type]
[--type-handler-version]Examples
Update a VM Extension
az connectedvmware vm extension update --name "CustomScriptExtension" --type "CustomScriptExtension" --publisher "Microsoft.Compute" --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version "1.10" --vm-name "vm name" --resource-group "myResourceGroup"Required Parameters
The name of the vm extension.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
The name of the vm where the extension should be created or updated.
Optional Parameters
Indicate whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.
Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
How the extension handler should be forced to update even if the extension configuration has not changed.
Do not wait for the long-running operation to finish.
The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file.
The name of the extension handler publisher.
Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Specify the type of the extension; an example is "CustomScriptExtension".
Specifies the version of the script handler.
Global Parameters
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.
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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for