Partilhar via

Microsoft.DocumentDB cassandraClusters

  • Artigo

Definição de recursos do bíceps

O tipo de recurso cassandraClusters pode ser implantado com operações que visam:

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

Formato do recurso

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2024-12-01-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authenticationMethod: 'string'
    autoReplicate: 'string'
    azureConnectionMethod: 'string'
    backupSchedules: [
      {
        cronExpression: 'string'
        retentionInHours: int
        scheduleName: 'string'
      }
    ]
    cassandraAuditLoggingEnabled: bool
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    clusterType: 'string'
    deallocated: bool
    delegatedManagementSubnetId: 'string'
    extensions: [
      'string'
    ]
    externalDataCenters: [
      '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'
    scheduledEventStrategy: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

BackupSchedule

Designação Descrição Valor
cronExpressão A expressão cron que define quando você deseja fazer backup de seus dados. string
retençãoInHours O período de retenção (horas) dos backups. Se quiser reter dados para sempre, defina a retenção como 0. Int
nome_da_agenda O identificador exclusivo do agendamento de backup. string

CassandraErro

Designação Descrição Valor
adicionalErrorInfo Informações adicionais sobre o erro. string
código O código de erro que ocorreu. string
Mensagem A mensagem do erro. string
público-alvo O recurso de destino do erro. string

Certidão

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

ClusterResourceProperties

Designação Descrição Valor
authenticationMethod Qual método de autenticação Cassandra deve usar para autenticar clientes. 'Nenhum' desativa a autenticação, por isso não deve ser usado exceto em emergências. 'Cassandra' é a autenticação padrão baseada em senha. O padrão é 'Cassandra'. 'Cassandra'
'Ldap'
'Nenhuma'
autoReplicar A forma de AutoReplicate que está sendo usada por esse cluster. 'AllKeyspaces'
'Nenhuma'
'SystemKeyspaces'
azureConnectionMethod Como conectar-se aos serviços azure necessários para executar o cluster 'Nenhuma'
'VPN'
backupAgendas Lista de agendamentos de backup que definem quando você deseja fazer backup de seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o log de auditoria Cassandra está habilitado Bool
cassandraVersão Qual versão do Cassandra esse cluster deve convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. string
clientCertificados Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas TLS, quer clientCertificates esteja definida ou não, mas se clientCertificates estiver definido, o cluster Cassandra gerenciado rejeitará todas as conexões que não possuam um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nessa propriedade. Certificado[]
clusterNameOverride Se você precisar definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade. string
tipo de cluster Tipo de cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster. 'Não produção'
'Produção'
desafetada Se o cluster e os data centers associados foram deslocalizados. Bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter sua interface de rede conectada. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. O id do recurso deve ser do formato '/subscriptions/<ID de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<rede virtual>/subnets/<sub-rede>' string
Extensões Extensões a serem adicionadas ou atualizadas no cluster. string[]
externalDataCenters Lista dos nomes de data center para data centers não gerenciados neste cluster a serem incluídos na replicação automática. string[]
externalGossipCertificados 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 propagação em centros de dados não geridos. Eles serão adicionados às listas de nós de propagação de todos os nós gerenciados. SeedNode[]
horasEntreBackups (Preterido) Número de horas de espera entre a realização de um backup do cluster. Int
inicialCassandraAdminPassword Senha inicial para clientes que se conectam como administrador ao cluster. Deve ser alterado após a criação do cluster. Retorna null em GET. Este campo só se aplica quando o campo authenticationMethod é 'Cassandra'. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP onde o ponto de extremidade Prometheus contendo dados sobre os nós Cassandra gerenciados pode ser alcançado. SeedNode
provisionError Erro relacionado ao provisionamento de recursos. CassandraError
provisionamentoEstado O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'
repairEnabled Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdade e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido onde já esteja fazendo seus próprios reparos. Bool
restoreFromBackupId Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina este campo como a id de recurso do backup. string
agendadoEventStrategy Como os nós no cluster reagem a eventos agendados 'Ignorar'
'StopAny'
'StopByRack'

ManagedCassandraManagedServiceIdentity

Designação Descrição Valor
tipo O tipo do recurso. 'Nenhuma'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Designação Descrição Valor
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string

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 cluster Cassandra gerenciado. ClusterResourceProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos

SeedNode

Designação Descrição Valor
Endereço IP Endereço IP deste nó semente. string

Etiquetas

Designação Descrição Valor

Definição de recurso de modelo ARM

O tipo de recurso cassandraClusters pode ser implantado com operações que visam:

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

Formato do recurso

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2024-12-01-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authenticationMethod": "string",
    "autoReplicate": "string",
    "azureConnectionMethod": "string",
    "backupSchedules": [
      {
        "cronExpression": "string",
        "retentionInHours": "int",
        "scheduleName": "string"
      }
    ],
    "cassandraAuditLoggingEnabled": "bool",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "clusterType": "string",
    "deallocated": "bool",
    "delegatedManagementSubnetId": "string",
    "extensions": [ "string" ],
    "externalDataCenters": [ "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",
    "scheduledEventStrategy": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

BackupSchedule

Designação Descrição Valor
cronExpressão A expressão cron que define quando você deseja fazer backup de seus dados. string
retençãoInHours O período de retenção (horas) dos backups. Se quiser reter dados para sempre, defina a retenção como 0. Int
nome_da_agenda O identificador exclusivo do agendamento de backup. string

CassandraErro

Designação Descrição Valor
adicionalErrorInfo Informações adicionais sobre o erro. string
código O código de erro que ocorreu. string
Mensagem A mensagem do erro. string
público-alvo O recurso de destino do erro. string

Certidão

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

ClusterResourceProperties

Designação Descrição Valor
authenticationMethod Qual método de autenticação Cassandra deve usar para autenticar clientes. 'Nenhum' desativa a autenticação, por isso não deve ser usado exceto em emergências. 'Cassandra' é a autenticação padrão baseada em senha. O padrão é 'Cassandra'. 'Cassandra'
'Ldap'
'Nenhuma'
autoReplicar A forma de AutoReplicate que está sendo usada por esse cluster. 'AllKeyspaces'
'Nenhuma'
'SystemKeyspaces'
azureConnectionMethod Como conectar-se aos serviços azure necessários para executar o cluster 'Nenhuma'
'VPN'
backupAgendas Lista de agendamentos de backup que definem quando você deseja fazer backup de seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o log de auditoria Cassandra está habilitado Bool
cassandraVersão Qual versão do Cassandra esse cluster deve convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. string
clientCertificados Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas TLS, quer clientCertificates esteja definida ou não, mas se clientCertificates estiver definido, o cluster Cassandra gerenciado rejeitará todas as conexões que não possuam um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nessa propriedade. Certificado[]
clusterNameOverride Se você precisar definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade. string
tipo de cluster Tipo de cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster. 'Não produção'
'Produção'
desafetada Se o cluster e os data centers associados foram deslocalizados. Bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter sua interface de rede conectada. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. O id do recurso deve ser do formato '/subscriptions/<ID de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<rede virtual>/subnets/<sub-rede>' string
Extensões Extensões a serem adicionadas ou atualizadas no cluster. string[]
externalDataCenters Lista dos nomes de data center para data centers não gerenciados neste cluster a serem incluídos na replicação automática. string[]
externalGossipCertificados 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 propagação em centros de dados não geridos. Eles serão adicionados às listas de nós de propagação de todos os nós gerenciados. SeedNode[]
horasEntreBackups (Preterido) Número de horas de espera entre a realização de um backup do cluster. Int
inicialCassandraAdminPassword Senha inicial para clientes que se conectam como administrador ao cluster. Deve ser alterado após a criação do cluster. Retorna null em GET. Este campo só se aplica quando o campo authenticationMethod é 'Cassandra'. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP onde o ponto de extremidade Prometheus contendo dados sobre os nós Cassandra gerenciados pode ser alcançado. SeedNode
provisionError Erro relacionado ao provisionamento de recursos. CassandraError
provisionamentoEstado O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'
repairEnabled Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdade e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido onde já esteja fazendo seus próprios reparos. Bool
restoreFromBackupId Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina este campo como a id de recurso do backup. string
agendadoEventStrategy Como os nós no cluster reagem a eventos agendados 'Ignorar'
'StopAny'
'StopByRack'

ManagedCassandraManagedServiceIdentity

Designação Descrição Valor
tipo O tipo do recurso. 'Nenhuma'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Designação Descrição Valor
apiVersion A versão api '2024-12-01-pré-visualização'
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string

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 cluster Cassandra gerenciado. ClusterResourceProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags. Consulte Tags em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/cassandraClusters'

SeedNode

Designação Descrição Valor
Endereço IP Endereço IP deste nó semente. string

Etiquetas

Designação Descrição Valor

Definição de recursos Terraform (provedor AzAPI)

O tipo de recurso cassandraClusters pode ser implantado com operações que visam:

  • Grupos de recursos

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

Formato do recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2024-12-01-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      autoReplicate = "string"
      azureConnectionMethod = "string"
      backupSchedules = [
        {
          cronExpression = "string"
          retentionInHours = int
          scheduleName = "string"
        }
      ]
      cassandraAuditLoggingEnabled = bool
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      clusterType = "string"
      deallocated = bool
      delegatedManagementSubnetId = "string"
      extensions = [
        "string"
      ]
      externalDataCenters = [
        "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"
      scheduledEventStrategy = "string"
    }
  })
}

