az cognitiveservices account identity

Manage identity of Cognitive Services accounts.

Commands

Name	Description	Type	Status
az cognitiveservices account identity assign	Assign an identity of a Cognitive Services account.	Core	GA
az cognitiveservices account identity remove	Remove the identity from a Cognitive Services account.	Core	GA
az cognitiveservices account identity show	Show the identity of a Cognitive Services account.	Core	GA

az cognitiveservices account identity assign

Edit

Assign an identity of a Cognitive Services account.

Assign an identity object of a Cognitive Services account. An system assigned identity will be generate and assigned to the account.

az cognitiveservices account identity assign --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]

Examples

Assign an identity of Cognitive Services accounts.

az cognitiveservices account identity assign --name myresource --resource-group cognitive-services-resource-group

Required Parameters

--name -n

Cognitive service account name.

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

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 cognitiveservices account identity remove

Edit

Remove the identity from a Cognitive Services account.

Remove the identity (if exists) from a Cognitive Services account.

az cognitiveservices account identity remove --name
                                             --resource-group
                                             [--acquire-policy-token]
                                             [--change-reference]

Examples

Remove the identity from a Cognitive Services account.

az cognitiveservices account identity remove --name myresource --resource-group cognitive-services-resource-group

Required Parameters

--name -n

Cognitive service account name.

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

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 cognitiveservices account identity show

Edit

Show the identity of a Cognitive Services account.

Show the identity object of a Cognitive Services account, empty object might be returned if the account has no assigned identity.

az cognitiveservices account identity show --name
                                           --resource-group

Examples

Show the identity of Cognitive Services accounts.

az cognitiveservices account identity show --name myresource --resource-group cognitive-services-resource-group

Required Parameters

--name -n

Cognitive service account name.

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