Partilhar via

Microsoft.DocumentDB cassandraClusters 2023-09-15-preview

  • Artigo

Definição de recurso do Bicep

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

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, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: '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'
  }
}

Valores de propriedade

cassandraClusters

Nome Descrição Valor
name O nome do recurso cadeia (obrigatório)
localização A localização do grupo de recursos ao qual o recurso pertence. string
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
propriedades Propriedades de um cluster do Cassandra gerido. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nome Descrição Valor
tipo O tipo do recurso. "Nenhum"
"SystemAssigned"

ClusterResourceProperties

Nome Descrição Valor
authenticationMethod Que método de autenticação o Cassandra deve utilizar para autenticar clientes. "Nenhum" desativa a autenticação, pelo que não deve ser utilizada, exceto em situações de emergência. "Cassandra" é a autenticação predefinida baseada em palavra-passe. A predefinição é "Cassandra". 'Cassandra'
'Ldap'
"Nenhum"
backupSchedules Lista de agendas de cópias de segurança que definem quando pretende criar cópias de segurança dos seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o registo de auditoria do Cassandra está ativado bool
cassandraVersion Que versão do Cassandra deve este cluster convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode demorar algum tempo a migrar para a nova versão. string
clientCertificates Lista de certificados TLS utilizados para autorizar clientes que se ligam ao cluster. Todas as ligações são encriptadas por TLS, quer clientCertificates esteja definido ou não, mas se clientCertificates estiver definido, o cluster do Cassandra gerido rejeitará todas as ligações que não tenham um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nesta propriedade. Certificado[]
clusterNameOverride Se precisar de definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a utilizar nesta propriedade. string
clusterType Tipo do cluster. Se estiver definido como Produção, algumas operações poderão não ser permitidas no cluster. "Não Produção"
"Produção"
desalocado Se o cluster e os datacenters associados foram desalocados. bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gestão deste cluster deve ter a respetiva interface de rede anexada. A sub-rede tem de ser encaminhável para todas as sub-redes que serão delegadas a datacenters. O ID do recurso tem de ser do formulário "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" string
extensões Extensões a adicionar ou atualizar no cluster. cadeia[]
externalGossipCertificates Lista de certificados TLS utilizados para autorizar fofocas a partir de datacenters não geridos. Os certificados TLS de todos os nós em datacenters não geridos têm de ser verificáveis através de um dos certificados fornecidos nesta propriedade. Certificado[]
externalSeedNodes Lista de endereços IP de nós de seed em datacenters não geridos. Estes serão adicionados às listas de nós de seed de todos os nós geridos. SeedNode[]
hoursBetweenBackups (Preterido) Número de horas a aguardar entre fazer uma cópia de segurança do cluster. int
initialCassandraAdminPassword Palavra-passe inicial para clientes que se ligam como administrador ao cluster. Deve ser alterado após a criação do cluster. Devolve nulo no GET. Este campo só se aplica quando o campo authenticationMethod é "Cassandra". string

Restrições:
Valor sensível. Transmita como um parâmetro seguro.
prometheusEndpoint Nome do anfitrião ou endereço IP onde o ponto final do Prometheus que contém dados sobre os nós geridos do Cassandra pode ser alcançado. SeedNode
provisionError Erro relacionado com o aprovisionamento de recursos. CassandraError
provisioningState O estado do recurso no momento em que a operação foi chamada. "Cancelado"
"A criar"
"A eliminar"
"Falha"
"Bem-sucedido"
"A atualizar"
repairEnabled As reparações automáticas devem ser executadas neste cluster? Se for omitido, isto é verdade e deve manter-se verdadeiro, a menos que esteja a executar um cluster híbrido onde já esteja a fazer as suas próprias reparações. bool
restoreFromBackupId Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar uma cópia de segurança para um novo cluster, defina este campo como o ID de recurso da cópia de segurança. string

BackupSchedule

Nome Descrição Valor
cronExpression A expressão cron que define quando pretende criar uma cópia de segurança dos seus dados. string
retentionInHours O período de retenção (horas) das cópias de segurança. Se quiser reter dados para sempre, defina a retenção como 0. int
scheduleName O identificador exclusivo da agenda de cópias de segurança. string

Certificado

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

SeedNode

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

CassandraError

Nome 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 modelo arm

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

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, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2023-09-15-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "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"
  }
}

Valores de propriedade

cassandraClusters

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters"
apiVersion A versão da API de recursos '2023-09-15-preview'
name O nome do recurso cadeia (obrigatório)
localização A localização do grupo de recursos ao qual o recurso pertence. string
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas para ver e agrupar este recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Table", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas. Ver Etiquetas em modelos
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
propriedades Propriedades de um cluster do Cassandra gerido. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nome Descrição Valor
tipo O tipo do recurso. "Nenhum"
"SystemAssigned"

