Dela via

Microsoft.DocumentDB cassandraClusters/dataCenters 2023-04-15

  • Artikel

Bicep-resursdefinition

Resurstypen cassandraClusters/dataCenters kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/cassandraClusters/dataCenters-resurs lägger du till följande Bicep i mallen.

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

Egenskapsvärden

cassandraClusters/dataCenters

Name Beskrivning Värde
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i Bicep.		 sträng (krävs)
parent I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.

Mer information finns i Underordnad resurs utanför överordnad resurs.		 Symboliskt namn för resurs av typen: cassandraClusters
properties Egenskaper för ett hanterat Cassandra-datacenter. DataCenterResourceProperties

DataCenterResourceProperties

Name Beskrivning Värde
authenticationMethodLdapProperties Egenskaper för Ldap-autentiseringsmetod. Den här funktionen är en förhandsversion. AuthenticationMethodLdapProperties
availabilityZone Om datacentret har stöd för tillgänglighetszoner tillämpar du det på vm-skalningsuppsättningen som är värd för virtuella datorer i Cassandra-datacentret. boolesk
backupStorageCustomerKeyUri Anger nyckel-URI för kundnyckeln som ska användas för kryptering av lagringskontot för säkerhetskopior. sträng
base64EncodedCassandraYamlFragment Ett fragment av en cassandra.yaml-konfigurationsfil som ska ingå i cassandra.yaml för alla noder i det här datacentret. Fragmentet ska vara Base64-kodat och endast en delmängd nycklar tillåts. sträng
dataCenterLocation Den region som det här datacentret ska skapas i. sträng
frigjord Om datacentret har frigjorts. boolesk
delegatedSubnetId Resurs-ID för ett undernät som noderna i det här datacentret ska ha sina nätverksgränssnitt anslutna till. Undernätet måste finnas i samma region som anges i "dataCenterLocation" och måste kunna dirigeras till det undernät som anges i klustrets egenskap "delegatedManagementSubnetId". Det här resurs-ID:t kommer att ha formatet "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". sträng
diskKapacitet Antal diskar som är anslutna till varje nod. Standardvärdet är 4. int
diskSku Disk-SKU som används för datacenter. Standardvärdet är P30. sträng
managedDiskCustomerKeyUri Nyckel-URI som ska användas för kryptering av hanterade diskar. Se till att klustrets systemtilldelade identitet har tilldelats lämpliga behörigheter (behörigheterna hämta/omsluta/packa upp) för nyckeln. sträng
nodeCount Antalet noder som datacentret ska ha. Det här är det önskade talet. När den har angetts kan det ta lite tid innan datacentret skalas så att det matchar. Om du vill övervaka antalet noder och deras status använder du metoden fetchNodeStatus i klustret. int
provisionError Fel som rör resursetablering. CassandraError
provisioningState Status för resursen vid den tidpunkt då åtgärden anropades. "Avbruten"
"Skapar"
"Tar bort"
"Misslyckades"
"Lyckades"
"Uppdaterar"
sku SKU för virtuella datorer som används för datacenter. Standardvärdet är Standard_DS14_v2 sträng

AuthenticationMethodLdapProperties

Name Beskrivning Värde
connectionTimeoutInMs Tidsgräns för anslutning till LDAP-servern i miliseconds. Standardvärdet är 5 000 ms. int
searchBaseDistinguishedName Unikt namn på objektet som du vill starta den rekursiva sökningen av användare från. sträng
searchFilterTemplate Mall som ska användas för sökning. Standardvärdet är (cn=%s) där %s ersätts av användarnamnet som används för inloggning. sträng
serverCertificates Certifikat[]
serverHostname Värdnamn för LDAP-servern. sträng
serverPort Port för LDAP-servern. int
serviceUserDistinguishedName Unikt namn på uppslagsanvändarkontot, som kan söka efter användarinformation om autentisering. sträng
serviceUserPassword Lösenord för uppslagsanvändaren. sträng

Certifikat

Name Beskrivning Värde
Pem PEM-formaterad offentlig nyckel. sträng

CassandraError

Name Beskrivning Värde
additionalErrorInfo Ytterligare information om felet. sträng
kod Felkoden som uppstod. sträng
meddelande Meddelandet om felet. sträng
Mål Målresursen för felet. sträng

Resursdefinition för ARM-mall

