CassandraClusters 2024-08-15 de Microsoft.DocumentDB
- más reciente
- 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
Definición de recursos de Bicep
El tipo de recurso cassandraClusters se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.DocumentDB/cassandraClusters, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-08-15' = {
identity: {
type: 'string'
}
location: 'string'
name: 'string'
properties: {
authenticationMethod: 'string'
azureConnectionMethod: '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'
}
}
Valores de propiedad
CassandraError
| Nombre | Descripción | Valor |
|---|---|---|
| additionalErrorInfo | Información adicional sobre el error. | cuerda |
| código | Código de error que se produjo. | cuerda |
| Mensaje | Mensaje del error. | cuerda |
| blanco | Recurso de destino del error. | cuerda |
Certificado
| Nombre | Descripción | Valor |
|---|---|---|
| Pem | Clave pública con formato PEM. | cuerda |
ClusterResourceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| authenticationMethod | Qué método de autenticación Debe usar Cassandra para autenticar a los clientes. 'None' desactiva la autenticación, por lo que no debe usarse excepto en emergencias. "Cassandra" es la autenticación predeterminada basada en contraseña. El valor predeterminado es "Cassandra". | 'Cassandra' 'Ldap' 'Ninguno' |
| azureConnectionMethod | Conexión a los servicios de Azure necesarios para ejecutar el clúster | 'Ninguno' "VPN" |
| cassandraAuditLoggingEnabled | Si el registro de auditoría de Cassandra está habilitado | Bool |
| cassandraVersion | Qué versión de Cassandra debe converger para ejecutar este clúster (por ejemplo, 3.11). Cuando se actualiza, el clúster puede tardar algún tiempo en migrar a la nueva versión. | cuerda |
| clientCertificates | Lista de certificados TLS usados para autorizar a los clientes que se conectan al clúster. Todas las conexiones se cifran con TLS tanto si se establece clientCertificates como si no, pero si se establece clientCertificates, el clúster de Cassandra administrado rechazará todas las conexiones que no contengan un certificado de cliente TLS que se pueda validar desde uno o varios de los certificados públicos de esta propiedad. | certificado[] |
| clusterNameOverride | Si necesita establecer la propiedad clusterName en cassandra.yaml en algo aparte del nombre de recurso del clúster, establezca el valor que se usará en esta propiedad. | cuerda |
| desasignado | Si el clúster y los centros de datos asociados se han desasignado. | Bool |
| delegatedManagementSubnetId | Identificador de recurso de una subred a la que el servicio de administración de este clúster debe tener asociada su interfaz de red. La subred debe ser enrutable a todas las subredes que se delegarán en los centros de datos. El identificador de recurso debe tener el formato "/subscriptions/<id. de suscripción>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<red virtual>/subnets/<subred>" | cuerda |
| externalGossipCertificates | Lista de certificados TLS usados para autorizar el ipse desde centros de datos no administrados. Los certificados TLS de todos los nodos de centros de datos no administrados deben ser verificables mediante uno de los certificados proporcionados en esta propiedad. | certificado[] |
| externalSeedNodes | Lista de direcciones IP de nodos de inicialización en centros de datos no administrados. Se agregarán a las listas de nodos de inicialización de todos los nodos administrados. | SeedNode [] |
| hoursBetweenBackups | (en desuso) Número de horas de espera entre realizar una copia de seguridad del clúster. | Int |
| initialCassandraAdminPassword | Contraseña inicial para los clientes que se conectan como administrador al clúster. Debe cambiarse después de la creación del clúster. Devuelve null en GET. Este campo solo se aplica cuando el campo authenticationMethod es "Cassandra". | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| prometheusEndpoint | Nombre de host o dirección IP donde se puede acceder al punto de conexión de Prometheus que contiene datos sobre los nodos de Cassandra administrados. | seedNode de |
| provisionError | Error relacionado con el aprovisionamiento de recursos. | CassandraError |
| provisioningState | Estado del recurso en el momento en que se llamó a la operación. | 'Cancelado' 'Crear' "Eliminar" 'Error' "Correcto" "Actualización" |
| repairEnabled | ¿Se deben ejecutar reparaciones automáticas en este clúster? Si se omite, esto es true y debe permanecer true a menos que ejecute un clúster híbrido en el que ya esté realizando sus propias reparaciones. | Bool |
| restoreFromBackupId | Para crear un clúster vacío, omita este campo o establézcalo en NULL. Para restaurar una copia de seguridad en un nuevo clúster, establezca este campo en el identificador de recurso de la copia de seguridad. | cuerda |
ManagedCassandraManagedServiceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | Tipo del recurso. | 'Ninguno' 'SystemAssigned' |
Microsoft.DocumentDB/cassandraClusters
| Nombre | Descripción | Valor |
|---|---|---|
| identidad | Identidad del recurso. | ManagedCassandraManagedServiceIdentity |
| ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | cuerda |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatorio) |
| Propiedades | Propiedades de un clúster de Cassandra administrado. | ClusterResourceProperties |
| Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas |
SeedNode
| Nombre | Descripción | Valor |
|---|---|---|
| ipAddress | Dirección IP de este nodo de inicialización. | cuerda |
Etiquetas
| Nombre | Descripción | Valor |
|---|
Definición de recursos de plantilla de ARM
El tipo de recurso cassandraClusters se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.DocumentDB/cassandraClusters, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.DocumentDB/cassandraClusters",
"apiVersion": "2024-08-15",
"name": "string",
"identity": {
"type": "string"
},
"location": "string",
"properties": {
"authenticationMethod": "string",
"azureConnectionMethod": "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"
}
}
Valores de propiedad
CassandraError
| Nombre | Descripción | Valor |
|---|---|---|
| additionalErrorInfo | Información adicional sobre el error. | cuerda |
| código | Código de error que se produjo. | cuerda |
| Mensaje | Mensaje del error. | cuerda |
| blanco | Recurso de destino del error. | cuerda |
Certificado
| Nombre | Descripción | Valor |
|---|---|---|
| Pem | Clave pública con formato PEM. | cuerda |
ClusterResourceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| authenticationMethod | Qué método de autenticación Debe usar Cassandra para autenticar a los clientes. 'None' desactiva la autenticación, por lo que no debe usarse excepto en emergencias. "Cassandra" es la autenticación predeterminada basada en contraseña. El valor predeterminado es "Cassandra". | 'Cassandra' 'Ldap' 'Ninguno' |
| azureConnectionMethod | Conexión a los servicios de Azure necesarios para ejecutar el clúster | 'Ninguno' "VPN" |
| cassandraAuditLoggingEnabled | Si el registro de auditoría de Cassandra está habilitado | Bool |
| cassandraVersion | Qué versión de Cassandra debe converger para ejecutar este clúster (por ejemplo, 3.11). Cuando se actualiza, el clúster puede tardar algún tiempo en migrar a la nueva versión. | cuerda |
| clientCertificates | Lista de certificados TLS usados para autorizar a los clientes que se conectan al clúster. Todas las conexiones se cifran con TLS tanto si se establece clientCertificates como si no, pero si se establece clientCertificates, el clúster de Cassandra administrado rechazará todas las conexiones que no contengan un certificado de cliente TLS que se pueda validar desde uno o varios de los certificados públicos de esta propiedad. | certificado[] |
| clusterNameOverride | Si necesita establecer la propiedad clusterName en cassandra.yaml en algo aparte del nombre de recurso del clúster, establezca el valor que se usará en esta propiedad. | cuerda |
| desasignado | Si el clúster y los centros de datos asociados se han desasignado. | Bool |
| delegatedManagementSubnetId | Identificador de recurso de una subred a la que el servicio de administración de este clúster debe tener asociada su interfaz de red. La subred debe ser enrutable a todas las subredes que se delegarán en los centros de datos. El identificador de recurso debe tener el formato "/subscriptions/<id. de suscripción>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<red virtual>/subnets/<subred>" | cuerda |
| externalGossipCertificates | Lista de certificados TLS usados para autorizar el ipse desde centros de datos no administrados. Los certificados TLS de todos los nodos de centros de datos no administrados deben ser verificables mediante uno de los certificados proporcionados en esta propiedad. | certificado[] |
| externalSeedNodes | Lista de direcciones IP de nodos de inicialización en centros de datos no administrados. Se agregarán a las listas de nodos de inicialización de todos los nodos administrados. | SeedNode [] |
| hoursBetweenBackups | (en desuso) Número de horas de espera entre realizar una copia de seguridad del clúster. | Int |
| initialCassandraAdminPassword | Contraseña inicial para los clientes que se conectan como administrador al clúster. Debe cambiarse después de la creación del clúster. Devuelve null en GET. Este campo solo se aplica cuando el campo authenticationMethod es "Cassandra". | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| prometheusEndpoint | Nombre de host o dirección IP donde se puede acceder al punto de conexión de Prometheus que contiene datos sobre los nodos de Cassandra administrados. | seedNode de |
| provisionError | Error relacionado con el aprovisionamiento de recursos. | CassandraError |
| provisioningState | Estado del recurso en el momento en que se llamó a la operación. | 'Cancelado' 'Crear' "Eliminar" 'Error' "Correcto" "Actualización" |
| repairEnabled | ¿Se deben ejecutar reparaciones automáticas en este clúster? Si se omite, esto es true y debe permanecer true a menos que ejecute un clúster híbrido en el que ya esté realizando sus propias reparaciones. | Bool |
| restoreFromBackupId | Para crear un clúster vacío, omita este campo o establézcalo en NULL. Para restaurar una copia de seguridad en un nuevo clúster, establezca este campo en el identificador de recurso de la copia de seguridad. | cuerda |
ManagedCassandraManagedServiceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | Tipo del recurso. | 'Ninguno' 'SystemAssigned' |
Microsoft.DocumentDB/cassandraClusters
| Nombre | Descripción | Valor |
|---|---|---|
| apiVersion | La versión de api | '2024-08-15' |
| identidad | Identidad del recurso. | ManagedCassandraManagedServiceIdentity |
| ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | cuerda |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatorio) |
| Propiedades | Propiedades de un clúster de Cassandra administrado. | ClusterResourceProperties |
| Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. Consulte etiquetas de en plantillas |
| tipo | El tipo de recurso | 'Microsoft.DocumentDB/cassandraClusters' |
SeedNode
| Nombre | Descripción | Valor |
|---|---|---|
| ipAddress | Dirección IP de este nodo de inicialización. | cuerda |
Etiquetas
| Nombre | Descripción | Valor |
|---|
Definición de recursos de Terraform (proveedor AzAPI)
El tipo de recurso cassandraClusters se puede implementar con operaciones que tienen como destino:
- grupos de recursos de
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.
Formato de recurso
Para crear un recurso Microsoft.DocumentDB/cassandraClusters, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters@2024-08-15"
name = "string"
identity = {
type = "string"
}
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
authenticationMethod = "string"
azureConnectionMethod = "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"
}
})
}
Valores de propiedad
CassandraError
| Nombre | Descripción | Valor |
|---|---|---|
| additionalErrorInfo | Información adicional sobre el error. | cuerda |
| código | Código de error que se produjo. | cuerda |
| Mensaje | Mensaje del error. | cuerda |
| blanco | Recurso de destino del error. | cuerda |
Certificado
| Nombre | Descripción | Valor |
|---|---|---|
| Pem | Clave pública con formato PEM. | cuerda |
ClusterResourceProperties
| Nombre | Descripción | Valor |
|---|---|---|
| authenticationMethod | Qué método de autenticación Debe usar Cassandra para autenticar a los clientes. 'None' desactiva la autenticación, por lo que no debe usarse excepto en emergencias. "Cassandra" es la autenticación predeterminada basada en contraseña. El valor predeterminado es "Cassandra". | 'Cassandra' 'Ldap' 'Ninguno' |
| azureConnectionMethod | Conexión a los servicios de Azure necesarios para ejecutar el clúster | 'Ninguno' "VPN" |
| cassandraAuditLoggingEnabled | Si el registro de auditoría de Cassandra está habilitado | Bool |
| cassandraVersion | Qué versión de Cassandra debe converger para ejecutar este clúster (por ejemplo, 3.11). Cuando se actualiza, el clúster puede tardar algún tiempo en migrar a la nueva versión. | cuerda |
| clientCertificates | Lista de certificados TLS usados para autorizar a los clientes que se conectan al clúster. Todas las conexiones se cifran con TLS tanto si se establece clientCertificates como si no, pero si se establece clientCertificates, el clúster de Cassandra administrado rechazará todas las conexiones que no contengan un certificado de cliente TLS que se pueda validar desde uno o varios de los certificados públicos de esta propiedad. | certificado[] |
| clusterNameOverride | Si necesita establecer la propiedad clusterName en cassandra.yaml en algo aparte del nombre de recurso del clúster, establezca el valor que se usará en esta propiedad. | cuerda |
| desasignado | Si el clúster y los centros de datos asociados se han desasignado. | Bool |
| delegatedManagementSubnetId | Identificador de recurso de una subred a la que el servicio de administración de este clúster debe tener asociada su interfaz de red. La subred debe ser enrutable a todas las subredes que se delegarán en los centros de datos. El identificador de recurso debe tener el formato "/subscriptions/<id. de suscripción>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<red virtual>/subnets/<subred>" | cuerda |
| externalGossipCertificates | Lista de certificados TLS usados para autorizar el ipse desde centros de datos no administrados. Los certificados TLS de todos los nodos de centros de datos no administrados deben ser verificables mediante uno de los certificados proporcionados en esta propiedad. | certificado[] |
| externalSeedNodes | Lista de direcciones IP de nodos de inicialización en centros de datos no administrados. Se agregarán a las listas de nodos de inicialización de todos los nodos administrados. | SeedNode [] |
| hoursBetweenBackups | (en desuso) Número de horas de espera entre realizar una copia de seguridad del clúster. | Int |
| initialCassandraAdminPassword | Contraseña inicial para los clientes que se conectan como administrador al clúster. Debe cambiarse después de la creación del clúster. Devuelve null en GET. Este campo solo se aplica cuando el campo authenticationMethod es "Cassandra". | cuerda Restricciones: Valor confidencial. Pase como parámetro seguro. |
| prometheusEndpoint | Nombre de host o dirección IP donde se puede acceder al punto de conexión de Prometheus que contiene datos sobre los nodos de Cassandra administrados. | seedNode de |
| provisionError | Error relacionado con el aprovisionamiento de recursos. | CassandraError |
| provisioningState | Estado del recurso en el momento en que se llamó a la operación. | 'Cancelado' 'Crear' "Eliminar" 'Error' "Correcto" "Actualización" |
| repairEnabled | ¿Se deben ejecutar reparaciones automáticas en este clúster? Si se omite, esto es true y debe permanecer true a menos que ejecute un clúster híbrido en el que ya esté realizando sus propias reparaciones. | Bool |
| restoreFromBackupId | Para crear un clúster vacío, omita este campo o establézcalo en NULL. Para restaurar una copia de seguridad en un nuevo clúster, establezca este campo en el identificador de recurso de la copia de seguridad. | cuerda |
ManagedCassandraManagedServiceIdentity
| Nombre | Descripción | Valor |
|---|---|---|
| tipo | Tipo del recurso. | 'Ninguno' 'SystemAssigned' |
Microsoft.DocumentDB/cassandraClusters
| Nombre | Descripción | Valor |
|---|---|---|
| identidad | Identidad del recurso. | ManagedCassandraManagedServiceIdentity |
| ubicación | Ubicación del grupo de recursos al que pertenece el recurso. | cuerda |
| nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 1 Patrón = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obligatorio) |
| Propiedades | Propiedades de un clúster de Cassandra administrado. | ClusterResourceProperties |
| Etiquetas | Etiquetas de recursos | Diccionario de nombres y valores de etiqueta. |
| tipo | El tipo de recurso | "Microsoft.DocumentDB/cassandraClusters@2024-08-15" |
SeedNode
| Nombre | Descripción | Valor |
|---|---|---|
| ipAddress | Dirección IP de este nodo de inicialización. | cuerda |
Etiquetas
| Nombre | Descripción | Valor |
|---|