Partager via

Base de données Microsoft.DocumentDBAccounts/mongodbRoleDefinitions 2023-09-15-preview

  • Article

Définition de ressource Bicep

Le type de ressource databaseAccounts/mongodbRoleDefinitions peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions, ajoutez le Bicep suivant à votre modèle.

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

Valeurs de propriétés

databaseAccounts/mongodbRoleDefinitions

Nom Description Valeur
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep.		 string (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente.

Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente.		 Nom symbolique de la ressource de type : databaseAccounts
properties Propriétés permettant de créer et de mettre à jour une définition de rôle Mongo Azure Cosmos DB. MongoRoleDefinitionResource

MongoRoleDefinitionResource

Nom Description Valeur
databaseName Nom de la base de données pour laquelle l’accès est accordé pour cette définition de rôle. string
privilèges Ensemble de privilèges contenus dans la définition de rôle. Cela permet l’application de cette définition de rôle sur l’ensemble du compte de base de données ou sur toute base de données/collection sous-jacente. Les étendues supérieures à La base de données ne sont pas applicables en tant que privilèges. Privilege[]
roleName Nom convivial pour la définition de rôle. Doit être unique pour le compte de base de données. string
roles Ensemble de rôles hérités par cette définition de rôle. Rôle[]
type Indique si la définition de rôle a été intégrée ou créée par l’utilisateur. 'BuiltInRole'
'CustomRole'

Privilège

Nom Description Valeur
actions Tableau d’actions autorisées. string[]
resource Une ressource Mongo DB Azure Cosmos DB. PrivilegeResource

PrivilegeResource

Nom Description Valeur
collection Nom de collection auquel le rôle est appliqué. string
db Nom de base de données auquel le rôle est appliqué. string

Rôle

Nom Description Valeur
db Nom de base de données auquel le rôle est appliqué. string
rôle Nom du rôle. string

Définition de ressources de modèle ARM

Le type de ressource databaseAccounts/mongodbRoleDefinitions peut être déployé avec des opérations qui ciblent :

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions, ajoutez le code JSON suivant à votre modèle.

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

Valeurs de propriétés

databaseAccounts/mongodbRoleDefinitions

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions »
apiVersion Version de l’API de ressource « 2023-09-15-preview »
name Nom de la ressource

Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON.		 chaîne (obligatoire)
properties Propriétés permettant de créer et de mettre à jour une définition de rôle Mongo Azure Cosmos DB. MongoRoleDefinitionResource

MongoRoleDefinitionResource

Nom Description Valeur
databaseName Nom de la base de données pour laquelle l’accès est accordé pour cette définition de rôle. string
privilèges Ensemble de privilèges contenus dans la définition de rôle. Cela permet l’application de cette définition de rôle sur l’ensemble du compte de base de données ou sur toute base de données/collection sous-jacente. Les étendues supérieures à la base de données ne sont pas applicables en tant que privilèges. Privilege[]
roleName Nom convivial pour la définition de rôle. Doit être unique pour le compte de base de données. string
roles Ensemble de rôles hérités par cette définition de rôle. Rôle[]
type Indique si la définition de rôle a été intégrée ou créée par l’utilisateur. 'BuiltInRole'
'CustomRole'

Privilège

Nom Description Valeur
actions Tableau d’actions autorisées. string[]
resource Une ressource Mongo DB Azure Cosmos DB. PrivilegeResource

PrivilegeResource

Nom Description Valeur
collection Nom de collection auquel le rôle est appliqué. string
db Nom de base de données auquel le rôle est appliqué. string

Rôle

Nom Description Valeur
db Nom de base de données auquel le rôle est appliqué. string
rôle Nom du rôle. string

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/mongodbRoleDefinitions peut être déployé avec des opérations qui ciblent :

  • Groupes de ressources

Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications.

Format des ressources

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions, ajoutez le Terraform suivant à votre modèle.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-09-15-preview"
  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"
    }
  })
}

Valeurs de propriétés

databaseAccounts/mongodbRoleDefinitions

Nom Description Valeur
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/mongodbRoleDefinitions@2023-09-15-preview »
name Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID pour la ressource de type : databaseAccounts
properties Propriétés permettant de créer et de mettre à jour une définition de rôle Mongo Azure Cosmos DB. MongoRoleDefinitionResource

MongoRoleDefinitionResource

Nom Description Valeur
databaseName Nom de la base de données pour laquelle l’accès est accordé pour cette définition de rôle. string
privilèges Ensemble de privilèges contenus dans la définition de rôle. Cela permet l’application de cette définition de rôle sur l’ensemble du compte de base de données ou sur toute base de données/collection sous-jacente. Les étendues supérieures à la base de données ne sont pas applicables en tant que privilèges. Privilege[]
roleName Nom convivial pour la définition de rôle. Doit être unique pour le compte de base de données. string
roles Ensemble de rôles hérités par cette définition de rôle. Rôle[]
type Indique si la définition de rôle a été intégrée ou créée par l’utilisateur. « BuiltInRole »
« CustomRole »

Privilège

Nom Description Valeur
actions Tableau d’actions autorisées. string[]
resource Une ressource Mongo DB Azure Cosmos DB. PrivilegeResource

PrivilegeResource

Nom Description Valeur
collection Nom de collection auquel le rôle est appliqué. string
db Nom de base de données auquel le rôle est appliqué. string

Rôle

Nom Description Valeur
db Nom de base de données auquel le rôle est appliqué. string
rôle Nom du rôle. string