Поделиться через


База данных Microsoft.DocumentDBAccounts/sqlRoleAssignments

Определение ресурсов Bicep

Тип ресурса databaseAccounts/sqlRoleAssignments можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2025-11-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    principalId: 'string'
    roleDefinitionId: 'string'
    scope: 'string'
  }
}

Значения свойств

Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: databaseAccounts
свойства Свойства для создания и обновления назначения ролей SQL Azure Cosmos DB. SqlRoleAssignmentResource

SqlRoleAssignmentResource

Имя Описание Ценность
идентификатор принципала Уникальный идентификатор связанного субъекта AAD в графе AAD, к которому предоставляется доступ с помощью этого назначения ролей. Идентификатор клиента для субъекта выводится с помощью клиента, связанного с подпиской. струна
roleDefinitionId Уникальный идентификатор связанного определения роли. струна
размах Путь к ресурсу плоскости данных, для которого предоставляется доступ с помощью этого назначения ролей. струна

Примеры использования

Примеры быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure содержат примеры Bicep для развертывания этого типа ресурса.

Bicep-файл Описание
создание учетной записи SQL Azure Cosmos DB с уровня данных Этот шаблон создаст учетную запись SQL Cosmos, собственное определение роли и собственное назначение ролей для удостоверения AAD.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

Определение ресурса шаблона ARM

Тип ресурса databaseAccounts/sqlRoleAssignments можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments",
  "apiVersion": "2025-11-01-preview",
  "name": "string",
  "properties": {
    "principalId": "string",
    "roleDefinitionId": "string",
    "scope": "string"
  }
}

Значения свойств

Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments

Имя Описание Ценность
apiVersion Версия API «2025-11-01-превью»
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления назначения ролей SQL Azure Cosmos DB. SqlRoleAssignmentResource
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments"

SqlRoleAssignmentResource

Имя Описание Ценность
идентификатор принципала Уникальный идентификатор связанного субъекта AAD в графе AAD, к которому предоставляется доступ с помощью этого назначения ролей. Идентификатор клиента для субъекта выводится с помощью клиента, связанного с подпиской. струна
roleDefinitionId Уникальный идентификатор связанного определения роли. струна
размах Путь к ресурсу плоскости данных, для которого предоставляется доступ с помощью этого назначения ролей. струна

Примеры использования

Шаблоны быстрого запуска Azure

Следующие шаблоны быстрого запуска Azure развернуть этот тип ресурса.

Шаблон Описание
создание учетной записи SQL Azure Cosmos DB с уровня данных

развертывание в Azure
Этот шаблон создаст учетную запись SQL Cosmos, собственное определение роли и собственное назначение ролей для удостоверения AAD.
Развертывание базы данных Azure Data Explorer с помощью подключения Cosmos DB

развертывание в Azure
Разверните базу данных Azure Data Explorer с подключением Cosmos DB.

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса databaseAccounts/sqlRoleAssignments можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2025-11-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      principalId = "string"
      roleDefinitionId = "string"
      scope = "string"
    }
  }
}

Значения свойств

Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
свойства Свойства для создания и обновления назначения ролей SQL Azure Cosmos DB. SqlRoleAssignmentResource
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2025-11-01-preview"

SqlRoleAssignmentResource

Имя Описание Ценность
идентификатор принципала Уникальный идентификатор связанного субъекта AAD в графе AAD, к которому предоставляется доступ с помощью этого назначения ролей. Идентификатор клиента для субъекта выводится с помощью клиента, связанного с подпиской. струна
roleDefinitionId Уникальный идентификатор связанного определения роли. струна
размах Путь к ресурсу плоскости данных, для которого предоставляется доступ с помощью этого назначения ролей. струна

Примеры использования

Примеры Terraform

Простой пример развертывания назначения ролей 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" "cluster" {
  type      = "Microsoft.Kusto/clusters@2023-05-02"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  identity {
    type         = "SystemAssigned"
    identity_ids = []
  }
  body = {
    properties = {
      enableAutoStop                = true
      enableDiskEncryption          = false
      enableDoubleEncryption        = false
      enablePurge                   = false
      enableStreamingIngest         = false
      engineType                    = "V2"
      publicIPType                  = "IPv4"
      publicNetworkAccess           = "Enabled"
      restrictOutboundNetworkAccess = "Disabled"
      trustedExternalTenants = [
      ]
    }
    sku = {
      capacity = 1
      name     = "Dev(No SLA)_Standard_D11_v2"
      tier     = "Basic"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

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 = "Session"
        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    = ["*"]
}

data "azapi_resource" "sqlRoleDefinition" {
  type                   = "Microsoft.DocumentDB/databaseAccounts/sqlRoleDefinitions@2021-10-15"
  parent_id              = azapi_resource.databaseAccount.id
  name                   = "00000000-0000-0000-0000-000000000001"
  response_export_values = ["*"]
}

resource "azapi_resource" "database" {
  type      = "Microsoft.Kusto/clusters/databases@2023-05-02"
  parent_id = azapi_resource.cluster.id
  name      = var.resource_name
  location  = var.location
  body = {
    kind = "ReadWrite"
    properties = {
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "sqlRoleAssignment" {
  type      = "Microsoft.DocumentDB/databaseAccounts/sqlRoleAssignments@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = "ff419bf7-f8ca-ef51-00d2-3576700c341b"
  body = {
    properties = {
      principalId      = azapi_resource.cluster.output.identity.principalId
      roleDefinitionId = data.azapi_resource.sqlRoleDefinition.id
      scope            = azapi_resource.databaseAccount.id
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}