az connectedmachine extension

Note

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

Manage a VM extension on an Azure Arc-Enabled Server.

Commands

Name	Description	Type	Status
az connectedmachine extension create	Create operation to create or update the extension.	Extension	GA
az connectedmachine extension delete	Delete operation to delete the extension.	Extension	GA
az connectedmachine extension image	Manage VM extension metadata available for Azure Arc-Enabled Servers.	Extension	GA
az connectedmachine extension image list	List all Extension versions based on location, publisher, extensionType.	Extension	GA
az connectedmachine extension image show	Get an Extension Metadata based on location, publisher, extensionType and version.	Extension	GA
az connectedmachine extension list	Get all extensions of a Non-Azure machine.	Extension	GA
az connectedmachine extension show	Get operation to get the extension.	Extension	GA
az connectedmachine extension update	Update operation to create or update the extension.	Extension	GA
az connectedmachine extension wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az connectedmachine extension create

Create operation to create or update the extension.

az connectedmachine extension create --extension-name --name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--instance-view]
                                     [--location]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--settings]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Examples

sample command for extension create

az connectedmachine extension create --resource-group myResourceGroup --machine-name myMachine --extension-name CustomScriptExtension --location eastus2euap --publisher Microsoft.Compute --type-handler-version 1.10 --type CustomScriptExtension --settings "{commandToExecute:'powershell.exe -c "Get-Process | Where-Object { $_.CPU -gt 10000 }"'}"

Required Parameters

--extension-name --name -n

The name of the machine extension.

--machine-name

The name of the machine where the extension should be created or updated.

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

--auto-upgrade-min --auto-upgrade-minor-version

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--enable-auto-upgrade --enable-automatic-upgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--force-update-tag

How the extension handler should be forced to update even if the extension configuration has not changed.

Property	Value
Parameter group:	Properties Arguments

--instance-view

The machine extension instance view. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

Property	Value
Parameter group:	ExtensionParameters Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--protected-settings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--publisher

The name of the extension handler publisher.

Property	Value
Parameter group:	Properties Arguments

--settings

Json formatted public settings for the extension. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ExtensionParameters Arguments

--type

Specifies the type of the extension; an example is "CustomScriptExtension".

Property	Value
Parameter group:	Properties Arguments

--type-handler-version

Specifies the version of the script handler.

Property	Value
Parameter group:	Properties Arguments

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 connectedmachine extension delete

Delete operation to delete the extension.

az connectedmachine extension delete [--extension-name --name]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--resource-group]
                                     [--subscription]
                                     [--yes]

Examples

sample command for extension delete

az connectedmachine extension delete --resource-group myResourceGroup --machine-name myMachine --extension-name MMA

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--extension-name --name -n

The name of the machine extension.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--machine-name

The name of the machine where the extension should be deleted.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az connectedmachine extension list

Get all extensions of a Non-Azure machine.

az connectedmachine extension list --machine-name
                                   --resource-group
                                   [--expand]
                                   [--max-items]
                                   [--next-token]

Examples

Sample command for extension list

az connectedmachine extension list --machine-name myMachine --resource-group myResourceGroup

Required Parameters

--machine-name

The name of the machine containing the extension.

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

--expand

The expand expression to apply on the operation.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

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 connectedmachine extension show

Get operation to get the extension.

az connectedmachine extension show [--extension-name --name]
                                   [--ids]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]

Examples

sample command for extension show

az connectedmachine extension show --resource-group myResourceGroup --machine-name myMachine --extension-name CustomScriptExtension

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--extension-name --name -n

The name of the machine extension.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--machine-name

The name of the machine containing the extension.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az connectedmachine extension update

Update operation to create or update the extension.

az connectedmachine extension update [--auto-upgrade-min --auto-upgrade-minor-version {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade --enable-automatic-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name --name]
                                     [--force-update-tag]
                                     [--ids]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--resource-group]
                                     [--settings]
                                     [--subscription]
                                     [--tags]
                                     [--type]
                                     [--type-handler-version]

Examples

sample command for extension update

az connectedmachine extension update --name CustomScriptExtension --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group 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.

--auto-upgrade-min --auto-upgrade-minor-version

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

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--enable-auto-upgrade --enable-automatic-upgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--extension-name --name -n

The name of the machine extension.

Property	Value
Parameter group:	Resource Id Arguments

--force-update-tag

How the extension handler should be forced to update even if the extension configuration has not changed.

Property	Value
Parameter group:	Properties Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--machine-name

The name of the machine where the extension should be created or updated.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--protected-settings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--publisher

The name of the extension handler publisher.

Property	Value
Parameter group:	Properties Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--settings

Json formatted public settings for the extension. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--tags

Resource tags Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ExtensionParameters Arguments

--type

Specifies the type of the extension; an example is "CustomScriptExtension".

Property	Value
Parameter group:	Properties Arguments

--type-handler-version

Specifies the version of the script handler.

Property	Value
Parameter group:	Properties Arguments

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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az connectedmachine extension wait

Place the CLI in a waiting state until a condition is met.

az connectedmachine extension wait [--created]
                                   [--custom]
                                   [--deleted]
                                   [--exists]
                                   [--extension-name --name]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--extension-name --name -n

The name of the machine extension.

Property	Value
Parameter group:	Resource Id Arguments

--ids

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.

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--machine-name

The name of the machine containing the extension.

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Property	Value
Parameter group:	Resource Id Arguments

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
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.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False