Microsoft.DocumentDB cassandraClusters/dataCenters 2023-11-15

  • Artykuł

Definicja zasobu Bicep

Typ zasobu cassandraClusters/dataCenters można wdrożyć za pomocą operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters/dataCenters, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

cassandraClusters/dataCenters

Nazwa Opis Wartość
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w aplikacji Bicep.		 ciąg (wymagany)
Nadrzędny W pliku Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu : cassandraClusters
properties Właściwości zarządzanego centrum danych Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Nazwa Opis Wartość
authenticationMethodLdapProperties Właściwości metody uwierzytelniania Ldap. Ta funkcja jest dostępna w wersji zapoznawczej. AuthenticationMethodLdapProperties
availabilityZone Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu skalowania maszyn wirtualnych hostujących maszyny wirtualne centrum danych cassandra. bool
backupStorageCustomerKeyUri Wskazuje identyfikator URI klucza klienta, który ma być używany do szyfrowania konta magazynu kopii zapasowej. ciąg
base64EncodedCassandraYamlFragment Fragment pliku konfiguracji cassandra.yaml, który ma zostać uwzględniony w pliku cassandra.yaml dla wszystkich węzłów w tym centrum danych. Fragment powinien być zakodowany w formacie Base64, a dozwolony jest tylko podzbiór kluczy. ciąg
dataCenterLocation Region, w którym należy utworzyć to centrum danych. ciąg
Dealokowane Czy centrum danych zostało cofnięto przydział. bool
delegatedSubnetId Identyfikator zasobu podsieci węzłów w tym centrum danych powinien mieć połączone interfejsy sieciowe. Podsieć musi znajdować się w tym samym regionie określonym w właściwości "dataCenterLocation" i musi być w stanie kierować ją do podsieci określonej w właściwości "delegatedManagementSubnetId". Ten identyfikator zasobu będzie mieć postać "/subscriptions/{subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". ciąg
diskCapacity Liczba dysków dołączonych do każdego węzła. Wartość domyślna to 4. int
diskSku Jednostka SKU dysku używana dla centrów danych. Wartość domyślna to P30. ciąg
managedDiskCustomerKeyUri Identyfikator URI klucza używany do szyfrowania dysków zarządzanych. Upewnij się, że przypisana przez system tożsamość klastra została przypisana do odpowiednich uprawnień (klucz get/wrap/unwrap permissions) na kluczu. ciąg
nodeCount Liczba węzłów, które powinien mieć centrum danych. Jest to żądana liczba. Po ustawieniu może upłynąć trochę czasu, aby centrum danych było skalowane w celu dopasowania. Aby monitorować liczbę węzłów i ich stan, użyj metody fetchNodeStatus w klastrze. int
provisionError Błąd związany z aprowizowaniem zasobów. CassandraError
provisioningState Stan zasobu w momencie wywołania operacji. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"
sku Jednostka SKU maszyny wirtualnej używana dla centrów danych. Wartość domyślna to Standard_DS14_v2 ciąg

AuthenticationMethodLdapProperties

Nazwa Opis Wartość
connectionTimeoutInMs Limit czasu nawiązywania połączenia z serwerem LDAP w milisekundach. Wartość domyślna to 5000 ms. int
searchBaseDistinguishedName Nazwa wyróżniająca obiektu w celu rozpoczęcia cyklicznego wyszukiwania użytkowników. ciąg
searchFilterTemplate Szablon do użycia do wyszukiwania. Wartość domyślna to (cn=%s), gdzie %s zostanie zastąpiona nazwą użytkownika używaną do logowania. ciąg
serverCertificates Certyfikat[]
serverHostname Nazwa hosta serwera LDAP. ciąg
serverPort Port serwera LDAP. int
serviceUserDistinguishedName Nazwa wyróżniająca konta użytkownika wyszukiwania, który może wyszukać szczegóły użytkownika dotyczące uwierzytelniania. ciąg
serviceUserPassword Hasło użytkownika wyszukiwania. ciąg

Certyfikat

Nazwa Opis Wartość
Pem Klucz publiczny sformatowany przez PEM. ciąg

CassandraError

Nazwa Opis Wartość
additionalErrorInfo Dodatkowe informacje o błędzie. ciąg
kod Kod błędu, który wystąpił. ciąg
message Komunikat o błędzie. ciąg
Docelowego Zasób docelowy błędu. ciąg

Definicja zasobu szablonu usługi ARM

Typ zasobu cassandraClusters/dataCenters można wdrożyć z operacjami docelowymi:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters/dataCenters, dodaj następujący kod JSON do szablonu.

{
  "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"
  }
}

Wartości właściwości