ClusterResourceProperties

Nome Descrição Valor
authenticationMethod Que método de autenticação o Cassandra deve utilizar para autenticar clientes. "Nenhum" desativa a autenticação, pelo que não deve ser utilizada, exceto em situações de emergência. "Cassandra" é a autenticação predefinida baseada em palavra-passe. A predefinição é "Cassandra". 'Cassandra'
'Ldap'
"Nenhum"
backupSchedules Lista de agendas de cópias de segurança que definem quando pretende criar cópias de segurança dos seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o registo de auditoria do Cassandra está ativado bool
cassandraVersion Que versão do Cassandra deve este cluster convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode demorar algum tempo a migrar para a nova versão. string
clientCertificates Lista de certificados TLS utilizados para autorizar clientes que se ligam ao cluster. Todas as ligações são encriptadas por TLS, quer clientCertificates esteja definido ou não, mas se clientCertificates estiver definido, o cluster do Cassandra gerido rejeitará todas as ligações que não tenham um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nesta propriedade. Certificado[]
clusterNameOverride Se precisar de definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a utilizar nesta propriedade. string
clusterType Tipo do cluster. Se estiver definido como Produção, algumas operações poderão não ser permitidas no cluster. "Não Produção"
"Produção"
desalocado Se o cluster e os datacenters associados foram desalocados. bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gestão deste cluster deve ter a respetiva interface de rede anexada. A sub-rede tem de ser encaminhável para todas as sub-redes que serão delegadas a datacenters. O ID do recurso tem de ser do formulário "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" string
extensões Extensões a adicionar ou atualizar no cluster. string[]
externalGossipCertificates Lista de certificados TLS utilizados para autorizar fofocas a partir de datacenters não geridos. Os certificados TLS de todos os nós em datacenters não geridos têm de ser verificáveis através de um dos certificados fornecidos nesta propriedade. Certificado[]
externalSeedNodes Lista de endereços IP de nós de seed em datacenters não geridos. Estes serão adicionados às listas de nós de seed de todos os nós geridos. SeedNode[]
hoursBetweenBackups (Preterido) Número de horas a aguardar entre fazer uma cópia de segurança do cluster. int
initialCassandraAdminPassword Palavra-passe inicial para clientes que se ligam como administrador ao cluster. Deve ser alterado após a criação do cluster. Devolve nulo no GET. Este campo só se aplica quando o campo authenticationMethod é "Cassandra". string

Restrições:
Valor sensível. Transmita como um parâmetro seguro.
prometheusEndpoint Nome do anfitrião ou endereço IP onde o ponto final do Prometheus que contém dados sobre os nós geridos do Cassandra pode ser alcançado. SeedNode
provisionError Erro relacionado com o aprovisionamento de recursos. CassandraError
provisioningState O estado do recurso no momento em que a operação foi chamada. "Cancelado"
"A criar"
"A eliminar"
"Falha"
"Bem-sucedido"
"A atualizar"
repairEnabled As reparações automáticas devem ser executadas neste cluster? Se for omitido, isto é verdade e deve manter-se verdadeiro, a menos que esteja a executar um cluster híbrido onde já esteja a fazer as suas próprias reparações. bool
restoreFromBackupId Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar uma cópia de segurança para um novo cluster, defina este campo como o ID de recurso da cópia de segurança. string

BackupSchedule

Nome Descrição Valor
cronExpression A expressão cron que define quando pretende criar uma cópia de segurança dos seus dados. string
retentionInHours O período de retenção (horas) das cópias de segurança. Se quiser reter dados para sempre, defina a retenção como 0. int
scheduleName O identificador exclusivo da agenda de cópias de segurança. string

Certificado

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

SeedNode

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

CassandraError

Nome 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 (fornecedor AzAPI)

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

  • Grupos de recursos

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type =  "SystemAssigned"
  }
  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

cassandraClusters

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters@2023-09-15-preview"
name O nome do recurso cadeia (obrigatório)
localização A localização do grupo de recursos ao qual o recurso pertence. string
parent_id Para implementar num grupo de recursos, utilize o ID desse grupo de recursos. cadeia (obrigatório)
etiquetas As etiquetas são uma lista de pares chave-valor que descrevem o recurso. Estas etiquetas podem ser utilizadas na visualização e agrupamento deste recurso (entre grupos de recursos). Pode ser fornecido um máximo de 15 etiquetas para um recurso. Cada etiqueta tem de ter uma chave não superior a 128 carateres e um valor não superior a 256 carateres. Por exemplo, a experiência predefinida para um tipo de modelo é definida com "defaultExperience": "Cassandra". Os valores atuais "defaultExperience" também incluem "Tabela", "Graph", "DocumentDB" e "MongoDB". Dicionário de nomes e valores de etiquetas.
identidade Identidade do recurso. ManagedCassandraManagedServiceIdentity
propriedades Propriedades de um cluster do Cassandra gerido. ClusterResourceProperties

