Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions 2024-05-15

  • Artikel

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 im Änderungsprotokoll.

Ressourcenformat

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

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

Eigenschaftswerte

databaseAccounts/sqlRoleDefinitions

Name BESCHREIBUNG Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 Zeichenfolge (erforderlich)
parent 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 vom Typ: databaseAccounts
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Rollendefinition. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Name BESCHREIBUNG Wert
assignableScopes Eine Gruppe vollqualifizierter Bereiche ab oder darunter, in denen Rollenzuweisungen mithilfe dieser Rollendefinition erstellt werden können. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine zugrunde liegende Datenbank/Sammlung. Muss mindestens ein Element aufweisen. Bereiche, die höher als das Datenbankkonto sind, können nicht als zuweisbare Bereiche erzwungen werden. Beachten Sie, dass Ressourcen, auf die in zuweisbaren Bereichen verwiesen wird, nicht vorhanden sein müssen. string[]
Berechtigungen Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind. Berechtigung[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Zeichenfolge
type Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. "BuiltInRole"
"CustomRole"

Berechtigung

Name BESCHREIBUNG Wert
dataActions Ein Array von zulässigen Datenaktionen. string[]
notDataActions Ein Array von Datenaktionen, die verweigert werden. string[]

Schnellstartvorlagen

In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-SQL-Kontos mit RBAC auf Datenebene

Bereitstellen in Azure		 Mit dieser Vorlage wird ein SQL Cosmos-Konto erstellt, eine nativ gepflegte Rollendefinition und eine nativ gepflegte Rollenzuweisung für eine AAD-Identität.

Ressourcendefinition mit einer ARM-Vorlage

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 im Ä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": "2024-05-15",
  "name": "string",
  "properties": {
    "assignableScopes": [ "string" ],
    "permissions": [
      {
        "dataActions": [ "string" ],
        "notDataActions": [ "string" ]
      }
    ],
    "roleName": "string",
    "type": "string"
  }
}

Eigenschaftswerte

databaseAccounts/sqlRoleDefinitions

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions"
apiVersion Die Ressourcen-API-Version '2024-05-15'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 Zeichenfolge (erforderlich)
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Rollendefinition. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Name BESCHREIBUNG Wert
assignableScopes Eine Reihe vollqualifizierter Bereiche ab oder darunter, in 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 sind als das Datenbankkonto, sind nicht als zuweisbare Bereiche erzwingbar. Beachten Sie, dass Ressourcen, auf die in zuweisbaren Bereichen verwiesen wird, nicht vorhanden sein müssen. string[]
Berechtigungen Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind. Berechtigung[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Zeichenfolge
type Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. "BuiltInRole"
'CustomRole'

Berechtigung

Name BESCHREIBUNG Wert
dataActions Ein Array von zulässigen Datenaktionen. string[]
notDataActions Ein Array von Datenaktionen, die verweigert werden. string[]

Schnellstartvorlagen

Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.

Vorlage BESCHREIBUNG
Erstellen eines Azure Cosmos DB-SQL-Kontos mit RBAC auf Datenebene

Bereitstellen in Azure		 Mit dieser Vorlage wird ein SQL Cosmos-Konto erstellt, eine nativ gepflegte Rollendefinition und eine nativ gepflegte Rollenzuweisung für eine AAD-Identität.

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp databaseAccounts/sqlRoleDefinitions kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:

  • 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 Der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      assignableScopes = [
        "string"
      ]
      permissions = [
        {
          dataActions = [
            "string"
          ]
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  })
}

Eigenschaftswerte

databaseAccounts/sqlRoleDefinitions

Name BESCHREIBUNG Wert
type Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2024-05-15"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: databaseAccounts
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-SQL-Rollendefinition. SqlRoleDefinitionResource

SqlRoleDefinitionResource

Name BESCHREIBUNG Wert
assignableScopes Eine Reihe vollqualifizierter Bereiche ab oder darunter, in 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 sind als das Datenbankkonto, sind nicht als zuweisbare Bereiche erzwingbar. Beachten Sie, dass Ressourcen, auf die in zuweisbaren Bereichen verwiesen wird, nicht vorhanden sein müssen. string[]
Berechtigungen Der Satz von Vorgängen, die über diese Rollendefinition zulässig sind. Berechtigung[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Zeichenfolge
type Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. "BuiltInRole"
"CustomRole"

Berechtigung

Name BESCHREIBUNG Wert
dataActions Ein Array von zulässigen Datenaktionen. string[]
notDataActions Ein Array von Datenaktionen, die verweigert werden. string[]