Microsoft.DocumentDB cassandraClusters 2023-03-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 можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters, добавьте следующий Bicep в шаблон.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-03-15-preview' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
authenticationMethod: 'string'
cassandraAuditLoggingEnabled: bool
cassandraVersion: 'string'
clientCertificates: [
{
pem: 'string'
}
]
clusterNameOverride: 'string'
deallocated: bool
delegatedManagementSubnetId: 'string'
externalGossipCertificates: [
{
pem: 'string'
}
]
externalSeedNodes: [
{
ipAddress: 'string'
}
]
hoursBetweenBackups: int
initialCassandraAdminPassword: 'string'
prometheusEndpoint: {
ipAddress: 'string'
}
provisionError: {
additionalErrorInfo: 'string'
code: 'string'
message: 'string'
target: 'string'
}
provisioningState: 'string'
repairEnabled: bool
restoreFromBackupId: 'string'
}
tags: {
{customized property}: 'string'
}
}
Значения свойств
CassandraError
| Имя | Описание | Ценность |
|---|---|---|
| additionalErrorInfo | Дополнительные сведения об ошибке. | струна |
| код | Код ошибки, которая произошла. | струна |
| Сообщение | Сообщение об ошибке. | струна |
| цель | Целевой ресурс ошибки. | струна |
Сертификат
| Имя | Описание | Ценность |
|---|---|---|
| pem | Открытый ключ в формате PEM. | струна |
ClusterResourceProperties
| Имя | Описание | Ценность |
|---|---|---|
| authenticationMethod | Какой метод проверки подлинности Cassandra должен использовать для проверки подлинности клиентов. "Нет" отключает проверку подлинности, поэтому не следует использовать только в чрезвычайных ситуациях. Cassandra — это проверка подлинности на основе пароля по умолчанию. Значение по умолчанию — Cassandra. | "Cassandra" "Ldap" "Нет" |
| cassandraAuditLoggingEnabled | Включена ли ведение журнала аудита Cassandra | bool |
| cassandraVersion | Какая версия Cassandra должна выполняться в этом кластере (например, 3.11). При обновлении кластер может занять некоторое время для миграции в новую версию. | струна |
| clientCertificates | Список сертификатов TLS, используемых для авторизации клиентов, подключающихся к кластеру. Все подключения шифруются по протоколу TLS независимо от того, задано ли значение clientCertificates, но если задано значение clientCertificates, управляемый кластер Cassandra отклонит все подключения, не имеющие сертификат клиента TLS, который можно проверить с помощью одного или нескольких общедоступных сертификатов в этом свойстве. | сертификат[] |
| clusterNameOverride | Если необходимо задать свойство clusterName в cassandra.yaml что-то помимо имени ресурса кластера, задайте для этого свойства значение. | струна |
| Освобождена | Имеет ли кластер и связанные центры обработки данных. | bool |
| delegatedManagementSubnetId | Идентификатор ресурса подсети, к которому должна быть подключена служба управления этого кластера. Подсеть должна быть маршрутизируемой для всех подсетей, которые будут делегированы центрам обработки данных. Идентификатор ресурса должен иметь форму "/subscriptions/<идентификатор подписки>/resourceGroups/<группы ресурсов>/providers/Microsoft.Network/virtualNetworks/<виртуальной сети>/subnets/<подсети>' | струна |
| externalGossipCertificates | Список сертификатов TLS, используемых для авторизации сплетни из неуправляемых центров обработки данных. Сертификаты TLS всех узлов в неуправляемых центрах обработки данных должны быть проверены с помощью одного из сертификатов, предоставленных в этом свойстве. | сертификат[] |
| externalSeedNodes | Список IP-адресов начальных узлов в неуправляемых центрах обработки данных. Они будут добавлены в списки начальных узлов всех управляемых узлов. | SeedNode[] |
| hoursBetweenBackups | (не рекомендуется) Количество часов ожидания между резервной копией кластера. | int |
| initialCassandraAdminPassword | Исходный пароль для клиентов, подключающихся от имени администратора к кластеру. Необходимо изменить после создания кластера. Возвращает значение NULL в GET. Это поле применяется только в том случае, если поле authenticationMethod равно Cassandra. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| prometheusEndpoint | Имя узла или IP-адрес, где можно получить конечную точку Prometheus, содержащую данные об управляемых узлах Cassandra. | SeedNode |
| provisionError | Ошибка, связанная с подготовкой ресурсов. | CassandraError |
| provisioningState | Состояние ресурса во время вызова операции. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
| repairEnabled | Следует ли выполнять автоматическое восстановление в этом кластере? Если опущено, это верно и должно оставаться верным, если вы не используете гибридный кластер, где вы уже выполняете собственное восстановление. | bool |
| restoreFromBackupId | Чтобы создать пустой кластер, опустите это поле или задайте для него значение NULL. Чтобы восстановить резервную копию в новом кластере, задайте для этого поля идентификатор ресурса резервной копии. | струна |
ManagedCassandraManagedServiceIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса. | "Нет" SystemAssigned |
Microsoft.DocumentDB/cassandraClusters
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Удостоверение ресурса. | ManagedCassandraManagedServiceIdentity |
| местоположение | Расположение группы ресурсов, к которой принадлежит ресурс. | струна |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (обязательно) |
| свойства | Свойства управляемого кластера Cassandra. | clusterResourceProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
SeedNode
| Имя | Описание | Ценность |
|---|---|---|
| ipAddress | IP-адрес этого начального узла. | струна |
Теги
| Имя | Описание | Ценность |
|---|
Определение ресурса шаблона ARM
Тип ресурса cassandraClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- группы ресурсов . См. команды развертывания группы ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters, добавьте следующий код JSON в шаблон.
{
"type": "Microsoft.DocumentDB/cassandraClusters",
"apiVersion": "2023-03-15-preview",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"authenticationMethod": "string",
"cassandraAuditLoggingEnabled": "bool",
"cassandraVersion": "string",
"clientCertificates": [
{
"pem": "string"
}
],
"clusterNameOverride": "string",
"deallocated": "bool",
"delegatedManagementSubnetId": "string",
"externalGossipCertificates": [
{
"pem": "string"
}
],
"externalSeedNodes": [
{
"ipAddress": "string"
}
],
"hoursBetweenBackups": "int",
"initialCassandraAdminPassword": "string",
"prometheusEndpoint": {
"ipAddress": "string"
},
"provisionError": {
"additionalErrorInfo": "string",
"code": "string",
"message": "string",
"target": "string"
},
"provisioningState": "string",
"repairEnabled": "bool",
"restoreFromBackupId": "string"
},
"tags": {
"{customized property}": "string"
}
}
Значения свойств
CassandraError
| Имя | Описание | Ценность |
|---|---|---|
| additionalErrorInfo | Дополнительные сведения об ошибке. | струна |
| код | Код ошибки, которая произошла. | струна |
| Сообщение | Сообщение об ошибке. | струна |
| цель | Целевой ресурс ошибки. | струна |
Сертификат
| Имя | Описание | Ценность |
|---|---|---|
| pem | Открытый ключ в формате PEM. | струна |
ClusterResourceProperties
| Имя | Описание | Ценность |
|---|---|---|
| authenticationMethod | Какой метод проверки подлинности Cassandra должен использовать для проверки подлинности клиентов. "Нет" отключает проверку подлинности, поэтому не следует использовать только в чрезвычайных ситуациях. Cassandra — это проверка подлинности на основе пароля по умолчанию. Значение по умолчанию — Cassandra. | "Cassandra" "Ldap" "Нет" |
| cassandraAuditLoggingEnabled | Включена ли ведение журнала аудита Cassandra | bool |
| cassandraVersion | Какая версия Cassandra должна выполняться в этом кластере (например, 3.11). При обновлении кластер может занять некоторое время для миграции в новую версию. | струна |
| clientCertificates | Список сертификатов TLS, используемых для авторизации клиентов, подключающихся к кластеру. Все подключения шифруются по протоколу TLS независимо от того, задано ли значение clientCertificates, но если задано значение clientCertificates, управляемый кластер Cassandra отклонит все подключения, не имеющие сертификат клиента TLS, который можно проверить с помощью одного или нескольких общедоступных сертификатов в этом свойстве. | сертификат[] |
| clusterNameOverride | Если необходимо задать свойство clusterName в cassandra.yaml что-то помимо имени ресурса кластера, задайте для этого свойства значение. | струна |
| Освобождена | Имеет ли кластер и связанные центры обработки данных. | bool |
| delegatedManagementSubnetId | Идентификатор ресурса подсети, к которому должна быть подключена служба управления этого кластера. Подсеть должна быть маршрутизируемой для всех подсетей, которые будут делегированы центрам обработки данных. Идентификатор ресурса должен иметь форму "/subscriptions/<идентификатор подписки>/resourceGroups/<группы ресурсов>/providers/Microsoft.Network/virtualNetworks/<виртуальной сети>/subnets/<подсети>' | струна |
| externalGossipCertificates | Список сертификатов TLS, используемых для авторизации сплетни из неуправляемых центров обработки данных. Сертификаты TLS всех узлов в неуправляемых центрах обработки данных должны быть проверены с помощью одного из сертификатов, предоставленных в этом свойстве. | сертификат[] |
| externalSeedNodes | Список IP-адресов начальных узлов в неуправляемых центрах обработки данных. Они будут добавлены в списки начальных узлов всех управляемых узлов. | SeedNode[] |
| hoursBetweenBackups | (не рекомендуется) Количество часов ожидания между резервной копией кластера. | int |
| initialCassandraAdminPassword | Исходный пароль для клиентов, подключающихся от имени администратора к кластеру. Необходимо изменить после создания кластера. Возвращает значение NULL в GET. Это поле применяется только в том случае, если поле authenticationMethod равно Cassandra. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| prometheusEndpoint | Имя узла или IP-адрес, где можно получить конечную точку Prometheus, содержащую данные об управляемых узлах Cassandra. | SeedNode |
| provisionError | Ошибка, связанная с подготовкой ресурсов. | CassandraError |
| provisioningState | Состояние ресурса во время вызова операции. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
| repairEnabled | Следует ли выполнять автоматическое восстановление в этом кластере? Если опущено, это верно и должно оставаться верным, если вы не используете гибридный кластер, где вы уже выполняете собственное восстановление. | bool |
| restoreFromBackupId | Чтобы создать пустой кластер, опустите это поле или задайте для него значение NULL. Чтобы восстановить резервную копию в новом кластере, задайте для этого поля идентификатор ресурса резервной копии. | струна |
ManagedCassandraManagedServiceIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса. | "Нет" SystemAssigned |
Microsoft.DocumentDB/cassandraClusters
| Имя | Описание | Ценность |
|---|---|---|
| apiVersion | Версия API | '2023-03-15-preview' |
| тождество | Удостоверение ресурса. | ManagedCassandraManagedServiceIdentity |
| местоположение | Расположение группы ресурсов, к которой принадлежит ресурс. | струна |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (обязательно) |
| свойства | Свойства управляемого кластера Cassandra. | clusterResourceProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. См. теги в шаблонах |
| тип | Тип ресурса | "Microsoft.DocumentDB/cassandraClusters" |
SeedNode
| Имя | Описание | Ценность |
|---|---|---|
| ipAddress | IP-адрес этого начального узла. | струна |
Теги
| Имя | Описание | Ценность |
|---|
Определение ресурса Terraform (поставщик AzAPI)
Тип ресурса cassandraClusters можно развернуть с помощью операций, предназначенных для следующих операций:
- групп ресурсов
Список измененных свойств в каждой версии API см. в журнала изменений.
Формат ресурса
Чтобы создать ресурс Microsoft.DocumentDB/cassandraClusters, добавьте следующий объект Terraform в шаблон.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters@2023-03-15-preview"
name = "string"
identity = {
type = "string"
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authenticationMethod = "string"
cassandraAuditLoggingEnabled = bool
cassandraVersion = "string"
clientCertificates = [
{
pem = "string"
}
]
clusterNameOverride = "string"
deallocated = bool
delegatedManagementSubnetId = "string"
externalGossipCertificates = [
{
pem = "string"
}
]
externalSeedNodes = [
{
ipAddress = "string"
}
]
hoursBetweenBackups = int
initialCassandraAdminPassword = "string"
prometheusEndpoint = {
ipAddress = "string"
}
provisionError = {
additionalErrorInfo = "string"
code = "string"
message = "string"
target = "string"
}
provisioningState = "string"
repairEnabled = bool
restoreFromBackupId = "string"
}
})
}
Значения свойств
CassandraError
| Имя | Описание | Ценность |
|---|---|---|
| additionalErrorInfo | Дополнительные сведения об ошибке. | струна |
| код | Код ошибки, которая произошла. | струна |
| Сообщение | Сообщение об ошибке. | струна |
| цель | Целевой ресурс ошибки. | струна |
Сертификат
| Имя | Описание | Ценность |
|---|---|---|
| pem | Открытый ключ в формате PEM. | струна |
ClusterResourceProperties
| Имя | Описание | Ценность |
|---|---|---|
| authenticationMethod | Какой метод проверки подлинности Cassandra должен использовать для проверки подлинности клиентов. "Нет" отключает проверку подлинности, поэтому не следует использовать только в чрезвычайных ситуациях. Cassandra — это проверка подлинности на основе пароля по умолчанию. Значение по умолчанию — Cassandra. | "Cassandra" "Ldap" "Нет" |
| cassandraAuditLoggingEnabled | Включена ли ведение журнала аудита Cassandra | bool |
| cassandraVersion | Какая версия Cassandra должна выполняться в этом кластере (например, 3.11). При обновлении кластер может занять некоторое время для миграции в новую версию. | струна |
| clientCertificates | Список сертификатов TLS, используемых для авторизации клиентов, подключающихся к кластеру. Все подключения шифруются по протоколу TLS независимо от того, задано ли значение clientCertificates, но если задано значение clientCertificates, управляемый кластер Cassandra отклонит все подключения, не имеющие сертификат клиента TLS, который можно проверить с помощью одного или нескольких общедоступных сертификатов в этом свойстве. | сертификат[] |
| clusterNameOverride | Если необходимо задать свойство clusterName в cassandra.yaml что-то помимо имени ресурса кластера, задайте для этого свойства значение. | струна |
| Освобождена | Имеет ли кластер и связанные центры обработки данных. | bool |
| delegatedManagementSubnetId | Идентификатор ресурса подсети, к которому должна быть подключена служба управления этого кластера. Подсеть должна быть маршрутизируемой для всех подсетей, которые будут делегированы центрам обработки данных. Идентификатор ресурса должен иметь форму "/subscriptions/<идентификатор подписки>/resourceGroups/<группы ресурсов>/providers/Microsoft.Network/virtualNetworks/<виртуальной сети>/subnets/<подсети>' | струна |
| externalGossipCertificates | Список сертификатов TLS, используемых для авторизации сплетни из неуправляемых центров обработки данных. Сертификаты TLS всех узлов в неуправляемых центрах обработки данных должны быть проверены с помощью одного из сертификатов, предоставленных в этом свойстве. | сертификат[] |
| externalSeedNodes | Список IP-адресов начальных узлов в неуправляемых центрах обработки данных. Они будут добавлены в списки начальных узлов всех управляемых узлов. | SeedNode[] |
| hoursBetweenBackups | (не рекомендуется) Количество часов ожидания между резервной копией кластера. | int |
| initialCassandraAdminPassword | Исходный пароль для клиентов, подключающихся от имени администратора к кластеру. Необходимо изменить после создания кластера. Возвращает значение NULL в GET. Это поле применяется только в том случае, если поле authenticationMethod равно Cassandra. | струна Ограничения целостности: Конфиденциальное значение. Передайте в качестве безопасного параметра. |
| prometheusEndpoint | Имя узла или IP-адрес, где можно получить конечную точку Prometheus, содержащую данные об управляемых узлах Cassandra. | SeedNode |
| provisionError | Ошибка, связанная с подготовкой ресурсов. | CassandraError |
| provisioningState | Состояние ресурса во время вызова операции. | "Отменено" Создание Удаление "Не удалось" "Успешно" "Обновление" |
| repairEnabled | Следует ли выполнять автоматическое восстановление в этом кластере? Если опущено, это верно и должно оставаться верным, если вы не используете гибридный кластер, где вы уже выполняете собственное восстановление. | bool |
| restoreFromBackupId | Чтобы создать пустой кластер, опустите это поле или задайте для него значение NULL. Чтобы восстановить резервную копию в новом кластере, задайте для этого поля идентификатор ресурса резервной копии. | струна |
ManagedCassandraManagedServiceIdentity
| Имя | Описание | Ценность |
|---|---|---|
| тип | Тип ресурса. | "Нет" SystemAssigned |
Microsoft.DocumentDB/cassandraClusters
| Имя | Описание | Ценность |
|---|---|---|
| тождество | Удостоверение ресурса. | ManagedCassandraManagedServiceIdentity |
| местоположение | Расположение группы ресурсов, к которой принадлежит ресурс. | струна |
| имя | Имя ресурса | струна Ограничения целостности: Минимальная длина = 1 Максимальная длина = 1 Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (обязательно) |
| свойства | Свойства управляемого кластера Cassandra. | clusterResourceProperties |
| Теги | Теги ресурсов | Словарь имен и значений тегов. |
| тип | Тип ресурса | "Microsoft.DocumentDB/cassandraClusters@2023-03-15-preview" |
SeedNode
| Имя | Описание | Ценность |
|---|---|---|
| ipAddress | IP-адрес этого начального узла. | струна |
Теги
| Имя | Описание | Ценность |
|---|