CassandraClusters/dataCenters Microsoft.DocumentDB 2022-11-15-preview

  • Artigo

Definição de recurso do Bicep

O tipo de recurso cassandraClusters/dataCenters pode ser implementado com operações que visam:

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

Formato do recurso

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-11-15-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    authenticationMethodLdapProperties: {
      searchBaseDistinguishedName: 'string'
      searchFilterTemplate: 'string'
      serverCertificates: [
        {
          pem: 'string'
        }
      ]
      serverHostname: 'string'
      serverPort: int
      serviceUserDistinguishedName: 'string'
      serviceUserPassword: 'string'
    }
    availabilityZone: bool
    backupStorageCustomerKeyUri: 'string'
    base64EncodedCassandraYamlFragment: 'string'
    dataCenterLocation: 'string'
    delegatedSubnetId: 'string'
    diskCapacity: int
    diskSku: 'string'
    managedDiskCustomerKeyUri: 'string'
    nodeCount: int
    provisioningState: 'string'
    sku: 'string'
  }
}

Valores de propriedade

cassandraClusters/dataCenters

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados no Bicep.		 cadeia (obrigatório)
principal No Bicep, pode especificar o recurso principal de um recurso subordinado. Só precisa de adicionar esta propriedade quando o recurso subordinado for declarado fora do recurso principal.

Para obter mais informações, veja Recurso subordinado fora do recurso principal.		 Nome simbólico para recurso do tipo: cassandraClusters
propriedades Propriedades de um datacenter do Cassandra gerido. DataCenterResourceProperties

DataCenterResourceProperties

Nome Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esta funcionalidade está em pré-visualização. AuthenticationMethodLdapProperties
availabilityZone Se o datacenter tiver a funcionalidade Zona de Disponibilidade, aplique-a ao Conjunto de Dimensionamento de Máquinas Virtuais que aloja as máquinas virtuais do centro de dados cassandra. bool
backupStorageCustomerKeyUri Indica o Uri de Chave da chave de cliente a utilizar para encriptação da conta de armazenamento de cópias de segurança. string
base64EncodedCassandraYamlFragment Um fragmento de um ficheiro de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste datacenter. O fragmento deve ser codificado com Base64 e só é permitido um subconjunto de chaves. string
dataCenterLocation A região onde este datacenter deve ser criado. string
delegatedSubnetId ID de recurso de uma sub-rede a que os nós neste datacenter devem ter as respetivas interfaces de rede ligadas. A sub-rede tem de estar na mesma região especificada em "dataCenterLocation" e tem de ser capaz de encaminhar para a sub-rede especificada na propriedade "delegatedManagementSubnetId" do cluster. Este 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 disco utilizado para datacenters. O valor predefinido é 4. int
diskSku SKU de disco utilizado para datacenters. O valor predefinido é P30. string
managedDiskCustomerKeyUri URI de chave a utilizar para encriptação de discos geridos. Certifique-se de que a identidade atribuída pelo sistema do cluster foi atribuída às permissões adequadas (permissões de obtenção/moldagem/desembrulhar chave) na chave. string
nodeCount O número de nós que o datacenter deve ter. Este é o número pretendido. Depois de definido, pode demorar algum tempo até que o datacenter seja dimensionado para corresponder. Para monitorizar o número de nós e o respetivo estado, utilize o método fetchNodeStatus no cluster. int
provisioningState O estado do recurso no momento em que a operação foi chamada. "Cancelado"
"A criar"
"A eliminar"
"Falha"
"Com êxito"
"A atualizar"
sku SKU de Máquina Virtual utilizado para datacenters. O valor predefinido é Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nome Descrição Valor
searchBaseDistinguishedName Nome único do objeto a partir do qual iniciar a pesquisa recursiva de utilizadores. string
searchFilterTemplate Modelo a utilizar para procurar. A predefinição é (cn=%s) em que %s será substituído pelo nome de utilizador utilizado para iniciar sessão. string
serverCertificates Certificado[]
serverHostname Nome do anfitrião do servidor LDAP. string
serverPort Porta do servidor LDAP. int
serviceUserDistinguishedName Nome único da conta de utilizador de pesquisa, que pode procurar detalhes do utilizador sobre a autenticação. string
serviceUserPassword Palavra-passe do utilizador de pesquisa. string