Valores de propriedade

BackupSchedule

Designação Descrição Valor
cronExpressão A expressão cron que define quando você deseja fazer backup de seus dados. string
retençãoInHours O período de retenção (horas) dos backups. Se quiser reter dados para sempre, defina a retenção como 0. Int
nome_da_agenda O identificador exclusivo do agendamento de backup. string

CassandraErro

Designação Descrição Valor
adicionalErrorInfo Informações adicionais sobre o erro. string
código O código de erro que ocorreu. string
Mensagem A mensagem do erro. string
público-alvo O recurso de destino do erro. string

Certidão

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

ClusterResourceProperties

Designação Descrição Valor
authenticationMethod Qual método de autenticação Cassandra deve usar para autenticar clientes. 'Nenhum' desativa a autenticação, por isso não deve ser usado exceto em emergências. 'Cassandra' é a autenticação padrão baseada em senha. O padrão é 'Cassandra'. 'Cassandra'
'Ldap'
'Nenhuma'
autoReplicar A forma de AutoReplicate que está sendo usada por esse cluster. 'AllKeyspaces'
'Nenhuma'
'SystemKeyspaces'
azureConnectionMethod Como conectar-se aos serviços azure necessários para executar o cluster 'Nenhuma'
'VPN'
backupAgendas Lista de agendamentos de backup que definem quando você deseja fazer backup de seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o log de auditoria Cassandra está habilitado Bool
cassandraVersão Qual versão do Cassandra esse cluster deve convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. string
clientCertificados Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas TLS, quer clientCertificates esteja definida ou não, mas se clientCertificates estiver definido, o cluster Cassandra gerenciado rejeitará todas as conexões que não possuam um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nessa propriedade. Certificado[]
clusterNameOverride Se você precisar definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a ser usado nessa propriedade. string
tipo de cluster Tipo de cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster. 'Não produção'
'Produção'
desafetada Se o cluster e os data centers associados foram deslocalizados. Bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gerenciamento desse cluster deve ter sua interface de rede conectada. A sub-rede deve ser roteável para todas as sub-redes que serão delegadas aos data centers. O id do recurso deve ser do formato '/subscriptions/<ID de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<rede virtual>/subnets/<sub-rede>' string
Extensões Extensões a serem adicionadas ou atualizadas no cluster. string[]
externalDataCenters Lista dos nomes de data center para data centers não gerenciados neste cluster a serem incluídos na replicação automática. string[]
externalGossipCertificados 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 propagação em centros de dados não geridos. Eles serão adicionados às listas de nós de propagação de todos os nós gerenciados. SeedNode[]
horasEntreBackups (Preterido) Número de horas de espera entre a realização de um backup do cluster. Int
inicialCassandraAdminPassword Senha inicial para clientes que se conectam como administrador ao cluster. Deve ser alterado após a criação do cluster. Retorna null em GET. Este campo só se aplica quando o campo authenticationMethod é 'Cassandra'. string

