Microsoft.DocumentDB cassandraClusters/dataCenters

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa cassandraClusters/dataCenters può essere distribuito con operazioni destinate:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/cassandraClusters/dataCenters, aggiungere il modello Bicep seguente.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15' = {
  name: 'string'
  parent: resourceSymbolicName
  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
    privateEndpointIpAddress: 'string'
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

Valori delle proprietà

cassandraClusters/dataCenters

Nome Descrizione valore
name Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatoria)
padre In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere Risorsa figlio esterna alla risorsa padre.		 Nome simbolico per la risorsa di tipo: cassandraClusters
properties Proprietà di un data center Cassandra gestito. DataCenterResourceProperties

DataCenterResourceProperties

Nome Descrizione Valore
authenticationMethodLdapProperties Proprietà del metodo di autenticazione LDAP. Questa funzionalità è in anteprima. AuthenticationMethodLdapProperties
availabilityZone Se il data center dispone del supporto della zona di disponibilità, applicarlo al set di scalabilità di macchine virtuali della macchina virtuale che ospita le macchine virtuali del data center cassandra. bool
backupStorageCustomerKeyUri Indica l'URI chiave della chiave del cliente da usare per la crittografia dell'account di archiviazione di backup. string
base64EncodedCassandraYamlFragment Frammento di un file di configurazione cassandra.yaml da includere nella cassandra.yaml per tutti i nodi in questo data center. Il frammento deve essere codificato in Base64 e sono consentiti solo un subset di chiavi. string
dataCenterLocation L'area in cui deve essere creato il data center. string
Deallocato Indica se il data center è stato deallocato. bool
delegatedSubnetId ID risorsa di una subnet a cui devono essere connessi i nodi del data center. La subnet deve trovarsi nella stessa area specificata in 'dataCenterLocation' e deve essere in grado di instradare la subnet specificata nella proprietà 'delegatedManagementSubnetId' del cluster. Questo ID risorsa sarà del modulo '/subscriptions/{subscription id}/resourceGroups/{gruppo di risorse}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. string
diskCapacity Numero di dischi collegati a ogni nodo. Il valore predefinito è 4. INT
diskSku SKU del disco usato per i data center. Il valore predefinito è P30. string
managedDiskCustomerKeyUri URI della chiave da usare per la crittografia dei dischi gestiti. Assicurarsi che l'identità assegnata dal sistema del cluster sia stata assegnata alle autorizzazioni appropriate(autorizzazioni di recupero/wrapping/annullamento del wrapping) nella chiave. string
nodeCount Il numero di nodi che il data center deve avere. Si tratta del numero desiderato. Dopo aver impostato, potrebbe essere necessario tempo per il data center da ridimensionare in modo che corrisponda. Per monitorare il numero di nodi e il relativo stato, usare il metodo fetchNodeStatus nel cluster. INT
privateEndpointIpAddress Ip dell'endpoint VPN per questo data center. string
provisionError Errore correlato al provisioning delle risorse. CassandraError
provisioningState Stato della risorsa al momento della chiamata dell'operazione. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
sku SKU di macchina virtuale usato per i data center. Il valore predefinito è Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nome Descrizione Valore
connectionTimeoutInMs Timeout per la connessione al server LDAP in milisecondi. Il valore predefinito è 5000 ms. INT
searchBaseDistinguishedName Nome distinto dell'oggetto da cui avviare la ricerca ricorsiva degli utenti. string
searchFilterTemplate Modello da usare per la ricerca. Il valore predefinito è (cn=%s) in cui %s verrà sostituito dal nome utente usato per l'accesso. string
serverCertificates Certificato[]
serverHostname Nome host del server LDAP. string
serverPort Porta del server LDAP. INT
serviceUserDistinguishedName Nome distinto dell'account utente di ricerca, che può cercare i dettagli dell'utente sull'autenticazione. string
serviceUserPassword Password dell'utente di ricerca. string

Certificato

Nome Descrizione Valore
Pem Chiave pubblica in formato PEM. string

CassandraError

Nome Descrizione Valore
additionalErrorInfo Informazioni aggiuntive sull'errore. string
codice Codice di errore che si è verificato. string
message Messaggio dell'errore. string
target Risorsa di destinazione dell'errore. string

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa cassandraClusters/dataCenters può essere distribuito con operazioni destinate a:

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/cassandraClusters/dataCenters, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2024-05-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",
    "privateEndpointIpAddress": "string",
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "sku": "string"
  }
}

