az connectedmachine

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 command. Learn more about extensions.

Manage Azure Arc-Enabled Server.

Commands

Name	Description	Type	Status
az connectedmachine assess-patches	Assess patches on an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine delete	Delete an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine extension	Manage a VM extension on an Azure Arc-Enabled Server.	Extension	GA
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 install-patches	Install patches on an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine license	Manage ESU license on an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine license-profile	Manages all Pay-As-You-Go licenses for an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine license-profile create	Create operation to create a license profile.	Extension	GA
az connectedmachine license-profile delete	Delete operation to delete a license profile.	Extension	GA
az connectedmachine license-profile list	List operation to get all license profiles of a non-Azure machine.	Extension	GA
az connectedmachine license-profile show	Get information about the view of a license profile.	Extension	GA
az connectedmachine license-profile update	Update operation to update a license profile.	Extension	GA
az connectedmachine license-profile wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az connectedmachine license create	Create a license.	Extension	GA
az connectedmachine license delete	Delete a license.	Extension	GA
az connectedmachine license list	Get all licenses of a non-Azure machine.	Extension	GA
az connectedmachine license show	Get information about the view of a license.	Extension	GA
az connectedmachine license update	Update operation to update a license.	Extension	GA
az connectedmachine license wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az connectedmachine list	List all Azure Arc-Enabled Servers in the specified resource group.	Extension	GA
az connectedmachine private-endpoint-connection	Manage private endpoint connection with an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine private-endpoint-connection delete	Delete a private endpoint connection with a given name.	Extension	GA
az connectedmachine private-endpoint-connection list	List all private endpoint connections on a private link scope.	Extension	GA
az connectedmachine private-endpoint-connection show	Get a private endpoint connection.	Extension	GA
az connectedmachine private-endpoint-connection update	Update a private endpoint connection with a given name.	Extension	GA
az connectedmachine private-endpoint-connection wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az connectedmachine private-link-resource	Manage private link resource of an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine private-link-resource list	List the private link resources that need to be created for an Azure Monitor PrivateLinkScope.	Extension	GA
az connectedmachine private-link-resource show	Get the private link resources that need to be created for an Azure Monitor PrivateLinkScope.	Extension	GA
az connectedmachine private-link-scope	Manage private link scope of an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine private-link-scope create	Create an Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.	Extension	GA
az connectedmachine private-link-scope delete	Delete an Azure Arc PrivateLinkScope.	Extension	GA
az connectedmachine private-link-scope list	Get a list of Azure Arc PrivateLinkScopes for a resource group or a subscription.	Extension	GA
az connectedmachine private-link-scope network-security-perimeter-configuration	Manage network security perimeter configration on an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine private-link-scope network-security-perimeter-configuration list	List the network security perimeter configurations for a private link scope.	Extension	GA
az connectedmachine private-link-scope network-security-perimeter-configuration reconcile	Force the network security perimeter configuration to refresh for a private link scope.	Extension	GA
az connectedmachine private-link-scope network-security-perimeter-configuration show	Get the network security perimeter configuration for a private link scope.	Extension	GA
az connectedmachine private-link-scope show	Get an Azure Arc PrivateLinkScope.	Extension	GA
az connectedmachine private-link-scope update	Update an Azure Arc PrivateLinkScope. Note: You cannot specify a different value for InstrumentationKey nor AppId in the Put operation.	Extension	GA
az connectedmachine private-link-scope wait	Place the CLI in a waiting state until a condition is met.	Extension	GA
az connectedmachine run-command	Manage run commands on an Azure Arc-Enabled Server.	Extension	Preview
az connectedmachine run-command create	Create a run command.	Extension	Preview
az connectedmachine run-command delete	Delete a run command.	Extension	Preview
az connectedmachine run-command list	Get all the run commands of a non-Azure machine.	Extension	Preview
az connectedmachine run-command show	Get a run command.	Extension	Preview
az connectedmachine run-command update	Update a run command.	Extension	Preview
az connectedmachine run-command wait	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az connectedmachine show	Get information about the model view or the instance view of an Azure Arc-Enabled Server.	Extension	GA
az connectedmachine update	Update an Azure Arc-Enabled Server. Please note some properties can be set only during machine creation.	Extension	GA
az connectedmachine upgrade-extension	Upgrade Machine Extensions.	Extension	GA

az connectedmachine assess-patches

Assess patches on an Azure Arc-Enabled Server.

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

Examples

Sample command for assess-patches

az connectedmachine assess-patches --resource-group MyResourceGroup --name MyMachine

Optional Parameters

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

--name -n

