Microsoft.DocumentDB cassandraClusters/dataCenters 2023-04-15
- Últimas
- 2024-12-01-preview
- 2024-11-15
- 2024-09-01-preview
- 2024-08-15
- 2024-05-15
- 2024-05-15-preview
- 2024-02-15-preview
- 2023-11-15
- 2023-11-15-preview
- 2023-09-15
- 2023-09-15-preview
- 2023-04-15
- 2023-03-15
- 2023-03-15-preview
- 2023-03-01-preview
- 2022-11-15
- 2022-11-15-preview
- 2022-08-15
- 2022-08-15-preview
- 2022-05-15
- 2022-05-15-preview
- 2022-02-15-preview
- 2021-11-15-preview
- 2021-10-15
- 2021-10-15-preview
- 2021-07-01-preview
- 2021-04-01-preview
- 2021-03-01-preview
Definição de recursos do bíceps
O tipo de recurso cassandraClusters/dataCenters pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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/dataCenters, adicione o seguinte Bicep ao seu modelo.
resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-04-15' = {
parent: resourceSymbolicName
name: 'string'
properties: {
authenticationMethodLdapProperties: {
connectionTimeoutInMs: int
searchBaseDistinguishedName: 'string'
searchFilterTemplate: 'string'
serverCertificates: [
{
pem: 'string'
}
]
serverHostname: 'string'
serverPort: int
serviceUserDistinguishedName: 'string'
serviceUserPassword: 'string'
}
availabilityZone: bool
backupStorageCustomerKeyUri: 'string'
base64EncodedCassandraYamlFragment: 'string'
dataCenterLocation: 'string'
deallocated: bool
delegatedSubnetId: 'string'
diskCapacity: int
diskSku: 'string'
managedDiskCustomerKeyUri: 'string'
nodeCount: int
provisionError: {
additionalErrorInfo: 'string'
code: 'string'
message: 'string'
target: 'string'
}
provisioningState: 'string'
sku: 'string'
}
}
Valores de propriedade
AuthenticationMethodLdapProperties
| Designação | Descrição | Valor |
|---|---|---|
| connectionTimeoutInMs | Tempo limite para conexão com o servidor LDAP em milissegundos. O padrão é 5000 ms. | Int |
| searchBaseDistinguishedName | Nome distinto do objeto a partir do qual iniciar a pesquisa recursiva de usuários. | string |
| searchFilterTemplate | Modelo a utilizar na pesquisa. O padrão é (cn=%s) onde %s será substituído pelo nome de usuário usado para fazer login. | string |
| serverCertificados | Certificado[] | |
| serverHostname | Nome do host do servidor LDAP. | string |
| serverPort | Porta do servidor LDAP. | Int |
| serviceUserDistinguishedName | Nome distinto da conta de usuário de pesquisa, que pode procurar detalhes do usuário na autenticação. | string |
| serviceUserPassword | Senha do usuário de pesquisa. | 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 |
DataCenterResourceProperties
| Designação | Descrição | Valor |
|---|---|---|
| authenticationMethodLdapProperties | Propriedades do método de autenticação LDAP. Este recurso está em pré-visualização. | AuthenticationMethodLdapProperties |
| availabilityZone | Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao ScaleSet da Máquina Virtual que hospeda as máquinas virtuais do data center cassandra. | Bool |
| backupStorageCustomerKeyUri | Indica o Uri de chave da chave do cliente a ser usado para criptografia da conta de armazenamento de backup. | string |
| base64EncodedCassandraYamlFragment | Um fragmento de um arquivo de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste data center. O fragmento deve ser codificado em Base64 e apenas um subconjunto de chaves é permitido. | string |
| dataCenterLocalização | A região em que este data center deve ser criado. | string |
| desafetada | Se o data center foi deslocalizado. | Bool |
| delegadoSubnetId | ID de recurso de uma sub-rede: os nós neste data center devem ter suas interfaces de rede conectadas. A sub-rede deve estar na mesma região especificada em 'dataCenterLocation' e deve ser capaz de rotear para a sub-rede especificada na propriedade 'delegatedManagementSubnetId' do cluster. Este ID de recurso terá o formato '/subscriptions/<ID de subscrição>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<rede virtual>/subnets/<sub-rede>'. | string |
| diskCapacity | Número de discos conectados a cada nó. O padrão é 4. | Int |
| diskSku | Disk SKU usado para data centers. O valor padrão é P30. | string |
| managedDiskCustomerKeyUri | Uri de chave a ser usado para criptografia de discos gerenciados. Verifique se a identidade atribuída ao sistema do cluster recebeu as permissões apropriadas (permissões get/wrap/unwrap da chave) na chave. | string |
| nodeCount | O número de nós que o data center deve ter. Este é o número desejado. Depois de definido, pode levar algum tempo para que o data center seja dimensionado para corresponder. Para monitorar o número de nós e seu status, use o método fetchNodeStatus no cluster. | Int |
| 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' |
| SKU | SKU de máquina virtual usado para data centers. O valor padrão é Standard_DS14_v2 | string |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Designação | Descrição | Valor |
|---|---|---|
| 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) |
| pai | No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai. Para obter mais informações, consulte recurso filho fora do recurso pai. |
Nome simbólico para recurso do tipo: cassandraClusters |
| propriedades | Propriedades de um data center Cassandra gerenciado. | DataCenterResourceProperties |
Definição de recurso de modelo ARM
O tipo de recurso cassandraClusters/dataCenters pode ser implantado com operações que visam:
- Grupos de recursos - Consulte comandos de implantação de grupo 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/dataCenters, adicione o seguinte JSON ao seu modelo.
{
"type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
"apiVersion": "2023-04-15",
"name": "string",
"properties": {
"authenticationMethodLdapProperties": {
"connectionTimeoutInMs": "int",
"searchBaseDistinguishedName": "string",
"searchFilterTemplate": "string",
"serverCertificates": [
{
"pem": "string"
}
],
"serverHostname": "string",
"serverPort": "int",
"serviceUserDistinguishedName": "string",
"serviceUserPassword": "string"
},
"availabilityZone": "bool",
"backupStorageCustomerKeyUri": "string",
"base64EncodedCassandraYamlFragment": "string",
"dataCenterLocation": "string",
"deallocated": "bool",
"delegatedSubnetId": "string",
"diskCapacity": "int",
"diskSku": "string",
"managedDiskCustomerKeyUri": "string",
"nodeCount": "int",
"provisionError": {
"additionalErrorInfo": "string",
"code": "string",
"message": "string",
"target": "string"
},
"provisioningState": "string",
"sku": "string"
}
}
Valores de propriedade
AuthenticationMethodLdapProperties
| Designação | Descrição | Valor |
|---|---|---|
| connectionTimeoutInMs | Tempo limite para conexão com o servidor LDAP em milissegundos. O padrão é 5000 ms. | Int |
| searchBaseDistinguishedName | Nome distinto do objeto a partir do qual iniciar a pesquisa recursiva de usuários. | string |
| searchFilterTemplate | Modelo a utilizar na pesquisa. O padrão é (cn=%s) onde %s será substituído pelo nome de usuário usado para fazer login. | string |
| serverCertificados | Certificado[] | |
| serverHostname | Nome do host do servidor LDAP. | string |
| serverPort | Porta do servidor LDAP. | Int |
| serviceUserDistinguishedName | Nome distinto da conta de usuário de pesquisa, que pode procurar detalhes do usuário na autenticação. | string |
| serviceUserPassword | Senha do usuário de pesquisa. | 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 |
DataCenterResourceProperties
| Designação | Descrição | Valor |
|---|---|---|
| authenticationMethodLdapProperties | Propriedades do método de autenticação LDAP. Este recurso está em pré-visualização. | AuthenticationMethodLdapProperties |
| availabilityZone | Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao ScaleSet da Máquina Virtual que hospeda as máquinas virtuais do data center cassandra. | Bool |
| backupStorageCustomerKeyUri | Indica o Uri de chave da chave do cliente a ser usado para criptografia da conta de armazenamento de backup. | string |
| base64EncodedCassandraYamlFragment | Um fragmento de um arquivo de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste data center. O fragmento deve ser codificado em Base64 e apenas um subconjunto de chaves é permitido. | string |
| dataCenterLocalização | A região em que este data center deve ser criado. | string |
| desafetada | Se o data center foi deslocalizado. | Bool |
| delegadoSubnetId | ID de recurso de uma sub-rede: os nós neste data center devem ter suas interfaces de rede conectadas. A sub-rede deve estar na mesma região especificada em 'dataCenterLocation' e deve ser capaz de rotear para a sub-rede especificada na propriedade 'delegatedManagementSubnetId' do cluster. Este ID de recurso terá o formato '/subscriptions/<ID de subscrição>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<rede virtual>/subnets/<sub-rede>'. | string |
| diskCapacity | Número de discos conectados a cada nó. O padrão é 4. | Int |
| diskSku | Disk SKU usado para data centers. O valor padrão é P30. | string |
| managedDiskCustomerKeyUri | Uri de chave a ser usado para criptografia de discos gerenciados. Verifique se a identidade atribuída ao sistema do cluster recebeu as permissões apropriadas (permissões get/wrap/unwrap da chave) na chave. | string |
| nodeCount | O número de nós que o data center deve ter. Este é o número desejado. Depois de definido, pode levar algum tempo para que o data center seja dimensionado para corresponder. Para monitorar o número de nós e seu status, use o método fetchNodeStatus no cluster. | Int |
| 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' |
| SKU | SKU de máquina virtual usado para data centers. O valor padrão é Standard_DS14_v2 | string |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Designação | Descrição | Valor |
|---|---|---|
| apiVersion | A versão api | '2023-04-15' |
| 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 data center Cassandra gerenciado. | DataCenterResourceProperties |
| tipo | O tipo de recurso | 'Microsoft.DocumentDB/cassandraClusters/dataCenters' |
Definição de recursos Terraform (provedor AzAPI)
O tipo de recurso cassandraClusters/dataCenters 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/dataCenters, adicione o seguinte Terraform ao seu modelo.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-04-15"
name = "string"
body = jsonencode({
properties = {
authenticationMethodLdapProperties = {
connectionTimeoutInMs = int
searchBaseDistinguishedName = "string"
searchFilterTemplate = "string"
serverCertificates = [
{
pem = "string"
}
]
serverHostname = "string"
serverPort = int
serviceUserDistinguishedName = "string"
serviceUserPassword = "string"
}
availabilityZone = bool
backupStorageCustomerKeyUri = "string"
base64EncodedCassandraYamlFragment = "string"
dataCenterLocation = "string"
deallocated = bool
delegatedSubnetId = "string"
diskCapacity = int
diskSku = "string"
managedDiskCustomerKeyUri = "string"
nodeCount = int
provisionError = {
additionalErrorInfo = "string"
code = "string"
message = "string"
target = "string"
}
provisioningState = "string"
sku = "string"
}
})
}
Valores de propriedade
AuthenticationMethodLdapProperties
| Designação | Descrição | Valor |
|---|---|---|
| connectionTimeoutInMs | Tempo limite para conexão com o servidor LDAP em milissegundos. O padrão é 5000 ms. | Int |
| searchBaseDistinguishedName | Nome distinto do objeto a partir do qual iniciar a pesquisa recursiva de usuários. | string |
| searchFilterTemplate | Modelo a utilizar na pesquisa. O padrão é (cn=%s) onde %s será substituído pelo nome de usuário usado para fazer login. | string |
| serverCertificados | Certificado[] | |
| serverHostname | Nome do host do servidor LDAP. | string |
| serverPort | Porta do servidor LDAP. | Int |
| serviceUserDistinguishedName | Nome distinto da conta de usuário de pesquisa, que pode procurar detalhes do usuário na autenticação. | string |
| serviceUserPassword | Senha do usuário de pesquisa. | 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 |
DataCenterResourceProperties
| Designação | Descrição | Valor |
|---|---|---|
| authenticationMethodLdapProperties | Propriedades do método de autenticação LDAP. Este recurso está em pré-visualização. | AuthenticationMethodLdapProperties |
| availabilityZone | Se o data center tiver suporte à Zona de Disponibilidade, aplique-o ao ScaleSet da Máquina Virtual que hospeda as máquinas virtuais do data center cassandra. | Bool |
| backupStorageCustomerKeyUri | Indica o Uri de chave da chave do cliente a ser usado para criptografia da conta de armazenamento de backup. | string |
| base64EncodedCassandraYamlFragment | Um fragmento de um arquivo de configuração cassandra.yaml a ser incluído no cassandra.yaml para todos os nós neste data center. O fragmento deve ser codificado em Base64 e apenas um subconjunto de chaves é permitido. | string |
| dataCenterLocalização | A região em que este data center deve ser criado. | string |
| desafetada | Se o data center foi deslocalizado. | Bool |
| delegadoSubnetId | ID de recurso de uma sub-rede: os nós neste data center devem ter suas interfaces de rede conectadas. A sub-rede deve estar na mesma região especificada em 'dataCenterLocation' e deve ser capaz de rotear para a sub-rede especificada na propriedade 'delegatedManagementSubnetId' do cluster. Este ID de recurso terá o formato '/subscriptions/<ID de subscrição>/resourceGroups/<grupo de recursos>/providers/Microsoft.Network/virtualNetworks/<rede virtual>/subnets/<sub-rede>'. | string |
| diskCapacity | Número de discos conectados a cada nó. O padrão é 4. | Int |
| diskSku | Disk SKU usado para data centers. O valor padrão é P30. | string |
| managedDiskCustomerKeyUri | Uri de chave a ser usado para criptografia de discos gerenciados. Verifique se a identidade atribuída ao sistema do cluster recebeu as permissões apropriadas (permissões get/wrap/unwrap da chave) na chave. | string |
| nodeCount | O número de nós que o data center deve ter. Este é o número desejado. Depois de definido, pode levar algum tempo para que o data center seja dimensionado para corresponder. Para monitorar o número de nós e seu status, use o método fetchNodeStatus no cluster. | Int |
| 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' |
| SKU | SKU de máquina virtual usado para data centers. O valor padrão é Standard_DS14_v2 | string |
Microsoft.DocumentDB/cassandraClusters/dataCenters
| Designação | Descrição | Valor |
|---|---|---|
| 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) |
| parent_id | A ID do recurso que é o pai para este recurso. | ID para recurso do tipo: cassandraClusters |
| propriedades | Propriedades de um data center Cassandra gerenciado. | DataCenterResourceProperties |
| tipo | O tipo de recurso | "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-04-15" |