Microsoft.DocumentDB cassandraClusters/dataCenters 2023-03-15

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp cassandraClusters/dataCenters kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/cassandraClusters/dataCenters-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-03-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
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

Eigenschaftswerte

cassandraClusters/dataCenters

Name BESCHREIBUNG Wert
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in Bicep festlegen.		 Zeichenfolge (erforderlich)
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: cassandraClusters
properties Eigenschaften eines verwalteten Cassandra-Rechenzentrums. DataCenterResourceProperties

DataCenterResourceProperties

Name BESCHREIBUNG Wert
authenticationMethodLdapProperties Eigenschaften der LDAP-Authentifizierungsmethode. Dieses Feature befindet sich in der Vorschauphase. AuthenticationMethodLdapProperties
availabilityZone Wenn das Rechenzentrum Verfügbarkeitszonenunterstützung hat, wenden Sie sie auf das ScaleSet des virtuellen Computers an, das die virtuellen Computer des Cassandra-Rechenzentrums hostet. bool
backupStorageCustomerKeyUri Gibt den Schlüssel-URI des Kundenschlüssels an, der für die Verschlüsselung des Sicherungsspeicherkontos verwendet werden soll. Zeichenfolge
base64EncodedCassandraYamlFragment Ein Fragment einer Cassandra.yaml-Konfigurationsdatei, die in die cassandra.yaml für alle Knoten in diesem Rechenzentrum eingeschlossen werden soll. Das Fragment sollte Base64-codiert sein, und nur eine Teilmenge der Schlüssel ist zulässig. Zeichenfolge
dataCenterLocation Die Region, in der dieses Rechenzentrum erstellt werden soll. Zeichenfolge
Freigegeben Gibt an, ob das Rechenzentrum zugeordnet wurde. bool
delegatedSubnetId Ressourcen-ID eines Subnetzes, mit dem die Knoten in diesem Rechenzentrum ihre Netzwerkschnittstellen verbinden sollten. Das Subnetz muss sich in derselben Region befinden, die in "dataCenterLocation" angegeben ist, und muss in der Lage sein, an das Subnetz weiterzuleiten, das in der Eigenschaft "delegatedManagementSubnetId" des Clusters angegeben ist. Diese Ressourcen-ID hat das Format '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. Zeichenfolge
diskCapacity Anzahl der Datenträger, die an jeden Knoten angefügt sind. Der Standardwert ist 4. INT
diskSku Datenträger-SKU, die für Rechenzentren verwendet wird. Der Standardwert ist P30. Zeichenfolge
managedDiskCustomerKeyUri Schlüssel-URI, der für die Verschlüsselung von verwalteten Datenträgern verwendet werden soll. Stellen Sie sicher, dass der systemseitig zugewiesenen Identität des Clusters entsprechende Berechtigungen (Schlüsselberechtigungen get/wrap/unwrap) für den Schlüssel zugewiesen wurden. Zeichenfolge
nodeCount Die Anzahl der Knoten, über die das Rechenzentrum verfügen sollte. Dies ist die gewünschte Zahl. Nach dem Festlegen kann es einige Zeit dauern, bis das Rechenzentrum entsprechend skaliert wird. Verwenden Sie die fetchNodeStatus-Methode für den Cluster, um die Anzahl der Knoten und deren Status zu überwachen. INT
provisionError Fehler im Zusammenhang mit der Ressourcenbereitstellung. CassandraError
provisioningState Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs. "Abgebrochen"
"Erstellen"
"Löschen"
"Fehler"
"Erfolgreich"
"Aktualisieren"
sku Für Rechenzentren verwendete VM-SKU. Standardwert ist Standard_DS14_v2 Zeichenfolge

AuthenticationMethodLdapProperties

Name BESCHREIBUNG Wert
connectionTimeoutInMs Timeout für die Verbindung mit dem LDAP-Server in Millisekunden. Der Standardwert ist 5000 ms. INT
searchBaseDistinguishedName Distinguished name of the object to start the reursive search of users from. Zeichenfolge
searchFilterTemplate Vorlage, die für die Suche verwendet werden soll. Der Standardwert ist (cn=%s), wobei %s durch den Benutzernamen ersetzt wird, der für die Anmeldung verwendet wird. Zeichenfolge
serverCertificates Zertifikat[]
serverHostname Hostname des LDAP-Servers. Zeichenfolge
serverPort Port des LDAP-Servers. INT
serviceUserDistinguishedName Distinguished name of the look up user account, who can look up user details on authentication. Zeichenfolge
serviceUserPassword Kennwort des Nachschlagebenutzers. Zeichenfolge

Zertifikat

Name BESCHREIBUNG Wert
Pem Öffentlicher Schlüssel im PEM-Format. Zeichenfolge

CassandraError

Name BESCHREIBUNG Wert
additionalErrorInfo Weitere Informationen zum Fehler. Zeichenfolge
code Der Code des aufgetretenen Fehlers. Zeichenfolge
message Die Meldung des Fehlers. Zeichenfolge
target Die Zielressource des Fehlers. Zeichenfolge

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp cassandraClusters/dataCenters kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Ressource Microsoft.DocumentDB/cassandraClusters/dataCenters zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2023-03-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"
  }
}

