Microsoft.DocumentDB-DatenbankAccounts/mongodbRoleDefinitions 2023-03-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp databaseAccounts/mongodbRoleDefinitions 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/mongodbRoleDefinitions-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-03-15' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    databaseName: 'string'
    privileges: [
      {
        actions: [
          'string'
        ]
        resource: {
          collection: 'string'
          db: 'string'
        }
      }
    ]
    roleName: 'string'
    roles: [
      {
        db: 'string'
        role: 'string'
      }
    ]
    type: 'string'
  }
}

Eigenschaftswerte

databaseAccounts/mongodbRoleDefinitions

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 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-Mongo-Rollendefinition. MongoRoleDefinitionResource

MongoRoleDefinitionResource

Name BESCHREIBUNG Wert
databaseName Der Datenbankname, für den zugriff für diese Rollendefinition gewährt wird. Zeichenfolge
Berechtigungen Eine Gruppe von Berechtigungen, die in der Rollendefinition enthalten sind. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Bereiche, die höher als Die Datenbank sind, sind nicht als Berechtigungen erzwingbar. Berechtigung[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Zeichenfolge
roles Der Von dieser Rollendefinition geerbte Satz von Rollen. Rolle[]
Typ Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. "BuiltInRole"
'CustomRole'

Berechtigung

Name BESCHREIBUNG Wert
Aktionen Ein Array zulässiger Aktionen. string[]
resource Eine Azure Cosmos DB-Mongo DB-Ressource. PrivilegeResource

PrivilegeResource

Name BESCHREIBUNG Wert
collection Der Auflistungsname, den die Rolle angewendet wird. Zeichenfolge
db Der Datenbankname, den die Rolle angewendet wird. Zeichenfolge

Role

Name BESCHREIBUNG Wert
db Der Datenbankname, den die Rolle angewendet wird. Zeichenfolge
Rolle (role) Der Name der Rolle. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp databaseAccounts/mongodbRoleDefinitions 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/mongodbRoleDefinitions zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions",
  "apiVersion": "2023-03-15",
  "name": "string",
  "properties": {
    "databaseName": "string",
    "privileges": [
      {
        "actions": [ "string" ],
        "resource": {
          "collection": "string",
          "db": "string"
        }
      }
    ],
    "roleName": "string",
    "roles": [
      {
        "db": "string",
        "role": "string"
      }
    ],
    "type": "string"
  }
}

Eigenschaftswerte

databaseAccounts/mongodbRoleDefinitions

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions"
apiVersion Die Version der Ressourcen-API '2023-03-15'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)
properties Eigenschaften zum Erstellen und Aktualisieren einer Azure Cosmos DB-Mongo-Rollendefinition. MongoRoleDefinitionResource

MongoRoleDefinitionResource

Name BESCHREIBUNG Wert
databaseName Der Datenbankname, für den zugriff für diese Rollendefinition gewährt wird. Zeichenfolge
Berechtigungen Ein Satz von Berechtigungen, die in der Rollendefinition enthalten sind. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine zugrunde liegende Datenbank/Sammlung. Bereiche, die höher als Datenbank sind, können nicht als Berechtigungen erzwungen werden. Privilege[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Zeichenfolge
roles Der Satz von Rollen, der von dieser Rollendefinition geerbt wird. Rolle[]
Typ Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. "BuiltInRole"
"CustomRole"

Berechtigung

Name BESCHREIBUNG Wert
Aktionen Ein Array von zulässigen Aktionen. string[]
resource Eine Azure Cosmos DB-Mongo DB-Ressource. PrivilegeResource

PrivilegeResource

Name BESCHREIBUNG Wert
collection Der Auflistungsname, auf den die Rolle angewendet wird. Zeichenfolge
db Der Datenbankname, auf den die Rolle angewendet wird. Zeichenfolge

Role

Name BESCHREIBUNG Wert
db Der Datenbankname, auf den die Rolle angewendet wird. Zeichenfolge
Rolle (role) Der Name der Rolle. Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

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

  • Ressourcengruppen

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

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-03-15"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      databaseName = "string"
      privileges = [
        {
          actions = [
            "string"
          ]
          resource = {
            collection = "string"
            db = "string"
          }
        }
      ]
      roleName = "string"
      roles = [
        {
          db = "string"
          role = "string"
        }
      ]
      type = "string"
    }
  })
}

Eigenschaftswerte

databaseAccounts/mongodbRoleDefinitions

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

MongoRoleDefinitionResource

Name BESCHREIBUNG Wert
databaseName Der Datenbankname, für den zugriff für diese Rollendefinition gewährt wird. Zeichenfolge
Berechtigungen Eine Gruppe von Berechtigungen, die in der Rollendefinition enthalten sind. Dies ermöglicht die Anwendung dieser Rollendefinition auf das gesamte Datenbankkonto oder eine beliebige zugrunde liegende Datenbank/Sammlung. Bereiche, die höher als Die Datenbank sind, sind nicht als Berechtigungen erzwingbar. Berechtigung[]
roleName Ein benutzerfreundlicher Name für die Rollendefinition. Muss für das Datenbankkonto eindeutig sein. Zeichenfolge
roles Der Von dieser Rollendefinition geerbte Satz von Rollen. Rolle[]
Typ Gibt an, ob die Rollendefinition integriert oder vom Benutzer erstellt wurde. "BuiltInRole"
"CustomRole"

Berechtigung

Name BESCHREIBUNG Wert
Aktionen Ein Array zulässiger Aktionen. string[]
resource Eine Azure Cosmos DB-Mongo DB-Ressource. PrivilegeResource

PrivilegeResource

Name BESCHREIBUNG Wert
collection Der Auflistungsname, den die Rolle angewendet wird. Zeichenfolge
db Der Datenbankname, den die Rolle angewendet wird. Zeichenfolge

Role

Name BESCHREIBUNG Wert
db Der Datenbankname, den die Rolle angewendet wird. Zeichenfolge
Rolle (role) Der Name der Rolle. Zeichenfolge