Compartilhar via

CassandraClusters 2023-09-15 do Microsoft.DocumentDB

  • Artigo

Definição de recurso do Bicep

O tipo de recurso cassandraClusters 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, adicione o seguinte Bicep ao modelo.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
  }
  properties: {
    authenticationMethod: 'string'
    cassandraAuditLoggingEnabled: bool
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    deallocated: bool
    delegatedManagementSubnetId: 'string'
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: 'string'
    }
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    repairEnabled: bool
    restoreFromBackupId: 'string'
  }
}

Valores de propriedade

cassandraClusters

Name Descrição Valor
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). No máximo 15 marcas podem ser fornecidas para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Consulte Marcas em modelos
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
properties Propriedades de um cluster do Cassandra gerenciado. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name Descrição Valor
tipo Tipo do recurso. 'None'
'SystemAssigned'

ClusterResourceProperties

Name Descrição Valor
Authenticationmethod Qual método de autenticação o Cassandra deve usar para autenticar clientes. 'None' desativa a autenticação, portanto, não deve ser usado, exceto em emergências. 'Cassandra' é a autenticação baseada em senha padrão. O padrão é 'Cassandra'. 'Cassandra'
'Ldap'
'None'
cassandraAuditLoggingEnabled Se o log de auditoria do Cassandra está habilitado bool
cassandraVersion Qual versão do Cassandra esse cluster deve convergir para em execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. string
clientCertificates Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são TLS criptografadas se clientCertificates está definido ou não, mas se clientCertificates estiver definido, o cluster do Cassandra gerenciado rejeitará todas as conexões que não têm um certificado de cliente TLS que pode ser validado de um ou mais certificados públicos nesta propriedade. Certificado[]
clusterNameOverride Se você precisar definir a propriedade clusterName em cassandra.yaml como algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade. string
Desalocado Se o cluster e os data centers associados foram desalocados. bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter seu adaptador de rede anexado. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. A ID do recurso deve estar no formato '/subscriptions/{id da assinatura}/resourceGroups/{grupo de recursos}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' string
externalGossipCertificates Lista de certificados TLS usados para autorizar fofocas de data centers não gerenciados. Os certificados TLS de todos os nós em data centers não gerenciados devem ser verificáveis usando um dos certificados fornecidos nesta propriedade. Certificate[]
externalSeedNodes Lista de endereços IP de nós de semente em data centers não gerenciados. Eles serão adicionados às listas de nós de semente de todos os nós gerenciados. SeedNode[]
hoursBetweenBackups (Preterido) Número de horas de espera entre fazer um backup do cluster. INT
initialCassandraAdminPassword Senha inicial para clientes que se conectam como administradores ao cluster. Deve ser alterado após a criação do cluster. Retorna nulo em GET. Esse campo só se aplica quando o campo authenticationMethod é 'Cassandra'. string

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP em que o ponto de extremidade do Prometheus que contém dados sobre os nós gerenciados do Cassandra pode ser acessado. SeedNode
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'
repairEnabled Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdadeiro e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido em que você já está fazendo seus próprios reparos. bool
restoreFromBackupId Para criar um cluster vazio, omita esse campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina esse campo como a ID do recurso do backup. string

Certificado

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

SeedNode

Name Descrição Valor
ipAddress Endereço IP desse nó de semente. 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 pode ser implantado com operações direcionadas:

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, adicione o JSON a seguir ao modelo.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string"
  },
  "properties": {
    "authenticationMethod": "string",
    "cassandraAuditLoggingEnabled": "bool",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "deallocated": "bool",
    "delegatedManagementSubnetId": "string",
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "string"
    },
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "repairEnabled": "bool",
    "restoreFromBackupId": "string"
  }
}

Valores de propriedade

cassandraClusters

Name Descrição Valor
tipo O tipo de recurso 'Microsoft.DocumentDB/cassandraClusters'
apiVersion A versão da API do recurso '2023-09-15'
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas. Confira Marcas em modelos
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
properties Propriedades de um cluster do Cassandra gerenciado. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name Descrição Valor
tipo Tipo do recurso. 'None'
'SystemAssigned'

ClusterResourceProperties