Eigenschaftswerte

cassandraClusters/dataCenters

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/cassandraClusters/dataCenters"
apiVersion Die Version der Ressourcen-API '2023-03-15'
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen.		 Zeichenfolge (erforderlich)
properties Eigenschaften eines verwalteten Cassandra-Rechenzentrums. DataCenterResourceProperties

DataCenterResourceProperties

Name BESCHREIBUNG Wert
authenticationMethodLdapProperties Eigenschaften der Ldap-Authentifizierungsmethode. Dieses Feature befindet sich in der Vorschauphase. AuthenticationMethodLdapProperties
availabilityZone Wenn das Rechenzentrum Verfügbarkeitszonen unterstützt, wenden Sie sie auf das ScaleSet für virtuelle Computer an, das die virtuellen Computer des Cassandra-Rechenzentrums hostet. bool
backupStorageCustomerKeyUri Gibt den Schlüssel-URI des Kundenschlüssels an, der für die Verschlüsselung des Sicherungsspeicherkontos verwendet werden soll. Zeichenfolge
base64EncodedCassandraYamlFragment Ein Fragment einer Cassandra.yaml-Konfigurationsdatei, die in die cassandra.yaml für alle Knoten in diesem Rechenzentrum eingeschlossen werden soll. Das Fragment sollte Base64-codiert sein, und nur eine Teilmenge der Schlüssel ist zulässig. Zeichenfolge
dataCenterLocation Die Region, in der dieses Rechenzentrum erstellt werden soll. Zeichenfolge
Freigegeben Gibt an, ob das Rechenzentrum zugeordnet wurde. bool
delegatedSubnetId Ressourcen-ID eines Subnetzes, mit dem die Knoten in diesem Rechenzentrum ihre Netzwerkschnittstellen verbinden sollten. Das Subnetz muss sich in derselben Region befinden, die in "dataCenterLocation" angegeben ist, und muss in der Lage sein, an das Subnetz weiterzuleiten, das in der Eigenschaft "delegatedManagementSubnetId" des Clusters angegeben ist. Diese Ressourcen-ID hat das Format '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. Zeichenfolge
diskCapacity Anzahl der Datenträger, die an jeden Knoten angefügt sind. Der Standardwert ist 4. INT
diskSku Datenträger-SKU, die für Rechenzentren verwendet wird. Der Standardwert ist P30. Zeichenfolge
managedDiskCustomerKeyUri Schlüssel-URI, der für die Verschlüsselung von verwalteten Datenträgern verwendet werden soll. Stellen Sie sicher, dass der systemseitig zugewiesenen Identität des Clusters entsprechende Berechtigungen (Schlüsselberechtigungen get/wrap/unwrap) für den Schlüssel zugewiesen wurden. Zeichenfolge
nodeCount Die Anzahl der Knoten, über die das Rechenzentrum verfügen sollte. Dies ist die gewünschte Zahl. Nach dem Festlegen kann es einige Zeit dauern, bis das Rechenzentrum entsprechend skaliert wird. Verwenden Sie die fetchNodeStatus-Methode für den Cluster, um die Anzahl der Knoten und deren Status zu überwachen. INT
provisionError Fehler im Zusammenhang mit der Ressourcenbereitstellung. CassandraError
provisioningState Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs. "Abgebrochen"
"Erstellen"
"Löschen"
"Fehler"
"Erfolgreich"
"Aktualisieren"
sku Vm-SKU, die für Rechenzentren verwendet wird. Standardwert ist Standard_DS14_v2 Zeichenfolge

AuthenticationMethodLdapProperties

Name BESCHREIBUNG Wert
connectionTimeoutInMs Timeout für die Verbindung mit dem LDAP-Server in Milisekunden. Der Standardwert ist 5000 ms. INT
searchBaseDistinguishedName Distinguished name of the object to start the recursive search of users from. Zeichenfolge
searchFilterTemplate Vorlage, die für die Suche verwendet werden soll. Die Standardwerte sind (cn=%s), wobei %s durch den Benutzernamen ersetzt wird, der für die Anmeldung verwendet wird. Zeichenfolge
serverZertifikate Zertifikat[]
serverHostname Hostname des LDAP-Servers. Zeichenfolge
serverPort Port des LDAP-Servers. INT
serviceUserDistinguishedName Distinguished name of the look up user account, who can look up user details on authentication. Zeichenfolge
serviceUserPassword Kennwort des Nachschlagebenutzers. Zeichenfolge

Zertifikat

Name BESCHREIBUNG Wert
Pem PEM-formatierter öffentlicher Schlüssel. Zeichenfolge

CassandraError

Name BESCHREIBUNG Wert
additionalErrorInfo Weitere Informationen zum Fehler. Zeichenfolge
code Der Fehlercode, der aufgetreten ist. Zeichenfolge
message Die Meldung des Fehlers. Zeichenfolge
target Die Zielressource des Fehlers. Zeichenfolge

Terraform-Ressourcendefinition (AzAPI-Anbieter)

Der Ressourcentyp cassandraClusters/dataCenters kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Ressourcenformat

