Microsoft.DocumentDB cassandraClusters/dataCenters 2021-03-01-preview

  • Artigo

Definição de recurso do Bicep

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 Bicep ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    base64EncodedCassandraYamlFragment: 'string'
    dataCenterLocation: 'string'
    delegatedSubnetId: 'string'
    nodeCount: int
    provisioningState: '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ó tem 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
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
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"

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": "2021-03-01-preview",
  "name": "string",
  "properties": {
    "base64EncodedCassandraYamlFragment": "string",
    "dataCenterLocation": "string",
    "delegatedSubnetId": "string",
    "nodeCount": "int",
    "provisioningState": "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 '2021-03-01-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
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
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"

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@2021-03-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      base64EncodedCassandraYamlFragment = "string"
      dataCenterLocation = "string"
      delegatedSubnetId = "string"
      nodeCount = int
      provisioningState = "string"
    }
  })
}

Valores de propriedade

cassandraClusters/dataCenters

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters/dataCenters@2021-03-01-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
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
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"
"Falhou"
"Com êxito"
"A atualizar"