Compartir a través de

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

  • Artículo

Definición de recursos de Bicep

El tipo de recurso cassandraClusters/dataCenters 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/dataCenters, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

Valores de propiedad

cassandraClusters/dataCenters

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)
primario En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: cassandraClusters
properties Propiedades de un centro de datos de Cassandra administrado. DataCenterResourceProperties

DataCenterResourceProperties

Nombre Descripción Valor
authenticationMethodLdapProperties Propiedades del método de autenticación ldap. Esta característica se encuentra en su versión preliminar. AuthenticationMethodLdapProperties
availabilityZone Si el centro de datos tiene compatibilidad con la zona de disponibilidad, aplíquelo al conjunto de escalado de máquinas virtuales que hospeda las máquinas virtuales del centro de datos de cassandra. bool
backupStorageCustomerKeyUri Indica el URI de clave de la clave de cliente que se va a usar para el cifrado de la cuenta de almacenamiento de copia de seguridad. string
base64EncodedCassandraYamlFragment Fragmento de un archivo de configuración cassandra.yaml que se va a incluir en cassandra.yaml para todos los nodos de este centro de datos. El fragmento debe estar codificado en Base64 y solo se permite un subconjunto de claves. string
dataCenterLocation La región en la que se debe crear este centro de datos. string
desasignado Si el centro de datos se ha desasignado. bool
delegatedSubnetId Identificador de recurso de una subred a la que los nodos de este centro de datos deben tener sus interfaces de red conectadas. La subred debe estar en la misma región especificada en "dataCenterLocation" y debe poder enrutarse a la subred especificada en la propiedad "delegatedManagementSubnetId" del clúster. Este identificador de recurso tendrá el formato "/subscriptions/{id. de suscripción}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". string
diskCapacity Número de discos conectados a cada nodo. El valor predeterminado es 4. int
diskSku SKU de disco usada para centros de datos. El valor predeterminado es P30. string
managedDiskCustomerKeyUri URI de clave que se va a usar para el cifrado de discos administrados. Asegúrese de que a la identidad asignada por el sistema del clúster se le han asignado los permisos adecuados (permisos get/wrap/unwrap de clave) en la clave. string
nodeCount Número de nodos que debe tener el centro de datos. Este es el número deseado. Una vez establecido, el centro de datos puede tardar algún tiempo en escalarse para que coincida. Para supervisar el número de nodos y su estado, use el método fetchNodeStatus en el clúster. int
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'
'Failed'
"Correcto"
'Actualizar'
sku SKU de máquina virtual usada para centros de datos. El valor predeterminado es Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nombre Descripción Valor
connectionTimeoutInMs Tiempo de espera para conectarse al servidor LDAP en milisegundos. El valor predeterminado es 5000 ms. int
searchBaseDistinguishedName Nombre distintivo del objeto del que se va a iniciar la búsqueda recursiva de los usuarios. string
searchFilterTemplate Plantilla que se va a usar para la búsqueda. El valor predeterminado es (cn=%s), donde %s se reemplazará por el nombre de usuario usado para iniciar sesión. string
serverCertificates Certificado[]
serverHostname Nombre de host del servidor LDAP. string
serverPort Puerto del servidor LDAP. int
serviceUserDistinguishedName Nombre distintivo de la cuenta de usuario de búsqueda, que puede buscar los detalles del usuario en la autenticación. string
serviceUserPassword Contraseña del usuario de búsqueda. string

Certificado

Nombre Descripción Valor
Pem Clave pública con formato PEM. 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/dataCenters 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/dataCenters, agregue el siguiente json a la plantilla.

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2023-09-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",
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "sku": "string"
  }
}

Valores de propiedad

cassandraClusters/dataCenters

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters"
apiVersion La versión de la API de recursos "2023-09-15-preview"
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)
properties Propiedades de un centro de datos de Cassandra administrado. DataCenterResourceProperties

DataCenterResourceProperties

