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

Sql Resources - Get Sql Role Definition

检索具有给定 ID 的现有 Azure Cosmos DB SQL 角色定义的属性。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlRoleDefinitions/{roleDefinitionId}?api-version=2021-04-01-preview

URI 参数

Name In Required Type Description
accountName
path True
  • string

Cosmos DB 数据库帐户名称。

Regex pattern: ^[a-z0-9]+(-[a-z0-9]+)*

resourceGroupName
path True
  • string

资源组的名称。 此名称不区分大小写。

roleDefinitionId
path True
  • string

角色定义的 GUID。

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

响应

Name Type Description
200 OK

已成功检索角色定义。

Other Status Codes

描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

CosmosDBSqlRoleDefinitionGet

Sample Request

GET https://management.azure.com/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId?api-version=2021-04-01-preview

Sample Response

{
  "id": "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/sqlRoleDefinitions/myRoleDefinitionId",
  "name": "myRoleDefinitionId",
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/mySubscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/create",
          "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read"
        ],
        "notDataActions": []
      }
    ]
  }
}

定义

CloudError

服务的错误响应。

ErrorResponse

错误响应。

Permission

通过此角色定义允许的数据平面操作集。

RoleDefinitionType

指示角色定义是内置还是用户创建。

SqlRoleDefinitionGetResults

Azure Cosmos DB SQL 角色定义。

CloudError

服务的错误响应。

Name Type Description
error

错误响应。

ErrorResponse

错误响应。

Name Type Description
code
  • string

错误代码。

message
  • string

指示操作失败的原因的错误消息。

Permission

通过此角色定义允许的数据平面操作集。

Name Type Description
dataActions
  • string[]

允许的数据操作数组。

notDataActions
  • string[]

拒绝的数据操作数组。

RoleDefinitionType

指示角色定义是内置还是用户创建。

Name Type Description
BuiltInRole
  • string
CustomRole
  • string

SqlRoleDefinitionGetResults

Azure Cosmos DB SQL 角色定义。

Name Type Description
id
  • string

数据库帐户的唯一资源标识符。

name
  • string

数据库帐户的名称。

properties.assignableScopes
  • string[]

可以使用此角色定义创建角色分配的一组完全限定的范围。 这将允许对整个数据库帐户或任何基础数据库/集合应用此角色定义。 必须至少有一个元素。 高于数据库帐户的范围不能作为可分配范围强制实施。 请注意,在可分配作用域中引用的资源不存在。

properties.permissions

通过此角色定义允许的操作集。

properties.roleName
  • string

角色定义的用户友好名称。 数据库帐户必须是唯一的。

properties.type

指示角色定义是内置还是用户创建。

type
  • string

Azure 资源的类型。