Delen via

Microsoft.DocumentDB cassandraClusters/dataCenters 2023-11-15

  • Artikel

Bicep-resourcedefinitie

Het resourcetype cassandraClusters/dataCenters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een resource Microsoft.DocumentDB/cassandraClusters/dataCenters wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

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

Eigenschapswaarden

cassandraClusters/dataCenters

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.		 tekenreeks (vereist)
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.		 Symbolische naam voor resource van het type: cassandraClusters
properties Eigenschappen van een beheerd Cassandra-datacenter. DataCenterResourceProperties

DataCenterResourceProperties

Naam Description Waarde
authenticationMethodLdapProperties Eigenschappen van ldap-verificatiemethode. Deze functie is beschikbaar als preview-versie. AuthenticationMethodLdapProperties
availabilityZone Als het datacenter ondersteuning voor beschikbaarheidszones heeft, past u deze toe op de Virtual Machine ScaleSet die als host fungeert voor de virtuele machines van het Cassandra-datacenter. booleaans
backupStorageCustomerKeyUri Geeft de sleutel-URI van de klantsleutel aan die moet worden gebruikt voor versleuteling van het back-upopslagaccount. tekenreeks
base64EncodedCassandraYamlFragment Een fragment van een cassandra.yaml-configuratiebestand dat moet worden opgenomen in cassandra.yaml voor alle knooppunten in dit datacenter. Het fragment moet base64-gecodeerd zijn en alleen een subset van sleutels is toegestaan. tekenreeks
dataCenterLocation De regio waarin dit datacenter moet worden gemaakt. tekenreeks
toewijzing ongedaan gemaakt Of de toewijzing van het datacenter ongedaan is gemaakt. booleaans
delegatedSubnetId Resource-id van een subnet met de knooppunten in dit datacenter moeten de netwerkinterfaces zijn verbonden. Het subnet moet zich in dezelfde regio bevinden die is opgegeven in 'dataCenterLocation' en moet kunnen worden gerouteerd naar het subnet dat is opgegeven in de eigenschap delegatedManagementSubnetId van het cluster. Deze resource-id heeft de vorm '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. tekenreeks
diskCapacity Aantal schijven dat aan elk knooppunt is gekoppeld. De standaardwaarde is 4. int
diskSku Schijf-SKU die wordt gebruikt voor datacenters. De standaardwaarde is P30. tekenreeks
managedDiskCustomerKeyUri Sleutel-URI die moet worden gebruikt voor versleuteling van beheerde schijven. Zorg ervoor dat aan de door het systeem toegewezen identiteit van het cluster de juiste machtigingen (machtigingen voor sleutel ophalen/verpakken/uitpakken) voor de sleutel zijn toegewezen. tekenreeks
nodeCount Het aantal knooppunten dat het datacenter moet hebben. Dit is het gewenste getal. Nadat het is ingesteld, kan het enige tijd duren voordat het datacenter is aangepast. Als u het aantal knooppunten en hun status wilt controleren, gebruikt u de methode fetchNodeStatus op het cluster. int
provisionError Fout met betrekking tot het inrichten van resources. CassandraError
provisioningState De status van de resource op het moment dat de bewerking werd aangeroepen. 'Geannuleerd'
'Maken'
'Verwijderen'
'Mislukt'
'Geslaagd'
'Bijwerken'
sku Virtuele-machine-SKU die wordt gebruikt voor datacenters. De standaardwaarde is Standard_DS14_v2 tekenreeks

AuthenticationMethodLdapProperties

Naam Description Waarde
connectionTimeoutInMs Time-out voor het maken van verbinding met de LDAP-server in miliseconden. De standaardwaarde is 5000 ms. int
searchBaseDistinguishedName DN-naam van het object waaruit de recursieve zoekopdracht van gebruikers wordt gestart. tekenreeks
searchFilterTemplate Sjabloon die moet worden gebruikt om te zoeken. Standaard ingesteld op (cn=%s), waarbij %s wordt vervangen door de gebruikersnaam die wordt gebruikt om u aan te melden. tekenreeks
serverCertificaten Certificaat[]
serverHostname Hostnaam van de LDAP-server. tekenreeks
serverPort Poort van de LDAP-server. int
serviceUserDistinguishedName DN-naam van het opzoekgebruikersaccount, dat gebruikersgegevens kan opzoeken bij verificatie. tekenreeks
serviceUserPassword Wachtwoord van de opzoekgebruiker. tekenreeks

Certificaat

Naam Description Waarde
Pem Openbare sleutel met PEM-indeling. tekenreeks

CassandraError

Naam Description Waarde
additionalErrorInfo Aanvullende informatie over de fout. tekenreeks
code De code van de fout die is opgetreden. tekenreeks
message Het bericht van de fout. tekenreeks
Doel De doelresource van de fout. tekenreeks