Um eine Microsoft.DocumentDB/cassandraClusters/dataCenters-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

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

Eigenschaftswerte

cassandraClusters/dataCenters

Name BESCHREIBUNG Wert
type Der Ressourcentyp "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-03-15"
name Der Ressourcenname Zeichenfolge (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: cassandraClusters
properties Eigenschaften eines verwalteten Cassandra-Rechenzentrums. DataCenterResourceProperties

DataCenterResourceProperties

Name BESCHREIBUNG Wert
authenticationMethodLdapProperties Eigenschaften der Ldap-Authentifizierungsmethode. Dieses Feature befindet sich in der Vorschauphase. AuthenticationMethodLdapProperties
availabilityZone Wenn das Rechenzentrum Verfügbarkeitszonen unterstützt, wenden Sie sie auf das ScaleSet für virtuelle Computer an, das die virtuellen Computer des Cassandra-Rechenzentrums hostet. bool
backupStorageCustomerKeyUri Gibt den Schlüssel-URI des Kundenschlüssels an, der für die Verschlüsselung des Sicherungsspeicherkontos verwendet werden soll. Zeichenfolge
base64EncodedCassandraYamlFragment Ein Fragment einer Cassandra.yaml-Konfigurationsdatei, die in die cassandra.yaml für alle Knoten in diesem Rechenzentrum eingeschlossen werden soll. Das Fragment sollte Base64-codiert sein, und nur eine Teilmenge der Schlüssel ist zulässig. Zeichenfolge
dataCenterLocation Die Region, in der dieses Rechenzentrum erstellt werden soll. Zeichenfolge
Freigegeben Gibt an, ob die Zuordnung des Rechenzentrums aufgehoben wurde. bool
delegatedSubnetId Ressourcen-ID eines Subnetzes, mit dem die Knoten in diesem Rechenzentrum ihre Netzwerkschnittstellen verbunden sein sollen. Das Subnetz muss sich in derselben Region befinden, die in "dataCenterLocation" angegeben ist, und es muss in der Lage sein, an das Subnetz weiterzuleiten, das in der Eigenschaft "delegatedManagementSubnetId" des Clusters angegeben ist. Diese Ressourcen-ID hat das Format "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". Zeichenfolge
diskCapacity Anzahl der Datenträger, die an jeden Knoten angefügt sind. Der Standardwert ist 4. INT
diskSku Datenträger-SKU, die für Rechenzentren verwendet wird. Der Standardwert ist P30. Zeichenfolge
managedDiskCustomerKeyUri Schlüssel-URI, der für die Verschlüsselung von verwalteten Datenträgern verwendet werden soll. Stellen Sie sicher, dass der systemseitig zugewiesenen Identität des Clusters die entsprechenden Berechtigungen (Schlüsselberechtigungen zum Abrufen/Umschließen/Entpacken) für den Schlüssel zugewiesen wurden. Zeichenfolge
nodeCount Die Anzahl der Knoten, über die das Rechenzentrum verfügen sollte. Dies ist die gewünschte Zahl. Nach dem Festlegen kann es einige Zeit dauern, bis das Rechenzentrum entsprechend skaliert wird. Verwenden Sie die fetchNodeStatus-Methode für den Cluster, um die Anzahl der Knoten und deren Status zu überwachen. INT
provisionError Fehler im Zusammenhang mit der Ressourcenbereitstellung. CassandraError
provisioningState Der Status der Ressource zum Zeitpunkt des Aufrufs des Vorgangs. "Abgebrochen"
"Erstellen"
"Löschen"
"Fehler"
"Erfolgreich"
"Aktualisieren"
sku Für Rechenzentren verwendete VM-SKU. Standardwert ist Standard_DS14_v2 Zeichenfolge

AuthenticationMethodLdapProperties

Name BESCHREIBUNG Wert
connectionTimeoutInMs Timeout für die Verbindung mit dem LDAP-Server in Millisekunden. Der Standardwert ist 5000 ms. INT
searchBaseDistinguishedName Distinguished name of the object to start the reursive search of users from. Zeichenfolge
searchFilterTemplate Vorlage, die für die Suche verwendet werden soll. Der Standardwert ist (cn=%s), wobei %s durch den Benutzernamen ersetzt wird, der für die Anmeldung verwendet wird. Zeichenfolge
serverCertificates Zertifikat[]
serverHostname Hostname des LDAP-Servers. Zeichenfolge
serverPort Port des LDAP-Servers. INT
serviceUserDistinguishedName Distinguished name of the look up user account, who can look up user details on authentication. Zeichenfolge
serviceUserPassword Kennwort des Nachschlagebenutzers. Zeichenfolge

Zertifikat

Name BESCHREIBUNG Wert
Pem Öffentlicher Schlüssel im PEM-Format. Zeichenfolge

CassandraError

Name BESCHREIBUNG Wert
additionalErrorInfo Weitere Informationen zum Fehler. Zeichenfolge
code Der Code des aufgetretenen Fehlers. Zeichenfolge
message Die Meldung des Fehlers. Zeichenfolge
target Die Zielressource des Fehlers. Zeichenfolge