az automanage configuration-profile-assignment cluster

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

Manage association between an AzureStackHCI cluster and Automanage configuration profile.

Commands

Name	Description	Type	Status
az automanage configuration-profile-assignment cluster create	Create an association between an AzureStackHCI cluster and Automanage configuration profile.	Extension	GA
az automanage configuration-profile-assignment cluster delete	Delete an association between an AzureStackHCI cluster and Automanage configuration profile.	Extension	GA
az automanage configuration-profile-assignment cluster report	Manage report within a given AzureStackHCI cluster configuration profile assignment.	Extension	GA
az automanage configuration-profile-assignment cluster report list	List reports within a given AzureStackHCI cluster configuration profile assignment.	Extension	GA
az automanage configuration-profile-assignment cluster report show	Get information about a report associated with a AzureStackHCI cluster configuration profile assignment run.	Extension	GA
az automanage configuration-profile-assignment cluster show	Get information about an association between an AzureStackHCI cluster and Automanage configuration profile.	Extension	GA
az automanage configuration-profile-assignment cluster update	Update an association between a AzureStackHCI cluster and Automanage configuration profile.	Extension	GA

az automanage configuration-profile-assignment cluster create

Create an association between an AzureStackHCI cluster and Automanage configuration profile.

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

Examples

create configuration-profile-assignment for cluster

az automanage configuration-profile-assignment cluster create -n default -g {rg} --cluster-name {cluster_name} --configuration-profile {profile_id}

Required Parameters

--cluster-name

The name of the Arc machine.

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

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

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--configuration-profile

The Automanage configurationProfile ARM Resource URI.

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az automanage configuration-profile-assignment cluster delete

Delete an association between an AzureStackHCI cluster and Automanage configuration profile.

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

Examples

delete configuration-profile-assignment cluster

az automanage configuration-profile-assignment cluster delete -n default -g {rg} --cluster-name {cluster_name}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Arc machine.

Property	Value
Parameter group:	Resource Id Arguments

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

Name of the configuration profile assignment.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az automanage configuration-profile-assignment cluster show

Get information about an association between an AzureStackHCI cluster and Automanage configuration profile.

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

Examples

show configuration-profile-assignment for cluster

az automanage configuration-profile-assignment cluster show -n default -g {rg} --cluster-name {cluster_name}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--cluster-name

The name of the Arc machine.

Property	Value
Parameter group:	Resource Id Arguments

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

The configuration profile assignment name.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az automanage configuration-profile-assignment cluster update

Update an association between a AzureStackHCI cluster and Automanage configuration profile.

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

Examples

update configuration-profile-assignment cluster

az automanage configuration-profile-assignment cluster update --n default -g {rg} --cluster-name {cluster_name} --configuration-profile {profile_id_2}

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Generic Update Arguments

--cluster-name

The name of the Arc machine.

Property	Value
Parameter group:	Resource Id Arguments

--configuration-profile

The Automanage configurationProfile ARM Resource URI.

Property	Value
Parameter group:	Properties Arguments

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

The configuration profile assignment name.

Property	Value
Parameter group:	Resource Id Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az automanage configuration-profile-assignment cluster

Commands

az automanage configuration-profile-assignment cluster create

Examples

Required Parameters

Optional Parameters

az automanage configuration-profile-assignment cluster delete

Examples

Optional Parameters

az automanage configuration-profile-assignment cluster show

Examples

Optional Parameters

az automanage configuration-profile-assignment cluster update

Examples

Optional Parameters

Feedback