Sdílet prostřednictvím

Microsoft.DocumentDB cassandraClusters/dataCenters 2024-05-15

  • Článek

Definice prostředku Bicep

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

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' = {
  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'
  }
}

Hodnoty vlastností

AuthenticationMethodLdapProperties

Jméno Popis 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 pro zahájení rekurzivního vyhledávání uživatelů. řetězec
searchFilterTemplate Šablona, která se má použít k hledá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átu []
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

CassandraError

Jméno Popis 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

Certifikát

Jméno Popis Hodnota
Pem Veřejný klíč formátovaný PEM řetězec

DataCenterResourceProperties

Jméno Popis Hodnota
authenticationMethodLdapProperties Vlastnosti metody ověřování ldap. Tato funkce je ve verzi Preview. AuthenticationMethodLdapProperties
availabilityZone Pokud datové centrum podporuje zónu dostupnosti, použijte ji na škálovací sadu virtuálních počítačů cassandra, 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 být kódovaný v Base64 a je povolena pouze podmnožina klíčů. řetězec
dataCenterLocation Oblast, ve které by se toto datové centrum mělo vytvořit. řetězec
uvolnil Zda bylo datové centrum uvolněno. Bool
delegatedSubnetId ID prostředku podsítě, ke které uzly v tomto datovém centru mají připojená síťová rozhraní. Podsíť musí být ve stejné oblasti zadané v dataCenterLocation a musí být schopná směrovat do podsítě zadané ve vlastnosti delegovanýManagementSubnetId clusteru. Toto ID prostředku bude ve formátu /subscriptions/<ID předplatného>/resourceGroups/<skupina prostředků>/providers/Microsoft.Network/virtualNetworks/<virtuální síť>/subnets/<podsíť>'. řetězec
diskCapacity Počet disků připojených k jednotlivým uzlům Výchozí hodnota je 4. Int
diskSku Skladová položka disku používaná pro datová centra. 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 přiřazená systémem clusteru má přiřazená příslušná oprávnění (klíč get/wrap/unwrap permissions) klíče. řetězec
nodeCount Počet uzlů, které má mít datové centrum. Toto je požadované číslo. Po nastavení může nějakou dobu trvat, než se datové centrum škáluje na stejné úrovni. Pokud chcete monitorovat počet uzlů a jejich stav, použijte metodu fetchNodeStatus v clusteru. 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
Úspěch
Aktualizace
sku Skladová položka virtuálního počítače používaná pro datová centra. Výchozí hodnota je Standard_DS14_v2 řetězec

Microsoft.DocumentDB/cassandraClusters/dataCenters

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 100
Model = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (povinné)
rodič V bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost je potřeba 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
vlastnosti Vlastnosti spravovaného datového centra Cassandra DataCenterResourceProperties

Definice prostředku šablony ARM

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

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í JSON.

{
  "type": "Microsoft.DocumentDB/cassandraClusters/dataCenters",
  "apiVersion": "2024-05-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",
    "privateEndpointIpAddress": "string",
    "provisionError": {
      "additionalErrorInfo": "string",
      "code": "string",
      "message": "string",
      "target": "string"
    },
    "provisioningState": "string",
    "sku": "string"
  }
}

Hodnoty vlastností

AuthenticationMethodLdapProperties

Jméno Popis 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 pro zahájení rekurzivního vyhledávání uživatelů. řetězec
searchFilterTemplate Šablona, která se má použít k hledá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átu []
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

CassandraError

Jméno Popis 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

Certifikát

Jméno Popis Hodnota
Pem Veřejný klíč formátovaný PEM řetězec

DataCenterResourceProperties

