Delen via

Microsoft.DocumentDB cassandraClusters/dataCenters 2024-12-01-preview

  • Artikel

Bicep-resourcedefinitie

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

Zie logboek wijzigenvoor 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@2024-12-01-preview' = {
  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
    privateEndpointIpAddress: 'string'
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

Eigenschapswaarden

AuthenticationMethodLdapProperties

Naam Beschrijving 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 om de recursieve zoekopdracht van gebruikers te starten. snaar
searchFilterTemplate Te gebruiken sjabloon voor zoeken. De standaardwaarde is (cn=%s) waarbij %s wordt vervangen door de gebruikersnaam die wordt gebruikt om u aan te melden. snaar
serverCertificates Certificaat[]
serverHostname Hostnaam van de LDAP-server. snaar
serverPort Poort van de LDAP-server. Int
serviceUserDistinguishedName DN-naam van het opzoekgebruikersaccount, die gebruikersgegevens over verificatie kan opzoeken. snaar
serviceUserPassword Wachtwoord van de gebruiker opzoeken. snaar

CassandraError

Naam Beschrijving Waarde
additionalErrorInfo Aanvullende informatie over de fout. snaar
code De code van de fout die is opgetreden. snaar
Bericht Het bericht van de fout. snaar
doel De doelresource van de fout. snaar

Certificaat

Naam Beschrijving Waarde
Pem Openbare sleutel met PEM-indeling. snaar

DataCenterResourceProperties

Naam Beschrijving 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. Bool
backupStorageCustomerKeyUri Geeft de sleutel-URI aan van de klantsleutel die moet worden gebruikt voor versleuteling van het back-upopslagaccount. snaar
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 zijn gecodeerd en er is slechts een subset sleutels toegestaan. snaar
dataCenterLocation De regio waarin dit datacenter moet worden gemaakt. snaar
toewijzing ongedaan gemaakt Of de toewijzing van het datacenter ongedaan is gemaakt. Bool
delegatedSubnetId De resource-id van een subnet waar de knooppunten in dit datacenter mee moeten 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/<resourcegroep>/providers/Microsoft.Network/virtualNetworks/<virtueel netwerk>/subnetten/<subnet>'. snaar
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. snaar
managedDiskCustomerKeyUri Sleutel-URI die moet worden gebruikt voor versleuteling van beheerde schijven. Zorg ervoor dat aan de sleutel de door het systeem toegewezen identiteit van het cluster de juiste machtigingen zijn toegewezen (key get/wrap/unwrap-machtigingen). snaar
nodeCount Het aantal knooppunten dat het datacenter moet hebben. Dit is het gewenste getal. Nadat het is ingesteld, kan het even duren voordat het datacenter is geschaald. Als u het aantal knooppunten en hun status wilt controleren, gebruikt u de methode fetchNodeStatus in het cluster. Int
privateEndpointIpAddress Ip van het VPN-eindpunt voor dit datacenter. snaar
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 snaar

Microsoft.DocumentDB/cassandraClusters/dataCenters

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (vereist)
ouder 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 de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: cassandraClusters
Eigenschappen Eigenschappen van een beheerd Cassandra-datacenter. DataCenterResourceProperties-

Resourcedefinitie van ARM-sjabloon

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

Zie logboek wijzigenvoor 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": "2024-12-01-preview",
  "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"
  }
}

Eigenschapswaarden

AuthenticationMethodLdapProperties

Naam Beschrijving 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 om de recursieve zoekopdracht van gebruikers te starten. snaar
searchFilterTemplate Te gebruiken sjabloon voor zoeken. De standaardwaarde is (cn=%s) waarbij %s wordt vervangen door de gebruikersnaam die wordt gebruikt om u aan te melden. snaar
serverCertificates Certificaat[]
serverHostname Hostnaam van de LDAP-server. snaar
serverPort Poort van de LDAP-server. Int
serviceUserDistinguishedName DN-naam van het opzoekgebruikersaccount, die gebruikersgegevens over verificatie kan opzoeken. snaar
serviceUserPassword Wachtwoord van de gebruiker opzoeken. snaar

CassandraError

Naam Beschrijving Waarde
additionalErrorInfo Aanvullende informatie over de fout. snaar
code De code van de fout die is opgetreden. snaar
Bericht Het bericht van de fout. snaar
doel De doelresource van de fout. snaar

Certificaat

Naam Beschrijving Waarde
Pem Openbare sleutel met PEM-indeling. snaar

DataCenterResourceProperties

