Compartilhar via

CassandraClusters/dataCenters 2023-03-15 do Microsoft.DocumentDB

  • Artigo

Definição de recurso do Bicep

O tipo de recurso cassandraClusters/dataCenters pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/cassandraClusters/dataCenters, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-03-15' = {
  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 propriedade

cassandraClusters/dataCenters

Name Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte Recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: cassandraClusters
properties Propriedades de um data center gerenciado do Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Name Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esse recurso está em visualização. AuthenticationMethodLdapProperties
availabilityZone Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao Conjunto de Dimensionamento de Máquinas Virtuais que hospedam as máquinas virtuais do data center do Cassandra. bool
backupStorageCustomerKeyUri Indica o Uri de chave da chave do cliente a ser usada para criptografia da conta de armazenamento de backup. string
base64EncodedCassandraYamlFragment Um fragmento de um arquivo de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste data center. O fragmento deve ser codificado em Base64 e apenas um subconjunto de chaves é permitido. string
dataCenterLocation A região em que esse data center deve ser criado. string
Desalocado Se o data center foi desalocado. bool
delegatedSubnetId ID de recurso de uma sub-rede à qual os nós neste data center devem ter seus adaptadores de rede conectados. A sub-rede deve estar na mesma região especificada em 'dataCenterLocation' e deve ser capaz de rotear para a sub-rede especificada na propriedade 'delegatedManagementSubnetId' do cluster. Essa ID de recurso será do formulário '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. string
diskCapacity Número de discos anexados a cada nó. O padrão é 4. INT
diskSku SKU de disco usado para data centers. O valor padrão é P30. string
managedDiskCustomerKeyUri URI de chave a ser usado para criptografia de discos gerenciados. Verifique se a identidade atribuída pelo sistema do cluster recebeu permissões apropriadas (permissões get/wrap/unwrap de chave) na chave. string
nodeCount O número de nós que o data center deve ter. Esse é o número desejado. Depois de definido, pode levar algum tempo para que o data center seja dimensionado para corresponder. Para monitorar o número de nós e seu status, use o método fetchNodeStatus no cluster. INT
provisionError Erro relacionado ao provisionamento de recursos. CassandraError
provisioningState O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criando'
'Excluindo'
'Falha'
'Êxito'
'Atualizando'
sku SKU de máquina virtual usado para data centers. O valor padrão é Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Name Descrição Valor
connectionTimeoutInMs Tempo limite para se conectar ao servidor LDAP em milissegundos. O padrão é 5000 ms. INT
searchBaseDistinguishedName Nome diferenciado do objeto do qual iniciar a pesquisa recursiva de usuários. string
searchFilterTemplate Modelo a ser usado para pesquisa. O padrão é (cn=%s) em que %s será substituído pelo nome de usuário usado para fazer logon. string
serverCertificates Certificado[]
serverHostname Nome do host do servidor LDAP. string
Serverport Porta do servidor LDAP. INT
serviceUserDistinguishedName Nome diferenciado da conta de usuário de pesquisa, que pode pesquisar detalhes do usuário sobre autenticação. string
serviceUserPassword Senha do usuário de pesquisa. string

Certificado

Name Descrição Valor
Pem Chave pública formatada em PEM. string

CassandraError

Name Descrição Valor
additionalErrorInfo Informações adicionais sobre o erro. string
code O código de erro que ocorreu. string
message A mensagem do erro. string
destino O recurso de destino do erro. string

Definição de recurso de modelo do ARM

O tipo de recurso cassandraClusters/dataCenters pode ser implantado com operações direcionadas:

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/cassandraClusters/dataCenters, adicione o JSON a seguir ao modelo.

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

cassandraClusters/dataCenters

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/cassandraClusters/dataCenters'
apiVersion A versão da API de recursos '2023-03-15'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)
properties Propriedades de um data center gerenciado do Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Name Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esse recurso está em visualização. AuthenticationMethodLdapProperties
availabilityZone Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao Conjunto de Dimensionamento de Máquinas Virtuais que hospedam as máquinas virtuais do data center do Cassandra. bool
backupStorageCustomerKeyUri Indica o URI de chave da chave do cliente a ser usada para criptografia da conta de armazenamento de backup. string
base64EncodedCassandraYamlFragment Um fragmento de um arquivo de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste data center. O fragmento deve ser codificado em Base64 e apenas um subconjunto de chaves é permitido. string
dataCenterLocation A região em que esse data center deve ser criado. string
Desalocado Se o data center foi desalocado. bool
delegatedSubnetId ID de recurso de uma sub-rede à qual os nós neste data center devem ter seus adaptadores de rede conectados. A sub-rede deve estar na mesma região especificada em 'dataCenterLocation' e deve ser capaz de rotear para a sub-rede especificada na propriedade 'delegatedManagementSubnetId' do cluster. Essa ID de recurso será do formato '/subscriptions/{id da assinatura}/resourceGroups/{grupo de recursos}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. string
diskCapacity Número de discos anexados a cada nó. O padrão é 4. INT
diskSku SKU de disco usado para data centers. O valor padrão é P30. string
managedDiskCustomerKeyUri URI de chave a ser usado para criptografia de discos gerenciados. Verifique se a identidade atribuída pelo sistema do cluster recebeu permissões apropriadas (permissões get/wrap/unwrap de chave) na chave. string
nodeCount O número de nós que o data center deve ter. Esse é o número desejado. Depois de definido, pode levar algum tempo para que o data center seja dimensionado para corresponder. Para monitorar o número de nós e seu status, use o método fetchNodeStatus no cluster. INT
provisionError Erro relacionado ao provisionamento de recursos. CassandraError
provisioningState O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criando'
'Excluindo'
'Falha'
'Êxito'
'Atualizando'
sku SKU de máquina virtual usada para data centers. O valor padrão é Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Name Descrição Valor
connectionTimeoutInMs Tempo limite para se conectar ao servidor LDAP em milissegundos. O padrão é 5000 ms. INT
searchBaseDistinguishedName Nome diferenciado do objeto do qual iniciar a pesquisa recursiva dos usuários. string
searchFilterTemplate Modelo a ser usado para pesquisa. O padrão é (cn=%s) em que %s será substituído pelo nome de usuário usado para fazer logon. string
serverCertificates Certificate[]
serverHostname Nome do host do servidor LDAP. string
Serverport Porta do servidor LDAP. INT
serviceUserDistinguishedName Nome diferenciado da conta de usuário de pesquisa, que pode pesquisar detalhes do usuário sobre autenticação. string
serviceUserPassword Senha do usuário de pesquisa. string

