Microsoft.DocumentDB cassandraClusters 2021-11-15-preview

• Актуальная
• 2024-05-15
• 15.05.2024
• 2024-02-15-preview
• 2023-11-15
• 15.11.2023
• 2023-09-15
• 15.09.2023
• 2023-04-15
• 2023-03-15
• 2023-03-15-preview
• 2023-03-01-preview
• 2022-11-15
• 15.11.2022
• 2022-08-15
• 2022-08-15-preview
• 2022-05-15
• 2022-05-15-preview
• 15.02.2022
• 15.11.2021
• 2021-10-15
• 15.10.2021
• 2021-07-01-preview
• 2021-04-01-preview
• 2021-03-01-preview

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

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

• Группы ресурсов — см. команды развертывания групп ресурсов.

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

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

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2021-11-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: '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'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
  }
}

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

cassandraClusters

Имя	Описание	Значение
name	имя ресурса.	string (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, по умолчанию для типа шаблона задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают Table, Graph, DocumentDB и MongoDB.	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Удостоверение ресурса.	ManagedCassandraManagedServiceIdentity
properties	Свойства управляемого кластера Cassandra.	Свойства ClusterResource

ManagedCassandraManagedServiceIdentity

Имя	Описание	Значение
тип	Тип ресурса.	"Нет" SystemAssigned

Свойства ClusterResource

Имя	Описание	Значение
authenticationMethod	Какой метод проверки подлинности Следует использовать Cassandra для проверки подлинности клиентов. "Нет" отключает проверку подлинности, поэтому ее следует использовать только в чрезвычайных ситуациях. Cassandra — это проверка подлинности по умолчанию на основе пароля. Значение по умолчанию — Cassandra. "Ldap" находится в предварительной версии.	"Кассандра" "Ldap" "Нет"
cassandraAuditLoggingEnabled	Включено ли ведение журнала аудита Cassandra	bool
cassandraVersion	Какая версия Cassandra должна совпадать с работающим кластером (например, 3.11). После обновления для перехода на новую версию кластера может потребоваться некоторое время.	строка
clientCertificates	Список сертификатов TLS, используемых для авторизации клиентов, подключающихся к кластеру. Все подключения шифруются по протоколу TLS независимо от того, задано ли значение clientCertificates, но если задан параметр clientCertificates, управляемый кластер Cassandra будет отклонять все подключения, не имеющие сертификата клиента TLS, который можно проверить из одного или нескольких открытых сертификатов в этом свойстве.	Certificate[]
clusterNameOverride	Если необходимо задать для свойства clusterName в cassandra.yaml значение, отличное от имени ресурса кластера, присвойте этому свойству значение.	строка
Освобождена	Был ли освобожден кластер и связанные центры обработки данных.	bool
delegatedManagementSubnetId	Идентификатор ресурса подсети, к которому должен быть подключен сетевой интерфейс службы управления кластера. Подсеть должна быть маршрутизируемой для всех подсетей, которые будут делегированы центрам обработки данных. Идентификатор ресурса должен иметь вид "/subscriptions/{идентификатор подписки}/resourceGroups/{группа ресурсов}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}".	строка
externalGossipCertificates	Список сертификатов TLS, используемых для авторизации сплетен из неуправляемых центров обработки данных. Tls-сертификаты всех узлов в неуправляемых центрах обработки данных должны быть проверяемыми с помощью одного из сертификатов, указанных в этом свойстве.	Certificate[]
externalSeedNodes	Список IP-адресов начальных узлов в неуправляемых центрах обработки данных. Они будут добавлены в списки начальных узлов всех управляемых узлов.	SeedNode[]
hoursBetweenBackups	Количество часов ожидания между резервной копией кластера.	INT
initialCassandraAdminPassword	Начальный пароль для клиентов, подключающихся в качестве администратора к кластеру. Должен быть изменен после создания кластера. Возвращает значение NULL для GET. Это поле применяется только в том случае, если поле authenticationMethod имеет значение Cassandra.	строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра.
prometheusEndpoint	Имя узла или IP-адрес, по которому можно получить доступ к конечной точке Prometheus, содержащей данные об управляемых узлах Cassandra.	SeedNode
provisioningState	Состояние ресурса на момент вызова операции.	"Отменено" "Создание" Удаление "Сбой" "Успешно" "Обновление"
repairEnabled	Должно ли выполняться автоматическое восстановление в этом кластере? Если этот параметр опущен, этот параметр имеет значение true и должен оставаться верным, если вы не используете гибридный кластер, в котором уже выполняется собственное восстановление.	bool
restoreFromBackupId	Чтобы создать пустой кластер, опустите это поле или присвойте ему значение NULL. Чтобы восстановить резервную копию в новом кластере, задайте для этого поля идентификатор ресурса резервной копии.	строка

Сертификат

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

SeedNode

Имя	Описание	Значение
ipAddress	IP-адрес начального узла.	строка

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

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

• Группы ресурсов — см. команды развертывания группы ресурсов.

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

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

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2021-11-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "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"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string"
  }
}

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

