Microsoft.DocumentDB cassandraClusters/dataCenters 2024-05-15-preview

  • Článek

Definice prostředku Bicep

Typ prostředku cassandraClusters/dataCenters je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/cassandraClusters/dataCenters, přidejte do šablony následující bicep.

resource symbolicname 'Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15-preview' = {
  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
    privateEndpointIpAddress: 'string'
    provisionError: {
      additionalErrorInfo: 'string'
      code: 'string'
      message: 'string'
      target: 'string'
    }
    provisioningState: 'string'
    sku: 'string'
  }
}

Hodnoty vlastností

cassandraClusters/dataCenters

Název Description Hodnota
name Název prostředku

Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.		 string (povinné)
Nadřazené V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.

Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.		 Symbolický název prostředku typu : cassandraClusters
properties Vlastnosti spravovaného datacentra Cassandra DataCenterResourceProperties

DataCenterResourceProperties

Název Description Hodnota
authenticationMethodLdapProperties Vlastnosti metody ověřování LDAP. Tato funkce je ve verzi Preview. AuthenticationMethodLdapProperties
availabilityZone Pokud má datové centrum podporu zóny dostupnosti, použijte ji na virtuální sadu škálování virtuálních počítačů, která hostuje virtuální počítače datacentra cassandra. bool
backupStorageCustomerKeyUri Označuje identifikátor URI klíče zákazníka, který se má použít k šifrování účtu úložiště zálohování. řetězec
base64EncodedCassandraYamlFragment Fragment konfiguračního souboru cassandra.yaml, který se má zahrnout do souboru cassandra.yaml pro všechny uzly v tomto datovém centru. Fragment by měl mít kódování Base64 a je povolena pouze podmnožina klíčů. řetězec
dataCenterLocation Oblast, ve které by mělo být toto datové centrum vytvořeno. řetězec
Navrácen Jestli bylo datové centrum uvolněno. bool
delegatedSubnetId ID prostředku podsítě, ke které by uzly v tomto datacentru měly mít připojená síťová rozhraní. Podsíť musí být ve stejné oblasti jako dataCenterLocation a musí být schopná směrovat do podsítě zadané ve vlastnosti delegatedManagementSubnetId clusteru. Toto ID prostředku bude mít tvar /subscriptions/{id předplatného}/resourceGroups/{skupina prostředků}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}. řetězec
diskCapacity Počet disků připojených k jednotlivým uzlům Výchozí hodnota je 4. int
diskSku Disková skladová položka používaná pro datacentra. Výchozí hodnota je P30. řetězec
managedDiskCustomerKeyUri Identifikátor URI klíče, který se má použít pro šifrování spravovaných disků. Ujistěte se, že identita clusteru přiřazená systémem má přiřazená příslušná oprávnění (oprávnění get/wrap/unwrap) klíče. řetězec
nodeCount Počet uzlů, které by datové centrum mělo mít. Toto je požadované číslo. Po nastavení může nějakou dobu trvat, než se datacentrum škáluje tak, aby odpovídalo. Pokud chcete monitorovat počet uzlů a jejich stav, použijte metodu fetchNodeStatus v clusteru. int
privateEndpointIpAddress IP adresa koncového bodu VPN pro toto datové centrum. řetězec
provisionError Chyba související se zřizováním prostředků CassandraError
provisioningState Stav prostředku v době, kdy byla operace volána. Zrušeno
'Vytváření'
"Odstraňuje se"
Neúspěšné
"Úspěch"
"Probíhá aktualizace"
Sku Skladová položka virtuálního počítače používaná pro datacentra. Výchozí hodnota je Standard_DS14_v2 řetězec

AuthenticationMethodLdapProperties

Název Description Hodnota
connectionTimeoutInMs Časový limit pro připojení k serveru LDAP v milisekundách Výchozí hodnota je 5000 ms. int
searchBaseDistinguishedName Rozlišující název objektu, ze které se má spustit rekurzivní vyhledávání uživatelů. řetězec
searchFilterTemplate Šablona, která se má použít pro vyhledávání. Výchozí hodnota je (cn=%s), kde %s bude nahrazeno uživatelským jménem použitým k přihlášení. řetězec
serverCertificates Certifikát[]
serverHostname Název hostitele serveru LDAP. řetězec
serverPort Port serveru LDAP. int
serviceUserDistinguishedName Rozlišující název vyhledávacího uživatelského účtu, který může vyhledat podrobnosti o uživateli při ověřování. řetězec
serviceUserPassword Heslo vyhledávacího uživatele. řetězec

Certifikát

Název Description Hodnota
Pem Veřejný klíč formátovaný PEM. řetězec

