Microsoft. DocumentDB databaseAccounts/sqlRoleDefinitions

Bicep kaynak tanımı

databaseAccounts/sqlRoleDefinitions kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions kaynağı oluşturmak için, şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2026-04-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    assignableScopes: [
      'string'
    ]
    permissions: [
      {
        dataActions: [
          'string'
        ]
        id: 'string'
        notDataActions: [
          'string'
        ]
      }
    ]
    roleName: 'string'
    type: 'string'
  }
}

Özellik Değerleri

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Ad Açıklama Değer
ad Kaynak adı dize (gerekli)
ebeveyn Bicep'te bir alt kaynak için üst kaynak belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz. Alt kaynaküst kaynak dışında.
Kaynak türü için sembolik ad: databaseAccounts
Özellikler Azure Cosmos DB SQL Rol Tanımı oluşturma ve güncelleştirme özellikleri. SqlRoleDefinitionResource

İzin

Ad Açıklama Değer
dataActions İzin verilen veri eylemleri dizisi. dize[]
kimlik İzin kimliği. dizgi
notDataActions Reddedilen veri eylemleri dizisi. dize[]

SqlRoleDefinitionResource

Ad Açıklama Değer
assignableScopes Bu Rol Tanımı kullanılarak 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. dize[]
izinler Bu Rol Tanımı aracılığıyla izin verilen işlem kümesi. İzin[]
roleName Rol Tanımı için kullanıcı dostu bir ad. Veritabanı hesabı için benzersiz olmalıdır. dizgi
tür Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir. 'BuiltInRole'
'CustomRole'

Kullanım Örnekleri

Bicep Örnekleri

Cosmos DB SQL Rol Tanımı'nı dağıtmanın temel bir örneği.

param location string = 'westeurope'
param resourceName string = 'acctest0001'

resource databaseAccount 'Microsoft.DocumentDB/databaseAccounts@2021-10-15' = {
  name: resourceName
  location: location
  kind: 'GlobalDocumentDB'
  properties: {
    capabilities: []
    consistencyPolicy: {
      defaultConsistencyLevel: 'Strong'
      maxIntervalInSeconds: 5
      maxStalenessPrefix: 100
    }
    databaseAccountOfferType: 'Standard'
    defaultIdentity: 'FirstPartyIdentity'
    disableKeyBasedMetadataWriteAccess: false
    disableLocalAuth: false
    enableAnalyticalStorage: false
    enableAutomaticFailover: false
    enableFreeTier: false
    enableMultipleWriteLocations: false
    ipRules: []
    isVirtualNetworkFilterEnabled: false
    locations: [
      {
        failoverPriority: 0
        isZoneRedundant: false
        locationName: 'West Europe'
      }
    ]
    networkAclBypass: 'None'
    networkAclBypassResourceIds: []
    publicNetworkAccess: 'Enabled'
    virtualNetworkRules: []
  }
}

resource sqlRoleDefinition 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15' = {
  name: 'c3ce1661-d0b9-3476-0a7c-2654ce2f3055'
  parent: databaseAccount
  properties: {
    assignableScopes: [
      databaseAccount.id
    ]
    permissions: [
      {
        dataActions: [
          'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read'
        ]
      }
    ]
    roleName: resourceName
    type: 'CustomRole'
  }
}

Azure Doğrulanmış Modülleri

Aşağıdaki Azure Doğrulanmış Modüller bu kaynak türünü dağıtmak için kullanılabilir.

Modül Açıklama
Cosmos DB - SQL Rol Tanımı Cosmos DB için AVM Child Modülü - SQL Rol Tanımı

Azure Hızlı Başlangıç Örnekleri

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak için Bicep örnekleri içerir.

Bicep Dosyası Açıklama
Veri düzlemi RBAC ile Azure Cosmos DB SQL Hesabı oluşturma Bu şablon bir SQL Cosmos hesabı, yerel olarak korunan bir Rol Tanımı ve AAD kimliği için yerel olarak korunan rol ataması oluşturur.

ARM şablonu kaynak tanımı

databaseAccounts/sqlRoleDefinitions kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • kaynak grupları - Bkz. kaynak grubu dağıtım komutları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions kaynağı oluşturmak için, şablonunuza aşağıdaki JSON'u ekleyin.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions",
  "apiVersion": "2026-04-01-preview",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "id": "string",
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

