az connectedmachine license-profile
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 license-profile command. Learn more about extensions.
Manages all Pay-As-You-Go licenses for an Azure Arc-Enabled Server.
Commands
Name | Description | Type | Status |
---|---|---|---|
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-profile create
Create operation to create a license profile.
az connectedmachine license-profile create --machine-name
--resource-group
[--assigned-license]
[--location]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--product-features]
[--product-type {WindowsIoTEnterprise, WindowsServer}]
[--software-assurance {0, 1, f, false, n, no, t, true, y, yes}]
[--subscription-status {Disabled, Disabling, Enabled, Enabling, Failed, Unknown}]
[--tags]
Examples
Create a License Profile
az connectedmachine license-profile create --resource-group myRg --machine-name myMachine --location eastus --subscription-status Enabled --product-type WindowsServer --product-features "[{name:Hotpatch,subscription-status:Enabled}]"
Required Parameters
The name of the hybrid machine.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
The resource id of the license.
The geo-location where the resource lives When not specified, the location of the resource group will be used.
Do not wait for the long-running operation to finish.
The list of product features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Indicates the product type of the license.
Specifies if this machine is licensed as part of a Software Assurance agreement.
Indicates the subscription status of the product.
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 license-profile delete
Delete operation to delete a license profile.
az connectedmachine license-profile delete [--ids]
[--machine-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Examples
Delete a License Profile
az connectedmachine license-profile delete --resource-group myResourceGroup --machine-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
.
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 license-profile list
List operation to get all license profiles of a non-Azure machine.
az connectedmachine license-profile list --machine-name
--resource-group
[--max-items]
[--next-token]
Examples
List all License Profiles
az connectedmachine license-profile list --resource-group myResourceGroup --machine-name myMachine
Required Parameters
The name of the machine.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Optional Parameters
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 license-profile show
Get information about the view of a license profile.
az connectedmachine license-profile show [--ids]
[--machine-name]
[--resource-group]
[--subscription]
Examples
Get License Profile
az connectedmachine license-profile show --resource-group myResourceGroup --machine-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.
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 license-profile update
Update operation to update a license profile.
az connectedmachine license-profile update [--add]
[--assigned-license]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--ids]
[--machine-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--product-features]
[--product-type {WindowsIoTEnterprise, WindowsServer}]
[--remove]
[--resource-group]
[--set]
[--software-assurance {0, 1, f, false, n, no, t, true, y, yes}]
[--subscription]
[--subscription-status {Disabled, Disabling, Enabled, Enabling, Failed, Unknown}]
[--tags]
Examples
Update a License Profile
az connectedmachine license-profile udpate --resource-group myRg --machine-name myMachine --location eastus --subscription-status Enabled --product-type WindowsServer --product-features "[{name:Hotpatch,subscription-status:Enabled}]"
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 resource id of the license.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
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.
The list of product features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Indicates the product type of the license.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Specifies if this machine is licensed as part of a Software Assurance agreement.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Indicates the subscription status of the product.
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 license-profile wait
Place the CLI in a waiting state until a condition is met.
az connectedmachine license-profile wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--license-profile-name {default}]
[--machine-name]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the license profile.
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
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
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