CassandraError

Název Description Hodnota
additionalErrorInfo Další informace o chybě řetězec
kód Kód chyby, ke které došlo. řetězec
zpráva Zpráva o chybě. řetězec
Cíl Cílový prostředek chyby. řetězec

Definice prostředku šablony ARM

Typ prostředku cassandraClusters/dataCenters je možné nasadit s operacemi, které cílí na:

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/cassandraClusters/dataCenters, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

cassandraClusters/dataCenters

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/cassandraClusters/dataCenters
apiVersion Verze rozhraní API prostředků '2024-05-15-preview'
name Název prostředku

Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.		 string (povinné)
properties Vlastnosti spravovaného datacentra Cassandra DataCenterResourceProperties

DataCenterResourceProperties

Název Description Hodnota
authenticationMethodLdapProperties Vlastnosti metody ověřování LDAP. Tato funkce je ve verzi Preview. AuthenticationMethodLdapProperties
availabilityZone Pokud má datové centrum podporu zóny dostupnosti, použijte ji na virtuální sadu škálování virtuálních počítačů, která hostuje virtuální počítače datacentra cassandra. bool
backupStorageCustomerKeyUri Označuje identifikátor URI klíče zákazníka, který se má použít k šifrování účtu úložiště zálohování. řetězec
base64EncodedCassandraYamlFragment Fragment konfiguračního souboru cassandra.yaml, který se má zahrnout do souboru cassandra.yaml pro všechny uzly v tomto datovém centru. Fragment by měl mít kódování Base64 a je povolena pouze podmnožina klíčů. řetězec
dataCenterLocation Oblast, ve které by mělo být toto datové centrum vytvořeno. řetězec
Navrácen Jestli bylo datové centrum uvolněno. bool
delegatedSubnetId ID prostředku podsítě, ke které by uzly v tomto datacentru měly mít připojená síťová rozhraní. Podsíť musí být ve stejné oblasti jako dataCenterLocation a musí být schopná směrovat do podsítě zadané ve vlastnosti delegatedManagementSubnetId clusteru. Toto ID prostředku bude mít tvar /subscriptions/{id předplatného}/resourceGroups/{skupina prostředků}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}. řetězec
diskCapacity Počet disků připojených k jednotlivým uzlům Výchozí hodnota je 4. int
diskSku Disková skladová položka používaná pro datacentra. Výchozí hodnota je P30. řetězec
managedDiskCustomerKeyUri Identifikátor URI klíče, který se má použít pro šifrování spravovaných disků. Ujistěte se, že identita clusteru přiřazená systémem má přiřazená příslušná oprávnění (oprávnění get/wrap/unwrap) klíče. řetězec
nodeCount Počet uzlů, které by datové centrum mělo mít. Toto je požadované číslo. Po nastavení může nějakou dobu trvat, než se datacentrum škáluje tak, aby odpovídalo. Pokud chcete monitorovat počet uzlů a jejich stav, použijte metodu fetchNodeStatus v clusteru. int
privateEndpointIpAddress IP adresa koncového bodu VPN pro toto datové centrum. řetězec
provisionError Chyba související se zřizováním prostředků CassandraError
provisioningState Stav prostředku v době, kdy byla operace volána. Zrušeno
'Vytváření'
"Odstraňuje se"
Neúspěšné
"Úspěch"
"Probíhá aktualizace"
Sku Skladová položka virtuálního počítače používaná pro datacentra. Výchozí hodnota je Standard_DS14_v2 řetězec

AuthenticationMethodLdapProperties

Název Description Hodnota
connectionTimeoutInMs Časový limit pro připojení k serveru LDAP v milisekundách Výchozí hodnota je 5000 ms. int
searchBaseDistinguishedName Rozlišující název objektu, ze které se má spustit rekurzivní vyhledávání uživatelů. řetězec
searchFilterTemplate Šablona, která se má použít pro vyhledávání. Výchozí hodnota je (cn=%s), kde %s bude nahrazeno uživatelským jménem použitým k přihlášení. řetězec
serverCertificates Certifikát[]
serverHostname Název hostitele serveru LDAP. řetězec
serverPort Port serveru LDAP. int
serviceUserDistinguishedName Rozlišující název vyhledávacího uživatelského účtu, který může vyhledat podrobnosti o uživateli při ověřování. řetězec
serviceUserPassword Heslo vyhledávacího uživatele. řetězec

Certifikát

Název Description Hodnota
Pem Veřejný klíč formátovaný PEM. řetězec

CassandraError

Název Description Hodnota
additionalErrorInfo Další informace o chybě řetězec
kód Kód chyby, ke které došlo. řetězec
zpráva Zpráva o chybě řetězec
Cíl Cílový prostředek chyby. řetězec

