Microsoft.DocumentDB cassandraClusters/dataCenters 2023-11-15-preview
- последние
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Определение ресурсов Bicep
Тип ресурса cassandraClusters/dataCenters можно развернуть с помощью операций, целевых:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters/dataCenters, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
authenticationMethodLdapProperties: {
connectionTimeoutInMs: int
searchBaseDistinguishedName: 'string'
searchFilterTemplate: 'string'
serverCertificates: [
{
pem: 'string'
}
]
serverHostname: 'string'
serverPort: int
serviceUserDistinguishedName: 'string'
serviceUserPassword: 'string'
}
availabilityZone: bool
backupStorageCustomerKeyUri: 'string'
base64EncodedCassandraYamlFragment: 'string'
dataCenterLocation: 'string'
deallocated: bool
delegatedSubnetId: 'string'
diskCapacity: int
diskSku: 'string'
managedDiskCustomerKeyUri: 'string'
nodeCount: int
privateEndpointIpAddress: 'string'
provisionError: {
additionalErrorInfo: 'string'
code: 'string'
message: 'string'
target: 'string'
}
provisioningState: 'string'
sku: 'string'
}
}
Значения свойств
AuthenticationMethodLdapProperties
| Имя | Описание | Ценность |
|---|---|---|
| connectionTimeoutInMs | Время ожидания подключения к серверу LDAP в милисекундах. Значение по умолчанию — 5000 мс. | int |
| searchBaseDistinguishedName | Различающееся имя объекта для запуска рекурсивного поиска пользователей. | струна |
| searchFilterTemplate | Шаблон для поиска. По умолчанию используется значение (cn=%s), где %s будет заменено именем пользователя, используемого для входа. | струна |
| serverCertificates | сертификат[] | |
| serverHostname | Имя узла сервера LDAP. | струна |
| serverPort | Порт сервера LDAP. | int |
| serviceUserDistinguishedName | Различающееся имя учетной записи пользователя поиска, которая может искать сведения о пользователе при проверке подлинности. | струна |
| serviceUserPassword | Пароль пользователя поиска. | струна |
CassandraError
| Имя | Описание | Ценность |
|---|---|---|
| additionalErrorInfo | Дополнительные сведения об ошибке. | струна |
| код | Код ошибки, которая произошла. | струна |
| Сообщение | Сообщение об ошибке. | струна |
| цель | Целевой ресурс ошибки. | струна |
Сертификат
| Имя | Описание | Ценность |
|---|---|---|
| pem | Открытый ключ в формате PEM. | струна |
DataCenterResourceProperties
| Имя | Описание | Ценность |
|---|---|---|
| authenticationMethodLdapProperties | Свойства метода проверки подлинности LDAP. Эта функция доступна в предварительной версии. | AuthenticationMethodLdapProperties |
| availabilityZone | Если центр обработки данных поддерживает зону доступности, примените его к масштабируемой группе виртуальных машин, на которых размещены виртуальные машины центра обработки данных cassandra. | bool |
| backupStorageCustomerKeyUri | Указывает универсальный код ресурса (URI) ключа клиента для шифрования учетной записи хранения резервной копии. | струна |
| base64EncodedCassandraYamlFragment | Фрагмент файла конфигурации cassandra.yaml, который будет включен в cassandra.yaml для всех узлов в этом центре обработки данных. Фрагмент должен быть закодирован в Кодировке Base64, и разрешено только подмножество ключей. | струна |
| dataCenterLocation | Регион, в который должен быть создан этот центр обработки данных. | струна |
| Освобождена | Имеет ли центр обработки данных сделку. | bool |
| delegatedSubnetId | Идентификатор ресурса подсети узлов в этом центре обработки данных должен быть подключен к сетевым интерфейсам. Подсеть должна находиться в том же регионе, указанном в dataCenterLocation, и должна иметь возможность перенаправления в подсеть, указанную в свойстве "delegatedManagementSubnetId". Этот идентификатор ресурса будет иметь форму "/subscriptions/<идентификатор подписки>/resourceGroups/<группы ресурсов>/providers/Microsoft.Network/virtualNetworks/<виртуальной сети>/subnets/<подсети>". | струна |
| diskCapacity | Количество дисков, подключенных к каждому узлу. Значение по умолчанию — 4. | int |
| diskSku | Номер SKU диска, используемый для центров обработки данных. Значение по умолчанию — P30. | струна |
| managedDiskCustomerKeyUri | Универсальный код ресурса (URI) ключа для шифрования управляемых дисков. Убедитесь, что удостоверение, назначенное системой кластера, было назначено соответствующие разрешения (ключ get/wrap/unwrap) для ключа. | струна |
| nodeCount | Количество узлов, которые должен иметь центр обработки данных. Это нужное число. После установки может потребоваться некоторое время для масштабирования центра обработки данных для сопоставления. Чтобы отслеживать количество узлов и их состояние, используйте метод fetchNodeStatus в кластере. | int |
| privateEndpointIpAddress | IP-адрес конечной точки VPN для этого центра обработки данных. | струна |
| provisionError | Ошибка, связанная с подготовкой ресурсов. | CassandraError |
| provisioningState | Состояние ресурса во время вызова операции. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
| SKU | Номер SKU виртуальной машины, используемый для центров обработки данных. Значение по умолчанию — Standard_DS14_v2 | струна |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (обязательно) |
| родитель | В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса. Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса. |
Символьное имя ресурса типа: cassandraClusters |
| свойства | Свойства управляемого центра обработки данных Cassandra. | DataCenterResourceProperties |
Определение ресурса шаблона ARM
Тип ресурса cassandraClusters/dataCenters можно развернуть с помощью операций, целевых:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters/dataCenters, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2023-11-15-preview",
"name": "string",
"properties": {
"authenticationMethodLdapProperties": {
"connectionTimeoutInMs": "int",
"searchBaseDistinguishedName": "string",
"searchFilterTemplate": "string",
"serverCertificates": [
{
"pem": "string"
}
],
"serverHostname": "string",
"serverPort": "int",
"serviceUserDistinguishedName": "string",
"serviceUserPassword": "string"
},
"availabilityZone": "bool",
"backupStorageCustomerKeyUri": "string",
"base64EncodedCassandraYamlFragment": "string",
"dataCenterLocation": "string",
"deallocated": "bool",
"delegatedSubnetId": "string",
"diskCapacity": "int",
"diskSku": "string",
"managedDiskCustomerKeyUri": "string",
"nodeCount": "int",
"privateEndpointIpAddress": "string",
"provisionError": {
"additionalErrorInfo": "string",
"code": "string",
"message": "string",
"target": "string"
},
"provisioningState": "string",
"sku": "string"
}
}
Значения свойств
AuthenticationMethodLdapProperties
| Имя | Описание | Ценность |
|---|---|---|
| connectionTimeoutInMs | Время ожидания подключения к серверу LDAP в милисекундах. Значение по умолчанию — 5000 мс. | int |
| searchBaseDistinguishedName | Различающееся имя объекта для запуска рекурсивного поиска пользователей. | струна |
| searchFilterTemplate | Шаблон для поиска. По умолчанию используется значение (cn=%s), где %s будет заменено именем пользователя, используемого для входа. | струна |
| serverCertificates | сертификат[] | |
| serverHostname | Имя узла сервера LDAP. | струна |
| serverPort | Порт сервера LDAP. | int |
| serviceUserDistinguishedName | Различающееся имя учетной записи пользователя поиска, которая может искать сведения о пользователе при проверке подлинности. | струна |
| serviceUserPassword | Пароль пользователя поиска. | струна |
CassandraError
| Имя | Описание | Ценность |
|---|---|---|
| additionalErrorInfo | Дополнительные сведения об ошибке. | струна |
| код | Код ошибки, которая произошла. | струна |
| Сообщение | Сообщение об ошибке. | струна |
| цель | Целевой ресурс ошибки. | струна |
Сертификат
| Имя | Описание | Ценность |
|---|---|---|
| pem | Открытый ключ в формате PEM. | струна |
DataCenterResourceProperties
| Имя | Описание | Ценность |
|---|---|---|
| authenticationMethodLdapProperties | Свойства метода проверки подлинности LDAP. Эта функция доступна в предварительной версии. | AuthenticationMethodLdapProperties |
| availabilityZone | Если центр обработки данных поддерживает зону доступности, примените его к масштабируемой группе виртуальных машин, на которых размещены виртуальные машины центра обработки данных cassandra. | bool |
| backupStorageCustomerKeyUri | Указывает универсальный код ресурса (URI) ключа клиента для шифрования учетной записи хранения резервной копии. | струна |
| base64EncodedCassandraYamlFragment | Фрагмент файла конфигурации cassandra.yaml, который будет включен в cassandra.yaml для всех узлов в этом центре обработки данных. Фрагмент должен быть закодирован в Кодировке Base64, и разрешено только подмножество ключей. | струна |
| dataCenterLocation | Регион, в который должен быть создан этот центр обработки данных. | струна |
| Освобождена | Имеет ли центр обработки данных сделку. | bool |
| delegatedSubnetId | Идентификатор ресурса подсети узлов в этом центре обработки данных должен быть подключен к сетевым интерфейсам. Подсеть должна находиться в том же регионе, указанном в dataCenterLocation, и должна иметь возможность перенаправления в подсеть, указанную в свойстве "delegatedManagementSubnetId". Этот идентификатор ресурса будет иметь форму "/subscriptions/<идентификатор подписки>/resourceGroups/<группы ресурсов>/providers/Microsoft.Network/virtualNetworks/<виртуальной сети>/subnets/<подсети>". | струна |
| diskCapacity | Количество дисков, подключенных к каждому узлу. Значение по умолчанию — 4. | int |
| diskSku | Номер SKU диска, используемый для центров обработки данных. Значение по умолчанию — P30. | струна |
| managedDiskCustomerKeyUri | Универсальный код ресурса (URI) ключа для шифрования управляемых дисков. Убедитесь, что удостоверение, назначенное системой кластера, было назначено соответствующие разрешения (ключ get/wrap/unwrap) для ключа. | струна |
| nodeCount | Количество узлов, которые должен иметь центр обработки данных. Это нужное число. После установки может потребоваться некоторое время для масштабирования центра обработки данных для сопоставления. Чтобы отслеживать количество узлов и их состояние, используйте метод fetchNodeStatus в кластере. | int |
| privateEndpointIpAddress | IP-адрес конечной точки VPN для этого центра обработки данных. | струна |
| provisionError | Ошибка, связанная с подготовкой ресурсов. | CassandraError |
| provisioningState | Состояние ресурса во время вызова операции. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
| SKU | Номер SKU виртуальной машины, используемый для центров обработки данных. Значение по умолчанию — Standard_DS14_v2 | струна |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2023-11-15-preview' |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (обязательно) |
| свойства | Свойства управляемого центра обработки данных Cassandra. | DataCenterResourceProperties |
| тип | Тип ресурса | "Microsoft.DocumentDB/cassandraClusters/dataCenters" |
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса cassandraClusters/dataCenters можно развернуть с помощью операций, целевых:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters/dataCenters, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15-preview"
name = "string"
body = jsonencode({
properties = {
authenticationMethodLdapProperties = {
connectionTimeoutInMs = int
searchBaseDistinguishedName = "string"
searchFilterTemplate = "string"
serverCertificates = [
{
pem = "string"
}
]
serverHostname = "string"
serverPort = int
serviceUserDistinguishedName = "string"
serviceUserPassword = "string"
}
availabilityZone = bool
backupStorageCustomerKeyUri = "string"
base64EncodedCassandraYamlFragment = "string"
dataCenterLocation = "string"
deallocated = bool
delegatedSubnetId = "string"
diskCapacity = int
diskSku = "string"
managedDiskCustomerKeyUri = "string"
nodeCount = int
privateEndpointIpAddress = "string"
provisionError = {
additionalErrorInfo = "string"
code = "string"
message = "string"
target = "string"
}
provisioningState = "string"
sku = "string"
}
})
}
Значения свойств
AuthenticationMethodLdapProperties
| Имя | Описание | Ценность |
|---|---|---|
| connectionTimeoutInMs | Время ожидания подключения к серверу LDAP в милисекундах. Значение по умолчанию — 5000 мс. | int |
| searchBaseDistinguishedName | Различающееся имя объекта для запуска рекурсивного поиска пользователей. | струна |
| searchFilterTemplate | Шаблон для поиска. По умолчанию используется значение (cn=%s), где %s будет заменено именем пользователя, используемого для входа. | струна |
| serverCertificates | сертификат[] | |
| serverHostname | Имя узла сервера LDAP. | струна |
| serverPort | Порт сервера LDAP. | int |
| serviceUserDistinguishedName | Различающееся имя учетной записи пользователя поиска, которая может искать сведения о пользователе при проверке подлинности. | струна |
| serviceUserPassword | Пароль пользователя поиска. | струна |
CassandraError
| Имя | Описание | Ценность |
|---|---|---|
| additionalErrorInfo | Дополнительные сведения об ошибке. | струна |
| код | Код ошибки, которая произошла. | струна |
| Сообщение | Сообщение об ошибке. | струна |
| цель | Целевой ресурс ошибки. | струна |
Сертификат
| Имя | Описание | Ценность |
|---|---|---|
| pem | Открытый ключ в формате PEM. | струна |
DataCenterResourceProperties
| Имя | Описание | Ценность |
|---|---|---|
| authenticationMethodLdapProperties | Свойства метода проверки подлинности LDAP. Эта функция доступна в предварительной версии. | AuthenticationMethodLdapProperties |
| availabilityZone | Если центр обработки данных поддерживает зону доступности, примените его к масштабируемой группе виртуальных машин, на которых размещены виртуальные машины центра обработки данных cassandra. | bool |
| backupStorageCustomerKeyUri | Указывает универсальный код ресурса (URI) ключа клиента для шифрования учетной записи хранения резервной копии. | струна |
| base64EncodedCassandraYamlFragment | Фрагмент файла конфигурации cassandra.yaml, который будет включен в cassandra.yaml для всех узлов в этом центре обработки данных. Фрагмент должен быть закодирован в Кодировке Base64, и разрешено только подмножество ключей. | струна |
| dataCenterLocation | Регион, в который должен быть создан этот центр обработки данных. | струна |
| Освобождена | Имеет ли центр обработки данных сделку. | bool |
| delegatedSubnetId | Идентификатор ресурса подсети узлов в этом центре обработки данных должен быть подключен к сетевым интерфейсам. Подсеть должна находиться в том же регионе, указанном в dataCenterLocation, и должна иметь возможность перенаправления в подсеть, указанную в свойстве "delegatedManagementSubnetId". Этот идентификатор ресурса будет иметь форму "/subscriptions/<идентификатор подписки>/resourceGroups/<группы ресурсов>/providers/Microsoft.Network/virtualNetworks/<виртуальной сети>/subnets/<подсети>". | струна |
| diskCapacity | Количество дисков, подключенных к каждому узлу. Значение по умолчанию — 4. | int |
| diskSku | Номер SKU диска, используемый для центров обработки данных. Значение по умолчанию — P30. | струна |
| managedDiskCustomerKeyUri | Универсальный код ресурса (URI) ключа для шифрования управляемых дисков. Убедитесь, что удостоверение, назначенное системой кластера, было назначено соответствующие разрешения (ключ get/wrap/unwrap) для ключа. | струна |
| nodeCount | Количество узлов, которые должен иметь центр обработки данных. Это нужное число. После установки может потребоваться некоторое время для масштабирования центра обработки данных для сопоставления. Чтобы отслеживать количество узлов и их состояние, используйте метод fetchNodeStatus в кластере. | int |
| privateEndpointIpAddress | IP-адрес конечной точки VPN для этого центра обработки данных. | струна |
| provisionError | Ошибка, связанная с подготовкой ресурсов. | CassandraError |
| provisioningState | Состояние ресурса во время вызова операции. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
| SKU | Номер SKU виртуальной машины, используемый для центров обработки данных. Значение по умолчанию — Standard_DS14_v2 | струна |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Имя | Описание | Ценность |
|---|---|---|
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (обязательно) |
| parent_id | Идентификатор ресурса, который является родительским для этого ресурса. | Идентификатор ресурса типа: cassandraClusters |
| свойства | Свойства управляемого центра обработки данных Cassandra. | DataCenterResourceProperties |
| тип | Тип ресурса | "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15-preview" |