Certificado

Nome Descrição Valor
pem Chave pública formatada PEM. string

Definição de recurso do modelo arm

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

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

Formato do recurso

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2022-11-15-preview",
  "name": "string",
  "properties": {
    "authenticationMethodLdapProperties": {
      "searchBaseDistinguishedName": "string",
      "searchFilterTemplate": "string",
      "serverCertificates": [
        {
          "pem": "string"
        }
      ],
      "serverHostname": "string",
      "serverPort": "int",
      "serviceUserDistinguishedName": "string",
      "serviceUserPassword": "string"
    },
    "availabilityZone": "bool",
    "backupStorageCustomerKeyUri": "string",
    "base64EncodedCassandraYamlFragment": "string",
    "dataCenterLocation": "string",
    "delegatedSubnetId": "string",
    "diskCapacity": "int",
    "diskSku": "string",
    "managedDiskCustomerKeyUri": "string",
    "nodeCount": "int",
    "provisioningState": "string",
    "sku": "string"
  }
}

Valores de propriedade

cassandraClusters/dataCenters

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters"
apiVersion A versão da API de recursos '2022-11-15-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos subordinados em modelos arm JSON.		 cadeia (obrigatório)
propriedades Propriedades de um datacenter do Cassandra gerido. DataCenterResourceProperties

DataCenterResourceProperties

Nome Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esta funcionalidade está em pré-visualização. AuthenticationMethodLdapProperties
availabilityZone Se o datacenter tiver a funcionalidade Zona de Disponibilidade, aplique-a ao Conjunto de Dimensionamento de Máquinas Virtuais que aloja as máquinas virtuais do datacenter do cassandra. bool
backupStorageCustomerKeyUri Indica o Uri de Chave da chave do cliente a utilizar para encriptação da conta de armazenamento de cópias de segurança. string
base64EncodedCassandraYamlFragment Um fragmento de um ficheiro de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste datacenter. O fragmento deve ser codificado em Base64 e só é permitido um subconjunto de chaves. string
dataCenterLocation A região em que este datacenter deve ser criado. string
delegatedSubnetId ID de recurso de uma sub-rede a que os nós neste datacenter devem ter as respetivas interfaces de rede ligadas. A sub-rede tem de estar na mesma região especificada em "dataCenterLocation" e tem de ser capaz de encaminhar para a sub-rede especificada na propriedade "delegatedManagementSubnetId" do cluster. Este 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 utilizados para datacenters. O valor predefinido é 4. int
diskSku SKU de disco utilizado para datacenters. O valor predefinido é P30. string
managedDiskCustomerKeyUri URI de chave a utilizar para encriptação de discos geridos. Certifique-se de que a identidade atribuída pelo sistema do cluster foi atribuída às permissões adequadas (permissões de obtenção/moldagem/anulação de moldagem da chave) na chave. string
nodeCount O número de nós que o datacenter deve ter. Este é o número pretendido. Depois de definido, pode demorar algum tempo até que o datacenter seja dimensionado para corresponder. Para monitorizar o número de nós e o respetivo estado, utilize o método fetchNodeStatus no cluster. int
provisioningState O estado do recurso no momento em que a operação foi chamada. "Cancelado"
"A criar"
"A eliminar"
"Com falhas"
"Com êxito"
"A atualizar"
sku SKU de Máquina Virtual utilizado para datacenters. O valor predefinido é Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nome Descrição Valor
searchBaseDistinguishedName Nome único do objeto a partir do qual iniciar a pesquisa recursiva de utilizadores. string
searchFilterTemplate Modelo a utilizar para procurar. A predefinição é (cn=%s) em que %s será substituído pelo nome de utilizador utilizado para iniciar sessão. string
serverCertificates Certificado[]
serverHostname Nome do anfitrião do servidor LDAP. string
serverPort Porta do servidor LDAP. int
serviceUserDistinguishedName Nome único da conta de utilizador de pesquisa, que pode procurar detalhes do utilizador sobre a autenticação. string
serviceUserPassword Palavra-passe do utilizador de pesquisa. string