Resurstypen cassandraClusters/dataCenters kan distribueras med åtgärder som mål:

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/cassandraClusters/dataCenters-resurs lägger du till följande JSON i mallen.

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

Egenskapsvärden

cassandraClusters/dataCenters

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/cassandraClusters/dataCenters"
apiVersion Resurs-API-versionen '2023-04-15'
name Resursnamnet

Se hur du anger namn och typer för underordnade resurser i JSON ARM-mallar.		 sträng (krävs)
properties Egenskaper för ett hanterat Cassandra-datacenter. DataCenterResourceProperties

DataCenterResourceProperties

Name Beskrivning Värde
authenticationMethodLdapProperties Egenskaper för Ldap-autentiseringsmetod. Den här funktionen är en förhandsversion. AuthenticationMethodLdapProperties
availabilityZone Om datacentret har stöd för tillgänglighetszoner tillämpar du det på vm-skalningsuppsättningen som är värd för virtuella datorer i Cassandra-datacentret. boolesk
backupStorageCustomerKeyUri Anger nyckel-URI för kundnyckeln som ska användas för kryptering av lagringskontot för säkerhetskopior. sträng
base64EncodedCassandraYamlFragment Ett fragment av en cassandra.yaml-konfigurationsfil som ska ingå i cassandra.yaml för alla noder i det här datacentret. Fragmentet ska vara Base64-kodat och endast en delmängd nycklar tillåts. sträng
dataCenterLocation Den region som det här datacentret ska skapas i. sträng
frigjord Om datacentret har frigjorts. boolesk
delegatedSubnetId Resurs-ID för ett undernät som noderna i det här datacentret ska ha sina nätverksgränssnitt anslutna till. Undernätet måste finnas i samma region som anges i "dataCenterLocation" och måste kunna dirigeras till det undernät som anges i klustrets egenskap "delegatedManagementSubnetId". Det här resurs-ID:t kommer att ha formatet "/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". sträng
diskKapacitet Antal diskar som är anslutna till varje nod. Standardvärdet är 4. int
diskSku Disk-SKU som används för datacenter. Standardvärdet är P30. sträng
managedDiskCustomerKeyUri Nyckel-URI som ska användas för kryptering av hanterade diskar. Se till att klustrets systemtilldelade identitet har tilldelats lämpliga behörigheter (behörigheterna hämta/omsluta/packa upp) för nyckeln. sträng
nodeCount Antalet noder som datacentret ska ha. Det här är det önskade talet. När den har angetts kan det ta lite tid innan datacentret skalas så att det matchar. Om du vill övervaka antalet noder och deras status använder du metoden fetchNodeStatus i klustret. int
provisionError Fel som rör resursetablering. CassandraError
provisioningState Status för resursen vid den tidpunkt då åtgärden anropades. "Avbruten"
"Skapar"
"Tar bort"
"Misslyckades"
"Lyckades"
"Uppdaterar"
sku SKU för virtuella datorer som används för datacenter. Standardvärdet är Standard_DS14_v2 sträng

AuthenticationMethodLdapProperties

Name Beskrivning Värde
connectionTimeoutInMs Tidsgräns för anslutning till LDAP-servern i miliseconds. Standardvärdet är 5 000 ms. int
searchBaseDistinguishedName Unikt namn på objektet som du vill starta den rekursiva sökningen av användare från. sträng
searchFilterTemplate Mall som ska användas för sökning. Standardvärdet är (cn=%s) där %s ersätts av användarnamnet som används för inloggning. sträng
serverCertificates Certifikat[]
serverHostname Värdnamn för LDAP-servern. sträng
serverPort Port för LDAP-servern. int
serviceUserDistinguishedName Unikt namn på uppslagsanvändarkontot, som kan söka efter användarinformation om autentisering. sträng
serviceUserPassword Lösenord för uppslagsanvändaren. sträng

Certifikat

Name Beskrivning Värde
Pem PEM-formaterad offentlig nyckel. sträng

CassandraError

Name Beskrivning Värde
additionalErrorInfo Ytterligare information om felet. sträng
kod Felkoden som uppstod. sträng
meddelande Meddelandet om felet. sträng
Mål Målresursen för felet. sträng

Resursdefinition för Terraform (AzAPI-provider)

Resurstypen cassandraClusters/dataCenters kan distribueras med åtgärder som mål:

  • Resursgrupper

