az cosmosdb table role definition

Note

This reference is part of the cosmosdb-preview extension for the Azure CLI (version 2.17.1 or higher). The extension will automatically install the first time you run an az cosmosdb table role definition command. Learn more about extensions.

Manage Azure Cosmos DB Table role definitions.

Commands

Name	Description	Type	Status
az cosmosdb table role definition create	Create a Table role definition under an Azure Cosmos DB account.	Extension	GA
az cosmosdb table role definition delete	Delete a Table role definition under an Azure Cosmos DB account.	Extension	GA
az cosmosdb table role definition exists	Check if an Azure Cosmos DB role definition exists.	Extension	GA
az cosmosdb table role definition list	List all Table role definitions under an Azure Cosmos DB account.	Extension	GA
az cosmosdb table role definition show	Show the properties of a Table role definition under an Azure Cosmos DB account.	Extension	GA
az cosmosdb table role definition update	Update a Table role definition under an Azure Cosmos DB account.	Extension	GA

az cosmosdb table role definition create

Create a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition create --account-name
                                         --body
                                         --resource-group

Examples

Create a Table role definition under an Azure Cosmos DB account using a JSON string.

az cosmosdb table role definition create --account-name MyAccount --resource-group MyResourceGroup --body '{
  "Id": "be79875a-2cc4-40d5-8958-566017875b39",
  "RoleName": "My Read Only Role",
  "Type": "CustomRole",
  "AssignableScopes": ["/dbs/mydb/colls/mycontainer"],
  "Permissions": [{
    "DataActions": [
      "Microsoft.DocumentDB/databaseAccounts/readMetadata",
      "Microsoft.DocumentDB/databaseAccounts/tables/containers/entities/read",
      "Microsoft.DocumentDB/databaseAccounts/tables/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/tables/containers/readChangeFeed"
    ]
  }]
}'

Create a Table role definition under an Azure Cosmos DB account using a JSON file.

az cosmosdb table role definition create --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

Required Parameters

--account-name -a

Cosmosdb account name.

--body -b

Role Definition body with Id (Optional for create), Type (Default is CustomRole), RoleName, Description, AssignableScopes, Permissions. You can enter it as a string or as a file, e.g., --body @table-role_definition-body-file.json or --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "MyTestRole", "type": "CustomRole", "description": "Custom role to read Cosmos DB metadata", "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissions": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"]}] }".

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

az cosmosdb table role definition delete

Delete a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition delete --account-name
                                         --resource-group
                                         --role-definition-id
                                         [--yes]

Examples

Delete a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition delete --account-name MyAccount --resource-group MyResourceGroup --role-definition-id be79875a-2cc4-40d5-8958-566017875b39

Required Parameters

--account-name -a

Cosmosdb account name.

--resource-group -g

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

--role-definition-id -i

Unique ID for the Table Role Definition.

Optional Parameters

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

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

--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 cosmosdb table role definition exists

Check if an Azure Cosmos DB role definition exists.

az cosmosdb table role definition exists --account-name
                                         --resource-group
                                         --role-definition-id

Examples

Check if an Azure Cosmos DB role definition exists.

az cosmosdb table role definition exists --account-name MyAccount --resource-group MyResourceGroup --role-definition-id be79875a-2cc4-40d5-8958-566017875b39

Required Parameters

--account-name -a

Cosmosdb account name.

--resource-group -g

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

--role-definition-id -i

Unique ID for the Table Role Definition.

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 cosmosdb table role definition list

List all Table role definitions under an Azure Cosmos DB account.

az cosmosdb table role definition list --account-name
                                       --resource-group

Examples

List all Table role definitions under an Azure Cosmos DB account.

az cosmosdb table role definition list --account-name MyAccount --resource-group MyResourceGroup

Required Parameters

--account-name -a

Cosmosdb 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

az cosmosdb table role definition show

Show the properties of a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition show --account-name
                                       --resource-group
                                       --role-definition-id

Examples

Show the properties of a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition show --account-name MyAccount --resource-group MyResourceGroup --role-definition-id be79875a-2cc4-40d5-8958-566017875b39

Required Parameters

--account-name -a

Cosmosdb account name.

--resource-group -g

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

--role-definition-id -i

Unique ID for the Table Role Definition.

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 cosmosdb table role definition update

Update a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition update --account-name
                                         --body
                                         --resource-group

Examples

Update a Table role definition under an Azure Cosmos DB account.

az cosmosdb table role definition update --account-name MyAccount --resource-group MyResourceGroup --body @role-definition.json

Required Parameters

--account-name -a

Cosmosdb account name.

--body -b

Role Definition body with Id (Optional for create), Type (Default is CustomRole), RoleName, Description, AssignableScopes, Permissions. You can enter it as a string or as a file, e.g., --body @table-role_definition-body-file.json or --body "{ "Id": "be79875a-2cc4-40d5-8958-566017875b39", "RoleName": "MyTestRole", "type": "CustomRole", "description": "Custom role to read Cosmos DB metadata", "AssignableScopes":["/subscriptions/{0}/resourceGroups/{1}/providers/Microsoft.DocumentDB/databaseAccounts/MyDBAccountName"], "Permissions": [{"dataActions": ["Microsoft.DocumentDB/databaseAccounts/readMetadata"]}] }".

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