你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

az cosmosdb sql role definition

管理 Azure Cosmos DB SQL 角色定义。

命令

名称	说明	类型	状态
az cosmosdb sql role definition create	在 Azure Cosmos DB 帐户下创建 SQL 角色定义。	核心	GA
az cosmosdb sql role definition delete	删除 Azure Cosmos DB 帐户下的 SQL 角色定义。	核心	GA
az cosmosdb sql role definition exists	检查 Azure Cosmos DB 角色定义是否存在。	核心	GA
az cosmosdb sql role definition list	列出 Azure Cosmos DB 帐户下的所有 SQL 角色定义。	核心	GA
az cosmosdb sql role definition show	显示 Azure Cosmos DB 帐户下 SQL 角色定义的属性。	核心	GA
az cosmosdb sql role definition update	在 Azure Cosmos DB 帐户下更新 SQL 角色定义。	核心	GA
az cosmosdb sql role definition wait	轮询 SQL 角色定义，直到满足特定条件。	核心	GA

az cosmosdb sql role definition create

在 Azure Cosmos DB 帐户下创建 SQL 角色定义。

az cosmosdb sql role definition create --account-name
                                       --body
                                       --resource-group
                                       [--no-wait]

示例

使用 JSON 字符串在 Azure Cosmos DB 帐户下创建 SQL 角色定义。

az cosmosdb sql 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/sqlDatabases/containers/items/read",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/executeQuery",
      "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/readChangeFeed"
    ]
  }]
}'

使用 JSON 文件在 Azure Cosmos DB 帐户下创建 SQL 角色定义。

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

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

具有 ID（可选）的角色定义正文、DataActions 或权限、类型（默认值为 CustomRole）和 AssignableScopes。 可以将其输入为字符串或文件，例如 --body 或 --body @rdbody-file.json “{ ”Id“： ”be79875a-2cc4-40d5-8958-566017875b39“， ”RoleName“： ”My Read Write Role“， ”Type“： ”CustomRole“， ”AssignableScopes“： [ ”/“ ]， ”DataActions“： [ ”Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create“， ”Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read“ ]}”。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql role definition delete

删除 Azure Cosmos DB 帐户下的 SQL 角色定义。

az cosmosdb sql role definition delete --account-name
                                       --id
                                       --resource-group
                                       [--no-wait]
                                       [--yes]

示例

删除 Azure Cosmos DB 帐户下的 SQL 角色定义。

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

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

角色定义的唯一 ID。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

--yes -y

不提示确认。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql role definition exists

检查 Azure Cosmos DB 角色定义是否存在。

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

示例

检查 Azure Cosmos DB 角色定义是否存在。

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

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

角色定义的唯一 ID。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql role definition list

列出 Azure Cosmos DB 帐户下的所有 SQL 角色定义。

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

示例

列出 Azure Cosmos DB 帐户下的所有 SQL 角色定义。

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

必需参数

--account-name -a

Cosmosdb 帐户名称。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql role definition show

显示 Azure Cosmos DB 帐户下 SQL 角色定义的属性。

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

示例

显示 Azure Cosmos DB 帐户下 SQL 角色定义的属性。

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

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

角色定义的唯一 ID。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql role definition update

在 Azure Cosmos DB 帐户下更新 SQL 角色定义。

az cosmosdb sql role definition update --account-name
                                       --body
                                       --resource-group
                                       [--no-wait]

示例

在 Azure Cosmos DB 帐户下更新 SQL 角色定义。

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

必需参数

--account-name -a

Cosmosdb 帐户名称。

--body -b

具有 ID（可选）的角色定义正文、DataActions 或权限、类型（默认值为 CustomRole）和 AssignableScopes。 可以将其输入为字符串或文件，例如 --body 或 --body @rdbody-file.json “{ ”Id“： ”be79875a-2cc4-40d5-8958-566017875b39“， ”RoleName“： ”My Read Write Role“， ”Type“： ”CustomRole“， ”AssignableScopes“： [ ”/“ ]， ”DataActions“： [ ”Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create“， ”Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read“ ]}”。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--no-wait

不等待长时间运行的操作完成。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。

az cosmosdb sql role definition wait

轮询 SQL 角色定义，直到满足特定条件。

az cosmosdb sql role definition wait --account-name
                                     --id
                                     --resource-group
                                     [--created]
                                     [--custom]
                                     [--deleted]
                                     [--exists]
                                     [--interval]
                                     [--timeout]
                                     [--updated]

示例

轮询 SQL 角色定义，直到删除它。

az cosmosdb sql role definition wait --account-name MyAccount --resource-group MyResourceGroup --id cb8ed2d7-2371-4e3c-bd31-6cc1560e84f8 --deleted

必需参数

--account-name -a

Cosmosdb 帐户名称。

--id -i

角色定义的唯一 ID。

--resource-group -g

资源组的名称。 可以使用 az configure --defaults group=<name> 配置默认组。

可选参数

--created

等待在“Succeeded”中使用“provisioningState”创建。

默认值: False

--custom

等待条件满足自定义 JMESPath 查询。 例如 provisioningState！='InProgress'， instanceView.statuses[？code=='PowerState/running']。

--deleted

等到删除为止。

默认值: False

--exists

等待资源存在。

默认值: False

--interval

轮询间隔（以秒为单位）。

默认值: 30

--timeout

最大等待（以秒为单位）。

默认值: 3600

--updated

等到 provisioningState 更新为“Succeeded”。

默认值: False

全局参数

--debug

提高日志记录详细程度以显示所有调试日志。

--help -h

显示此帮助消息并退出。

--only-show-errors

只显示错误，取消显示警告。

--output -o

输出格式。

接受的值: json, jsonc, none, table, tsv, yaml, yamlc

默认值: json

--query

JMESPath 查询字符串。 有关更多信息和示例，请参阅 http://jmespath.org/。

--subscription

订阅的名称或 ID。 可以使用 az account set -s NAME_OR_ID 配置默认订阅。

--verbose

提高日志记录详细程度。 使用 --debug 获取完整的调试日志。