Naam Beschrijving 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. Bool
backupStorageCustomerKeyUri Geeft de sleutel-URI aan van de klantsleutel die moet worden gebruikt voor versleuteling van het back-upopslagaccount. snaar
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 zijn gecodeerd en er is slechts een subset sleutels toegestaan. snaar
dataCenterLocation De regio waarin dit datacenter moet worden gemaakt. snaar
toewijzing ongedaan gemaakt Of de toewijzing van het datacenter ongedaan is gemaakt. Bool
delegatedSubnetId De resource-id van een subnet waar de knooppunten in dit datacenter mee moeten 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/<resourcegroep>/providers/Microsoft.Network/virtualNetworks/<virtueel netwerk>/subnetten/<subnet>'. snaar
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. snaar
managedDiskCustomerKeyUri Sleutel-URI die moet worden gebruikt voor versleuteling van beheerde schijven. Zorg ervoor dat aan de sleutel de door het systeem toegewezen identiteit van het cluster de juiste machtigingen zijn toegewezen (key get/wrap/unwrap-machtigingen). snaar
nodeCount Het aantal knooppunten dat het datacenter moet hebben. Dit is het gewenste getal. Nadat het is ingesteld, kan het even duren voordat het datacenter is geschaald. Als u het aantal knooppunten en hun status wilt controleren, gebruikt u de methode fetchNodeStatus in het cluster. Int
privateEndpointIpAddress Ip van het VPN-eindpunt voor dit datacenter. snaar
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 snaar

Microsoft.DocumentDB/cassandraClusters/dataCenters

Naam Beschrijving Waarde
apiVersion De API-versie '2024-12-01-preview'
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (vereist)
Eigenschappen Eigenschappen van een beheerd Cassandra-datacenter. DataCenterResourceProperties-
type Het resourcetype 'Microsoft.DocumentDB/cassandraClusters/dataCenters'

Resourcedefinitie van Terraform (AzAPI-provider)

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

  • resourcegroepen

Zie logboek wijzigenvoor 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@2024-12-01-preview"
  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
      privateEndpointIpAddress = "string"
      provisionError = {
        additionalErrorInfo = "string"
        code = "string"
        message = "string"
        target = "string"
      }
      provisioningState = "string"
      sku = "string"
    }
  })
}

Eigenschapswaarden

AuthenticationMethodLdapProperties

Naam Beschrijving 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 om de recursieve zoekopdracht van gebruikers te starten. snaar
searchFilterTemplate Te gebruiken sjabloon voor zoeken. De standaardwaarde is (cn=%s) waarbij %s wordt vervangen door de gebruikersnaam die wordt gebruikt om u aan te melden. snaar
serverCertificates Certificaat[]
serverHostname Hostnaam van de LDAP-server. snaar
serverPort Poort van de LDAP-server. Int
serviceUserDistinguishedName DN-naam van het opzoekgebruikersaccount, die gebruikersgegevens over verificatie kan opzoeken. snaar
serviceUserPassword Wachtwoord van de gebruiker opzoeken. snaar

CassandraError

Naam Beschrijving Waarde
additionalErrorInfo Aanvullende informatie over de fout. snaar
code De code van de fout die is opgetreden. snaar
Bericht Het bericht van de fout. snaar
doel De doelresource van de fout. snaar

Certificaat

Naam Beschrijving Waarde
Pem Openbare sleutel met PEM-indeling. snaar

DataCenterResourceProperties

Naam Beschrijving 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. Bool
backupStorageCustomerKeyUri Geeft de sleutel-URI aan van de klantsleutel die moet worden gebruikt voor versleuteling van het back-upopslagaccount. snaar
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 zijn gecodeerd en er is slechts een subset sleutels toegestaan. snaar
dataCenterLocation De regio waarin dit datacenter moet worden gemaakt. snaar
toewijzing ongedaan gemaakt Of de toewijzing van het datacenter ongedaan is gemaakt. Bool
delegatedSubnetId De resource-id van een subnet waar de knooppunten in dit datacenter mee moeten 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/<resourcegroep>/providers/Microsoft.Network/virtualNetworks/<virtueel netwerk>/subnetten/<subnet>'. snaar
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. snaar
managedDiskCustomerKeyUri Sleutel-URI die moet worden gebruikt voor versleuteling van beheerde schijven. Zorg ervoor dat aan de sleutel de door het systeem toegewezen identiteit van het cluster de juiste machtigingen zijn toegewezen (key get/wrap/unwrap-machtigingen). snaar
nodeCount Het aantal knooppunten dat het datacenter moet hebben. Dit is het gewenste getal. Nadat het is ingesteld, kan het even duren voordat het datacenter is geschaald. Als u het aantal knooppunten en hun status wilt controleren, gebruikt u de methode fetchNodeStatus in het cluster. Int
privateEndpointIpAddress Ip van het VPN-eindpunt voor dit datacenter. snaar
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 snaar

Microsoft.DocumentDB/cassandraClusters/dataCenters

Naam Beschrijving Waarde
naam De resourcenaam snaar

Beperkingen:
Minimale lengte = 1
Maximale lengte = 1
Patroon = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: cassandraClusters
Eigenschappen Eigenschappen van een beheerd Cassandra-datacenter. DataCenterResourceProperties-
type Het resourcetype "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-12-01-preview"