Jméno Popis Hodnota
authenticationMethodLdapProperties Vlastnosti metody ověřování ldap. Tato funkce je ve verzi Preview. AuthenticationMethodLdapProperties
availabilityZone Pokud datové centrum podporuje zónu dostupnosti, použijte ji na škálovací sadu virtuálních počítačů cassandra, 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 být kódovaný v Base64 a je povolena pouze podmnožina klíčů. řetězec
dataCenterLocation Oblast, ve které by se toto datové centrum mělo vytvořit. řetězec
uvolnil Zda bylo datové centrum uvolněno. Bool
delegatedSubnetId ID prostředku podsítě, ke které uzly v tomto datovém centru mají připojená síťová rozhraní. Podsíť musí být ve stejné oblasti zadané v dataCenterLocation a musí být schopná směrovat do podsítě zadané ve vlastnosti delegovanýManagementSubnetId clusteru. Toto ID prostředku bude ve formátu /subscriptions/<ID předplatného>/resourceGroups/<skupina prostředků>/providers/Microsoft.Network/virtualNetworks/<virtuální síť>/subnets/<podsíť>'. řetězec
diskCapacity Počet disků připojených k jednotlivým uzlům Výchozí hodnota je 4. Int
diskSku Skladová položka disku používaná pro datová centra. 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 přiřazená systémem clusteru má přiřazená příslušná oprávnění (klíč get/wrap/unwrap permissions) klíče. řetězec
nodeCount Počet uzlů, které má mít datové centrum. Toto je požadované číslo. Po nastavení může nějakou dobu trvat, než se datové centrum škáluje na stejné úrovni. Pokud chcete monitorovat počet uzlů a jejich stav, použijte metodu fetchNodeStatus v clusteru. 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
Úspěch
Aktualizace
sku Skladová položka virtuálního počítače používaná pro datová centra. Výchozí hodnota je Standard_DS14_v2 řetězec

Microsoft.DocumentDB/cassandraClusters/dataCenters

Jméno Popis Hodnota
apiVersion Verze rozhraní API '2024-05-15'
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 100
Model = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (povinné)
vlastnosti Vlastnosti spravovaného datového centra Cassandra DataCenterResourceProperties
typ Typ prostředku Microsoft.DocumentDB/cassandraClusters/dataCenters

Příklady použití

Definice prostředku Terraformu (poskytovatel AzAPI)

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

  • 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"
  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"
    }
  })
}

Hodnoty vlastností

AuthenticationMethodLdapProperties

Jméno Popis 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 pro zahájení rekurzivního vyhledávání uživatelů. řetězec
searchFilterTemplate Šablona, která se má použít k hledá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átu []
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

CassandraError

Jméno Popis 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

Certifikát

Jméno Popis Hodnota
Pem Veřejný klíč formátovaný PEM řetězec

DataCenterResourceProperties

Jméno Popis Hodnota
authenticationMethodLdapProperties Vlastnosti metody ověřování ldap. Tato funkce je ve verzi Preview. AuthenticationMethodLdapProperties
availabilityZone Pokud datové centrum podporuje zónu dostupnosti, použijte ji na škálovací sadu virtuálních počítačů cassandra, 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 být kódovaný v Base64 a je povolena pouze podmnožina klíčů. řetězec
dataCenterLocation Oblast, ve které by se toto datové centrum mělo vytvořit. řetězec
uvolnil Zda bylo datové centrum uvolněno. Bool
delegatedSubnetId ID prostředku podsítě, ke které uzly v tomto datovém centru mají připojená síťová rozhraní. Podsíť musí být ve stejné oblasti zadané v dataCenterLocation a musí být schopná směrovat do podsítě zadané ve vlastnosti delegovanýManagementSubnetId clusteru. Toto ID prostředku bude ve formátu /subscriptions/<ID předplatného>/resourceGroups/<skupina prostředků>/providers/Microsoft.Network/virtualNetworks/<virtuální síť>/subnets/<podsíť>'. řetězec
diskCapacity Počet disků připojených k jednotlivým uzlům Výchozí hodnota je 4. Int
diskSku Skladová položka disku používaná pro datová centra. 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 přiřazená systémem clusteru má přiřazená příslušná oprávnění (klíč get/wrap/unwrap permissions) klíče. řetězec
nodeCount Počet uzlů, které má mít datové centrum. Toto je požadované číslo. Po nastavení může nějakou dobu trvat, než se datové centrum škáluje na stejné úrovni. Pokud chcete monitorovat počet uzlů a jejich stav, použijte metodu fetchNodeStatus v clusteru. 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
Úspěch
Aktualizace
sku Skladová položka virtuálního počítače používaná pro datová centra. Výchozí hodnota je Standard_DS14_v2 řetězec

Microsoft.DocumentDB/cassandraClusters/dataCenters

Jméno Popis Hodnota
Jméno Název prostředku řetězec

Omezení:
Minimální délka = 1
Maximální délka = 100
Model = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (povinné)
parent_id ID prostředku, který je nadřazený pro tento prostředek. ID prostředku typu: cassandraClusters
vlastnosti Vlastnosti spravovaného datového centra Cassandra DataCenterResourceProperties
typ Typ prostředku "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15"