База данных Microsoft.DocumentDBAccounts/cassandraKeyspaces 2021-10-15-preview

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

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

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

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

Примеры Bicep

Простой пример развертывания Cassandra KeySpace в учетной записи 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: [
      {
        name: 'EnableCassandra'
      }
    ]
    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 cassandraKeyspace 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15' = {
  name: resourceName
  parent: databaseAccount
  properties: {
    options: {}
    resource: {
      id: resourceName
    }
  }
}

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

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

Bicep-файл Описание
создание учетной записи Azure Cosmos DB для API Cassandra Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с выделенной пропускной способностью.
Создание учетной записи azure Cosmos DB автомасштабирования для API Cassandra Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с пропускной способностью автомасштабирования.

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

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

resource symbolicname 'Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15-preview' = {
  parent: resourceSymbolicName
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    options: {
      autoscaleSettings: {
        maxThroughput: int
      }
      throughput: int
    }
    resource: {
      id: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

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

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: databaseAccounts
свойства Свойства для создания и обновления пространства ключей Cassandra в Azure Cosmos DB. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах

АвтомасштабированиеSettings

Имя Описание Ценность
maxПропускная способность Представляет максимальную пропускную способность, ресурс может масштабироваться до. инт

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
ресурс Стандартный формат JSON пространства ключей Cassandra CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (обязательно)

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

Имя Описание Ценность
идентификатор Имя пространства ключей Cassandra Cosmos DB строка (обязательно)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. АвтомасштабированиеSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. инт

Управляемая служебная идентичность

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

Теги

Имя Описание Ценность

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

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

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

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

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

Шаблон Описание
создание учетной записи Azure Cosmos DB для API Cassandra

развертывание в Azure
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с выделенной пропускной способностью.
Создание учетной записи azure Cosmos DB автомасштабирования для API Cassandra

развертывание в Azure
Этот шаблон создает учетную запись Azure Cosmos DB для API Cassandra в двух регионах с пространством ключей и таблицей с пропускной способностью автомасштабирования.

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

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

{
  "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces",
  "apiVersion": "2021-10-15-preview",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "location": "string",
  "properties": {
    "options": {
      "autoscaleSettings": {
        "maxThroughput": "int"
      },
      "throughput": "int"
    },
    "resource": {
      "id": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

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

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

Имя Описание Ценность
apiVersion Версия API '2021-10-15-превью'
тождество Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
свойства Свойства для создания и обновления пространства ключей Cassandra в Azure Cosmos DB. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов. См. теги в шаблонах
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces"

АвтомасштабированиеSettings

Имя Описание Ценность
maxПропускная способность Представляет максимальную пропускную способность, ресурс может масштабироваться до. инт

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
ресурс Стандартный формат JSON пространства ключей Cassandra CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (обязательно)

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

Имя Описание Ценность
идентификатор Имя пространства ключей Cassandra Cosmos DB строка (обязательно)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. АвтомасштабированиеSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. инт

Управляемая служебная идентичность

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

Теги

Имя Описание Ценность

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

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

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

Примеры Terraform

Простой пример развертывания Cassandra KeySpace в учетной записи 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 = [
        {
          name = "EnableCassandra"
        },
      ]
      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" "cassandraKeyspace" {
  type      = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15"
  parent_id = azapi_resource.databaseAccount.id
  name      = var.resource_name
  body = {
    properties = {
      options = {
      }
      resource = {
        id = var.resource_name
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15-preview"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      options = {
        autoscaleSettings = {
          maxThroughput = int
        }
        throughput = int
      }
      resource = {
        id = "string"
      }
    }
  }
}

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

Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces

Имя Описание Ценность
тождество Удостоверение ресурса. ManagedServiceIdentity (Управляемый сервисИдентификация)
местоположение Расположение группы ресурсов, к которой принадлежит ресурс. струна
имя Имя ресурса строка (обязательно)
идентификатор_родителя Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: databaseAccounts
свойства Свойства для создания и обновления пространства ключей Cassandra в Azure Cosmos DB. CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties (обязательно)
Теги Теги ресурсов Словарь имен и значений тегов.
тип Тип ресурса "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces@2021-10-15-preview"

АвтомасштабированиеSettings

Имя Описание Ценность
maxПропускная способность Представляет максимальную пропускную способность, ресурс может масштабироваться до. инт

CassandraKeyspaceCreateUpdatePropertiesOrCassandraKeyspaceGetProperties

Имя Описание Ценность
Параметры Пара параметров с ключом-значением, применяемая для запроса. Это соответствует заголовкам, отправленным запросом. CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions
ресурс Стандартный формат JSON пространства ключей Cassandra CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource (обязательно)

CassandraKeyspaceResourceOrCassandraKeyspaceGetPropertiesResource

Имя Описание Ценность
идентификатор Имя пространства ключей Cassandra Cosmos DB строка (обязательно)

Components1Jq1T4ISchemasManagedserviceidentityPropertiesUserassignedidentitiesAdditionalproperties

Имя Описание Ценность

CreateUpdateOptionsOrCassandraKeyspaceGetPropertiesOptions

Имя Описание Ценность
autoscaleSettings Задает параметры автомасштабирования. АвтомасштабированиеSettings
производительность Единицы запроса в секунду. Например, "пропускная способность": 10000. инт

Управляемая служебная идентичность

Имя Описание Ценность
тип Тип удостоверения, используемого для ресурса. Тип SystemAssigned,UserAssigned включает как неявное созданное удостоверение, так и набор назначенных пользователем удостоверений. Тип "Нет" удаляет все удостоверения из службы. "Нет"
SystemAssigned
SystemAssigned, UserAssigned
UserAssigned
ИдентичностиНазначенныеПользователем Список удостоверений пользователей, связанных с ресурсом. Ссылки на ключ словаря удостоверений пользователя будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}". ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Имя Описание Ценность

Теги

Имя Описание Ценность