Microsoft.DocumentDB cassandraClusters/dataCenters 2022-08-15-preview

Определение ресурса Bicep

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

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

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

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-08-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authenticationMethodLdapProperties: {
      searchBaseDistinguishedName: 'string'
      searchFilterTemplate: 'string'
      serverCertificates: [
        {
          pem: 'string'
        }
      ]
      serverHostname: 'string'
      serverPort: int
      serviceUserDistinguishedName: 'string'
      serviceUserPassword: 'string'
    }
    availabilityZone: bool
    backupStorageCustomerKeyUri: 'string'
    base64EncodedCassandraYamlFragment: 'string'
    dataCenterLocation: 'string'
    delegatedSubnetId: 'string'
    diskCapacity: int
    diskSku: 'string'
    managedDiskCustomerKeyUri: 'string'
    nodeCount: int
    provisioningState: 'string'
    sku: 'string'
  }
}

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

cassandraClusters/dataCenters

Имя Описание Значение
name имя ресурса.

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

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа cassandraClusters
properties Свойства управляемого центра обработки данных Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Имя Описание Значение
authenticationMethodLdapProperties Свойства метода проверки подлинности ldap. Эта функция предоставляется в предварительной версии. AuthenticationMethodLdapProperties
availabilityZone Если в центре обработки данных есть функция зоны доступности, примените ее к масштабируемой набору виртуальных машин, в котором размещаются виртуальные машины центра обработки данных cassandra. bool
backupStorageCustomerKeyUri Указывает универсальный код ресурса (URI) ключа клиента для шифрования учетной записи хранения резервных копий. строка
base64EncodedCassandraYamlFragment Фрагмент файла конфигурации cassandra.yaml, который будет включен в файл cassandra.yaml для всех узлов в этом центре обработки данных. Фрагмент должен быть закодирован в кодировке Base64, и допускается только подмножество ключей. строка
dataCenterLocation Регион, в который должен быть создан этот центр обработки данных. строка
delegatedSubnetId Идентификатор ресурса подсети, к которому должны быть подключены сетевые интерфейсы узлов в этом центре обработки данных. Подсеть должна находиться в том же регионе, что и dataCenterLocation, и должна иметь возможность маршрутизироваться к подсети, указанной в свойстве "delegatedManagementSubnetId" кластера. Этот идентификатор ресурса будет иметь вид "/subscriptions/{subscription id}/resourceGroups/{группа ресурсов}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}. строка
diskCapacity Количество дисков, используемых для центров обработки данных. Значение по умолчанию — 4. INT
diskSku Номер SKU диска, используемый для центров обработки данных. Значение по умолчанию — P30. строка
managedDiskCustomerKeyUri URI ключа, используемый для шифрования управляемых дисков. Убедитесь, что назначенному системой удостоверению кластера назначены соответствующие разрешения (разрешения на получение, перенос ключа или распаковка) на ключ. строка
nodeCount Количество узлов, которые должен иметь центр обработки данных. Это нужное число. После настройки масштабирования центра обработки данных может потребоваться некоторое время. Чтобы отслеживать количество узлов и их состояние, используйте метод fetchNodeStatus в кластере. INT
provisioningState Состояние ресурса на момент вызова операции. "Отменено"
"Создание"
Удаление
"Сбой"
"Успешно"
"Обновление"
sku Номер SKU виртуальной машины, используемый для центров обработки данных. Значение по умолчанию — Standard_DS14_v2 строка

AuthenticationMethodLdapProperties

Имя Описание Значение
searchBaseDistinguishedName Различающееся имя объекта для запуска рекурсивного поиска пользователей. строка
searchFilterTemplate Шаблон для поиска. По умолчанию используется значение (cn=%s), где %s будет заменено именем пользователя, используемым для входа. строка
serverCertificates Certificate[]
serverHostname Имя узла сервера LDAP. строка
serverPort Порт LDAP-сервера. INT
serviceUserDistinguishedName Различающееся имя учетной записи пользователя поиска, которая может искать сведения о пользователе по проверке подлинности. строка
serviceUserPassword Пароль искать пользователя. строка

Сертификат

