Compartir a través de

CassandraClusters/dataCenters 2023-11-15 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 recurso

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15' = {
  parent: resourceSymbolicName
  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

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 para iniciar la búsqueda recursiva de los usuarios. cuerda
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. cuerda
serverCertificates certificado[]
serverHostname Nombre de host del servidor LDAP. cuerda
serverPort Puerto del servidor LDAP. Int
serviceUserDistinguishedName Nombre distintivo de la cuenta de usuario de búsqueda, que puede buscar detalles del usuario sobre la autenticación. cuerda
serviceUserPassword Contraseña del usuario de búsqueda. cuerda

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

DataCenterResourceProperties

Nombre Descripción Valor
authenticationMethodLdapProperties Propiedades del método de autenticación ldap. Esta característica está en 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 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. cuerda
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. cuerda
dataCenterLocation La región en la que se debe crear este centro de datos. cuerda
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/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<red virtual>/subnets/<subred>". cuerda
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. cuerda
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. cuerda
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 cuerda

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nombre Descripción Valor
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)
padre 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 obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: cassandraClusters
Propiedades Propiedades de un centro de datos de Cassandra administrado. DataCenterResourceProperties

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 recurso

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2023-11-15",
  "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

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 para iniciar la búsqueda recursiva de los usuarios. cuerda
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. cuerda
serverCertificates certificado[]
serverHostname Nombre de host del servidor LDAP. cuerda
serverPort Puerto del servidor LDAP. Int
serviceUserDistinguishedName Nombre distintivo de la cuenta de usuario de búsqueda, que puede buscar detalles del usuario sobre la autenticación. cuerda
serviceUserPassword Contraseña del usuario de búsqueda. cuerda

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

DataCenterResourceProperties

Nombre Descripción Valor
authenticationMethodLdapProperties Propiedades del método de autenticación ldap. Esta característica está en 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 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. cuerda
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. cuerda
dataCenterLocation La región en la que se debe crear este centro de datos. cuerda
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/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<red virtual>/subnets/<subred>". cuerda
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. cuerda
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. cuerda
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 cuerda

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nombre Descripción Valor
apiVersion La versión de api '2023-11-15'
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 centro de datos de Cassandra administrado. DataCenterResourceProperties
tipo El tipo de recurso 'Microsoft.DocumentDB/cassandraClusters/dataCenters'

Definición de recursos de Terraform (proveedor AzAPI)

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

  • 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/dataCenters, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15"
  name = "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

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 para iniciar la búsqueda recursiva de los usuarios. cuerda
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. cuerda
serverCertificates certificado[]
serverHostname Nombre de host del servidor LDAP. cuerda
serverPort Puerto del servidor LDAP. Int
serviceUserDistinguishedName Nombre distintivo de la cuenta de usuario de búsqueda, que puede buscar detalles del usuario sobre la autenticación. cuerda
serviceUserPassword Contraseña del usuario de búsqueda. cuerda

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

DataCenterResourceProperties

Nombre Descripción Valor
authenticationMethodLdapProperties Propiedades del método de autenticación ldap. Esta característica está en 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 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. cuerda
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. cuerda
dataCenterLocation La región en la que se debe crear este centro de datos. cuerda
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/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<red virtual>/subnets/<subred>". cuerda
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. cuerda
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. cuerda
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 cuerda

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nombre Descripción Valor
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)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: cassandraClusters
Propiedades Propiedades de un centro de datos de Cassandra administrado. DataCenterResourceProperties
tipo El tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15"