Freigeben über


Microsoft.DocumentDB cassandraClusters/dataCenters 2023-09-15

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 ihrer Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-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'
  }
}

Eigenschaftswerte

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. Schnur
searchFilterTemplate Vorlage, die für die Suche verwendet werden soll. Standardwert ist (cn=%s), wobei %s durch den Benutzernamen ersetzt wird, der für die Anmeldung verwendet wird. Schnur
serverCertificates Zertifikat[]
serverHostname Hostname des LDAP-Servers. Schnur
serverPort Port des LDAP-Servers. Int
serviceUserDistinguishedName Distinguished name of the look up user account, who can look up user details on authentication. Schnur
serviceUserPassword Kennwort des Nachschlagebenutzers. Schnur

CassandraError

Name Beschreibung Wert
additionalErrorInfo Zusätzliche Informationen zum Fehler. Schnur
Code Der Fehlercode, der aufgetreten ist. Schnur
Nachricht Die Meldung des Fehlers. Schnur
Ziel Die Zielressource des Fehlers. Schnur

Zertifikat

Name Beschreibung Wert
Pem PEM formatierter öffentlicher Schlüssel. Schnur

DataCenterResourceProperties

Name Beschreibung Wert
authenticationMethodLdapProperties Eigenschaften der Ldap-Authentifizierungsmethode. Dieses Feature befindet sich in der Vorschau. AuthenticationMethodLdapProperties
availabilityZone Wenn das Rechenzentrum über Unterstützung für die Verfügbarkeitszone verfügt, wenden Sie es auf das ScaleSet des virtuellen Computers des virtuellen Computers des virtuellen Cassandra-Rechenzentrums an. Bool
backupStorageCustomerKeyUri Gibt den Schlüssel-URI des Kundenschlüssels an, der für die Verschlüsselung des Sicherungsspeicherkontos verwendet werden soll. Schnur
base64EncodedCassandraYamlFragment Ein Fragment einer cassandra.yaml-Konfigurationsdatei, die in das cassandra.yaml für alle Knoten in diesem Rechenzentrum aufgenommen werden soll. Das Fragment sollte base64-codiert sein, und nur eine Teilmenge von Schlüsseln ist zulässig. Schnur
dataCenterLocation Die Region dieses Rechenzentrums sollte erstellt werden. Schnur
Freigegeben Gibt an, ob das Rechenzentrum umgestellt wurde. Bool
delegierteSubnetId Die Ressourcen-ID eines Subnetzes, mit dem die Knoten in diesem Rechenzentrum verbunden sein sollen. Das Subnetz muss sich in derselben Region befinden, die in 'dataCenterLocation' angegeben ist, und muss in der Lage sein, zum subnetz zu leiten, das in der Eigenschaft "delegatedManagementSubnetId" des Clusters angegeben ist. Diese Ressourcen-ID ist das Format "/subscriptions/<Abonnement-ID>/resourceGroups/<Ressourcengruppe>/providers/Microsoft.Network/virtualNetworks/<virtuelles Netzwerk>/subnets/<Subnetz>". Schnur
diskCapacity Die 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. Schnur
managedDiskCustomerKeyUri Schlüssel-URI, der für die Verschlüsselung von verwalteten Datenträgern verwendet werden soll. Stellen Sie sicher, dass der vom System zugewiesene Identität des Clusters für den Schlüssel geeignete Berechtigungen zugewiesen wurde(key get/wrap/unwrap permissions). Schnur
nodeCount Die Anzahl der Knoten, die das Rechenzentrum aufweisen soll. Dies ist die gewünschte Zahl. Nachdem sie festgelegt wurde, kann es einige Zeit dauern, bis das Rechenzentrum entsprechend skaliert wird. Um die Anzahl der Knoten und deren Status zu überwachen, verwenden Sie die fetchNodeStatus-Methode auf dem Cluster. 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 Virtuelle Computer-SKU, die für Rechenzentren verwendet wird. Standardwert ist Standard_DS14_v2 Schnur

Microsoft.DocumentDB/cassandraClusters/dataCenters

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (erforderlich)
Elternteil 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
Eigenschaften Eigenschaften eines verwalteten Cassandra-Rechenzentrums. DataCenterResourceProperties-

