Share via


az automanage configuration-profile-assignment arc

Note

This reference is part of the automanage extension for the Azure CLI (version 2.44.1 or higher). The extension will automatically install the first time you run an az automanage configuration-profile-assignment arc command. Learn more about extensions.

Manage association between an ARC machine and Automanage configuration profile.

Commands

Name Description Type Status
az automanage configuration-profile-assignment arc create

Create an association between an ARC machine and Automanage configuration profile.

Extension GA
az automanage configuration-profile-assignment arc delete

Delete an association between an ARC machine and Automanage configuration profile.

Extension GA
az automanage configuration-profile-assignment arc report

Manage report within a given ARC machine configuration profile assignment.

Extension GA
az automanage configuration-profile-assignment arc report list

List reports within a given ARC machine configuration profile assignment.

Extension GA
az automanage configuration-profile-assignment arc report show

Get information about a report associated with an ARC machine configuration profile assignment run.

Extension GA
az automanage configuration-profile-assignment arc show

Get information about an association between an ARC machine and Automanage configuration profile.

Extension GA
az automanage configuration-profile-assignment arc update

Update an association between a ARC machine and Automanage configuration profile.

Extension GA

az automanage configuration-profile-assignment arc create

Create an association between an ARC machine and Automanage configuration profile.

az automanage configuration-profile-assignment arc create --configuration-profile-assignment-name
                                                          --machine-name
                                                          --resource-group
                                                          [--configuration-profile]

Examples

create configuration-profile-assignment for arc

az automanage configuration-profile-assignment arc create -n default -g {rg} --machine-name {arc_name} --configuration-profile {profile_id}

Required Parameters

--configuration-profile-assignment-name --name -n

Name of the configuration profile assignment. Only default is supported.

--machine-name

The name of the Arc machine.

--resource-group -g

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

Optional Parameters

--configuration-profile

The Automanage configurationProfile ARM Resource URI.

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 automanage configuration-profile-assignment arc delete

Delete an association between an ARC machine and Automanage configuration profile.

az automanage configuration-profile-assignment arc delete [--configuration-profile-assignment-name]
                                                          [--ids]
                                                          [--machine-name]
                                                          [--resource-group]
                                                          [--subscription]
                                                          [--yes]

Examples

delete configuration-profile-assignment for arc

az automanage configuration-profile-assignment arc delete -n default -g {rg} --machine-name {arc_name}

Optional Parameters

--configuration-profile-assignment-name --name -n

Name of the configuration profile assignment.

--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 Arc 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 automanage configuration-profile-assignment arc show

Get information about an association between an ARC machine and Automanage configuration profile.

az automanage configuration-profile-assignment arc show [--configuration-profile-assignment-name]
                                                        [--ids]
                                                        [--machine-name]
                                                        [--resource-group]
                                                        [--subscription]

Examples

show configuration-profile-assignment for arc

az automanage configuration-profile-assignment arc show -n default -g {rg} --machine-name {arc_name}

Optional Parameters

--configuration-profile-assignment-name --name -n

The configuration profile assignment name.

--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 Arc 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 automanage configuration-profile-assignment arc update

Update an association between a ARC machine and Automanage configuration profile.

az automanage configuration-profile-assignment arc update [--add]
                                                          [--configuration-profile]
                                                          [--configuration-profile-assignment-name]
                                                          [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                                          [--ids]
                                                          [--machine-name]
                                                          [--remove]
                                                          [--resource-group]
                                                          [--set]
                                                          [--subscription]

Examples

update configuration-profile-assignment for arc

az automanage configuration-profile-assignment arc update --n default -g {rg} --machine-name {arc_name} --configuration-profile {profile_id_2}

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

--configuration-profile

The Automanage configurationProfile ARM Resource URI.

--configuration-profile-assignment-name --name -n

The configuration profile assignment name.

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

The name of the Arc machine.

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

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