Name Descrição Valor
Authenticationmethod Qual método de autenticação o Cassandra deve usar para autenticar clientes. 'None' desativa a autenticação, portanto, não deve ser usado, exceto em emergências. 'Cassandra' é a autenticação baseada em senha padrão. O padrão é 'Cassandra'. 'Cassandra'
'Ldap'
'None'
cassandraAuditLoggingEnabled Se o log de auditoria do Cassandra está habilitado bool
cassandraVersion Qual versão do Cassandra esse cluster deve convergir para em execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. string
clientCertificates Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são TLS criptografadas se clientCertificates está definido ou não, mas se clientCertificates estiver definido, o cluster do Cassandra gerenciado rejeitará todas as conexões que não têm um certificado de cliente TLS que pode ser validado de um ou mais certificados públicos nessa propriedade. Certificate[]
clusterNameOverride Se você precisar definir a propriedade clusterName em cassandra.yaml como algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade. string
Desalocado Se o cluster e os data centers associados foram desalocados. bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter seu adaptador de rede anexado. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. A ID do recurso deve estar no formato '/subscriptions/{id da assinatura}/resourceGroups/{grupo de recursos}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' string
externalGossipCertificates Lista de certificados TLS usados para autorizar fofocas de data centers não gerenciados. Os certificados TLS de todos os nós em data centers não gerenciados devem ser verificáveis usando um dos certificados fornecidos nesta propriedade. Certificate[]
externalSeedNodes Lista de endereços IP de nós de semente em data centers não gerenciados. Eles serão adicionados às listas de nós de semente de todos os nós gerenciados. SeedNode[]
hoursBetweenBackups (Preterido) Número de horas de espera entre fazer um backup do cluster. INT
initialCassandraAdminPassword Senha inicial para clientes que se conectam como administradores ao cluster. Deve ser alterado após a criação do cluster. Retorna nulo em GET. Esse campo só se aplica quando o campo authenticationMethod é 'Cassandra'. string

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP em que o ponto de extremidade do Prometheus que contém dados sobre os nós gerenciados do Cassandra pode ser acessado. SeedNode
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'
repairEnabled Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdadeiro e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido em que você já está fazendo seus próprios reparos. bool
restoreFromBackupId Para criar um cluster vazio, omita esse campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina esse campo como a ID do recurso do backup. string

Certificado

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

SeedNode

Name Descrição Valor
ipAddress Endereço IP desse nó de semente. 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 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, adicione o Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      cassandraAuditLoggingEnabled = bool
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      deallocated = bool
      delegatedManagementSubnetId = "string"
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

Valores de propriedade

cassandraClusters

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters@2023-09-15"
name O nome do recurso cadeia de caracteres (obrigatório)
local O local do grupo de recursos ao qual o recurso pertence. string
parent_id Para implantar em um grupo de recursos, use a ID desse grupo de recursos. cadeia de caracteres (obrigatório)
marcas As marcas são uma lista de pares chave-valor que descrevem o recurso. Essas marcas podem ser usadas para exibir e agrupar esse recurso (entre grupos de recursos). Um máximo de 15 marcas pode ser fornecido para um recurso. Cada marca deve ter uma chave com no máximo 128 caracteres e um valor com no máximo 256 caracteres. Por exemplo, a experiência padrão para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais de "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de marcas.
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
properties Propriedades de um cluster do Cassandra gerenciado. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Name Descrição Valor
tipo Tipo do recurso. "SystemAssigned"

ClusterResourceProperties

Name Descrição Valor
Authenticationmethod Qual método de autenticação o Cassandra deve usar para autenticar clientes. 'None' desativa a autenticação, portanto, não deve ser usado, exceto em emergências. 'Cassandra' é a autenticação baseada em senha padrão. O padrão é 'Cassandra'. "Cassandra"
"Ldap"
"None"
cassandraAuditLoggingEnabled Se o log de auditoria do Cassandra está habilitado bool
cassandraVersion Qual versão do Cassandra esse cluster deve convergir para em execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. string
clientCertificates Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são TLS criptografadas se clientCertificates está definido ou não, mas se clientCertificates estiver definido, o cluster do Cassandra gerenciado rejeitará todas as conexões que não têm um certificado de cliente TLS que pode ser validado de um ou mais certificados públicos nessa propriedade. Certificate[]
clusterNameOverride Se você precisar definir a propriedade clusterName em cassandra.yaml como algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade. string
Desalocado Se o cluster e os data centers associados foram desalocados. bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter seu adaptador de rede anexado. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. A ID do recurso deve ser do formulário '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}' string
externalGossipCertificates Lista de certificados TLS usados para autorizar fofocas de data centers não gerenciados. Os certificados TLS de todos os nós em data centers não gerenciados devem ser verificáveis usando um dos certificados fornecidos nesta propriedade. Certificado[]
externalSeedNodes Lista de endereços IP de nós de semente em data centers não gerenciados. Elas serão adicionadas às listas de nós de semente de todos os nós gerenciados. SeedNode[]
hoursBetweenBackups (Preterido) Número de horas de espera entre fazer um backup do cluster. INT
initialCassandraAdminPassword Senha inicial para clientes que se conectam como administradores ao cluster. Deve ser alterado após a criação do cluster. Retorna nulo em GET. Esse campo só se aplica quando o campo authenticationMethod é 'Cassandra'. string

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP em que o ponto de extremidade do Prometheus que contém dados sobre os nós gerenciados do Cassandra pode ser acessado. SeedNode
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"
repairEnabled Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdadeiro e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido em que já está fazendo seus próprios reparos. bool
restoreFromBackupId Para criar um cluster vazio, omita esse campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina esse campo como a ID do recurso do backup. string

Certificado

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

SeedNode

Name Descrição Valor
ipAddress Endereço IP deste nó de semente. 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