ARM-Vorlagenressourcendefinition

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 JSON-Code hinzu.

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

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. Schnur
searchFilterTemplate Vorlage, die für die Suche verwendet werden soll. Standardwert ist (cn=%s), wobei %s durch den Benutzernamen ersetzt wird, der für die Anmeldung verwendet wird. Schnur
serverCertificates Zertifikat[]
serverHostname Hostname des LDAP-Servers. Schnur
serverPort Port des LDAP-Servers. Int
serviceUserDistinguishedName Distinguished name of the look up user account, who can look up user details on authentication. Schnur
serviceUserPassword Kennwort des Nachschlagebenutzers. Schnur

CassandraError

Name Beschreibung Wert
additionalErrorInfo Zusätzliche Informationen zum Fehler. Schnur
Code Der Fehlercode, der aufgetreten ist. Schnur
Nachricht Die Meldung des Fehlers. Schnur
Ziel Die Zielressource des Fehlers. Schnur

Zertifikat

Name Beschreibung Wert
Pem PEM formatierter öffentlicher Schlüssel. Schnur

DataCenterResourceProperties

Name Beschreibung Wert
authenticationMethodLdapProperties Eigenschaften der Ldap-Authentifizierungsmethode. Dieses Feature befindet sich in der Vorschau. AuthenticationMethodLdapProperties
availabilityZone Wenn das Rechenzentrum über Unterstützung für die Verfügbarkeitszone verfügt, wenden Sie es auf das ScaleSet des virtuellen Computers des virtuellen Computers des virtuellen Cassandra-Rechenzentrums an. Bool
backupStorageCustomerKeyUri Gibt den Schlüssel-URI des Kundenschlüssels an, der für die Verschlüsselung des Sicherungsspeicherkontos verwendet werden soll. Schnur
base64EncodedCassandraYamlFragment Ein Fragment einer cassandra.yaml-Konfigurationsdatei, die in das cassandra.yaml für alle Knoten in diesem Rechenzentrum aufgenommen werden soll. Das Fragment sollte base64-codiert sein, und nur eine Teilmenge von Schlüsseln ist zulässig. Schnur
dataCenterLocation Die Region dieses Rechenzentrums sollte erstellt werden. Schnur
Freigegeben Gibt an, ob das Rechenzentrum umgestellt wurde. Bool
delegierteSubnetId Die Ressourcen-ID eines Subnetzes, mit dem die Knoten in diesem Rechenzentrum verbunden sein sollen. Das Subnetz muss sich in derselben Region befinden, die in 'dataCenterLocation' angegeben ist, und muss in der Lage sein, zum subnetz zu leiten, das in der Eigenschaft "delegatedManagementSubnetId" des Clusters angegeben ist. Diese Ressourcen-ID ist das Format "/subscriptions/<Abonnement-ID>/resourceGroups/<Ressourcengruppe>/providers/Microsoft.Network/virtualNetworks/<virtuelles Netzwerk>/subnets/<Subnetz>". Schnur
diskCapacity Die 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. Schnur
managedDiskCustomerKeyUri Schlüssel-URI, der für die Verschlüsselung von verwalteten Datenträgern verwendet werden soll. Stellen Sie sicher, dass der vom System zugewiesene Identität des Clusters für den Schlüssel geeignete Berechtigungen zugewiesen wurde(key get/wrap/unwrap permissions). Schnur
nodeCount Die Anzahl der Knoten, die das Rechenzentrum aufweisen soll. Dies ist die gewünschte Zahl. Nachdem sie festgelegt wurde, kann es einige Zeit dauern, bis das Rechenzentrum entsprechend skaliert wird. Um die Anzahl der Knoten und deren Status zu überwachen, verwenden Sie die fetchNodeStatus-Methode auf dem Cluster. 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 Virtuelle Computer-SKU, die für Rechenzentren verwendet wird. Standardwert ist Standard_DS14_v2 Schnur

Microsoft.DocumentDB/cassandraClusters/dataCenters

Name Beschreibung Wert
apiVersion Die API-Version '2023-09-15'
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (erforderlich)
Eigenschaften Eigenschaften eines verwalteten Cassandra-Rechenzentrums. DataCenterResourceProperties-
Art Der Ressourcentyp 'Microsoft.DocumentDB/cassandraClusters/dataCenters'

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 unter Änderungsprotokoll.

Ressourcenformat

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-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"
    }
  })
}