The name of the hybrid machine.

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

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 delete

Delete an Azure Arc-Enabled Server.

az connectedmachine delete [--ids]
                           [--machine-name]
                           [--resource-group]
                           [--subscription]
                           [--yes]

Examples

Sample command for delete

az connectedmachine delete --name myMachine --resource-group myResourceGroup

Optional Parameters

--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 --name -n

The name of the hybrid machine.

--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 install-patches

Install patches on an Azure Arc-Enabled Server.

az connectedmachine install-patches --maximum-duration
                                    --reboot-setting {Always, IfRequired, Never}
                                    [--ids]
                                    [--linux-parameters]
                                    [--name]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--resource-group]
                                    [--subscription]
                                    [--windows-parameters]

Examples

Sample command for install-patches

az connectedmachine install-patches --resource-group MyResourceGroup --name MyMachine --maximum-duration PT4H --reboot-setting IfRequired --windows-parameters "{"classificationsToInclude": ["Critical", "Security"]}"

Required Parameters

--maximum-duration

Specifies the maximum amount of time that the operation will run. It must be an ISO 8601-compliant duration string such as PT4H (4 hours).

--reboot-setting

Defines when it is acceptable to reboot a VM during a software update operation.

Accepted values: Always, IfRequired, Never

Optional Parameters

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

--linux-parameters

Input for InstallPatches on a Linux VM, as directly received by the API Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name -n

The name of the hybrid machine.

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

--windows-parameters

Input for InstallPatches on a Windows VM, as directly received by the API Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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 list

List all Azure Arc-Enabled Servers in the specified resource group.

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

Examples

Sample command for list

az connectedmachine list --resource-group myResourceGroup

Required Parameters

--resource-group -g

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

Optional Parameters

--expand

Expands referenced resources.

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

Get information about the model view or the instance view of an Azure Arc-Enabled Server.

az connectedmachine show [--expand {instanceView}]
                         [--ids]
                         [--machine-name]
                         [--resource-group]
                         [--subscription]

Examples

Sample command for show

az connectedmachine show --name myMachine --resource-group myResourceGroup

Optional Parameters

--expand

The expand expression to apply on the operation.

Accepted values: instanceView

--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 --name -n

The name of the hybrid machine.

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

Update an Azure Arc-Enabled Server. Please note some properties can be set only during machine creation.

az connectedmachine update [--add]
                           [--agent-upgrade]
                           [--client-public-key]
                           [--expand {instanceView}]
                           [--extensions]
                           [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                           [--identity]
                           [--ids]
                           [--kind {AVS, AWS, EPS, GCP, HCI, SCVMM, VMware}]
                           [--license-profile]
                           [--location-data]
                           [--machine-name]
                           [--mssql-discovered]
                           [--os-profile]
                           [--os-type]
                           [--parent-cluster-id]
                           [--private-link-scope-id]
                           [--remove]
                           [--resource-group]
                           [--service-statuses]
                           [--set]
                           [--subscription]
                           [--tags]

Examples

Sample command for update

az connectedmachine update --name myMachine --resource-group myResourceGroup --location eastus2euap

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

--agent-upgrade

The info of the machine w.r.t Agent Upgrade Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--client-public-key

Public Key that the client provides to be used during initial resource onboarding.

--expand

The expand expression to apply on the operation.

Accepted values: instanceView

--extensions

Machine Extensions information (deprecated field) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--identity

Identity for the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

--kind

Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.

Accepted values: AVS, AWS, EPS, GCP, HCI, SCVMM, VMware

--license-profile

Specifies the License related properties for a machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--location-data

Metadata pertaining to the geographic location of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--machine-name --name -n

The name of the hybrid machine.

--mssql-discovered

Specifies whether any MS SQL instance is discovered on the machine.

--os-profile

Specifies the operating system settings for the hybrid machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--os-type

The type of Operating System (windows/linux).

--parent-cluster-id --parent-cluster-resource-id

The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.

--private-link-scope-id --private-link-scope-resource-id

The resource id of the private link scope this machine is assigned to, if any.

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

--service-statuses

Statuses of dependent services that are reported back to ARM. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--set

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

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

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 upgrade-extension

Upgrade Machine Extensions.

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

Examples

Sample command for upgrade-extension

az connectedmachine extension upgrade --machine-name "myMachineName" --resource-group "myResourceGroup" --subscription "mySubscription" --targets "{"Microsoft.Compute.CustomScriptExtension": "{"targetVersion": "1.10"}", "Microsoft.Azure.Monitoring": "{"targetVersion": "2.0"}"}"

Optional Parameters

--extension-targets

Describes the Extension Target Properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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.