Özellik Değerleri

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Ad Açıklama Değer
apiVersiyonu API sürümü '2026-04-01-önizleme'
ad Kaynak adı dize (gerekli)
Özellikler Azure Cosmos DB SQL Rol Tanımı oluşturma ve güncelleştirme özellikleri. SqlRoleDefinitionResource
tür Kaynak türü 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

İzin

Ad Açıklama Değer
dataActions İzin verilen veri eylemleri dizisi. dize[]
kimlik İzin kimliği. dizgi
notDataActions Reddedilen veri eylemleri dizisi. dize[]

SqlRoleDefinitionResource

Ad Açıklama Değer
assignableScopes Bu Rol Tanımı kullanılarak 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. dize[]
izinler Bu Rol Tanımı aracılığıyla izin verilen işlem kümesi. İzin[]
roleName Rol Tanımı için kullanıcı dostu bir ad. Veritabanı hesabı için benzersiz olmalıdır. dizgi
tür Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir. 'BuiltInRole'
'CustomRole'

Kullanım Örnekleri

Azure Hızlı Başlangıç Şablonları

Aşağıdaki Azure Hızlı Başlangıç şablonları bu kaynak türünü dağıtmak.

Şablon Açıklama
Veri düzlemi RBAC ile Azure Cosmos DB SQL Hesabı oluşturma

Azure 'a dağıtma
Bu şablon bir SQL Cosmos hesabı, yerel olarak korunan bir Rol Tanımı ve AAD kimliği için yerel olarak korunan rol ataması oluşturur.

Terraform (AzAPI sağlayıcısı) kaynak tanımı

databaseAccounts/sqlRoleDefinitions kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions kaynağı oluşturmak için, şablonunuza aşağıdaki Terraform'u ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2026-04-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          id = "string"
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  }
}

Özellik Değerleri

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Ad Açıklama Değer
ad Kaynak adı dize (gerekli)
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Tür kaynağı kimliği: databaseAccounts
Özellikler Azure Cosmos DB SQL Rol Tanımı oluşturma ve güncelleştirme özellikleri. SqlRoleDefinitionResource
tür Kaynak türü "Microsoft. DocumentDB/databaseAccounts/sqlRoleDefinitions@2026-04-01-önizleme"

İzin

Ad Açıklama Değer
dataActions İzin verilen veri eylemleri dizisi. dize[]
kimlik İzin kimliği. dizgi
notDataActions Reddedilen veri eylemleri dizisi. dize[]

SqlRoleDefinitionResource

Ad Açıklama Değer
assignableScopes Bu Rol Tanımı kullanılarak 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. dize[]
izinler Bu Rol Tanımı aracılığıyla izin verilen işlem kümesi. İzin[]
roleName Rol Tanımı için kullanıcı dostu bir ad. Veritabanı hesabı için benzersiz olmalıdır. dizgi
tür Rol Tanımı'nın yerleşik mi yoksa kullanıcının mı oluşturulduğunu gösterir. 'BuiltInRole'
'CustomRole'

Kullanım Örnekleri

Terraform Örnekleri

Cosmos DB SQL Rol Tanımı'nı dağıtmanın temel bir örneği.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "databaseAccount" {
  type      = "Microsoft.DocumentDB/databaseAccounts@2021-10-15"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "GlobalDocumentDB"
    properties = {
      capabilities = [
      ]
      consistencyPolicy = {
        defaultConsistencyLevel = "Strong"
        maxIntervalInSeconds    = 5
        maxStalenessPrefix      = 100
      }
      databaseAccountOfferType           = "Standard"
      defaultIdentity                    = "FirstPartyIdentity"
      disableKeyBasedMetadataWriteAccess = false
      disableLocalAuth                   = false
      enableAnalyticalStorage            = false
      enableAutomaticFailover            = false
      enableFreeTier                     = false
      enableMultipleWriteLocations       = false
      ipRules = [
      ]
      isVirtualNetworkFilterEnabled = false
      locations = [
        {
          failoverPriority = 0
          isZoneRedundant  = false
          locationName     = "West Europe"
        },
      ]
      networkAclBypass = "None"
      networkAclBypassResourceIds = [
      ]
      publicNetworkAccess = "Enabled"
      virtualNetworkRules = [
      ]
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlRoleDefinition" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = "c3ce1661-d0b9-3476-0a7c-2654ce2f3055"
  body = {
    properties = {
      assignableScopes = [
        azapi_resource.databaseAccount.id,
      ]
      permissions = [
        {
          dataActions = [
            "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read",
          ]
        },
      ]
      roleName = var.resource_name
      type     = "CustomRole"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}