Eigenschaftswerte

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. Schnur
searchFilterTemplate Vorlage, die für die Suche verwendet werden soll. Standardwert ist (cn=%s), wobei %s durch den Benutzernamen ersetzt wird, der für die Anmeldung verwendet wird. Schnur
serverCertificates Zertifikat[]
serverHostname Hostname des LDAP-Servers. Schnur
serverPort Port des LDAP-Servers. Int
serviceUserDistinguishedName Distinguished name of the look up user account, who can look up user details on authentication. Schnur
serviceUserPassword Kennwort des Nachschlagebenutzers. Schnur

CassandraError

Name Beschreibung Wert
additionalErrorInfo Zusätzliche Informationen zum Fehler. Schnur
Code Der Fehlercode, der aufgetreten ist. Schnur
Nachricht Die Meldung des Fehlers. Schnur
Ziel Die Zielressource des Fehlers. Schnur

Zertifikat

Name Beschreibung Wert
Pem PEM formatierter öffentlicher Schlüssel. Schnur

DataCenterResourceProperties

Name Beschreibung Wert
authenticationMethodLdapProperties Eigenschaften der Ldap-Authentifizierungsmethode. Dieses Feature befindet sich in der Vorschau. AuthenticationMethodLdapProperties
availabilityZone Wenn das Rechenzentrum über Unterstützung für die Verfügbarkeitszone verfügt, wenden Sie es auf das ScaleSet des virtuellen Computers des virtuellen Computers des virtuellen Cassandra-Rechenzentrums an. Bool
backupStorageCustomerKeyUri Gibt den Schlüssel-URI des Kundenschlüssels an, der für die Verschlüsselung des Sicherungsspeicherkontos verwendet werden soll. Schnur
base64EncodedCassandraYamlFragment Ein Fragment einer cassandra.yaml-Konfigurationsdatei, die in das cassandra.yaml für alle Knoten in diesem Rechenzentrum aufgenommen werden soll. Das Fragment sollte base64-codiert sein, und nur eine Teilmenge von Schlüsseln ist zulässig. Schnur
dataCenterLocation Die Region dieses Rechenzentrums sollte erstellt werden. Schnur
Freigegeben Gibt an, ob das Rechenzentrum umgestellt wurde. Bool
delegierteSubnetId Die Ressourcen-ID eines Subnetzes, mit dem die Knoten in diesem Rechenzentrum verbunden sein sollen. Das Subnetz muss sich in derselben Region befinden, die in 'dataCenterLocation' angegeben ist, und muss in der Lage sein, zum subnetz zu leiten, das in der Eigenschaft "delegatedManagementSubnetId" des Clusters angegeben ist. Diese Ressourcen-ID ist das Format "/subscriptions/<Abonnement-ID>/resourceGroups/<Ressourcengruppe>/providers/Microsoft.Network/virtualNetworks/<virtuelles Netzwerk>/subnets/<Subnetz>". Schnur
diskCapacity Die 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. Schnur
managedDiskCustomerKeyUri Schlüssel-URI, der für die Verschlüsselung von verwalteten Datenträgern verwendet werden soll. Stellen Sie sicher, dass der vom System zugewiesene Identität des Clusters für den Schlüssel geeignete Berechtigungen zugewiesen wurde(key get/wrap/unwrap permissions). Schnur
nodeCount Die Anzahl der Knoten, die das Rechenzentrum aufweisen soll. Dies ist die gewünschte Zahl. Nachdem sie festgelegt wurde, kann es einige Zeit dauern, bis das Rechenzentrum entsprechend skaliert wird. Um die Anzahl der Knoten und deren Status zu überwachen, verwenden Sie die fetchNodeStatus-Methode auf dem Cluster. 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 Virtuelle Computer-SKU, die für Rechenzentren verwendet wird. Standardwert ist Standard_DS14_v2 Schnur

Microsoft.DocumentDB/cassandraClusters/dataCenters

Name Beschreibung Wert
Name Der Ressourcenname Schnur

Zwänge:
Min. Länge = 1
Max. Länge = 1
Pattern = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (erforderlich)
parent_id Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. ID für Ressource vom Typ: cassandraClusters
Eigenschaften Eigenschaften eines verwalteten Cassandra-Rechenzentrums. DataCenterResourceProperties-
Art Der Ressourcentyp "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-09-15"