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 an 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 operation to 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 |
The operation to create the extension. |
Extension | GA |
az connectedmachine extension delete |
The 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 |
The operation to get all extensions of a Non-Azure machine. |
Extension | GA |
az connectedmachine extension show |
The operation to create or update the extension. |
Extension | GA |
az connectedmachine extension update |
Update operation to 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 install-patches |
Install patches on an Azure Arc-Enabled Server. |
Extension | GA |
az connectedmachine license |
The operations on ESU license. |
Extension | Preview |
az connectedmachine license create |
Create operation to create a license. |
Extension | Preview |
az connectedmachine license delete |
Delete operation to delete a license. |
Extension | Preview |
az connectedmachine license list |
List operation to get all licenses of a non-Azure machine. |
Extension | Preview |
az connectedmachine license show |
Get information about the view of a license. |
Extension | Preview |
az connectedmachine license update |
Update operation to create or update a license. |
Extension | Preview |
az connectedmachine license wait |
Place the CLI in a waiting state until a condition is met. |
Extension | Preview |
az connectedmachine list |
List all the 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 |
Private link scope. |
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 within a resource group and get a list of all Azure Arc PrivateLinkScopes within a subscription. |
Extension | GA |
az connectedmachine private-link-scope network-security-perimeter-configuration |
Network-security-perimeter-configuration. |
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 show |
Get the network security perimeter configuration for a private link scope. |
Extension | GA |
az connectedmachine private-link-scope show |
Return 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 update-tag |
Update an existing PrivateLinkScope's tags. To update other fields use the CreateOrUpdate method. |
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 operation to create or update a run command. |
Extension | Preview |
az connectedmachine run-command delete |
Delete operation to delete a run command. |
Extension | Preview |
az connectedmachine run-command list |
List operation to get all the run commands of a non-Azure machine. |
Extension | Preview |
az connectedmachine run-command show |
Get operation to get a run command. |
Extension | Preview |
az connectedmachine run-command update |
Update operation to create or 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 |
The operation to 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
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 hybrid machine.
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
.
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 connectedmachine delete
Delete operation to 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
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 hybrid machine.
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
.
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 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
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).
Defines when it is acceptable to reboot a VM during a software update operation.
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.
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.
The name of the hybrid machine.
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
.
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
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 connectedmachine list
List all the 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
az connectedmachine list
Required Parameters
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
Expands referenced resources.
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
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 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
The expand expression to apply on the operation.
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 hybrid machine.
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
.
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 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-resource-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 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>.
The info of the machine w.r.t Agent Upgrade Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Public Key that the client provides to be used during initial resource onboarding.
The expand expression to apply on the operation.
Machine Extensions information (deprecated field) Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Identity for the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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.
Indicates which kind of Arc machine placement on-premises, such as HCI, SCVMM or VMware etc.
Specifies the License related properties for a machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Metadata pertaining to the geographic location of the resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the hybrid machine.
Specifies whether any MS SQL instance is discovered on the machine.
Specifies the operating system settings for the hybrid machine. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The type of Operating System (windows/linux).
The resource id of the parent cluster (Azure HCI) this machine is assigned to, if any.
The resource id of the private link scope this machine is assigned to, if any.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Statuses of dependent services that are reported back to ARM. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 connectedmachine upgrade-extension
The operation to 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 extension upgrade
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
Describes the Extension Target Properties. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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 hybrid machine.
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
.
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.
Azure CLI
משוב
https://aka.ms/ContentUserFeedback.
בקרוב: במהלך 2024, נפתור בעיות GitHub כמנגנון המשוב לתוכן ונחליף אותו במערכת משוב חדשה. לקבלת מידע נוסף, ראה:שלח והצג משוב עבור