Gremlin Resources - Create Update Gremlin Role Definition

Referência

Serviço:: Cosmos DB Resource Provider

Versão da API:: 2025-05-01-preview

Cria ou atualiza uma Definição de Função Gremlin do Azure Cosmos DB.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nome da conta do banco de dados do Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
roleDefinitionId	path	True	string	O GUID para a definição de função.
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.assignableScopes	string[]	Um conjunto de Escopos totalmente qualificados em ou abaixo dos quais as Atribuições de Função Gremlin podem ser criadas usando esta Definição de Função. Isso permitirá a aplicação desta Definição de Função em toda a conta do banco de dados ou em qualquer Banco de Dados / Coleção subjacente. Deve ter pelo menos um elemento. Escopos superiores à conta de banco de dados não são aplicáveis como escopos atribuíveis. Observe que os recursos referenciados em Escopos atribuíveis não precisam existir.
properties.id	string	A id do caminho para a Definição de Função.
properties.permissions	Permission[]	O conjunto de operações permitidas através desta Definição de Função.
properties.roleName	string	Um nome amigável para a definição de função. Deve ser exclusivo para a conta do banco de dados.
properties.type	RoleDefinitionType	Indica se a Definição de Função foi interna ou criada pelo usuário.

Respostas

Name	Tipo	Description
200 OK	GremlinRoleDefinitionResource	A operação de criação ou atualização da Definição de Função foi concluída com êxito.
202 Accepted		A solicitação de criação ou atualização de Definição de Função foi aceita e será concluída de forma assíncrona. Cabeçalhos azure-AsyncOperation: string location: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

GremlinRoleDefinitionResource

A operação de criação ou atualização da Definição de Função foi concluída com êxito.

202 Accepted

A solicitação de criação ou atualização de Definição de Função foi aceita e será concluída de forma assíncrona.

Cabeçalhos

azure-AsyncOperation: string
location: string

Other Status Codes

ErrorResponse

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	Personificar a sua conta de utilizador

Exemplos

CosmosDBGremlinRoleDefinitionCreateUpdate

Pedido de amostra

HTTP

PUT 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

{
  "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": []
      }
    ]
  }
}

Resposta da amostra

Código de estado:: 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"
        ]
      }
    ]
  }
}

Código de estado:: 202

azure-AsyncOperation: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview
location: https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/operationsStatus/{operationId}?api-version=2025-05-01-preview

Definições

Name	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GremlinRoleDefinitionResource	Parâmetros para criar e atualizar uma Definição de Função Gremlin do Azure Cosmos DB.
Permission	O conjunto de operações do plano de dados permitidas através desta Definição de Função.
RoleDefinitionType	Indica se a Definição de Função foi interna ou criada pelo usuário.
systemData	Metadados referentes à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

GremlinRoleDefinitionResource

Object

Parâmetros para criar e atualizar uma Definição de Função Gremlin do Azure Cosmos DB.

Name	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.assignableScopes	string[]	Um conjunto de Escopos totalmente qualificados em ou abaixo dos quais as Atribuições de Função Gremlin podem ser criadas usando esta Definição de Função. Isso permitirá a aplicação desta Definição de Função em toda a conta do banco de dados ou em qualquer Banco de Dados / Coleção subjacente. Deve ter pelo menos um elemento. Escopos superiores à conta de banco de dados não são aplicáveis como escopos atribuíveis. Observe que os recursos referenciados em Escopos atribuíveis não precisam existir.
properties.id	string	A id do caminho para a Definição de Função.
properties.permissions	Permission[]	O conjunto de operações permitidas através desta Definição de Função.
properties.roleName	string	Um nome amigável para a definição de função. Deve ser exclusivo para a conta do banco de dados.
properties.type	RoleDefinitionType	Indica se a Definição de Função foi interna ou criada pelo usuário.
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

Permission

Object

O conjunto de operações do plano de dados permitidas através desta Definição de Função.

Name	Tipo	Description
dataActions	string[]	Uma matriz de ações de dados que são permitidas.
id	string	O id para a permissão.
notDataActions	string[]	Uma matriz de ações de dados que são negadas.

RoleDefinitionType

Enumeração

Indica se a Definição de Função foi interna ou criada pelo usuário.

Valor	Description
BuiltInRole
CustomRole

systemData

Object

Metadados referentes à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Partilhar via

Gremlin Resources - Create Update Gremlin Role Definition

Parâmetros do URI

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

CosmosDBGremlinRoleDefinitionCreateUpdate

Pedido de amostra

Resposta da amostra

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GremlinRoleDefinitionResource

Permission

RoleDefinitionType

systemData