Compartilhar via

CassandraClusters 2023-09-15-preview do Microsoft.DocumentDB

  • Artigo

Definição de recurso do Bicep

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

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

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview' = {
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    authenticationMethod: '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'
    ]
    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'
  }
  tags: {
    {customized property}: 'string'
  }
}

Valores de propriedade

BackupSchedule

Nome Descrição Valor
cronExpression A expressão cron que define quando você deseja fazer backup de seus dados. corda
retentionInHours O período de retenção (horas) dos backups. Se você quiser reter dados para sempre, defina a retenção como 0. int
scheduleName O identificador exclusivo do agendamento de backup. 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

ClusterResourceProperties

Nome 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'
backupSchedules Lista de agendamentos de backup que definem quando você deseja fazer backup de seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o log de auditoria do Cassandra está habilitado Bool
cassandraVersion Qual versão do Cassandra deve convergir para execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. corda
clientCertificates Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas por TLS 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 dos certificados públicos nessa propriedade. de 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 nesta propriedade. corda
clusterType Tipo do cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster. 'NonProduction'
'Produção'
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 sua interface de rede anexada. 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/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>' corda
Extensões Extensões a serem adicionadas ou atualizadas no cluster. 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 nessa propriedade. de Certificado []
externalSeedNodes Lista de endereços IP de nós de sementes 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 para aguardar 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 no GET. Esse campo só se aplica quando o campo authenticationMethod é 'Cassandra'. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP em que o ponto de extremidade prometheus que contém dados sobre os nós gerenciados do Cassandra pode ser acessado. seedNode
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'
repairEnabled Os reparos automáticos devem ser executados nesse cluster? Se omitido, isso é verdadeiro e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido em que já esteja 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. corda

ManagedCassandraManagedServiceIdentity

Nome Descrição Valor
tipo O tipo do recurso. 'None'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Nome Descrição Valor
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
localização O local do grupo de recursos ao qual o recurso pertence. corda
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 cluster do Cassandra gerenciado. clusterResourceProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos

SeedNode

Nome Descrição Valor
ipAddress Endereço IP deste nó de semente. corda

Tags

Nome Descrição Valor

Definição de recurso de modelo do ARM

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

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "authenticationMethod": "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" ],
    "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"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Valores de propriedade

BackupSchedule

Nome Descrição Valor
cronExpression A expressão cron que define quando você deseja fazer backup de seus dados. corda
retentionInHours O período de retenção (horas) dos backups. Se você quiser reter dados para sempre, defina a retenção como 0. int
scheduleName O identificador exclusivo do agendamento de backup. 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

ClusterResourceProperties

Nome 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'
backupSchedules Lista de agendamentos de backup que definem quando você deseja fazer backup de seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o log de auditoria do Cassandra está habilitado Bool
cassandraVersion Qual versão do Cassandra deve convergir para execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. corda
clientCertificates Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas por TLS 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 dos certificados públicos nessa propriedade. de 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 nesta propriedade. corda
clusterType Tipo do cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster. 'NonProduction'
'Produção'
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 sua interface de rede anexada. 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/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>' corda
Extensões Extensões a serem adicionadas ou atualizadas no cluster. 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 nessa propriedade. de Certificado []
externalSeedNodes Lista de endereços IP de nós de sementes 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 para aguardar 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 no GET. Esse campo só se aplica quando o campo authenticationMethod é 'Cassandra'. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP em que o ponto de extremidade prometheus que contém dados sobre os nós gerenciados do Cassandra pode ser acessado. seedNode
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'
repairEnabled Os reparos automáticos devem ser executados nesse cluster? Se omitido, isso é verdadeiro e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido em que já esteja 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. corda

ManagedCassandraManagedServiceIdentity

Nome Descrição Valor
tipo O tipo do recurso. 'None'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Nome Descrição Valor
apiVersion A versão da API '2023-09-15-preview'
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
localização O local do grupo de recursos ao qual o recurso pertence. corda
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 cluster do Cassandra gerenciado. clusterResourceProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca. Consulte Marcas em modelos
tipo O tipo de recurso 'Microsoft.DocumentDB/cassandraClusters'

SeedNode

Nome Descrição Valor
ipAddress Endereço IP deste nó de semente. corda

Tags

Nome Descrição Valor

Definição de recurso do Terraform (provedor de AzAPI)

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
  name = "string"
  identity = {
    type = "string"
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "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"
      ]
      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

BackupSchedule

Nome Descrição Valor
cronExpression A expressão cron que define quando você deseja fazer backup de seus dados. corda
retentionInHours O período de retenção (horas) dos backups. Se você quiser reter dados para sempre, defina a retenção como 0. int
scheduleName O identificador exclusivo do agendamento de backup. 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

ClusterResourceProperties

Nome 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'
backupSchedules Lista de agendamentos de backup que definem quando você deseja fazer backup de seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o log de auditoria do Cassandra está habilitado Bool
cassandraVersion Qual versão do Cassandra deve convergir para execução (por exemplo, 3.11). Quando atualizado, o cluster pode levar algum tempo para migrar para a nova versão. corda
clientCertificates Lista de certificados TLS usados para autorizar clientes que se conectam ao cluster. Todas as conexões são criptografadas por TLS 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 dos certificados públicos nessa propriedade. de 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 nesta propriedade. corda
clusterType Tipo do cluster. Se definido como Produção, algumas operações podem não ser permitidas no cluster. 'NonProduction'
'Produção'
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 sua interface de rede anexada. 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/<id de assinatura>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<>de rede virtual /sub-redes/<sub-rede>' corda
Extensões Extensões a serem adicionadas ou atualizadas no cluster. 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 nessa propriedade. de Certificado []
externalSeedNodes Lista de endereços IP de nós de sementes 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 para aguardar 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 no GET. Esse campo só se aplica quando o campo authenticationMethod é 'Cassandra'. corda

Restrições:
Valor confidencial. Passe como um parâmetro seguro.
prometheusEndpoint Nome do host ou endereço IP em que o ponto de extremidade prometheus que contém dados sobre os nós gerenciados do Cassandra pode ser acessado. seedNode
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'
repairEnabled Os reparos automáticos devem ser executados nesse cluster? Se omitido, isso é verdadeiro e deve permanecer verdadeiro, a menos que você esteja executando um cluster híbrido em que já esteja 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. corda

ManagedCassandraManagedServiceIdentity

Nome Descrição Valor
tipo O tipo do recurso. 'None'
'SystemAssigned'

Microsoft.DocumentDB/cassandraClusters

Nome Descrição Valor
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
localização O local do grupo de recursos ao qual o recurso pertence. corda
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 cluster do Cassandra gerenciado. clusterResourceProperties
Tags Marcas de recurso Dicionário de nomes e valores de marca.
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"

SeedNode

Nome Descrição Valor
ipAddress Endereço IP deste nó de semente. corda

Tags

Nome Descrição Valor