cassandraClusters/dataCenters

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/cassandraClusters/dataCenters"
apiVersion Wersja interfejsu API zasobów '2023-11-15'
name Nazwa zasobu

Zobacz, jak ustawić nazwy i typy dla zasobów podrzędnych w szablonach usługi ARM w formacie JSON.		 ciąg (wymagany)
properties Właściwości zarządzanego centrum danych Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Nazwa Opis Wartość
authenticationMethodLdapProperties Właściwości metody uwierzytelniania Ldap. Ta funkcja jest dostępna w wersji zapoznawczej. AuthenticationMethodLdapProperties
availabilityZone Jeśli centrum danych ma obsługę strefy dostępności, zastosuj ją do zestawu skalowania maszyn wirtualnych, który hostuje maszyny wirtualne centrum danych cassandra. bool
backupStorageCustomerKeyUri Wskazuje identyfikator URI klucza klienta do użycia na potrzeby szyfrowania konta magazynu kopii zapasowych. ciąg
base64EncodedCassandraYamlFragment Fragment pliku konfiguracji cassandra.yaml, który ma zostać uwzględniony w pliku cassandra.yaml dla wszystkich węzłów w tym centrum danych. Fragment powinien być zakodowany w formacie Base64, a dozwolony jest tylko podzbiór kluczy. ciąg
dataCenterLocation Region, w którym należy utworzyć to centrum danych. ciąg
Dealokowane Czy centrum danych zostało cofnięto przydział. bool
delegatedSubnetId Identyfikator zasobu podsieci węzłów w tym centrum danych powinien mieć połączone interfejsy sieciowe. Podsieć musi znajdować się w tym samym regionie określonym w poleceniu "dataCenterLocation" i musi być w stanie kierować do podsieci określonej we właściwości "delegatedManagementSubnetId". Ten identyfikator zasobu będzie mieć postać "/subscriptions/{subscription id}/resourceGroups/{resource Group}/providers/Microsoft.Network/virtualNetworks/{virtualNetworks/{virtual network}/subnets/{subnet}". ciąg
diskCapacity Liczba dysków dołączonych do każdego węzła. Wartość domyślna to 4. int
diskSku Jednostka SKU dysku używana dla centrów danych. Wartość domyślna to P30. ciąg
managedDiskCustomerKeyUri Identyfikator URI klucza używany do szyfrowania dysków zarządzanych. Upewnij się, że przypisana przez system tożsamość klastra została przypisana do odpowiednich uprawnień (klucz get/wrap/unwrap permissions) w kluczu. ciąg
nodeCount Liczba węzłów, które powinny znajdować się w centrum danych. Jest to żądana liczba. Po ustawieniu może upłynąć trochę czasu, aby centrum danych było skalowane w celu dopasowania. Aby monitorować liczbę węzłów i ich stan, użyj metody fetchNodeStatus w klastrze. int
provisionError Błąd związany z aprowizowaniem zasobów. CassandraError
provisioningState Stan zasobu w momencie wywołania operacji. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"
sku Jednostka SKU maszyny wirtualnej używana dla centrów danych. Wartość domyślna to Standard_DS14_v2 ciąg

AuthenticationMethodLdapProperties

Nazwa Opis Wartość
connectionTimeoutInMs Limit czasu nawiązywania połączenia z serwerem LDAP w milisekundach. Wartość domyślna to 5000 ms. int
searchBaseDistinguishedName Nazwa wyróżniająca obiektu w celu rozpoczęcia cyklicznego wyszukiwania użytkowników. ciąg
searchFilterTemplate Szablon do użycia do wyszukiwania. Wartość domyślna to (cn=%s), gdzie %s zostanie zastąpiona nazwą użytkownika używaną do logowania. ciąg
serverCertificates Certyfikat[]
serverHostname Nazwa hosta serwera LDAP. ciąg
serverPort Port serwera LDAP. int
serviceUserDistinguishedName Nazwa wyróżniająca konta użytkownika wyszukiwania, który może wyszukać szczegóły użytkownika dotyczące uwierzytelniania. ciąg
serviceUserPassword Hasło użytkownika wyszukiwania. ciąg

Certyfikat

Nazwa Opis Wartość
Pem Klucz publiczny sformatowany przez PEM. ciąg

CassandraError

Nazwa Opis Wartość
additionalErrorInfo Dodatkowe informacje o błędzie. ciąg
kod Kod błędu, który wystąpił. ciąg
message Komunikat o błędzie. ciąg
Docelowego Zasób docelowy błędu. ciąg

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu cassandraClusters/dataCenters można wdrożyć za pomocą operacji docelowych:

  • Grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennik zmian.