ManagedCassandraManagedServiceIdentity

Nome Descrição Valor
tipo O tipo de recurso. "SystemAssigned"

ClusterResourceProperties

Nome Descrição Valor
authenticationMethod Que método de autenticação o Cassandra deve utilizar para autenticar clientes. "Nenhum" desativa a autenticação, pelo que não deve ser utilizada, exceto em situações de emergência. "Cassandra" é a autenticação baseada em palavra-passe predefinida. A predefinição é "Cassandra". "Cassandra"
"Ldap"
"Nenhum"
backupSchedules Lista de agendamentos de cópias de segurança que definem quando pretende fazer uma cópia de segurança dos seus dados. BackupSchedule[]
cassandraAuditLoggingEnabled Se o registo de auditoria do Cassandra está ativado bool
cassandraVersion Que versão do Cassandra deve este cluster convergir para a execução (por exemplo, 3.11). Quando atualizado, o cluster pode demorar algum tempo a migrar para a nova versão. string
clientCertificates Lista de certificados TLS utilizados para autorizar clientes que se ligam ao cluster. Todas as ligações são encriptadas por TLS, quer o clientCertificates esteja definido ou não, mas se clientCertificates estiver definido, o cluster do Cassandra gerido rejeitará todas as ligações que não têm um certificado de cliente TLS que possa ser validado a partir de um ou mais certificados públicos nesta propriedade. Certificado[]
clusterNameOverride Se precisar de definir a propriedade clusterName em cassandra.yaml para algo além do nome do recurso do cluster, defina o valor a utilizar nesta propriedade. string
clusterType Tipo de cluster. Se estiver definido como Produção, algumas operações poderão não ser permitidas no cluster. "Não Produção"
"Produção"
desalocado Se o cluster e os datacenters associados foram desalocados. bool
delegatedManagementSubnetId ID de recurso de uma sub-rede à qual o serviço de gestão deste cluster deve ter a respetiva interface de rede anexada. A sub-rede tem de ser encaminhável para todas as sub-redes que serão delegadas a datacenters. O ID do recurso tem de ser do formulário "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}" string
extensões Extensões a adicionar ou atualizar no cluster. cadeia[]
externalGossipCertificates Lista de certificados TLS utilizados para autorizar fofocas a partir de datacenters não geridos. Os certificados TLS de todos os nós em datacenters não geridos têm de ser verificáveis através de um dos certificados fornecidos nesta propriedade. Certificado[]
externalSeedNodes Lista de endereços IP de nós de seed em datacenters não geridos. Estes serão adicionados às listas de nós de seed de todos os nós geridos. SeedNode[]
hoursBetweenBackups (Preterido) Número de horas a aguardar entre fazer uma cópia de segurança do cluster. int
initialCassandraAdminPassword Palavra-passe inicial para clientes que se ligam como administrador ao cluster. Deve ser alterado após a criação do cluster. Devolve nulo no GET. Este campo só se aplica quando o campo authenticationMethod é "Cassandra". string

Restrições:
Valor sensível. Transmita como um parâmetro seguro.
prometheusEndpoint Nome do anfitrião ou endereço IP onde o ponto final do Prometheus que contém dados sobre os nós geridos do Cassandra pode ser alcançado. SeedNode
provisionError Erro relacionado com o aprovisionamento de recursos. CassandraError
provisioningState O estado do recurso no momento em que a operação foi chamada. "Cancelado"
"Criar"
"A eliminar"
"Falha"
"Com êxito"
"A atualizar"
repairEnabled As reparações automáticas devem ser executadas neste cluster? Se for omitido, isto é verdade e deve manter-se verdadeiro, a menos que esteja a executar um cluster híbrido onde já esteja a fazer as suas próprias reparações. bool
restoreFromBackupId Para criar um cluster vazio, omita este campo ou defina-o como nulo. Para restaurar uma cópia de segurança para um novo cluster, defina este campo como o ID de recurso da cópia de segurança. string

BackupSchedule

Nome Descrição Valor
cronExpression A expressão cron que define quando pretende criar uma cópia de segurança dos seus dados. string
retentionInHours O período de retenção (horas) das cópias de segurança. Se quiser reter dados para sempre, defina a retenção como 0. int
scheduleName O identificador exclusivo da agenda de cópias de segurança. string

Certificado

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

SeedNode

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

CassandraError

Nome 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