Имя Описание Значение
Pem Открытый ключ в формате PEM. строка

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

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

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

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

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2022-08-15-preview",
  "name": "string",
  "properties": {
    "authenticationMethodLdapProperties": {
      "searchBaseDistinguishedName": "string",
      "searchFilterTemplate": "string",
      "serverCertificates": [
        {
          "pem": "string"
        }
      ],
      "serverHostname": "string",
      "serverPort": "int",
      "serviceUserDistinguishedName": "string",
      "serviceUserPassword": "string"
    },
    "availabilityZone": "bool",
    "backupStorageCustomerKeyUri": "string",
    "base64EncodedCassandraYamlFragment": "string",
    "dataCenterLocation": "string",
    "delegatedSubnetId": "string",
    "diskCapacity": "int",
    "diskSku": "string",
    "managedDiskCustomerKeyUri": "string",
    "nodeCount": "int",
    "provisioningState": "string",
    "sku": "string"
  }
}

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

cassandraClusters/dataCenters

Имя Описание Значение
тип Тип ресурса Microsoft.DocumentDB/cassandraClusters/dataCenters
версия_API Версия API ресурсов '2022-08-15-preview'
name имя ресурса.

Узнайте, как задать имена и типы для дочерних ресурсов в шаблонах JSON ARM.
string (обязательно)
properties Свойства управляемого центра обработки данных Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Имя Описание Значение
authenticationMethodLdapProperties Свойства метода проверки подлинности Ldap. Эта функция предоставляется в предварительной версии. AuthenticationMethodLdapProperties
availabilityZone Если в центре обработки данных есть функция зоны доступности, примените ее к масштабируемой набору виртуальных машин, на которых размещаются виртуальные машины центра обработки данных cassandra. bool
backupStorageCustomerKeyUri Указывает URI ключа клиента для шифрования учетной записи хранения резервных копий. строка
base64EncodedCassandraYamlFragment Фрагмент файла конфигурации cassandra.yaml, который будет включен в файл cassandra.yaml для всех узлов в этом центре обработки данных. Фрагмент должен быть в кодировке Base64, и допускается только подмножество ключей. строка
dataCenterLocation Регион, в который должен быть создан центр обработки данных. строка
delegatedSubnetId Идентификатор ресурса подсети, к которому должны быть подключены сетевые интерфейсы узлов в этом центре обработки данных. Подсеть должна находиться в том же регионе, что и dataCenterLocation, и должна иметь возможность маршрутизации в подсеть, указанную в свойстве "delegatedManagementSubnetId" кластера. Этот идентификатор ресурса будет иметь вид "/subscriptions/{subscription id}/resourceGroups/{группа ресурсов}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". строка
diskCapacity Количество дисков, используемых для центров обработки данных. Значение по умолчанию — 4. INT
diskSku Номер SKU диска, используемый для центров обработки данных. Значение по умолчанию — P30. строка
managedDiskCustomerKeyUri URI ключа, используемый для шифрования управляемых дисков. Убедитесь, что назначенному системой удостоверению кластера назначены соответствующие разрешения (разрешения на получение, перенос или распаковку ключа) на ключ. строка
nodeCount Количество узлов, которые должен иметь центр обработки данных. Это нужное число. После его настройки может потребоваться некоторое время для масштабирования центра обработки данных в соответствии с ним. Чтобы отслеживать количество узлов и их состояние, используйте метод fetchNodeStatus в кластере. INT
provisioningState Состояние ресурса на момент вызова операции. "Отменено"
"Создание"
"Удаление"
"Сбой"
"Успешно"
"Обновление"
sku Номер SKU виртуальной машины, используемый для центров обработки данных. Значение по умолчанию — Standard_DS14_v2 строка

AuthenticationMethodLdapProperties

Имя Описание Значение
searchBaseDistinguishedName Различающееся имя объекта для запуска рекурсивного поиска пользователей. строка
searchFilterTemplate Шаблон для поиска. По умолчанию используется значение (cn=%s), где %s будет заменено именем пользователя, используемым для входа. строка
serverCertificates Certificate[]
serverHostname Имя узла сервера LDAP. строка
serverPort Порт LDAP-сервера. INT
serviceUserDistinguishedName Различающееся имя учетной записи пользователя поиска, которая может искать сведения о пользователе по проверке подлинности. строка
serviceUserPassword Пароль искать пользователя. строка

