Compartilhar via

CassandraClusters 2021-03-01-preview 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@2021-03-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    authenticationMethod: 'string'
    cassandraVersion: 'string'
    clientCertificates: [
      {
        pem: 'string'
      }
    ]
    clusterNameOverride: 'string'
    delegatedManagementSubnetId: 'string'
    externalGossipCertificates: [
      {
        pem: 'string'
      }
    ]
    externalSeedNodes: [
      {
        ipAddress: 'string'
      }
    ]
    hoursBetweenBackups: int
    initialCassandraAdminPassword: 'string'
    prometheusEndpoint: {
      ipAddress: '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. ManagedServiceIdentity
properties Propriedades de um cluster do Cassandra gerenciado. ClusterResourceProperties

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

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'
'None'
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
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 Número de horas de espera entre fazer um backup do cluster. Para desabilitar backups, defina essa propriedade como 0. 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
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

Definição de recurso de modelo do ARM

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

{
  "type": "Microsoft.DocumentDB/cassandraClusters",
  "apiVersion": "2021-03-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "authenticationMethod": "string",
    "cassandraVersion": "string",
    "clientCertificates": [
      {
        "pem": "string"
      }
    ],
    "clusterNameOverride": "string",
    "delegatedManagementSubnetId": "string",
    "externalGossipCertificates": [
      {
        "pem": "string"
      }
    ],
    "externalSeedNodes": [
      {
        "ipAddress": "string"
      }
    ],
    "hoursBetweenBackups": "int",
    "initialCassandraAdminPassword": "string",
    "prometheusEndpoint": {
      "ipAddress": "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 de recursos '2021-03-01-preview'
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. ManagedServiceIdentity
properties Propriedades de um cluster do Cassandra gerenciado. ClusterResourceProperties

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá todas as identidades do serviço. 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned'
userAssignedIdentities A lista de identidades de usuário associadas ao recurso. As referências de chave de dicionário de identidade do usuário serão IDs de recurso do ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. ManagedServiceIdentityUserAssignedIdentities

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

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'
'None'
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
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 Número de horas de espera entre fazer um backup do cluster. Para desabilitar backups, defina essa propriedade como 0. 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
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 deste nó de semente. string

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

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

  • Grupos de recursos

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 Terraform a seguir ao modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      authenticationMethod = "string"
      cassandraVersion = "string"
      clientCertificates = [
        {
          pem = "string"
        }
      ]
      clusterNameOverride = "string"
      delegatedManagementSubnetId = "string"
      externalGossipCertificates = [
        {
          pem = "string"
        }
      ]
      externalSeedNodes = [
        {
          ipAddress = "string"
        }
      ]
      hoursBetweenBackups = int
      initialCassandraAdminPassword = "string"
      prometheusEndpoint = {
        ipAddress = "string"
      }
      provisioningState = "string"
      repairEnabled = bool
      restoreFromBackupId = "string"
    }
  })
}

Valores de propriedade

cassandraClusters

Name Descrição Valor
tipo O tipo de recurso "Microsoft.DocumentDB/cassandraClusters@2021-03-01-preview"
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). 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.
identidade Identidade do recurso. ManagedServiceIdentity
properties Propriedades de um cluster do Cassandra gerenciado. ClusterResourceProperties

ManagedServiceIdentity

Name Descrição Valor
tipo O tipo de identidade usado para o recurso. O tipo 'SystemAssigned,UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'None' removerá as identidades do serviço. "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned"
identity_ids A lista de identidades de usuário associadas ao recurso. As referências de chave do dicionário de identidade do usuário serão IDs de recurso do ARM no formulário: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. Matriz de IDs de identidade do usuário.

ManagedServiceIdentityUserAssignedIdentities

Name Descrição Valor
{propriedade personalizada} Components1Jq1T4ISchemasManagedserviceidentityProper...

Components1Jq1T4ISchemasManagedserviceidentityProper...

Esse objeto não contém nenhuma propriedade a ser definida durante a implantação. Todas as propriedades são ReadOnly.

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"
"None"
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
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. 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 Número de horas de espera entre fazer um backup do cluster. Para desabilitar backups, defina essa propriedade como 0. 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
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