az networkcloud clustermanager identity

Note

This reference is part of the networkcloud extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az networkcloud clustermanager identity command. Learn more about extensions.

Manage cluster manager's identity.

Commands

Name	Description	Type	Status
az networkcloud clustermanager identity assign	Assign the user or system managed identities.	Extension	GA
az networkcloud clustermanager identity remove	Remove the user or system managed identities.	Extension	GA
az networkcloud clustermanager identity show	Show the details of managed identities.	Extension	GA

az networkcloud clustermanager identity assign

Assign the user or system managed identities.

az networkcloud clustermanager identity assign --cluster-manager-name --name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--if-match]
                                               [--if-none-match]
                                               [--mi-system-assigned --system-assigned]
                                               [--mi-user-assigned --user-assigned]

Required Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--mi-system-assigned --system-assigned

Set the system managed identity.

Property	Value
Parameter group:	ClusterManagerUpdateParameters.identity Arguments

--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ClusterManagerUpdateParameters.identity 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 networkcloud clustermanager identity remove

Remove the user or system managed identities.

az networkcloud clustermanager identity remove --cluster-manager-name --name
                                               --resource-group
                                               [--acquire-policy-token]
                                               [--change-reference]
                                               [--if-match]
                                               [--if-none-match]
                                               [--mi-system-assigned --system-assigned]
                                               [--mi-user-assigned --user-assigned]

Required Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

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

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--if-match

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes.

--if-none-match

Set to '*' to allow a new record set to be created, but to prevent updating an existing resource. Other values will result in error from server as they are not supported.

--mi-system-assigned --system-assigned

Set the system managed identity.

Property	Value
Parameter group:	ClusterManagerUpdateParameters.identity Arguments

--mi-user-assigned --user-assigned

Set the user managed identities. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ClusterManagerUpdateParameters.identity 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 networkcloud clustermanager identity show

Show the details of managed identities.

az networkcloud clustermanager identity show --cluster-manager-name --name
                                             --resource-group

Required Parameters

--cluster-manager-name --name -n

The name of the cluster manager.

--resource-group -g

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

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

Feedback

Was this page helpful?