Сертификат

Имя Описание Значение
Pem Открытый ключ в формате PEM. строка

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

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

  • Группы ресурсов

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

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

Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters/dataCenters, добавьте следующую terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-08-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authenticationMethodLdapProperties = {
        searchBaseDistinguishedName = "string"
        searchFilterTemplate = "string"
        serverCertificates = [
          {
            pem = "string"
          }
        ]
        serverHostname = "string"
        serverPort = int
        serviceUserDistinguishedName = "string"
        serviceUserPassword = "string"
      }
      availabilityZone = bool
      backupStorageCustomerKeyUri = "string"
      base64EncodedCassandraYamlFragment = "string"
      dataCenterLocation = "string"
      delegatedSubnetId = "string"
      diskCapacity = int
      diskSku = "string"
      managedDiskCustomerKeyUri = "string"
      nodeCount = int
      provisioningState = "string"
      sku = "string"
    }
  })
}

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

cassandraClusters/dataCenters

Имя Описание Значение
тип Тип ресурса "Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-08-15-preview"
name имя ресурса. string (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа cassandraClusters
properties Свойства управляемого центра обработки данных Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Имя Описание Значение
authenticationMethodLdapProperties Свойства метода проверки подлинности Ldap. Эта функция предоставляется в предварительной версии. AuthenticationMethodLdapProperties
availabilityZone Если в центре обработки данных есть функция зоны доступности, примените ее к масштабируемой набору виртуальных машин, на которых размещаются виртуальные машины центра обработки данных cassandra. bool
backupStorageCustomerKeyUri Указывает URI ключа клиента для шифрования учетной записи хранения резервных копий. строка
base64EncodedCassandraYamlFragment Фрагмент файла конфигурации cassandra.yaml, который будет включен в файл cassandra.yaml для всех узлов в этом центре обработки данных. Фрагмент должен быть в кодировке Base64, и допускается только подмножество ключей. строка
dataCenterLocation Регион, в который должен быть создан центр обработки данных. строка
delegatedSubnetId Идентификатор ресурса подсети, к которому должны быть подключены сетевые интерфейсы узлов в этом центре обработки данных. Подсеть должна находиться в том же регионе, что и dataCenterLocation, и должна иметь возможность маршрутизации в подсеть, указанную в свойстве "delegatedManagementSubnetId" кластера. Этот идентификатор ресурса будет иметь вид "/subscriptions/{subscription id}/resourceGroups/{группа ресурсов}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". строка
diskCapacity Количество дисков, используемых для центров обработки данных. Значение по умолчанию — 4. INT
diskSku Номер SKU диска, используемый для центров обработки данных. Значение по умолчанию — P30. строка
managedDiskCustomerKeyUri URI ключа, используемый для шифрования управляемых дисков. Убедитесь, что назначенному системой удостоверению кластера назначены соответствующие разрешения (разрешения на получение, перенос ключа или распаковка) на ключ. строка
nodeCount Количество узлов, которые должен иметь центр обработки данных. Это нужное число. После настройки масштабирования центра обработки данных может потребоваться некоторое время. Чтобы отслеживать количество узлов и их состояние, используйте метод fetchNodeStatus в кластере. INT
provisioningState Состояние ресурса на момент вызова операции. "Отменено"
"Создание"
"Удаление"
"Сбой"
"Успешно"
"Обновление"
sku Номер SKU виртуальной машины, используемый для центров обработки данных. Значение по умолчанию — Standard_DS14_v2 строка

AuthenticationMethodLdapProperties

Имя Описание Значение
searchBaseDistinguishedName Различающееся имя объекта для запуска рекурсивного поиска пользователей. строка
searchFilterTemplate Шаблон, используемый для поиска. По умолчанию — (cn=%s), где %s будет заменено именем пользователя, используемым для входа. строка
serverCertificates Certificate[]
serverHostname Имя узла сервера LDAP. строка
serverPort Порт сервера LDAP. INT
serviceUserDistinguishedName Различающееся имя учетной записи пользователя, которая может искать сведения о пользователе при проверке подлинности. строка
serviceUserPassword Пароль искать пользователя. строка

Сертификат

Имя Описание Значение
Pem Открытый ключ в формате PEM. строка