Certificado

Name Descrição Valor
Pem Chave pública formatada em PEM. string

CassandraError

Name Descrição Valor
additionalErrorInfo Informações adicionais sobre o erro. string
code O código de erro que ocorreu. string
message A mensagem do erro. string
destino O recurso de destino do erro. string

Definição de recurso do Terraform (provedor de AzAPI)

O tipo de recurso cassandraClusters/dataCenters pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.DocumentDB/cassandraClusters/dataCenters, adicione o Terraform a seguir ao modelo.

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

cassandraClusters/dataCenters

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-03-15"
name O nome do recurso cadeia de caracteres (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: cassandraClusters
properties Propriedades de um data center gerenciado do Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Name Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esse recurso está em visualização. AuthenticationMethodLdapProperties
availabilityZone Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao Conjunto de Dimensionamento de Máquinas Virtuais que hospedam as máquinas virtuais do data center do Cassandra. bool
backupStorageCustomerKeyUri Indica o URI de chave da chave do cliente a ser usada para criptografia da conta de armazenamento de backup. string
base64EncodedCassandraYamlFragment Um fragmento de um arquivo de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste data center. O fragmento deve ser codificado em Base64 e apenas um subconjunto de chaves é permitido. string
dataCenterLocation A região em que esse data center deve ser criado. string
Desalocado Se o data center foi desalocado. bool
delegatedSubnetId ID de recurso de uma sub-rede à qual os nós neste data center devem ter seus adaptadores de rede conectados. A sub-rede deve estar na mesma região especificada em 'dataCenterLocation' e deve ser capaz de rotear para a sub-rede especificada na propriedade 'delegatedManagementSubnetId' do cluster. Essa ID de recurso será do formato '/subscriptions/{id da assinatura}/resourceGroups/{grupo de recursos}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. string
diskCapacity Número de discos anexados a cada nó. O padrão é 4. INT
diskSku SKU de disco usado para data centers. O valor padrão é P30. string
managedDiskCustomerKeyUri URI de chave a ser usado para criptografia de discos gerenciados. Verifique se a identidade atribuída pelo sistema do cluster recebeu permissões apropriadas (permissões get/wrap/unwrap de chave) na chave. string
nodeCount O número de nós que o data center deve ter. Esse é o número desejado. Depois de definido, pode levar algum tempo para que o data center seja dimensionado para corresponder. Para monitorar o número de nós e seu status, use o método fetchNodeStatus no cluster. INT
provisionError Erro relacionado ao provisionamento de recursos. CassandraError
provisioningState O status do recurso no momento em que a operação foi chamada. "Cancelado"
"Criando"
"Excluindo"
"Falha"
"Êxito"
"Atualizando"
sku SKU de máquina virtual usada para data centers. O valor padrão é Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Name Descrição Valor
connectionTimeoutInMs Tempo limite para se conectar ao servidor LDAP em milissegundos. O padrão é 5000 ms. INT
searchBaseDistinguishedName Nome diferenciado do objeto do qual iniciar a pesquisa recursiva dos usuários. string
searchFilterTemplate Modelo a ser usado para pesquisa. O padrão é (cn=%s) em que %s será substituído pelo nome de usuário usado para fazer logon. string
serverCertificates Certificate[]
serverHostname Nome do host do servidor LDAP. string
Serverport Porta do servidor LDAP. INT
serviceUserDistinguishedName Nome diferenciado da conta de usuário de pesquisa, que pode pesquisar detalhes do usuário sobre autenticação. string
serviceUserPassword Senha do usuário de pesquisa. string

Certificado

Name Descrição Valor
Pem Chave pública formatada em PEM. string

CassandraError

Name Descrição Valor
additionalErrorInfo Informações adicionais sobre o erro. string
code O código de erro que ocorreu. string
message A mensagem do erro. string
destino O recurso de destino do erro. string