Compartilhar via

Microsoft.DocumentDB cassandraClusters/dataCenters 2024-09-01-preview

  • 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 de log de alterações.

Formato de recurso

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

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

Valores de propriedade

AuthenticationMethodLdapProperties

Nome 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. corda
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. corda
serverCertificates de Certificado []
serverHostname Nome do host do servidor LDAP. corda
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. corda
serviceUserPassword Senha do usuário de pesquisa. corda

CassandraError

Nome Descrição Valor
additionalErrorInfo Informações adicionais sobre o erro. corda
código O código de erro que ocorreu. corda
Mensagem A mensagem do erro. corda
alvo O recurso de destino do erro. corda

Certificado

Nome Descrição Valor
Pem Chave pública formatada em PEM. corda

DataCenterResourceProperties

Nome Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esse recurso está em versão prévia. AuthenticationMethodLdapProperties
availabilityZone Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao ScaleSet de Máquina Virtual que hospeda as máquinas virtuais do data center do Cassandra. Bool
backupStorageCustomerKeyUri Indica o Uri de chave da chave do cliente a ser usado para criptografia da conta de armazenamento de backup. corda
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 somente um subconjunto de chaves é permitido. corda
dataCenterLocation A região em que esse data center deve ser criado. corda
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/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>'. corda
diskCapacity Número de discos anexados a cada nó. O padrão é 4. int
diskSku SKU de disco usada para data centers. O valor padrão é P30. corda
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 de obter/encapsular/desembrulhar chave) na chave. corda
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
privateEndpointIpAddress Ip do ponto de extremidade VPN para este data center. corda
provisionError Erro relacionado ao provisionamento de recursos. do CassandraError
provisioningState O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criando'
'Excluindo'
'Falha'
'Bem-sucedido'
'Atualizando'
Sku SKU de máquina virtual usada para data centers. O valor padrão é Standard_DS14_v2 corda

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (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
Propriedades Propriedades de um data center do Cassandra gerenciado. DataCenterResourceProperties

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 de log de alterações.

Formato de recurso

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

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

Valores de propriedade

AuthenticationMethodLdapProperties

Nome 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. corda
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. corda
serverCertificates de Certificado []
serverHostname Nome do host do servidor LDAP. corda
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. corda
serviceUserPassword Senha do usuário de pesquisa. corda

CassandraError

Nome Descrição Valor
additionalErrorInfo Informações adicionais sobre o erro. corda
código O código de erro que ocorreu. corda
Mensagem A mensagem do erro. corda
alvo O recurso de destino do erro. corda

Certificado

Nome Descrição Valor
Pem Chave pública formatada em PEM. corda

DataCenterResourceProperties

Nome Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esse recurso está em versão prévia. AuthenticationMethodLdapProperties
availabilityZone Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao ScaleSet de Máquina Virtual que hospeda as máquinas virtuais do data center do Cassandra. Bool
backupStorageCustomerKeyUri Indica o Uri de chave da chave do cliente a ser usado para criptografia da conta de armazenamento de backup. corda
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 somente um subconjunto de chaves é permitido. corda
dataCenterLocation A região em que esse data center deve ser criado. corda
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/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>'. corda
diskCapacity Número de discos anexados a cada nó. O padrão é 4. int
diskSku SKU de disco usada para data centers. O valor padrão é P30. corda
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 de obter/encapsular/desembrulhar chave) na chave. corda
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
privateEndpointIpAddress Ip do ponto de extremidade VPN para este data center. corda
provisionError Erro relacionado ao provisionamento de recursos. do CassandraError
provisioningState O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criando'
'Excluindo'
'Falha'
'Bem-sucedido'
'Atualizando'
Sku SKU de máquina virtual usada para data centers. O valor padrão é Standard_DS14_v2 corda

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nome Descrição Valor
apiVersion A versão da API '2024-09-01-preview'
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obrigatório)
Propriedades Propriedades de um data center do Cassandra gerenciado. DataCenterResourceProperties
tipo O tipo de recurso 'Microsoft.DocumentDB/cassandraClusters/dataCenters'

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 de propriedades alteradas em cada versão da API, consulte de log de alterações.

Formato de recurso

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

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

Valores de propriedade

AuthenticationMethodLdapProperties

Nome 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. corda
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. corda
serverCertificates de Certificado []
serverHostname Nome do host do servidor LDAP. corda
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. corda
serviceUserPassword Senha do usuário de pesquisa. corda

CassandraError

Nome Descrição Valor
additionalErrorInfo Informações adicionais sobre o erro. corda
código O código de erro que ocorreu. corda
Mensagem A mensagem do erro. corda
alvo O recurso de destino do erro. corda

Certificado

Nome Descrição Valor
Pem Chave pública formatada em PEM. corda

DataCenterResourceProperties

Nome Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esse recurso está em versão prévia. AuthenticationMethodLdapProperties
availabilityZone Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao ScaleSet de Máquina Virtual que hospeda as máquinas virtuais do data center do Cassandra. Bool
backupStorageCustomerKeyUri Indica o Uri de chave da chave do cliente a ser usado para criptografia da conta de armazenamento de backup. corda
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 somente um subconjunto de chaves é permitido. corda
dataCenterLocation A região em que esse data center deve ser criado. corda
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/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>'. corda
diskCapacity Número de discos anexados a cada nó. O padrão é 4. int
diskSku SKU de disco usada para data centers. O valor padrão é P30. corda
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 de obter/encapsular/desembrulhar chave) na chave. corda
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
privateEndpointIpAddress Ip do ponto de extremidade VPN para este data center. corda
provisionError Erro relacionado ao provisionamento de recursos. do CassandraError
provisioningState O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criando'
'Excluindo'
'Falha'
'Bem-sucedido'
'Atualizando'
Sku SKU de máquina virtual usada para data centers. O valor padrão é Standard_DS14_v2 corda

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Padrão = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: cassandraClusters
Propriedades Propriedades de um data center do Cassandra gerenciado. DataCenterResourceProperties
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-09-01-preview"