Gremlin Resources - Create Update Gremlin Role Definition

Başvuru

Hizmet:: Cosmos DB Resource Provider

API Sürümü:: 2025-05-01-preview

Azure Cosmos DB Gremlin Rol Tanımı oluşturur veya güncelleştirir.

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
accountName	path	True	string minLength: 3 maxLength: 50 pattern: ^[a-z0-9]+(-[a-z0-9]+)*	Cosmos DB veritabanı hesap adı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
roleDefinitionId	path	True	string	Rol Tanımı için GUID.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Gövdesi

Name	Tür	Description
properties.assignableScopes	string[]	Bu Rol Tanımı kullanılarak Gremlin Rol Atamalarının oluşturulabileceği veya altında tam kapsam kümesi. Bu, bu Rol Tanımının veritabanı hesabının tamamında veya temel alınan herhangi bir Veritabanı/Koleksiyonda uygulanmasına izin verir. En az bir öğe olmalıdır. Veritabanı hesabından daha yüksek kapsamlar atanabilir Kapsamlar olarak zorlanamaz. Atanabilir Kapsamlarda başvurulan kaynakların mevcut olmaması gerektiğini unutmayın.
properties.id	string	Rol Tanımı için yol kimliği.
properties.permissions	Permission[]	Bu Rol Tanımı aracılığıyla izin verilen işlem kümesi.
properties.roleName	string	Rol Tanımı için kullanıcı dostu bir ad. Veritabanı hesabı için benzersiz olmalıdır.
properties.type	RoleDefinitionType	Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir.

Yanıtlar

Name	Tür	Description
200 OK	GremlinRoleDefinitionResource	Rol Tanımı oluşturma veya güncelleştirme işlemi başarıyla tamamlandı.
202 Accepted		Rol Tanımı oluşturma veya güncelleştirme isteği kabul edildi ve zaman uyumsuz olarak tamamlanacak. Üst Bilgiler azure-AsyncOperation: string location: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Name

Tür

Description

200 OK

GremlinRoleDefinitionResource

Rol Tanımı oluşturma veya güncelleştirme işlemi başarıyla tamamlandı.

202 Accepted

Rol Tanımı oluşturma veya güncelleştirme isteği kabul edildi ve zaman uyumsuz olarak tamamlanacak.

Üst Bilgiler

azure-AsyncOperation: string
location: string

Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	Kullanıcı hesabınızı taklit edin

Örnekler

CosmosDBGremlinRoleDefinitionCreateUpdate

Örnek isteği

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

Örnek yanıt

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

Durum kodu:: 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

Tanımlar

Name	Description
createdByType	Kaynağı oluşturan kimliğin türü.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
GremlinRoleDefinitionResource	Azure Cosmos DB Gremlin Rol Tanımı oluşturma ve güncelleştirme parametreleri.
Permission	Bu Rol Tanımı aracılığıyla izin verilen veri düzlemi işlemleri kümesi.
RoleDefinitionType	Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir.
systemData	Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

createdByType

Listeleme

Kaynağı oluşturan kimliğin türü.

Değer	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

GremlinRoleDefinitionResource

Object

Azure Cosmos DB Gremlin Rol Tanımı oluşturma ve güncelleştirme parametreleri.

Name	Tür	Description
id	string (arm-id)	Kaynağın tam kaynak kimliği. Örneğin, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Kaynağın adı
properties.assignableScopes	string[]	Bu Rol Tanımı kullanılarak Gremlin Rol Atamalarının oluşturulabileceği veya altında tam kapsam kümesi. Bu, bu Rol Tanımının veritabanı hesabının tamamında veya temel alınan herhangi bir Veritabanı/Koleksiyonda uygulanmasına izin verir. En az bir öğe olmalıdır. Veritabanı hesabından daha yüksek kapsamlar atanabilir Kapsamlar olarak zorlanamaz. Atanabilir Kapsamlarda başvurulan kaynakların mevcut olmaması gerektiğini unutmayın.
properties.id	string	Rol Tanımı için yol kimliği.
properties.permissions	Permission[]	Bu Rol Tanımı aracılığıyla izin verilen işlem kümesi.
properties.roleName	string	Rol Tanımı için kullanıcı dostu bir ad. Veritabanı hesabı için benzersiz olmalıdır.
properties.type	RoleDefinitionType	Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir.
systemData	systemData	createdBy ve modifiedBy bilgilerini içeren Azure Resource Manager meta verileri.
type	string	Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

Permission

Object

Bu Rol Tanımı aracılığıyla izin verilen veri düzlemi işlemleri kümesi.

Name	Tür	Description
dataActions	string[]	İzin verilen veri eylemleri dizisi.
id	string	İzin kimliği.
notDataActions	string[]	Reddedilen veri eylemleri dizisi.

RoleDefinitionType

Listeleme

Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir.

Değer	Description
BuiltInRole
CustomRole

systemData

Object

Kaynağın oluşturulması ve son değiştirilmesiyle ilgili meta veriler.

Name	Tür	Description
createdAt	string (date-time)	Kaynak oluşturma (UTC) zaman damgası.
createdBy	string	Kaynağı oluşturan kimlik.
createdByType	createdByType	Kaynağı oluşturan kimliğin türü.
lastModifiedAt	string (date-time)	Kaynağın son değişikliğinin zaman damgası (UTC)
lastModifiedBy	string	Kaynağı en son değiştiren kimlik.
lastModifiedByType	createdByType	Kaynağı en son değiştiren kimlik türü.

Aracılığıyla paylaş

Gremlin Resources - Create Update Gremlin Role Definition

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

azure_auth

Kapsamlar

Örnekler

CosmosDBGremlinRoleDefinitionCreateUpdate

Örnek isteği

Örnek yanıt

Tanımlar

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GremlinRoleDefinitionResource

Permission

RoleDefinitionType

systemData