Certificado

Nome Descrição Valor
pem Chave pública formatada PEM. string

Definição de recurso terraform (fornecedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-11-15-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      authenticationMethodLdapProperties = {
        searchBaseDistinguishedName = "string"
        searchFilterTemplate = "string"
        serverCertificates = [
          {
            pem = "string"
          }
        ]
        serverHostname = "string"
        serverPort = int
        serviceUserDistinguishedName = "string"
        serviceUserPassword = "string"
      }
      availabilityZone = bool
      backupStorageCustomerKeyUri = "string"
      base64EncodedCassandraYamlFragment = "string"
      dataCenterLocation = "string"
      delegatedSubnetId = "string"
      diskCapacity = int
      diskSku = "string"
      managedDiskCustomerKeyUri = "string"
      nodeCount = int
      provisioningState = "string"
      sku = "string"
    }
  })
}

Valores de propriedade

cassandraClusters/dataCenters

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters@2022-11-15-preview"
name O nome do recurso cadeia (obrigatório)
parent_id O ID do recurso que é o principal para este recurso. ID do recurso do tipo: cassandraClusters
propriedades Propriedades de um datacenter do Cassandra gerido. DataCenterResourceProperties

DataCenterResourceProperties

Nome Descrição Valor
authenticationMethodLdapProperties Propriedades do método de autenticação Ldap. Esta funcionalidade está em pré-visualização. AuthenticationMethodLdapProperties
availabilityZone Se o datacenter tiver a funcionalidade Zona de Disponibilidade, aplique-a ao Conjunto de Dimensionamento de Máquinas Virtuais que aloja as máquinas virtuais do datacenter do cassandra. bool
backupStorageCustomerKeyUri Indica o Uri de Chave da chave do cliente a utilizar para encriptação da conta de armazenamento de cópias de segurança. string
base64EncodedCassandraYamlFragment Um fragmento de um ficheiro de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste datacenter. O fragmento deve ser codificado em Base64 e só é permitido um subconjunto de chaves. string
dataCenterLocation A região em que este datacenter deve ser criado. string
delegatedSubnetId ID de recurso de uma sub-rede a que os nós neste datacenter devem ter as respetivas interfaces de rede ligadas. A sub-rede tem de estar na mesma região especificada em "dataCenterLocation" e tem de ser capaz de encaminhar para a sub-rede especificada na propriedade "delegatedManagementSubnetId" do cluster. Este 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 disco utilizado para datacenters. O valor predefinido é 4. int
diskSku SKU de disco utilizado para datacenters. O valor predefinido é P30. string
managedDiskCustomerKeyUri URI de chave a utilizar para encriptação de discos geridos. Certifique-se de que a identidade atribuída pelo sistema do cluster foi atribuída às permissões adequadas (permissões de obtenção/moldagem/desembrulhar chave) na chave. string
nodeCount O número de nós que o datacenter deve ter. Este é o número pretendido. Depois de definido, pode demorar algum tempo até que o datacenter seja dimensionado para corresponder. Para monitorizar o número de nós e o respetivo estado, utilize o método fetchNodeStatus no cluster. int
provisioningState O estado do recurso no momento em que a operação foi chamada. "Cancelado"
"Criar"
"A eliminar"
"Falha"
"Com êxito"
"A atualizar"
sku SKU de Máquina Virtual utilizado para datacenters. O valor predefinido é Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nome Descrição Valor
searchBaseDistinguishedName Nome distinto do objeto a partir do qual iniciar a pesquisa recursiva dos utilizadores. string
searchFilterTemplate Modelo a utilizar para procurar. Predefinição para (cn=%s) em que %s será substituído pelo nome de utilizador utilizado para iniciar sessão. string
serverCertificates Certificado[]
serverHostname Nome do anfitrião do servidor LDAP. string
serverPort Porta do servidor LDAP. int
serviceUserDistinguishedName Nome distinto da conta de utilizador de pesquisa, que pode procurar detalhes do utilizador na autenticação. string
serviceUserPassword Palavra-passe do utilizador de pesquisa. string

Certificado

Nome Descrição Valor
pem Chave pública formatada PEM. string