Freigeben über

Microsoft.DocumentDB-DatenbankAccounts/sqlRoleDefinitions

Bicep-Ressourcendefinition

Der Ressourcentyp "databaseAccounts/sqlRoleDefinitions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep hinzu.

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

Eigenschaftswerte

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
Elternteil In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource des Typs: databaseAccounts
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB SQL-Rollendefinition. SqlRoleDefinitionResource-

BerechtigungAutomatisch generiert

Name Beschreibung Wert
dataAktionen Ein Array von Datenaktionen, die zulässig sind. Zeichenfolge[]
notDataActions Ein Array von Datenaktionen, die verweigert werden. Zeichenfolge[]

SqlRoleDefinitionResource

Name Beschreibung Wert
assignableScopes Eine Reihe vollqualifizierter Bereiche, unter denen Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Muss mindestens ein Element aufweisen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisungsfähige Bereiche erzwingt werden. Beachten Sie, dass Ressourcen, auf die in zugewiesenen Bereichen verwiesen wird, nicht vorhanden sind. Zeichenfolge[]
Erlaubnisse Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind. BerechtigungAutoGeneriert[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Schnur
Art Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. 'BuiltInRole'
'CustomRole'

Verwendungsbeispiele

Bicep-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung der Cosmos DB SQL-Rollendefinition.

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

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' = {
  parent: databaseAccount
  name: 'c3ce1661-d0b9-3476-0a7c-2654ce2f3055'
  properties: {
    assignableScopes: [
      databaseAccount.id
    ]
    permissions: [
      {
        dataActions: [
          'Microsoft.DocumentDB/databaseAccounts/sqlDatabases/containers/items/read'
        ]
      }
    ]
    roleName: 'acctest0001'
    type: 'CustomRole'
  }
}

Von Azure verifizierte Module

Die folgenden Azure Verified Modules können verwendet werden, um diesen Ressourcentyp bereitzustellen.

Modul Beschreibung
Cosmos DB – SQL-Rollendefinition AVM-Kindmodul für Cosmos DB – SQL-Rollendefinition

Azure-Schnellstartbeispiele

Die folgenden Azure-Schnellstartvorlagen Bicep-Beispiele für die Bereitstellung dieses Ressourcentyps enthalten.

Bicep-Datei Beschreibung
Erstellen eines Azure Cosmos DB SQL-Kontos mit RBAC- Diese Vorlage erstellt ein SQL Cosmos-Konto, eine systemeigene verwaltete Rollendefinition und eine systemeigene verwaltete Rollenzuweisung für eine AAD-Identität.

ARM-Vorlagenressourcendefinition

Der Ressourcentyp "databaseAccounts/sqlRoleDefinitions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

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

Eigenschaftswerte

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Name Beschreibung Wert
apiVersion (Englisch) Die API-Version '2025-11-01-Vorschau'
Name Der Ressourcenname Zeichenfolge (erforderlich)
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB SQL-Rollendefinition. SqlRoleDefinitionResource-
Art Der Ressourcentyp 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

BerechtigungAutomatisch generiert

Name Beschreibung Wert
dataAktionen Ein Array von Datenaktionen, die zulässig sind. Zeichenfolge[]
notDataActions Ein Array von Datenaktionen, die verweigert werden. Zeichenfolge[]

SqlRoleDefinitionResource

Name Beschreibung Wert
assignableScopes Eine Reihe vollqualifizierter Bereiche, unter denen Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Muss mindestens ein Element aufweisen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisungsfähige Bereiche erzwingt werden. Beachten Sie, dass Ressourcen, auf die in zugewiesenen Bereichen verwiesen wird, nicht vorhanden sind. Zeichenfolge[]
Erlaubnisse Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind. BerechtigungAutoGeneriert[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Schnur
Art Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. 'BuiltInRole'
'CustomRole'

Verwendungsbeispiele

Azure-Schnellstartvorlagen

Die folgenden Azure-Schnellstartvorlagen diesen Ressourcentyp bereitstellen.

Schablone Beschreibung
Erstellen eines Azure Cosmos DB SQL-Kontos mit RBAC-

Bereitstellen in Azure 		Diese Vorlage erstellt ein SQL Cosmos-Konto, eine systemeigene verwaltete Rollendefinition und eine systemeigene verwaltete Rollenzuweisung für eine AAD-Identität.

Terraform -Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp "databaseAccounts/sqlRoleDefinitions" kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions-Ressource zu erstellen, fügen Sie Ihrer Vorlage die folgende Terraform hinzu.

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

Eigenschaftswerte

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Name Beschreibung Wert
Name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource des Typs: databaseAccounts
Eigenschaften Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB SQL-Rollendefinition. SqlRoleDefinitionResource-
Art Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2025-11-01-preview"

BerechtigungAutomatisch generiert

Name Beschreibung Wert
dataAktionen Ein Array von Datenaktionen, die zulässig sind. Zeichenfolge[]
notDataActions Ein Array von Datenaktionen, die verweigert werden. Zeichenfolge[]

SqlRoleDefinitionResource

Name Beschreibung Wert
assignableScopes Eine Reihe vollqualifizierter Bereiche, unter denen Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Muss mindestens ein Element aufweisen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisungsfähige Bereiche erzwingt werden. Beachten Sie, dass Ressourcen, auf die in zugewiesenen Bereichen verwiesen wird, nicht vorhanden sind. Zeichenfolge[]
Erlaubnisse Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind. BerechtigungAutoGeneriert[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Schnur
Art Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. 'BuiltInRole'
'CustomRole'

Verwendungsbeispiele

Terraform-Beispiele

Ein grundlegendes Beispiel für die Bereitstellung der Cosmos DB SQL-Rollendefinition.

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    = ["*"]
}
  • Last updated on