Share via

az connectedmachine license-profile

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

--machine-name -m

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

Optional Parameters

--assigned-license

The resource id of the license.

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

The list of product features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--product-type

Indicates the product type of the license.

Accepted values: WindowsIoTEnterprise, WindowsServer
--software-assurance --software-assurance-customer

Specifies if this machine is licensed as part of a Software Assurance agreement.

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

Indicates the subscription status of the product.

Accepted values: Disabled, Disabling, Enabled, Enabling, Failed, Unknown
--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 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

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

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

--machine-name

The name of the machine.

--resource-group -g

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

Optional Parameters

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

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

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

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

--assigned-license

The resource id of the license.

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

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

The list of product features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--product-type

Indicates the product type of the license.

Accepted values: WindowsIoTEnterprise, WindowsServer
--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>.

--software-assurance --software-assurance-customer

Specifies if this machine is licensed as part of a Software Assurance agreement.

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

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

--subscription-status

Indicates the subscription status of the product.

Accepted values: Disabled, Disabling, Enabled, Enabling, Failed, Unknown
--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 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

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

--interval

Polling interval in seconds.

Default value: 30
--license-profile-name --name -n

The name of the license profile.

Accepted values: default
--machine-name

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.

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