az connectedmachine extension

Reference

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 an extension.	Extension	GA
az connectedmachine extension delete	Delete an 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	Show an extension of a Non-Azure machine.	Extension	GA
az connectedmachine extension update	Update an 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 an extension.

az connectedmachine extension create --extension-name
                                     --machine-name
                                     --resource-group
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-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 --name CustomScriptExtension --location eastus2euap --type CustomScriptExtension --publisher Microsoft.Compute --type-handler-version 1.10 --machine-name myMachine --resource-group myResourceGroup

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

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

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.

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.

--instance-view

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

--location -l

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

--no-wait

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

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 json-file and yaml-file.

--publisher

The name of the extension handler publisher.

--settings

Json formatted public settings for the extension. Support json-file and yaml-file.

--tags

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

--type

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

--type-handler-version

Specifies the version of the script handler.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az connectedmachine extension delete

Delete an extension.

az connectedmachine extension delete [--extension-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 --name myName --machine-name myMachine --resource-group myResourceGroup

Optional Parameters

--extension-name --name -n

The name of the machine extension.

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

--machine-name

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

--no-wait

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

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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

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

--next-token

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az connectedmachine extension show

Show an extension of a Non-Azure machine.

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

Examples

Sample command for extension show

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

Optional Parameters

--extension-name --name -n

The name of the machine extension.

--ids

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

--subscription

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

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az connectedmachine extension update

Update an extension.

az connectedmachine extension update [--add]
                                     [--auto-upgrade-min {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--enable-auto-upgrade {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--extension-name]
                                     [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--force-update-tag]
                                     [--ids]
                                     [--instance-view]
                                     [--machine-name]
                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                     [--protected-settings]
                                     [--publisher]
                                     [--remove]
                                     [--resource-group]
                                     [--set]
                                     [--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

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

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

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.

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

--extension-name --name -n

The name of the machine extension.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

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.

--ids

--instance-view

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

--machine-name

The name of the machine containing the extension.

--no-wait

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

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 json-file and yaml-file.

--publisher

The name of the extension handler publisher.

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

--resource-group -g

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

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

--settings

Json formatted public settings for the extension. Support json-file and yaml-file.

--subscription

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

--tags

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

--type

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

--type-handler-version

Specifies the version of the script handler.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

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]
                                   [--ids]
                                   [--interval]
                                   [--machine-name]
                                   [--resource-group]
                                   [--subscription]
                                   [--timeout]
                                   [--updated]

Optional Parameters

--created

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

Default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False

--exists

Wait until the resource exists.

Default value: False

--extension-name --name -n

The name of the machine extension.

--ids

--interval

Polling interval in seconds.

Default value: 30

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

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az connectedmachine extension

Commands

az connectedmachine extension create

Examples

Required Parameters

Optional Parameters

az connectedmachine extension delete

Examples

Optional Parameters

az connectedmachine extension list

Examples

Required Parameters

Optional Parameters

az connectedmachine extension show

Examples

Optional Parameters

az connectedmachine extension update

Examples

Optional Parameters

az connectedmachine extension wait

Optional Parameters

Additional resources