Restrições:
Valor sensível. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP onde o ponto de extremidade Prometheus contendo dados sobre os nós Cassandra gerenciados pode ser alcançado. SeedNode
provisionError Erro relacionado ao provisionamento de recursos. CassandraError
provisionamentoEstado O status do recurso no momento em que a operação foi chamada. 'Cancelado'
'Criar'
'Eliminação'
'Falhou'
'Conseguiu'
'Atualização'
repairEnabled Os reparos automáticos devem ser executados neste cluster? Se omitido, isso é verdade e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido onde já esteja fazendo seus próprios reparos. Bool
restoreFromBackupId Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar um backup em um novo cluster, defina este campo como a id de recurso do backup. string
agendadoEventStrategy Como os nós no cluster reagem a eventos agendados 'Ignorar'
'StopAny'
'StopByRack'

ManagedCassandraManagedServiceIdentity

Designação Descrição Valor
tipo O tipo do recurso. 'Nenhuma'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Designação Descrição Valor
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
Localização O local do grupo de recursos ao qual o recurso pertence. string
Designação O nome do recurso string

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 cluster Cassandra gerenciado. ClusterResourceProperties
Etiquetas Tags de recursos Dicionário de nomes e valores de tags.
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters@2024-12-01-preview"

SeedNode

Designação Descrição Valor
Endereço IP Endereço IP deste nó semente. string

Etiquetas

Designação Descrição Valor