Valori delle proprietà

cassandraClusters/dataCenters

Nome Descrizione Valore
tipo Tipo di risorsa 'Microsoft.DocumentDB/cassandraClusters/dataCenters'
apiVersion Versione dell'API della risorsa '2024-05-15'
name Nome della risorsa

Informazioni su come impostare nomi e tipi per le risorse figlio nei modelli di Resource Manager JSON.		 stringa (obbligatorio)
properties Proprietà di un data center Cassandra gestito. DataCenterResourceProperties

DataCenterResourceProperties

Nome Descrizione Valore
authenticationMethodLdapProperties Proprietà del metodo di autenticazione LDAP. Questa funzionalità è in anteprima. AuthenticationMethodLdapProperties
availabilityZone Se il data center supporta la zona di disponibilità, applicarlo al set di scalabilità di macchine virtuali che ospita le macchine virtuali del data center cassandra. bool
backupStorageCustomerKeyUri Indica l'URI della chiave del cliente da usare per la crittografia dell'account di archiviazione di backup. string
base64EncodedCassandraYamlFragment Frammento di un file di configurazione cassandra.yaml da includere in cassandra.yaml per tutti i nodi di questo data center. Il frammento deve essere codificato in Base64 e sono consentiti solo un subset di chiavi. string
dataCenterLocation L'area in cui deve essere creato il data center. string
Deallocato Indica se il data center è stato deallocato. bool
delegatedSubnetId ID risorsa di una subnet a cui i nodi in questo data center devono essere connesse le interfacce di rete. La subnet deve trovarsi nella stessa area specificata in 'dataCenterLocation' e deve essere in grado di indirizzare alla subnet specificata nella proprietà 'delegatedManagementSubnetId' del cluster. Questo ID risorsa sarà nel formato '/subscriptions/{id sottoscrizione}/resourceGroups/{gruppo di risorse}/providers/Microsoft.Network/virtualNetworks/{rete virtuale}/subnets/{subnet}'. string
diskCapacity Numero di dischi collegati a ogni nodo. Il valore predefinito è 4. INT
diskSku SKU del disco usato per i data center. Il valore predefinito è P30. string
managedDiskCustomerKeyUri URI della chiave da usare per la crittografia dei dischi gestiti. Verificare che all'identità assegnata dal sistema del cluster siano state assegnate autorizzazioni appropriate (autorizzazioni get/wrap/unwrap) sulla chiave. string
nodeCount Il numero di nodi che il data center deve avere. Questo è il numero desiderato. Dopo l'impostazione, la scalabilità del data center potrebbe richiedere del tempo. Per monitorare il numero di nodi e il relativo stato, usare il metodo fetchNodeStatus nel cluster. INT
privateEndpointIpAddress Ip dell'endpoint VPN per questo data center. string
provisionError Errore correlato al provisioning delle risorse. CassandraError
provisioningState Stato della risorsa al momento della chiamata dell'operazione. 'Annullata'
'Creating'
'Eliminazione'
'Failed'
'Succeeded'
'Aggiornamento'
sku SKU di macchina virtuale usato per i data center. Il valore predefinito è Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nome Descrizione Valore
connectionTimeoutInMs Timeout per la connessione al server LDAP in milisecondi. Il valore predefinito è 5000 ms. INT
searchBaseDistinguishedName Nome distinto dell'oggetto da cui avviare la ricerca ricorsiva degli utenti. string
searchFilterTemplate Modello da usare per la ricerca. Il valore predefinito è (cn=%s) in cui %s verrà sostituito dal nome utente usato per l'accesso. string
serverCertificates Certificato[]
serverHostname Nome host del server LDAP. string
serverPort Porta del server LDAP. INT
serviceUserDistinguishedName Nome distinto dell'account utente di ricerca, che può cercare i dettagli dell'utente sull'autenticazione. string
serviceUserPassword Password dell'utente di ricerca. string

Certificato

Nome Descrizione Valore
Pem Chiave pubblica in formato PEM. string

CassandraError

Nome Descrizione Valore
additionalErrorInfo Informazioni aggiuntive sull'errore. string
codice Codice di errore che si è verificato. string
message Messaggio dell'errore. string
target Risorsa di destinazione dell'errore. string

Definizione della risorsa Terraform (provider AzAPI)