Nombre Descripción Valor
authenticationMethodLdapProperties Propiedades del método de autenticación ldap. Esta característica se encuentra en su versión preliminar. AuthenticationMethodLdapProperties
availabilityZone Si el centro de datos tiene compatibilidad con la zona de disponibilidad, aplíquelo al conjunto de escalado de máquinas virtuales que hospeda las máquinas virtuales del centro de datos de cassandra. bool
backupStorageCustomerKeyUri Indica el URI de clave de la clave de cliente que se va a usar para el cifrado de la cuenta de almacenamiento de copia de seguridad. string
base64EncodedCassandraYamlFragment Fragmento de un archivo de configuración cassandra.yaml que se incluirá en cassandra.yaml para todos los nodos de este centro de datos. El fragmento debe estar codificado en Base64 y solo se permite un subconjunto de claves. string
dataCenterLocation La región en la que se debe crear este centro de datos. string
desasignado Si el centro de datos se ha desasignado. bool
delegatedSubnetId Identificador de recurso de una subred a la que deben estar conectados los nodos de este centro de datos. La subred debe estar en la misma región especificada en "dataCenterLocation" y debe poder enrutar a la subred especificada en la propiedad 'delegatedManagementSubnetId' del clúster. Este identificador de recurso tendrá el formato '/subscriptions/{id. de suscripción}/resourceGroups/{grupo de recursos}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. string
diskCapacity Número de discos conectados a cada nodo. El valor predeterminado es 4. int
diskSku SKU de disco usada para centros de datos. El valor predeterminado es P30. string
managedDiskCustomerKeyUri URI de clave que se va a usar para el cifrado de discos administrados. Asegúrese de que a la identidad asignada por el sistema del clúster se le han asignado los permisos adecuados (permisos de obtención, ajuste y desencapsulado de claves) en la clave. string
nodeCount Número de nodos que debe tener el centro de datos. Este es el número deseado. Una vez establecido, el centro de datos puede tardar algún tiempo en escalarse para que coincida. Para supervisar el número de nodos y su estado, use el método fetchNodeStatus en el clúster. int
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"
sku SKU de máquina virtual usada para centros de datos. El valor predeterminado es Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nombre Descripción Valor
connectionTimeoutInMs Tiempo de espera para conectarse al servidor LDAP en milisegundos. El valor predeterminado es 5000 ms. int
searchBaseDistinguishedName Nombre distintivo del objeto desde el que se va a iniciar la búsqueda recursiva de los usuarios. string
searchFilterTemplate Plantilla que se va a usar para la búsqueda. El valor predeterminado es (cn=%s), donde %s se reemplazará por el nombre de usuario usado para iniciar sesión. string
serverCertificates Certificado[]
serverHostname Nombre de host del servidor LDAP. string
serverPort Puerto del servidor LDAP. int
serviceUserDistinguishedName Nombre distintivo de la cuenta de usuario de búsqueda, que puede buscar los detalles del usuario en la autenticación. string
serviceUserPassword Contraseña del usuario de búsqueda. string

Certificado

Nombre Descripción Valor
Pem Clave pública con formato PEM. 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/dataCenters 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/dataCenters, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-15-preview"
  name = "string"
  parent_id = "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
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      sku = "string"
    }
  })
}

Valores de propiedad

cassandraClusters/dataCenters

Nombre Descripción Value
type Tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-15-preview"
name El nombre del recurso string (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: cassandraClusters
properties Propiedades de un centro de datos de Cassandra administrado. DataCenterResourceProperties

DataCenterResourceProperties

Nombre Descripción Valor
authenticationMethodLdapProperties Propiedades del método de autenticación ldap. Esta característica se encuentra en su versión preliminar. AuthenticationMethodLdapProperties
availabilityZone Si el centro de datos tiene compatibilidad con zona de disponibilidad, aplíquelo al conjunto de escalado de máquinas virtuales que hospeda las máquinas virtuales del centro de datos de cassandra. bool
backupStorageCustomerKeyUri Indica el URI de clave de la clave de cliente que se va a usar para el cifrado de la cuenta de almacenamiento de copia de seguridad. string
base64EncodedCassandraYamlFragment Fragmento de un archivo de configuración cassandra.yaml que se incluirá en cassandra.yaml para todos los nodos de este centro de datos. El fragmento debe estar codificado en Base64 y solo se permite un subconjunto de claves. string
dataCenterLocation La región en la que se debe crear este centro de datos. string
desasignado Si el centro de datos se ha desasignado. bool
delegatedSubnetId Identificador de recurso de una subred a la que deben estar conectados los nodos de este centro de datos. La subred debe estar en la misma región especificada en "dataCenterLocation" y debe poder enrutar a la subred especificada en la propiedad 'delegatedManagementSubnetId' del clúster. Este identificador de recurso tendrá el formato '/subscriptions/{id. de suscripción}/resourceGroups/{grupo de recursos}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. string
diskCapacity Número de discos conectados a cada nodo. El valor predeterminado es 4. int
diskSku SKU de disco usada para centros de datos. El valor predeterminado es P30. string
managedDiskCustomerKeyUri URI de clave que se va a usar para el cifrado de discos administrados. Asegúrese de que a la identidad asignada por el sistema del clúster se le han asignado los permisos adecuados (permisos de obtención, ajuste y desencapsulado de claves) en la clave. string
nodeCount Número de nodos que debe tener el centro de datos. Este es el número deseado. Una vez establecido, el centro de datos puede tardar algún tiempo en escalarse para que coincida. Para supervisar el número de nodos y su estado, use el método fetchNodeStatus en el clúster. int
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"
sku SKU de máquina virtual usada para centros de datos. El valor predeterminado es Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nombre Descripción Valor
connectionTimeoutInMs Tiempo de espera para conectarse al servidor LDAP en milisegundos. El valor predeterminado es 5000 ms. int
searchBaseDistinguishedName Nombre distintivo del objeto desde el que se va a iniciar la búsqueda recursiva de los usuarios. string
searchFilterTemplate Plantilla que se va a usar para la búsqueda. El valor predeterminado es (cn=%s), donde %s se reemplazará por el nombre de usuario usado para iniciar sesión. string
serverCertificates Certificado[]
serverHostname Nombre de host del servidor LDAP. string
serverPort Puerto del servidor LDAP. int
serviceUserDistinguishedName Nombre distintivo de la cuenta de usuario de búsqueda, que puede buscar los detalles del usuario en la autenticación. string
serviceUserPassword Contraseña del usuario de búsqueda. string

Certificado

Nombre Descripción Valor
Pem Clave pública con formato PEM. 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