cassandraClusters

Имя	Описание	Значение
тип	Тип ресурса	Microsoft.DocumentDB/cassandraClusters
версия_API	Версия API ресурсов	'15.11.2021-preview'
name	имя ресурса.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов. См . раздел Теги в шаблонах
удостоверение	Удостоверение ресурса.	ManagedCassandraManagedServiceIdentity
properties	Свойства управляемого кластера Cassandra.	ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Имя	Описание	Значение
тип	Тип ресурса.	"Нет" SystemAssigned

Свойства ClusterResource

Имя	Описание	Значение
authenticationMethod	Какой метод проверки подлинности Следует использовать Cassandra для проверки подлинности клиентов. "Нет" отключает проверку подлинности, поэтому ее следует использовать только в чрезвычайных ситуациях. Cassandra — это проверка подлинности по умолчанию на основе пароля. Значение по умолчанию — Cassandra. "Ldap" находится в предварительной версии.	"Кассандра" "Ldap" "Нет"
cassandraAuditLoggingEnabled	Включено ли ведение журнала аудита Cassandra	bool
cassandraVersion	Какая версия Cassandra должна совпадать с работающим кластером (например, 3.11). После обновления для перехода на новую версию кластера может потребоваться некоторое время.	строка
clientCertificates	Список сертификатов TLS, используемых для авторизации клиентов, подключающихся к кластеру. Все подключения шифруются по протоколу TLS независимо от того, задано ли значение clientCertificates, но если задан параметр clientCertificates, управляемый кластер Cassandra будет отклонять все подключения, не имеющие сертификата клиента TLS, который можно проверить из одного или нескольких открытых сертификатов в этом свойстве.	Certificate[]
clusterNameOverride	Если необходимо задать для свойства clusterName в cassandra.yaml значение, отличное от имени ресурса кластера, присвойте этому свойству значение.	строка
Освобождена	Был ли освобожден кластер и связанные центры обработки данных.	bool
delegatedManagementSubnetId	Идентификатор ресурса подсети, к которому должен быть подключен сетевой интерфейс службы управления кластера. Подсеть должна быть маршрутизируемой для всех подсетей, которые будут делегированы центрам обработки данных. Идентификатор ресурса должен иметь форму "/subscriptions/{subscription id}/resourceGroups/{группа ресурсов}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}".	строка
externalGossipCertificates	Список сертификатов TLS, используемых для авторизации сплетен из неуправляемых центров обработки данных. Tls-сертификаты всех узлов в неуправляемых центрах обработки данных должны проверяться с помощью одного из сертификатов, указанных в этом свойстве.	Certificate[]
externalSeedNodes	Список IP-адресов начальных узлов в неуправляемых центрах обработки данных. Они будут добавлены в списки начальных узлов всех управляемых узлов.	SeedNode[]
hoursBetweenBackups	Количество часов ожидания между резервной копией кластера.	INT
initialCassandraAdminPassword	Начальный пароль для клиентов, подключающихся от имени администратора к кластеру. Необходимо изменить после создания кластера. Возвращает значение NULL для GET. Это поле применяется только в том случае, если поле authenticationMethod имеет значение Cassandra.	строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра.
prometheusEndpoint	Имя узла или IP-адрес, по которому можно получить конечную точку Prometheus, содержащую данные об управляемых узлах Cassandra.	SeedNode
provisioningState	Состояние ресурса на момент вызова операции.	"Отменено" "Создание" "Удаление" "Сбой" "Успешно" "Обновление"
repairEnabled	Должно ли выполняться автоматическое восстановление в этом кластере? Если этот параметр опущен, это значение true и должно оставаться верным, если вы не используете гибридный кластер, в котором уже выполняется собственное восстановление.	bool
restoreFromBackupId	Чтобы создать пустой кластер, опустите это поле или присвойте ему значение NULL. Чтобы восстановить резервную копию в новом кластере, задайте для этого поля идентификатор ресурса резервной копии.	строка

Сертификат

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

SeedNode

Имя	Описание	Значение
ipAddress	IP-адрес этого начального узла.	строка

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

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

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

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

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2021-11-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  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"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

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

cassandraClusters

