extension.yml

### YamlMime:AzureCLIGroup
uid: az_scvmm_vm_extension
name: az scvmm vm extension
extensionInformation: >-
  > [!NOTE]

  > This reference is part of the **scvmm** extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an **az scvmm vm extension** command. [Learn more](https://learn.microsoft.com/cli/azure/azure-cli-extensions-overview) about extensions.
summary: |-
  Manage vm extension with scvmm.
status: GA
sourceType: Extension
directCommands:
- uid: az_scvmm_vm_extension_create
  name: az scvmm vm extension create
  summary: |-
    The operation to create the extension.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm 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:
  - summary: |-
      Create a VM Extension
    syntax: az scvmm vm extension create --name contoso-extension --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 contoso-vm --resource-group contoso-rg
  requiredParameters:
  - isRequired: true
    name: --location -l
    summary: |-
      Location. Values from: `az account list-locations`. You can configure the default location using `az configure --defaults location=<location>`.
  - isRequired: true
    name: --name
    summary: |-
      The name of the vm extension.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - isRequired: true
    name: --vm-name
    summary: |-
      The name of the vm where the extension should be created or updated.
  optionalParameters:
  - name: --auto-upgrade-minor
    parameterValueGroup: "false, true"
    summary: |-
      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.
  - name: --enable-auto-upgrade
    parameterValueGroup: "false, true"
    summary: |-
      Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
  - name: --force-update-tag
    summary: |-
      How the extension handler should be forced to update even if the extension configuration has not changed.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --protected-settings
    summary: |-
      The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file.
  - name: --publisher
    summary: |-
      The name of the extension handler publisher.
  - name: --settings
    summary: |-
      Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
  - name: --type
    summary: |-
      Specify the type of the extension; an example is "CustomScriptExtension".
  - name: --type-handler-version
    summary: |-
      Specifies the version of the script handler.
- uid: az_scvmm_vm_extension_delete
  name: az scvmm vm extension delete
  summary: |-
    The operation to delete the extension.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm vm extension delete [--ids]
                                 [--name]
                                 [--no-wait]
                                 [--resource-group]
                                 [--subscription]
                                 [--vm-name]
                                 [--yes]
  examples:
  - summary: |-
      Delete a VM Extension
    syntax: az scvmm vm extension delete --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --name
    summary: |-
      The name of the vm extension.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --vm-name
    summary: |-
      The name of the vm where the extension should be deleted.
  - name: --yes -y
    defaultValue: "False"
    summary: |-
      Do not prompt for confirmation.
- uid: az_scvmm_vm_extension_list
  name: az scvmm vm extension list
  summary: |-
    The operation to get all extensions of a non-Azure vm.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm vm extension list --resource-group
                               --vm-name
                               [--expand]
  examples:
  - summary: |-
      Get all VM Extensions
    syntax: az scvmm vm extension list --vm-name contoso-vm --resource-group contoso-rg
  requiredParameters:
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - isRequired: true
    name: --vm-name
    summary: |-
      The name of the vm containing the extension.
  optionalParameters:
  - name: --expand
    summary: |-
      The expand expression to apply on the operation.
- uid: az_scvmm_vm_extension_show
  name: az scvmm vm extension show
  summary: |-
    The operation to get the extension.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm vm extension show [--ids]
                               [--name]
                               [--resource-group]
                               [--subscription]
                               [--vm-name]
  examples:
  - summary: |-
      Get VM Extension
    syntax: az scvmm vm extension show --name contoso-extension --vm-name contoso-vm --resource-group contoso-rg
  optionalParameters:
  - name: --ids
    summary: |-
      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.
  - name: --name
    summary: |-
      The name of the vm extension.
  - name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - name: --subscription
    summary: |-
      Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
  - name: --vm-name
    summary: |-
      The name of the vm containing the extension.
- uid: az_scvmm_vm_extension_update
  name: az scvmm vm extension update
  summary: |-
    The operation to update the extension.
  status: GA
  sourceType: Extension
  syntax: >-
    az scvmm 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:
  - summary: |-
      Update a VM Extension
    syntax: az scvmm vm extension update --name contoso-extension --type CustomScriptExtension --publisher Microsoft.Compute --settings "{\"commandToExecute\":\"powershell.exe -c \\\"Get-Process | Where-Object { $_.CPU -lt 100 }\\\"\"}" --type-handler-version 1.10 --vm-name contoso-vm --resource-group contoso-rg
  requiredParameters:
  - isRequired: true
    name: --name
    summary: |-
      The name of the vm extension.
  - isRequired: true
    name: --resource-group -g
    summary: |-
      Name of resource group. You can configure the default group using `az configure --defaults group=<name>`.
  - isRequired: true
    name: --vm-name
    summary: |-
      The name of the vm where the extension should be created or updated.
  optionalParameters:
  - name: --auto-upgrade-minor
    parameterValueGroup: "false, true"
    summary: |-
      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.
  - name: --enable-auto-upgrade
    parameterValueGroup: "false, true"
    summary: |-
      Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.
  - name: --force-update-tag
    summary: |-
      How the extension handler should be forced to update even if the extension configuration has not changed.
  - name: --no-wait
    defaultValue: "False"
    summary: |-
      Do not wait for the long-running operation to finish.
  - name: --protected-settings
    summary: |-
      The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Expected value: json-string/json-file/@json-file.
  - name: --publisher
    summary: |-
      The name of the extension handler publisher.
  - name: --settings
    summary: |-
      Json formatted public settings for the extension. Expected value: json-string/json-file/@json-file.
  - name: --tags
    summary: |-
      Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
  - name: --type
    summary: |-
      Specify the type of the extension; an example is "CustomScriptExtension".
  - name: --type-handler-version
    summary: |-
      Specifies the version of the script handler.
commands:
- az_scvmm_vm_extension_create
- az_scvmm_vm_extension_delete
- az_scvmm_vm_extension_list
- az_scvmm_vm_extension_show
- az_scvmm_vm_extension_update
globalParameters:
- name: --debug
  summary: |-
    Increase logging verbosity to show all debug logs.
- name: --help -h
  summary: |-
    Show this help message and exit.
- name: --only-show-errors
  summary: |-
    Only show errors, suppressing warnings.
- name: --output -o
  defaultValue: "json"
  parameterValueGroup: "json, jsonc, none, table, tsv, yaml, yamlc"
  summary: |-
    Output format.
- name: --query
  summary: |-
    JMESPath query string. See <a href="http://jmespath.org/">http://jmespath.org/</a> for more information and examples.
- name: --subscription
  summary: |-
    Name or ID of subscription. You can configure the default subscription using `az account set -s NAME_OR_ID`.
- name: --verbose
  summary: |-
    Increase logging verbosity. Use --debug for full debug logs.
metadata:
  description: Manage vm extension with scvmm.