Definice prostředku Terraform (poskytovatel AzAPI)

Typ prostředku cassandraClusters/dataCenters je možné nasadit s operacemi, které cílí na:

  • Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.DocumentDB/cassandraClusters/dataCenters, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

cassandraClusters/dataCenters

Název Description Hodnota
typ Typ prostředku Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15-preview
name Název prostředku string (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: cassandraClusters
properties Vlastnosti spravovaného datového centra Cassandra DataCenterResourceProperties

DataCenterResourceProperties

Název Description Hodnota
ověřováníMethodLdapVlastnosti Vlastnosti metody ověřování LDAP. Tato funkce je ve verzi Preview. AuthenticationMethodLdapVlastnosti
availabilityZone Pokud datové centrum podporuje zónu dostupnosti, použijte ji u sady škálování virtuálních počítačů, která hostuje virtuální počítače datového centra Cassandra. bool
backupStorageCustomerKeyUri Určuje identifikátor URI klíče zákazníka, který se má použít k šifrování účtu úložiště zálohování. řetězec
base64EncodedCassandraYamlFragment Fragment konfiguračního souboru cassandra.yaml, který se má zahrnout do souboru cassandra.yaml pro všechny uzly v tomto datovém centru. Fragment by měl mít kódování Base64 a je povolena pouze podmnožina klíčů. řetězec
dataCenterLocation Oblast, ve které by se mělo toto datové centrum vytvořit. řetězec
Navrácen Určuje, jestli bylo datové centrum uvolněno. bool
delegatedSubnetId ID prostředku podsítě, ke které by uzly v tomto datacentru měly mít připojená síťová rozhraní. Podsíť musí být ve stejné oblasti jako dataCenterLocation a musí být schopná směrovat do podsítě zadané ve vlastnosti delegatedManagementSubnetId clusteru. Toto ID prostředku bude mít formát /subscriptions/{id_předplatného}/resourceGroups/{skupina prostředků}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}. řetězec
diskCapacity Počet disků připojených ke každému uzlu Výchozí hodnota je 4. int
diskSku Disková skladová položka používaná pro datacentra. Výchozí hodnota je P30. řetězec
managedDiskCustomerKeyUri Identifikátor URI klíče, který se má použít k šifrování spravovaných disků. Ujistěte se, že identita clusteru přiřazená systémem má ke klíči přiřazená příslušná oprávnění (oprávnění k získání, zabalení nebo rozbalení klíče). řetězec
počet uzlů Počet uzlů, které má datové centrum mít. Toto je požadované číslo. Po nastavení může nějakou dobu trvat, než se datové centrum škáluje tak, aby odpovídalo. Pokud chcete monitorovat počet uzlů a jejich stav, použijte v clusteru metodu fetchNodeStatus. int
privateEndpointIpAddress IP adresa koncového bodu SÍTĚ VPN pro toto datové centrum. řetězec
provisionError Chyba související se zřizováním prostředků CassandraError
provisioningState Stav prostředku v době, kdy byla operace volána. "Zrušeno"
"Vytváření"
"Odstranění"
Chyba
"Succeeded" (Úspěch)
"Probíhá aktualizace"
Sku Skladová položka virtuálního počítače používaná pro datacentra. Výchozí hodnota je Standard_DS14_v2 řetězec

AuthenticationMethodLdapVlastnosti

Název Description Hodnota
connectionTimeoutInMs Časový limit pro připojení k serveru LDAP v milisekundách Výchozí hodnota je 5000 ms. int
searchBaseDistinguishedName Rozlišující název objektu, ze které se má spustit rekurzivní vyhledávání uživatelů. řetězec
searchFilterTemplate Šablona, která se má použít pro vyhledávání. Výchozí hodnota je (cn=%s), kde %s bude nahrazeno uživatelským jménem použitým k přihlášení. řetězec
serverCertificates Certifikát[]
serverHostname Název hostitele serveru LDAP. řetězec
serverPort Port serveru LDAP. int
serviceUserDistinguishedName Rozlišující název vyhledávacího uživatelského účtu, který může vyhledat podrobnosti o uživateli při ověřování. řetězec
serviceUserPassword Heslo vyhledávacího uživatele. řetězec

Certifikát

Název Description Hodnota
Pem Veřejný klíč formátovaný PEM. řetězec

CassandraError

Název Description Hodnota
additionalErrorInfo Další informace o chybě řetězec
kód Kód chyby, ke které došlo. řetězec
zpráva Zpráva o chybě. řetězec
Cíl Cílový prostředek chyby. řetězec