Compartir a través de

CassandraClusters 2023-09-15-preview de Microsoft.DocumentDB

  • Artículo

Definición de recursos de Bicep

El tipo de recurso cassandraClusters se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/cassandraClusters, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    authenticationMethod: 'string'
    backupSchedules: [
      {
        cronExpression: 'string'
        retentionInHours: int
        scheduleName: 'string'
      }
    ]
    cassandraAuditLoggingEnabled: bool
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    clusterType: 'string'
    deallocated: bool
    delegatedManagementSubnetId: 'string'
    extensions: [
      '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

cassandraClusters

Nombre Descripción Value
name El nombre del recurso string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
identidad Identidad del recurso. ManagedCassandraManagedServiceIdentity
properties Propiedades de un clúster de Cassandra administrado. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nombre Descripción Value
type Tipo de recurso. 'Ninguno'
'SystemAssigned'

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 se debe usar excepto en situaciones de emergencia. "Cassandra" es la autenticación basada en contraseña predeterminada. El valor predeterminado es "Cassandra". "Cassandra"
'Ldap'
'Ninguno'
backupSchedules Lista de programaciones de copia de seguridad que definen cuándo desea realizar una copia de seguridad de los datos. BackupSchedule[]
cassandraAuditLoggingEnabled Si el registro de auditoría de Cassandra está habilitado bool
cassandraVersion Qué versión de Cassandra debe converger en ejecución (por ejemplo, 3.11). Cuando se actualiza, el clúster puede tardar algún tiempo en migrar a la nueva versión. string
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 del recurso del clúster, establezca el valor que se usará en esta propiedad. string
clusterType Tipo del clúster. Si se establece en Producción, es posible que algunas operaciones no se permitan en el clúster. 'NonProduction'
'Producción'
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/{virtual network}/subnets/{subnet}' string
extensions Extensiones que se van a agregar o actualizar en el clúster. string[]
externalGossipCertificates Lista de certificados TLS usados para autorizar elipse 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". string

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
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 mantenerse en 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. string

BackupSchedule

Nombre Descripción Valor
cronExpression Expresión cron que define cuándo desea realizar una copia de seguridad de los datos. string
retentionInHours Período de retención (horas) de las copias de seguridad. Si desea conservar los datos para siempre, establezca retención en 0. int
scheduleName Identificador único de la programación de copia de seguridad. string

Certificado

Nombre Descripción Valor
Pem Clave pública con formato PEM. string

SeedNode

Nombre Descripción Valor
ipAddress Dirección IP de este nodo de inicialización. string

CassandraError

Nombre Descripción Valor
additionalErrorInfo Información adicional sobre el error. string
código Código de error que se produjo. string
message Mensaje del error. string
Destino Recurso de destino del error. string

Definición de recursos de plantilla de ARM

El tipo de recurso cassandraClusters se puede implementar con operaciones destinadas a:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/cassandraClusters, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authenticationMethod": "string",
    "backupSchedules": [
      {
        "cronExpression": "string",
        "retentionInHours": "int",
        "scheduleName": "string"
      }
    ],
    "cassandraAuditLoggingEnabled": "bool",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "clusterType": "string",
    "deallocated": "bool",
    "delegatedManagementSubnetId": "string",
    "extensions": [ "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

cassandraClusters

Nombre Descripción Value
type Tipo de recurso 'Microsoft.DocumentDB/cassandraClusters'
apiVersion La versión de la API de recursos '2023-09-15-preview'
name El nombre del recurso string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta. Consulte Etiquetas en plantillas.
identidad Identidad del recurso. ManagedCassandraManagedServiceIdentity
properties Propiedades de un clúster de Cassandra administrado. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nombre Descripción Value
type Tipo de recurso. 'Ninguno'
'SystemAssigned'

ClusterResourceProperties

Nombre Descripción Valor
authenticationMethod Qué método de autenticación Cassandra debe usar para autenticar clientes. "Ninguno" 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'
backupSchedules Lista de programaciones de copia de seguridad que definen cuándo desea realizar una copia de seguridad de los datos. BackupSchedule[]
cassandraAuditLoggingEnabled Si el registro de auditoría de Cassandra está habilitado bool
cassandraVersion Qué versión de Cassandra debe converger para ejecutarse (por ejemplo, 3.11). Cuando se actualiza, el clúster puede tardar algún tiempo en migrar a la nueva versión. string
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. string
clusterType Tipo del clúster. Si se establece en Producción, es posible que algunas operaciones no se permitan en el clúster. 'NonProduction'
'Producción'
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/{virtual network}/subnets/{subnet}' string
extensions Extensiones que se van a agregar o actualizar en el clúster. string[]
externalGossipCertificates Lista de certificados TLS usados para autorizar elipse 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". string

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
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 mantenerse en 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. string

BackupSchedule

Nombre Descripción Valor
cronExpression Expresión cron que define cuándo desea realizar una copia de seguridad de los datos. string
retentionInHours Período de retención (horas) de las copias de seguridad. Si desea conservar los datos para siempre, establezca retención en 0. int
scheduleName Identificador único de la programación de copia de seguridad. string

Certificado

Nombre Descripción Valor
Pem Clave pública con formato PEM. string

SeedNode

Nombre Descripción Valor
ipAddress Dirección IP de este nodo de inicialización. string

CassandraError

Nombre Descripción Valor
additionalErrorInfo Información adicional sobre el error. string
código Código de error que se produjo. string
message Mensaje del error. string
Destino Recurso de destino del error. string

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso cassandraClusters se puede implementar con operaciones destinadas a:

  • Grupos de recursos

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de los recursos

Para crear un recurso Microsoft.DocumentDB/cassandraClusters, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      backupSchedules = [
        {
          cronExpression = "string"
          retentionInHours = int
          scheduleName = "string"
        }
      ]
      cassandraAuditLoggingEnabled = bool
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      clusterType = "string"
      deallocated = bool
      delegatedManagementSubnetId = "string"
      extensions = [
        "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

cassandraClusters

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
name El nombre del recurso string (obligatorio)
ubicación Ubicación del grupo de recursos al que pertenece el recurso. string
parent_id Para realizar la implementación en un grupo de recursos, use el identificador de ese grupo de recursos. string (obligatorio)
etiquetas Las etiquetas son una lista de pares clave-valor que describen el recurso. Estas etiquetas pueden utilizarse para visualizar y agrupar este recurso a través de grupos de recursos. Se puede proporcionar un máximo de 15 etiquetas para un recurso. Cada etiqueta debe tener una clave no superior a 128 caracteres y un valor no superior a 256 caracteres. Por ejemplo, la experiencia predeterminada para un tipo de plantilla se establece con "defaultExperience": "Cassandra". Los valores actuales "defaultExperience" también incluyen "Table", "Graph", "DocumentDB" y "MongoDB". Diccionario de nombres y valores de etiqueta.
identidad Identidad del recurso. ManagedCassandraManagedServiceIdentity
properties Propiedades de un clúster de Cassandra administrado. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nombre Descripción Value
type Tipo de recurso. "SystemAssigned"

ClusterResourceProperties

Nombre Descripción Valor
authenticationMethod Qué método de autenticación Cassandra debe usar para autenticar clientes. "Ninguno" 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"
"None"
backupSchedules Lista de programaciones de copia de seguridad que definen cuándo desea realizar una copia de seguridad de los datos. BackupSchedule[]
cassandraAuditLoggingEnabled Si el registro de auditoría de Cassandra está habilitado bool
cassandraVersion Qué versión de Cassandra debe converger para ejecutarse (por ejemplo, 3.11). Cuando se actualiza, el clúster puede tardar algún tiempo en migrar a la nueva versión. string
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. string
clusterType Tipo del clúster. Si se establece en Producción, es posible que algunas operaciones no se permitan en el clúster. "NonProduction"
"Production"
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/{virtual network}/subnets/{subnet}' string
extensions Extensiones que se van a agregar o actualizar en el clúster. string[]
externalGossipCertificates Lista de certificados TLS usados para autorizar elipse 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". string

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
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 mantenerse 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. string

BackupSchedule

Nombre Descripción Valor
cronExpression Expresión cron que define cuándo desea realizar una copia de seguridad de los datos. string
retentionInHours Período de retención (horas) de las copias de seguridad. Si desea conservar los datos para siempre, establezca la retención en 0. int
scheduleName Identificador único de la programación de copia de seguridad. string

Certificado

Nombre Descripción Valor
Pem Clave pública con formato PEM. string

SeedNode

Nombre Descripción Valor
ipAddress Dirección IP de este nodo de inicialización. string

CassandraError

Nombre Descripción Valor
additionalErrorInfo Información adicional sobre el error. string
código Código de error que se produjo. string
message Mensaje del error. string
Destino Recurso de destino del error. string