Gremlin Resources - List Gremlin Role Definitions

Usługa:

Cosmos DB Resource Provider

Wersja interfejsu API:

2025-05-01-preview

Pobiera listę wszystkich definicji ról języka Gremlin w usłudze Azure Cosmos DB.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nazwa konta bazy danych usługi Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	GremlinRoleDefinitionListResult	Operacja listy została ukończona pomyślnie.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	Personifikuj konto użytkownika

Przykłady

CosmosDBGremlinRoleDefinitionList

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

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

Definicje

Nazwa	Opis
createdByType	Typ tożsamości, która utworzyła zasób.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GremlinRoleDefinitionListResult	Odpowiednie definicje ról.
GremlinRoleDefinitionResource	Parametry do tworzenia i aktualizowania definicji roli języka Gremlin w usłudze Azure Cosmos DB.
Permission	Zestaw operacji płaszczyzny danych dozwolony za pomocą tej definicji roli.
RoleDefinitionType	Wskazuje, czy definicja roli została utworzona, czy też utworzona przez użytkownika.
systemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

createdByType

Wyliczanie

Typ tożsamości, która utworzyła zasób.

Wartość	Opis
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

GremlinRoleDefinitionListResult

Objekt

Odpowiednie definicje ról.

Nazwa	Typ	Opis
nextLink	string	Link użyty do pobrania następnej strony wyników.
value	GremlinRoleDefinitionResource[]	Lista definicji ról i ich właściwości.

GremlinRoleDefinitionResource

Objekt

Parametry do tworzenia i aktualizowania definicji roli języka Gremlin w usłudze Azure Cosmos DB.

Nazwa	Typ	Opis
id	string (arm-id)	W pełni kwalifikowany identyfikator zasobu dla zasobu. Np. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nazwa zasobu
properties.assignableScopes	string[]	Zestaw w pełni kwalifikowanych zakresów, w których można utworzyć przypisania ról języka Gremlin przy użyciu tej definicji roli. Umożliwi to zastosowanie tej definicji roli na całym koncie bazy danych lub dowolnej podstawowej bazie danych/kolekcji. Musi zawierać co najmniej jeden element. Zakresy wyższe niż konto bazy danych nie są wymuszane jako możliwe do przypisania zakresy. Należy pamiętać, że zasoby, do których odwołuje się przypisywane zakresy, nie muszą istnieć.
properties.id	string	Identyfikator ścieżki definicji roli.
properties.permissions	Permission[]	Zestaw operacji dozwolony za pomocą tej definicji roli.
properties.roleName	string	Przyjazna dla użytkownika nazwa definicji roli. Musi być unikatowa dla konta bazy danych.
properties.type	RoleDefinitionType	Wskazuje, czy definicja roli została utworzona, czy też utworzona przez użytkownika.
systemData	systemData	Metadane usługi Azure Resource Manager zawierające informacje „createdBy” i „modifiedBy”.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

Permission

Objekt

Zestaw operacji płaszczyzny danych dozwolony za pomocą tej definicji roli.

Nazwa	Typ	Opis
dataActions	string[]	Tablica akcji danych, które są dozwolone.
id	string	Identyfikator uprawnienia.
notDataActions	string[]	Tablica akcji danych, które są odrzucane.

RoleDefinitionType

Wyliczanie

Wskazuje, czy definicja roli została utworzona, czy też utworzona przez użytkownika.

Wartość	Opis
BuiltInRole
CustomRole

systemData

Objekt

Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.

Nazwa	Typ	Opis
createdAt	string (date-time)	Sygnatura czasowa tworzenia zasobu (UTC).
createdBy	string	Tożsamość, która utworzyła zasób.
createdByType	createdByType	Typ tożsamości, która utworzyła zasób.
lastModifiedAt	string (date-time)	Znacznik czasu ostatniej modyfikacji zasobu (UTC)
lastModifiedBy	string	Tożsamość, która ostatnio zmodyfikowała zasób.
lastModifiedByType	createdByType	Typ tożsamości, która ostatnio zmodyfikowała zasób.