En lista över ändrade egenskaper i varje API-version finns i ändringsloggen.

Resursformat

Om du vill skapa en Microsoft.DocumentDB/cassandraClusters/dataCenters-resurs lägger du till följande Terraform i mallen.

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

Egenskapsvärden

cassandraClusters/dataCenters

Name Beskrivning Värde
typ Resurstypen "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-04-15"
name Resursnamnet sträng (krävs)
parent_id ID:t för resursen som är överordnad för den här resursen. ID för resurs av typen: cassandraClusters
properties Egenskaper för ett hanterat Cassandra-datacenter. DataCenterResourceEgenskaper

DataCenterResourceEgenskaper

Name Beskrivning Värde
authenticationMethodLdapProperties Egenskaper för Ldap-autentiseringsmetod. Den här funktionen är en förhandsversion. AuthenticationMethodLdapProperties
availabilityZone Om datacentret har stöd för tillgänglighetszon tillämpar du det på den vm-skalningsuppsättning som är värd för virtuella datorer i Cassandra-datacentret. boolesk
backupStorageCustomerKeyUri Anger nyckel-Uri för den kundnyckel som ska användas för kryptering av lagringskontot för säkerhetskopior. sträng
base64EncodedCassandraYamlFragment Ett fragment av en cassandra.yaml-konfigurationsfil som ska ingå i cassandra.yaml för alla noder i det här datacentret. Fragmentet ska vara Base64-kodat och endast en delmängd nycklar tillåts. sträng
dataCenterLocation Den region som det här datacentret ska skapas i. sträng
frigjord Om datacentret har frigjorts. boolesk
delegatedSubnetId Resurs-ID för ett undernät som noderna i det här datacentret ska ha sina nätverksgränssnitt anslutna till. Undernätet måste finnas i samma region som anges i "dataCenterLocation" och måste kunna dirigeras till det undernät som anges i klustrets egenskap "delegatedManagementSubnetId". Det här resurs-ID:t kommer att ha formatet '/subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}'. sträng
diskCapacity Antal diskar som är anslutna till varje nod. Standardvärdet är 4. int
diskSku Disk-SKU som används för datacenter. Standardvärdet är P30. sträng
managedDiskCustomerKeyUri Nyckel-URI som ska användas för kryptering av hanterade diskar. Kontrollera att den systemtilldelade identiteten för klustret har tilldelats lämpliga behörigheter (behörigheter för att hämta/omsluta/avsluta) på nyckeln. sträng
nodeCount Antalet noder som datacentret ska ha. Det här är önskat tal. När det har angetts kan det ta lite tid innan datacentret skalas så att det matchar. Om du vill övervaka antalet noder och deras status använder du metoden fetchNodeStatus i klustret. int
provisionError Fel som rör resursetablering. CassandraError
provisioningState Status för resursen vid den tidpunkt då åtgärden anropades. "Avbruten"
"Skapa"
"Ta bort"
"Misslyckades"
"Lyckades"
"Uppdatera"
sku SKU för virtuella datorer som används för datacenter. Standardvärdet är Standard_DS14_v2 sträng

AuthenticationMethodLdapProperties

Name Beskrivning Värde
connectionTimeoutInMs Tidsgräns för anslutning till LDAP-servern i miliseconds. Standardvärdet är 5 000 ms. int
searchBaseDistinguishedName Unikt namn på objektet som ska starta den rekursiva sökningen av användare från. sträng
searchFilterTemplate Mall som ska användas för sökning. Standardvärdet är (cn=%s) där %s ersätts av användarnamnet som används för inloggning. sträng
serverCertificates Certifikat[]
serverHostname Värdnamn för LDAP-servern. sträng
serverPort Port för LDAP-servern. int
serviceUserDistinguishedName Unikt namn på uppslagsanvändarkontot, som kan söka efter användarinformation om autentisering. sträng
serviceUserPassword Lösenord för uppslagsanvändaren. sträng

Certifikat

Name Beskrivning Värde
Pem PEM-formaterad offentlig nyckel. sträng

CassandraError

Name Beskrivning Värde
additionalErrorInfo Ytterligare information om felet. sträng
kod Felkoden som inträffade. sträng
meddelande Meddelandet om felet. sträng
Mål Målresursen för felet. sträng