Format zasobu

Aby utworzyć zasób Microsoft.DocumentDB/cassandraClusters/dataCenters, dodaj następujące narzędzie Terraform do szablonu.

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

Wartości właściwości

cassandraClusters/dataCenters

Nazwa Opis Wartość
typ Typ zasobu "Microsoft.DocumentDB/cassandraClusters/dataCenters@2023-11-15"
name Nazwa zasobu ciąg (wymagany)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: cassandraClusters
properties Właściwości zarządzanego centrum danych Cassandra. DataCenterResourceProperties

DataCenterResourceProperties

Nazwa Opis Wartość
authenticationMethodLdapProperties Właściwości metody uwierzytelniania Ldap. Ta funkcja jest dostępna w wersji zapoznawczej. AuthenticationMethodLdapProperties
availabilityZone Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu skalowania maszyn wirtualnych hostujących maszyny wirtualne centrum danych cassandra. bool
backupStorageCustomerKeyUri Wskazuje identyfikator URI klucza klienta, który ma być używany do szyfrowania konta magazynu kopii zapasowej. ciąg
base64EncodedCassandraYamlFragment Fragment pliku konfiguracji cassandra.yaml, który ma zostać uwzględniony w pliku cassandra.yaml dla wszystkich węzłów w tym centrum danych. Fragment powinien być zakodowany w formacie Base64, a dozwolony jest tylko podzbiór kluczy. ciąg
dataCenterLocation Region, w którym należy utworzyć to centrum danych. ciąg
Dealokowane Czy centrum danych zostało cofnięto przydział. bool
delegatedSubnetId Identyfikator zasobu podsieci węzłów w tym centrum danych powinien mieć połączone interfejsy sieciowe. Podsieć musi znajdować się w tym samym regionie określonym w właściwości "dataCenterLocation" i musi być w stanie kierować ją do podsieci określonej w właściwości "delegatedManagementSubnetId". Ten identyfikator zasobu będzie mieć postać "/subscriptions/{subscriptions/{subscription id}/resourceGroups/{resource group}/providers/Microsoft.Network/virtualNetworks/{virtual network}/subnets/{subnet}". ciąg
diskCapacity Liczba dysków dołączonych do każdego węzła. Wartość domyślna to 4. int
diskSku Jednostka SKU dysku używana dla centrów danych. Wartość domyślna to P30. ciąg
managedDiskCustomerKeyUri Identyfikator URI klucza używany do szyfrowania dysków zarządzanych. Upewnij się, że przypisana przez system tożsamość klastra została przypisana do odpowiednich uprawnień (klucz get/wrap/unwrap permissions) na kluczu. ciąg
nodeCount Liczba węzłów, które powinien mieć centrum danych. Jest to żądana liczba. Po ustawieniu może upłynąć trochę czasu, aby centrum danych było skalowane w celu dopasowania. Aby monitorować liczbę węzłów i ich stan, użyj metody fetchNodeStatus w klastrze. int
provisionError Błąd związany z aprowizowaniem zasobów. CassandraError
provisioningState Stan zasobu w momencie wywołania operacji. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"
sku Jednostka SKU maszyny wirtualnej używana dla centrów danych. Wartość domyślna to Standard_DS14_v2 ciąg

AuthenticationMethodLdapProperties

Nazwa Opis Wartość
connectionTimeoutInMs Limit czasu nawiązywania połączenia z serwerem LDAP w milisekundach. Wartość domyślna to 5000 ms. int
searchBaseDistinguishedName Nazwa wyróżniająca obiektu w celu uruchomienia cyklicznego wyszukiwania użytkowników. ciąg
searchFilterTemplate Szablon do użycia do wyszukiwania. Wartość domyślna to (cn=%s), gdzie %s zostanie zastąpiona nazwą użytkownika używaną do logowania. ciąg
serverCertificates Certyfikat[]
serverHostname Nazwa hosta serwera LDAP. ciąg
serverPort Port serwera LDAP. int
serviceUserDistinguishedName Nazwa wyróżniająca konta użytkownika wyszukiwania, który może wyszukać szczegóły użytkownika dotyczące uwierzytelniania. ciąg
serviceUserPassword Hasło użytkownika wyszukiwania. ciąg

Certyfikat

Nazwa Opis Wartość
Pem Klucz publiczny sformatowany przez PEM. ciąg

CassandraError

Nazwa Opis Wartość
additionalErrorInfo Dodatkowe informacje o błędzie. ciąg
kod Kod błędu, który wystąpił. ciąg
message Komunikat o błędzie. ciąg
Docelowego Zasób docelowy błędu. ciąg