Gremlin Resources - Get Gremlin Role Definition

Layanan:

Cosmos DB Resource Provider

Versi API:

2025-05-01-preview

Mengambil properti Definisi Peran Gremlin Azure Cosmos DB yang ada dengan Id yang diberikan.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Nama akun database Cosmos DB.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama tidak sensitif terhadap penggunaan huruf besar atau kecil.
roleDefinitionId	path	True	string	GUID untuk Definisi Peran.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus sebuah UUID.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	GremlinRoleDefinitionResource	Definisi Peran berhasil diambil.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	Meniru akun pengguna Anda

Contoh

CosmosDBGremlinRoleDefinitionGet

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
createdByType	Jenis identitas yang membuat sumber daya.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan
GremlinRoleDefinitionResource	Parameter untuk membuat dan memperbarui Definisi Peran Gremlin Azure Cosmos DB.
Permission	Kumpulan operasi sarana data yang diizinkan melalui Definisi Peran ini.
RoleDefinitionType	Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.
systemData	Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

createdByType

Enumeration

Jenis identitas yang membuat sumber daya.

Nilai	Deskripsi
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

GremlinRoleDefinitionResource

Objek

Parameter untuk membuat dan memperbarui Definisi Peran Gremlin Azure Cosmos DB.

Nama	Jenis	Deskripsi
id	string (arm-id)	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nama sumber daya
properties.assignableScopes	string[]	Sekumpulan Cakupan yang sepenuhnya memenuhi syarat di atau di bawahnya yang dapat dibuat oleh Penetapan Peran Gremlin menggunakan Definisi Peran ini. Ini akan memungkinkan penerapan Definisi Peran ini pada seluruh akun database atau Database / Koleksi yang mendasar. Harus memiliki setidaknya satu elemen. Cakupan yang lebih tinggi dari akun Database tidak dapat diberlakukan sebagai Cakupan yang dapat ditetapkan. Perhatikan bahwa sumber daya yang dirujuk dalam Cakupan yang dapat ditetapkan tidak perlu ada.
properties.id	string	Id jalur untuk Definisi Peran.
properties.permissions	Permission[]	Kumpulan operasi yang diizinkan melalui Definisi Peran ini.
properties.roleName	string	Nama yang mudah digunakan untuk Definisi Peran. Harus unik untuk akun database.
properties.type	RoleDefinitionType	Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.
systemData	systemData	Metadata Azure Resource Manager yang berisi informasi createBy dan modifiedBy.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

Permission

Objek

Kumpulan operasi sarana data yang diizinkan melalui Definisi Peran ini.

Nama	Jenis	Deskripsi
dataActions	string[]	Array tindakan data yang diizinkan.
id	string	Id untuk izin.
notDataActions	string[]	Array tindakan data yang ditolak.

RoleDefinitionType

Enumeration

Menunjukkan apakah Definisi Peran adalah bawaan atau pengguna yang dibuat.

Nilai	Deskripsi
BuiltInRole
CustomRole

systemData

Objek

Metadata yang berkaitan dengan pembuatan dan modifikasi terakhir sumber daya.

Nama	Jenis	Deskripsi
createdAt	string (date-time)	Tanda waktu pembuatan sumber daya (UTC).
createdBy	string	Identitas yang membuat sumber daya.
createdByType	createdByType	Jenis identitas yang membuat sumber daya.
lastModifiedAt	string (date-time)	Tanda waktu modifikasi terakhir sumber daya (UTC)
lastModifiedBy	string	Identitas yang terakhir mengubah sumber daya.
lastModifiedByType	createdByType	Jenis identitas yang terakhir memodifikasi sumber daya.