Resourcedefinitie van ARM-sjabloon

Het resourcetype cassandraClusters/dataCenters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/cassandraClusters/dataCenters wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

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

Eigenschapswaarden

cassandraClusters/dataCenters

Naam Description Waarde
type Het resourcetype 'Microsoft.DocumentDB/cassandraClusters/dataCenters'
apiVersion De resource-API-versie '2023-11-15'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.		 tekenreeks (vereist)
properties Eigenschappen van een beheerd Cassandra-datacenter. DataCenterResourceProperties

DataCenterResourceProperties

Naam Description Waarde
authenticationMethodLdapProperties Eigenschappen van ldap-verificatiemethode. Deze functie is beschikbaar als preview-versie. AuthenticationMethodLdapProperties
availabilityZone Als het datacenter ondersteuning voor beschikbaarheidszones heeft, past u dit toe op de virtuele-machineschaalset die als host fungeert voor de virtuele machines van het Cassandra-datacenter. booleaans
backupStorageCustomerKeyUri Geeft de sleutel-URI van de klantsleutel aan die moet worden gebruikt voor versleuteling van het back-upopslagaccount. tekenreeks
base64EncodedCassandraYamlFragment Een fragment van een cassandra.yaml-configuratiebestand dat moet worden opgenomen in cassandra.yaml voor alle knooppunten in dit datacenter. Het fragment moet base64-gecodeerd zijn en alleen een subset van sleutels is toegestaan. tekenreeks
dataCenterLocation De regio waarin dit datacenter moet worden gemaakt. tekenreeks
toewijzing ongedaan gemaakt Of de toewijzing van het datacenter ongedaan is gemaakt. booleaans
delegatedSubnetId Resource-id van een subnet met de knooppunten in dit datacenter moeten de netwerkinterfaces zijn verbonden. Het subnet moet zich in dezelfde regio bevinden die is opgegeven in 'dataCenterLocation' en moet kunnen worden gerouteerd naar het subnet dat is opgegeven in de eigenschap delegatedManagementSubnetId van het cluster. Deze resource-id heeft de vorm '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. tekenreeks
diskCapacity Aantal schijven dat aan elk knooppunt is gekoppeld. De standaardwaarde is 4. int
diskSku Schijf-SKU die wordt gebruikt voor datacenters. De standaardwaarde is P30. tekenreeks
managedDiskCustomerKeyUri Sleutel-URI die moet worden gebruikt voor versleuteling van beheerde schijven. Zorg ervoor dat aan de door het systeem toegewezen identiteit van het cluster de juiste machtigingen (machtigingen voor sleutel ophalen/verpakken/uitpakken) voor de sleutel zijn toegewezen. tekenreeks
nodeCount Het aantal knooppunten dat het datacenter moet hebben. Dit is het gewenste getal. Nadat het is ingesteld, kan het enige tijd duren voordat het datacenter is aangepast. Als u het aantal knooppunten en hun status wilt controleren, gebruikt u de methode fetchNodeStatus op het cluster. int
provisionError Fout met betrekking tot het inrichten van resources. CassandraError
provisioningState De status van de resource op het moment dat de bewerking werd aangeroepen. 'Geannuleerd'
'Maken'
'Verwijderen'
'Mislukt'
Geslaagd
'Bijwerken'
sku Virtuele-machine-SKU die wordt gebruikt voor datacenters. De standaardwaarde is Standard_DS14_v2 tekenreeks

AuthenticationMethodLdapProperties

Naam Description Waarde
connectionTimeoutInMs Time-out voor het maken van verbinding met de LDAP-server in miliseconden. De standaardwaarde is 5000 ms. int
searchBaseDistinguishedName DN-naam van het object waaruit de recursieve zoekopdracht van gebruikers wordt gestart. tekenreeks
searchFilterTemplate Sjabloon die moet worden gebruikt voor zoeken. De standaardinstelling is (cn=%s), waarbij %s wordt vervangen door de gebruikersnaam die wordt gebruikt om u aan te melden. tekenreeks
serverCertificaten Certificaat[]
serverHostname Hostnaam van de LDAP-server. tekenreeks
serverPort Poort van de LDAP-server. int
serviceUserDistinguishedName DN-naam van het gebruikersaccount voor opzoeken, die gebruikersgegevens kan opzoeken bij verificatie. tekenreeks
serviceUserPassword Wachtwoord van de opzoekgebruiker. tekenreeks

Certificaat

Naam Description Waarde
Pem Openbare sleutel met PEM-indeling. tekenreeks

CassandraError