Имя	Описание	Значение
тип	Тип ресурса	"Microsoft.DocumentDB/cassandraClusters@2021-11-15-preview"
name	имя ресурса.	строка (обязательно)
location	Расположение группы ресурсов, к которой принадлежит ресурс.	строка
parent_id	Чтобы выполнить развертывание в группе ресурсов, используйте идентификатор этой группы ресурсов.	строка (обязательно)
tags	Теги — это список пар "ключ-значение", описывающих ресурс. Эти теги можно использовать при просмотре и группировании ресурсов (между группами). Для ресурса можно указать не более 15 тегов. В каждом теге длина ключа нее должна превышать 128 символов, а длина значения — 256 символов. Например, для типа шаблона по умолчанию задано значение defaultExperience: Cassandra. Текущие значения defaultExperience также включают "Table", "Graph", "DocumentDB" и "MongoDB".	Словарь имен и значений тегов.
удостоверение	Удостоверение ресурса.	ManagedCassandraManagedServiceIdentity
properties	Свойства управляемого кластера Cassandra.	ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Имя	Описание	Значение
тип	Тип ресурса.	"SystemAssigned"

ClusterResourceProperties

Имя	Описание	Значение
authenticationMethod	Какой метод проверки подлинности Cassandra должен использовать для проверки подлинности клиентов. "Нет" отключает проверку подлинности, поэтому не следует использовать только в чрезвычайных ситуациях. Cassandra — это проверка подлинности на основе пароля по умолчанию. Значение по умолчанию — Cassandra. "Ldap" находится в предварительной версии.	"Кассандра" "Ldap" "None"
cassandraAuditLoggingEnabled	Включено ли ведение журнала аудита Cassandra	bool
cassandraVersion	Какая версия Cassandra должна сойтись с работающим кластером (например, 3.11). При обновлении для перехода на новую версию кластера может потребоваться некоторое время.	строка
clientCertificates	Список сертификатов TLS, используемых для авторизации клиентов, подключающихся к кластеру. Все подключения шифруются по протоколу TLS независимо от того, задан ли clientCertificates, но если задан параметр clientCertificates, управляемый кластер Cassandra будет отклонять все подключения, не имеющие сертификата клиента TLS, который можно проверить из одного или нескольких открытых сертификатов в этом свойстве.	Certificate[]
clusterNameOverride	Если вам нужно задать для свойства clusterName в cassandra.yaml значение, отличное от имени ресурса кластера, задайте значение, которое будет использоваться для этого свойства.	строка
Освобождена	Был ли освобожден кластер и связанные центры обработки данных.	bool
delegatedManagementSubnetId	Идентификатор ресурса подсети, к которому должен быть подключен сетевой интерфейс службы управления кластера. Подсеть должна быть маршрутизируемой для всех подсетей, которые будут делегированы центрам обработки данных. Идентификатор ресурса должен иметь вид "/subscriptions/{идентификатор подписки}/resourceGroups/{группа ресурсов}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}".	строка
externalGossipCertificates	Список сертификатов TLS, используемых для авторизации сплетен из неуправляемых центров обработки данных. Tls-сертификаты всех узлов в неуправляемых центрах обработки данных должны быть проверяемыми с помощью одного из сертификатов, указанных в этом свойстве.	Certificate[]
externalSeedNodes	Список IP-адресов начальных узлов в неуправляемых центрах обработки данных. Они будут добавлены в списки начальных узлов всех управляемых узлов.	SeedNode[]
hoursBetweenBackups	Количество часов ожидания между резервной копией кластера.	INT
initialCassandraAdminPassword	Начальный пароль для клиентов, подключающихся в качестве администратора к кластеру. Должен быть изменен после создания кластера. Возвращает значение NULL для GET. Это поле применяется только в том случае, если поле authenticationMethod имеет значение Cassandra.	строка Ограничения: Конфиденциальное значение. Передайте в качестве безопасного параметра.
prometheusEndpoint	Имя узла или IP-адрес, по которому можно получить доступ к конечной точке Prometheus, содержащей данные об управляемых узлах Cassandra.	SeedNode
provisioningState	Состояние ресурса на момент вызова операции.	"Отменено" "Создание" "Удаление" "Сбой" "Успешно" "Обновление"
repairEnabled	Должно ли выполняться автоматическое восстановление в этом кластере? Если этот параметр опущен, этот параметр имеет значение true и должен оставаться верным, если вы не используете гибридный кластер, в котором уже выполняется собственное восстановление.	bool
restoreFromBackupId	Чтобы создать пустой кластер, опустите это поле или присвойте ему значение NULL. Чтобы восстановить резервную копию в новом кластере, задайте для этого поля идентификатор ресурса резервной копии.	строка

Сертификат

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

SeedNode

Имя	Описание	Значение
ipAddress	IP-адрес начального узла.	строка