Il tipo di risorsa cassandraClusters/dataCenters può essere distribuito con operazioni destinate a:

  • Gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere Log delle modifiche.

Formato di risorsa

Per creare una risorsa Microsoft.DocumentDB/cassandraClusters/dataCenters, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15"
  name = "string"
  parent_id = "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
      privateEndpointIpAddress = "string"
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      sku = "string"
    }
  })
}

Valori delle proprietà

cassandraClusters/dataCenters

Nome Descrizione Valore
tipo Tipo di risorsa "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15"
name Nome della risorsa stringa (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: cassandraClusters
properties Proprietà di un data center Cassandra gestito. DataCenterResourceProperties

DataCenterResourceProperties

Nome Descrizione Valore
authenticationMethodLdapProperties Proprietà del metodo di autenticazione LDAP. Questa funzionalità è in anteprima. AuthenticationMethodLdapProperties
availabilityZone Se il data center supporta la zona di disponibilità, applicarlo al set di scalabilità di macchine virtuali che ospita le macchine virtuali del data center cassandra. bool
backupStorageCustomerKeyUri Indica l'URI della chiave del cliente da usare per la crittografia dell'account di archiviazione di backup. string
base64EncodedCassandraYamlFragment Frammento di un file di configurazione cassandra.yaml da includere in cassandra.yaml per tutti i nodi di questo data center. Il frammento deve essere codificato in Base64 e sono consentiti solo un subset di chiavi. string
dataCenterLocation L'area in cui deve essere creato il data center. string
Deallocato Indica se il data center è stato deallocato. bool
delegatedSubnetId ID risorsa di una subnet a cui i nodi in questo data center devono essere connesse le interfacce di rete. La subnet deve trovarsi nella stessa area specificata in 'dataCenterLocation' e deve essere in grado di indirizzare alla subnet specificata nella proprietà 'delegatedManagementSubnetId' del cluster. Questo ID risorsa sarà nel formato '/subscriptions/{id sottoscrizione}/resourceGroups/{gruppo di risorse}/providers/Microsoft.Network/virtualNetworks/{rete virtuale}/subnets/{subnet}'. string
diskCapacity Numero di dischi collegati a ogni nodo. Il valore predefinito è 4. INT
diskSku SKU del disco usato per i data center. Il valore predefinito è P30. string
managedDiskCustomerKeyUri URI della chiave da usare per la crittografia dei dischi gestiti. Verificare che all'identità assegnata dal sistema del cluster siano state assegnate autorizzazioni appropriate (autorizzazioni get/wrap/unwrap) sulla chiave. string
nodeCount Il numero di nodi che il data center deve avere. Questo è il numero desiderato. Dopo l'impostazione, la scalabilità del data center potrebbe richiedere del tempo. Per monitorare il numero di nodi e il relativo stato, usare il metodo fetchNodeStatus nel cluster. INT
privateEndpointIpAddress Ip dell'endpoint VPN per questo data center. string
provisionError Errore correlato al provisioning delle risorse. CassandraError
provisioningState Stato della risorsa al momento della chiamata dell'operazione. "Annullato"
"Creazione"
"Eliminazione"
"Failed"
"Succeeded"
"Aggiornamento"
sku SKU di macchina virtuale usato per i data center. Il valore predefinito è Standard_DS14_v2 string

AuthenticationMethodLdapProperties

Nome Descrizione Valore
connectionTimeoutInMs Timeout per la connessione al server LDAP in milisecondi. Il valore predefinito è 5000 ms. INT
searchBaseDistinguishedName Nome distinto dell'oggetto da cui avviare la ricerca ricorsiva degli utenti. string
searchFilterTemplate Modello da usare per la ricerca. Per impostazione predefinita (cn=%s) dove %s verrà sostituito dal nome utente usato per accedere. string
serverCertificates Certificato[]
serverHostname Nome host del server LDAP. string
serverPort Porta del server LDAP. INT
serviceUserDistinguishedName Nome distinto dell'account utente di ricerca, che può cercare i dettagli utente sull'autenticazione. string
serviceUserPassword Password dell'utente di ricerca. string

Certificato

Nome Descrizione Valore
Pem Chiave pubblica formattata PEM. string

CassandraError

Nome Descrizione Valore
additionalErrorInfo Informazioni aggiuntive sull'errore. string
codice Codice di errore che si è verificato. string
message Messaggio dell'errore. string
target Risorsa di destinazione dell'errore. string