Naam Description Waarde
additionalErrorInfo Aanvullende informatie over de fout. tekenreeks
code De code van de fout die is opgetreden. tekenreeks
message Het bericht van de fout. tekenreeks
Doel De doelresource van de fout. tekenreeks

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype cassandraClusters/dataCenters kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource Microsoft.DocumentDB/cassandraClusters/dataCenters wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

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

Eigenschapswaarden

cassandraClusters/dataCenters

Naam Description Waarde
type Het resourcetype "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15"
naam De resourcenaam tekenreeks (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: cassandraClusters
properties Eigenschappen van een beheerd Cassandra-datacenter. DataCenterResourceProperties

DataCenterResourceProperties

Naam Description Waarde
authenticationMethodLdapProperties Eigenschappen van ldap-verificatiemethode. Deze functie is beschikbaar als preview-versie. AuthenticationMethodLdapProperties
availabilityZone Als het datacenter ondersteuning voor beschikbaarheidszones heeft, past u dit toe op de virtuele-machineschaalset die als host fungeert voor de virtuele machines van het Cassandra-datacenter. booleaans
backupStorageCustomerKeyUri Geeft de sleutel-URI van de klantsleutel aan die moet worden gebruikt voor versleuteling van het back-upopslagaccount. tekenreeks
base64EncodedCassandraYamlFragment Een fragment van een configuratiebestand cassandra.yaml dat moet worden opgenomen in de cassandra.yaml voor alle knooppunten in dit datacenter. Het fragment moet Base64-gecodeerd zijn en alleen een subset van sleutels is toegestaan. tekenreeks
dataCenterLocation De regio waarin dit datacenter moet worden gemaakt. tekenreeks
toewijzing ongedaan gemaakt Of de toewijzing van het datacenter ongedaan is gemaakt. booleaans
delegatedSubnetId Resource-id van een subnet met de knooppunten in dit datacenter moeten de netwerkinterfaces zijn verbonden. Het subnet moet zich in dezelfde regio bevinden die is opgegeven in 'dataCenterLocation' en moet kunnen worden gerouteerd naar het subnet dat is opgegeven in de eigenschap delegatedManagementSubnetId van het cluster. Deze resource-id heeft de vorm '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. tekenreeks
diskCapacity Het aantal schijven dat aan elk knooppunt is gekoppeld. De standaardwaarde is 4. int
diskSku Schijf-SKU die wordt gebruikt voor datacenters. De standaardwaarde is P30. tekenreeks
managedDiskCustomerKeyUri Sleutel-URI die moet worden gebruikt voor versleuteling van beheerde schijven. Zorg ervoor dat aan de door het systeem toegewezen identiteit van het cluster de juiste machtigingen zijn toegewezen (machtigingen voor sleutel ophalen/verpakken/uitpakken) voor de sleutel. tekenreeks
nodeCount Het aantal knooppunten dat het datacenter moet hebben. Dit is het gewenste getal. Nadat deze is ingesteld, kan het even duren voordat het datacenter is geschaald. Als u het aantal knooppunten en hun status wilt bewaken, gebruikt u de methode fetchNodeStatus op het cluster. int
provisionError Fout met betrekking tot het inrichten van resources. CassandraError
provisioningState De status van de resource op het moment dat de bewerking werd aangeroepen. "Geannuleerd"
"Maken"
"Verwijderen"
"Mislukt"
"Geslaagd"
"Bijwerken"
sku Virtuele-machine-SKU die wordt gebruikt voor datacenters. De standaardwaarde is Standard_DS14_v2 tekenreeks

AuthenticationMethodLdapProperties

Naam Description Waarde
connectionTimeoutInMs Time-out voor het maken van verbinding met de LDAP-server in miliseconden. De standaardwaarde is 5000 ms. int
searchBaseDistinguishedName DN-naam van het object waaruit de recursieve zoekopdracht van gebruikers wordt gestart. tekenreeks
searchFilterTemplate Sjabloon die moet worden gebruikt om te zoeken. Standaard ingesteld op (cn=%s), waarbij %s wordt vervangen door de gebruikersnaam die wordt gebruikt om u aan te melden. tekenreeks
serverCertificaten Certificaat[]
serverHostname Hostnaam van de LDAP-server. tekenreeks
serverPort Poort van de LDAP-server. int
serviceUserDistinguishedName DN-naam van het opzoekgebruikersaccount, dat gebruikersgegevens kan opzoeken bij verificatie. tekenreeks
serviceUserPassword Wachtwoord van de opzoekgebruiker. tekenreeks

Certificaat

Naam Description Waarde
Pem Openbare sleutel met PEM-indeling. tekenreeks

CassandraError

Naam Description Waarde
additionalErrorInfo Aanvullende informatie over de fout. tekenreeks
code De code van de fout die is opgetreden. tekenreeks
message Het bericht van de fout. tekenreeks
Doel De doelresource van de fout. tekenreeks