Microsoft.DocumentDB databaseAccounts/sqlRoleDefinitions

Définition de ressource Bicep

Le type de ressource databaseAccounts/sqlRoleDefinitions 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 de ressource

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

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

Valeurs de propriété

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Nom Descriptif Valeur
nom Nom de la ressource chaîne (obligatoire)
parent Dans Bicep, vous pouvez spécifier la ressource parente d’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
Propriétés Propriétés permettant de créer et de mettre à jour une définition de rôle SQL Azure Cosmos DB. SqlRoleDefinitionResource

Autorisation

Nom Descriptif Valeur
dataActions Tableau d’actions de données autorisées. string[]
pièce d'identité ID de l’autorisation. corde
notDataActions Tableau d’actions de données refusées. string[]

SqlRoleDefinitionResource

Nom Descriptif Valeur
assignableScopes Ensemble d’étendues complètes au niveau ou sous lequel les attributions de rôles peuvent être créées à l’aide de cette 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 toute base de données/collection sous-jacente. Doit avoir au moins un élément. Les étendues supérieures au compte de base de données ne peuvent pas être appliquées comme étendues assignables. Notez que les ressources référencées dans les étendues assignables n’ont pas besoin d’exister. string[]
Autorisations Ensemble d’opérations autorisées via cette définition de rôle. d’autorisation []
roleName Nom convivial pour la définition de rôle. Doit être unique pour le compte de base de données. corde
type Indique si la définition de rôle a été intégrée ou créée par l’utilisateur. 'BuiltInRole'
'CustomRole'

Exemples d’utilisation

Exemples Bicep

Exemple de base de déploiement de la définition de rôle SQL Cosmos DB.

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'
  }
}

Modules vérifiés Azure

Les modules vérifiés Azure suivants peuvent être utilisés pour déployer ce type de ressource.

Module Descriptif
Cosmos DB - Définition du rôle SQL Module enfant AVM pour Cosmos DB - Définition du rôle SQL

Exemples de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants contiennent des exemples Bicep pour le déploiement de ce type de ressource.

Fichier Bicep Descriptif
créer un compte SQL Azure Cosmos DB avec RBAC du plan de données Ce modèle crée un compte SQL Cosmos, une définition de rôle gérée en mode natif et une attribution de rôle gérée en mode natif pour une identité AAD.

Définition de ressource de modèle ARM

Le type de ressource databaseAccounts/sqlRoleDefinitions 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 de ressource

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

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

Valeurs de propriété

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Nom Descriptif Valeur
apiVersion Version de l’API '2025-11-01-preview'
nom Nom de la ressource chaîne (obligatoire)
Propriétés Propriétés permettant de créer et de mettre à jour une définition de rôle SQL Azure Cosmos DB. SqlRoleDefinitionResource
type Type de ressource 'Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions'

Autorisation

Nom Descriptif Valeur
dataActions Tableau d’actions de données autorisées. string[]
pièce d'identité ID de l’autorisation. corde
notDataActions Tableau d’actions de données refusées. string[]

SqlRoleDefinitionResource

Nom Descriptif Valeur
assignableScopes Ensemble d’étendues complètes au niveau ou sous lequel les attributions de rôles peuvent être créées à l’aide de cette 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 toute base de données/collection sous-jacente. Doit avoir au moins un élément. Les étendues supérieures au compte de base de données ne peuvent pas être appliquées comme étendues assignables. Notez que les ressources référencées dans les étendues assignables n’ont pas besoin d’exister. string[]
Autorisations Ensemble d’opérations autorisées via cette définition de rôle. d’autorisation []
roleName Nom convivial pour la définition de rôle. Doit être unique pour le compte de base de données. corde
type Indique si la définition de rôle a été intégrée ou créée par l’utilisateur. 'BuiltInRole'
'CustomRole'

Exemples d’utilisation

Modèles de démarrage rapide Azure

Les modèles de démarrage rapide Azure suivants déployer ce type de ressource.

Modèle Descriptif
créer un compte SQL Azure Cosmos DB avec RBAC du plan de données

Déployer sur Azure 		Ce modèle crée un compte SQL Cosmos, une définition de rôle gérée en mode natif et une attribution de rôle gérée en mode natif pour une identité AAD.

Définition de ressource Terraform (fournisseur AzAPI)

Le type de ressource databaseAccounts/sqlRoleDefinitions 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 de ressource

Pour créer une ressource Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions, ajoutez terraform suivante à votre modèle.

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"
          ]
          id = "string"
          notDataActions = [
            "string"
          ]
        }
      ]
      roleName = "string"
      type = "string"
    }
  }
}

Valeurs de propriété

Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions

Nom Descriptif Valeur
nom Nom de la ressource chaîne (obligatoire)
parent_id ID de la ressource qui est le parent de cette ressource. ID de ressource de type : databaseAccounts
Propriétés Propriétés permettant de créer et de mettre à jour une définition de rôle SQL Azure Cosmos DB. SqlRoleDefinitionResource
type Type de ressource « Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2025-11-01-preview »

Autorisation

Nom Descriptif Valeur
dataActions Tableau d’actions de données autorisées. string[]
pièce d'identité ID de l’autorisation. corde
notDataActions Tableau d’actions de données refusées. string[]

SqlRoleDefinitionResource

Nom Descriptif Valeur
assignableScopes Ensemble d’étendues complètes au niveau ou sous lequel les attributions de rôles peuvent être créées à l’aide de cette 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 toute base de données/collection sous-jacente. Doit avoir au moins un élément. Les étendues supérieures au compte de base de données ne peuvent pas être appliquées comme étendues assignables. Notez que les ressources référencées dans les étendues assignables n’ont pas besoin d’exister. string[]
Autorisations Ensemble d’opérations autorisées via cette définition de rôle. d’autorisation []
roleName Nom convivial pour la définition de rôle. Doit être unique pour le compte de base de données. corde
type Indique si la définition de rôle a été intégrée ou créée par l’utilisateur. 'BuiltInRole'
'CustomRole'

Exemples d’utilisation

Échantillons Terraform

Exemple de base de déploiement de la définition de rôle SQL Cosmos DB.

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