Gremlin Resources - Get Gremlin Role Definition

服务:

Cosmos DB Resource Provider

API 版本:

2025-05-01-preview

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

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

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB 数据库帐户名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	资源组的名称。 此名称不区分大小写。
roleDefinitionId	path	True	string	角色定义的 GUID。
subscriptionId	path	True	string (uuid)	目标订阅的 ID。 该值必须是 UUID。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	GremlinRoleDefinitionResource	已成功检索角色定义。
Other Status Codes	ErrorResponse	描述操作失败的原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟您的用户账户

示例

CosmosDBGremlinRoleDefinitionGet

示例请求

HTTP

GET https://management.azure.com/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId?api-version=2025-05-01-preview

示例响应

状态代码:

200

{
  "id": "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/gremlinRoleDefinitions/myRoleDefinitionId",
  "name": "myRoleDefinitionId",
  "type": "Microsoft.DocumentDB/databaseAccounts/gremlinRoleDefinitions",
  "properties": {
    "roleName": "myRoleName",
    "type": "CustomRole",
    "assignableScopes": [
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/sales",
      "/subscriptions/ffffffff-ffff-ffff-ffff-ffffffffffff/resourceGroups/myResourceGroupName/providers/Microsoft.DocumentDB/databaseAccounts/myAccountName/dbs/purchases"
    ],
    "permissions": [
      {
        "dataActions": [
          "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/containers/entities/create",
          "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/containers/entities/read"
        ],
        "notDataActions": []
      }
    ]
  }
}

定义

名称	说明
createdByType	创建资源的标识的类型。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
GremlinRoleDefinitionResource	用于创建和更新 Azure Cosmos DB Gremlin 角色定义的参数。
Permission	通过此角色定义允许的数据平面操作集。
RoleDefinitionType	指示角色定义是内置还是已创建用户。
systemData	与创建和上次修改资源相关的元数据。

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

Object

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponse

Object

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

GremlinRoleDefinitionResource

Object

用于创建和更新 Azure Cosmos DB Gremlin 角色定义的参数。

名称	类型	说明
id	string (arm-id)	资源的完全限定资源 ID。 例如“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}”
name	string	资源的名称
properties.assignableScopes	string[]	可以使用此角色定义在此角色定义中创建 Gremlin 角色分配的一组完全限定的范围。 这将允许对整个数据库帐户或任何基础数据库/集合应用此角色定义。 必须至少有一个元素。 高于数据库帐户的范围不能作为可分配作用域强制实施。 请注意，可分配作用域中引用的资源不存在。
properties.id	string	角色定义的路径 ID。
properties.permissions	Permission[]	通过此角色定义允许的操作集。
properties.roleName	string	角色定义的用户友好名称。 数据库帐户必须是唯一的。
properties.type	RoleDefinitionType	指示角色定义是内置还是已创建用户。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
type	string	资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

Permission

Object

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

名称	类型	说明
dataActions	string[]	允许的数据操作数组。
id	string	权限的 ID。
notDataActions	string[]	拒绝的数据操作数组。

RoleDefinitionType

枚举

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

值	说明
BuiltInRole
CustomRole

systemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。