Udostępnij za pośrednictwem

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

Definicja zasobu Bicep

Typ zasobu cassandraClusters/dataCenters można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika 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@2024-05-15-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'
  }
}

Wartości właściwości

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 100
Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane)
rodzic W 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
Właściwości Właściwości zarządzanego centrum danych Cassandra. DataCenterResourceProperties (Właściwości CentrumZasobów)

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_baza) Nazwa wyróżniająca obiektu w celu rozpoczęcia cyklicznego wyszukiwania użytkowników. struna
searchFilterTemplate (szablon filtru) Szablon do użycia do wyszukiwania. Wartością domyślną (cn=%s), gdzie %s zostanie zastąpiona nazwą użytkownika używaną do logowania. struna
serverCertificates (Certyfikaty serwera) certyfikatu []
serverHostname (nazwa_hosta) serwera Nazwa hosta serwera LDAP. struna
serverPort (port serwera) Port serwera LDAP. Int
serviceUserDistinguishedName (nazwa_wyróżniająca_usługi) Nazwa wyróżniająca konta użytkownika wyszukiwania, który może wyszukać szczegóły użytkownika dotyczące uwierzytelniania. struna
serviceUserPassword (hasło użytkownika) Hasło użytkownika wyszukiwania. struna

Błąd Kasandry

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

Certyfikat

Nazwa Opis Wartość
Pem Klucz publiczny sformatowany przez PEM. struna

DataCenterResourceProperties (Właściwości CentrumZasobów)

Nazwa Opis Wartość
authenticationMethodLdapProperties Właściwości metody uwierzytelniania Ldap. Ta funkcja jest dostępna w wersji zapoznawczej. AuthenticationMethodLdapProperties
Strefa dostępności Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu Skalowanie maszyn wirtualnych, które hostuje maszyny wirtualne centrum danych cassandra. Bool
backupStorageCustomerKeyUri Wskazuje identyfikator URI klucza klienta do użycia na potrzeby szyfrowania konta magazynu kopii zapasowej. struna
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. struna
dataCenterLocation (lokalizacja centrum danych) Region, w którym należy utworzyć to centrum danych. struna
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 lokalizacji "dataCenterLocation" i musi być w stanie kierować do podsieci określonej we właściwości "delegatedManagementSubnetId" klastra. Ten identyfikator zasobu będzie mieć postać "/subscriptions/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>". struna
diskCapacity (pojemność dysku) Liczba dysków dołączonych do każdego węzła. Wartość domyślna to 4. Int
diskSku (jednostka magazynowa diskSku) Jednostka SKU dysku używana dla centrów danych. Wartość domyślna to P30. struna
managedDiskCustomerKeyUri Identyfikator URI klucza używany do szyfrowania dysków zarządzanych. Upewnij się, że tożsamość przypisana przez system klastra została przypisana do odpowiednich uprawnień (klucz get/wrap/unwrap permissions) na kluczu. struna
nodeCount (liczba_węzłów) Liczba węzłów, które powinny znajdować się w centrum danych. Jest to żądana liczba. Po ustawieniu centrum danych 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
privateEndpointIpAddress (adres prywatnyEndpointIpAddress) Adres IP punktu końcowego sieci VPN dla tego centrum danych. struna
provisionError (błąd zaopatrzenia) Błąd związany z aprowizowaniem zasobów. Błąd Kasandry
stan provisioningu Stan zasobu w momencie wywołania operacji. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"
Numer jednostki magazynowej Jednostka SKU maszyny wirtualnej używana dla centrów danych. Wartość domyślna to Standard_DS14_v2 struna

Definicja zasobu szablonu usługi ARM

Typ zasobu cassandraClusters/dataCenters można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika 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": "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"
  }
}

Wartości właściwości

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API "2024-05-15-preview"
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 100
Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane)
Właściwości Właściwości zarządzanego centrum danych Cassandra. DataCenterResourceProperties (Właściwości CentrumZasobów)
typ Typ zasobu "Microsoft.DocumentDB/cassandraClusters/dataCenters"

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_baza) Nazwa wyróżniająca obiektu w celu rozpoczęcia cyklicznego wyszukiwania użytkowników. struna
searchFilterTemplate (szablon filtru) Szablon do użycia do wyszukiwania. Wartością domyślną (cn=%s), gdzie %s zostanie zastąpiona nazwą użytkownika używaną do logowania. struna
serverCertificates (Certyfikaty serwera) certyfikatu []
serverHostname (nazwa_hosta) serwera Nazwa hosta serwera LDAP. struna
serverPort (port serwera) Port serwera LDAP. Int
serviceUserDistinguishedName (nazwa_wyróżniająca_usługi) Nazwa wyróżniająca konta użytkownika wyszukiwania, który może wyszukać szczegóły użytkownika dotyczące uwierzytelniania. struna
serviceUserPassword (hasło użytkownika) Hasło użytkownika wyszukiwania. struna

Błąd Kasandry

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

Certyfikat

Nazwa Opis Wartość
Pem Klucz publiczny sformatowany przez PEM. struna

DataCenterResourceProperties (Właściwości CentrumZasobów)

Nazwa Opis Wartość
authenticationMethodLdapProperties Właściwości metody uwierzytelniania Ldap. Ta funkcja jest dostępna w wersji zapoznawczej. AuthenticationMethodLdapProperties
Strefa dostępności Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu Skalowanie maszyn wirtualnych, które hostuje maszyny wirtualne centrum danych cassandra. Bool
backupStorageCustomerKeyUri Wskazuje identyfikator URI klucza klienta do użycia na potrzeby szyfrowania konta magazynu kopii zapasowej. struna
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. struna
dataCenterLocation (lokalizacja centrum danych) Region, w którym należy utworzyć to centrum danych. struna
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 lokalizacji "dataCenterLocation" i musi być w stanie kierować do podsieci określonej we właściwości "delegatedManagementSubnetId" klastra. Ten identyfikator zasobu będzie mieć postać "/subscriptions/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>". struna
diskCapacity (pojemność dysku) Liczba dysków dołączonych do każdego węzła. Wartość domyślna to 4. Int
diskSku (jednostka magazynowa diskSku) Jednostka SKU dysku używana dla centrów danych. Wartość domyślna to P30. struna
managedDiskCustomerKeyUri Identyfikator URI klucza używany do szyfrowania dysków zarządzanych. Upewnij się, że tożsamość przypisana przez system klastra została przypisana do odpowiednich uprawnień (klucz get/wrap/unwrap permissions) na kluczu. struna
nodeCount (liczba_węzłów) Liczba węzłów, które powinny znajdować się w centrum danych. Jest to żądana liczba. Po ustawieniu centrum danych 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
privateEndpointIpAddress (adres prywatnyEndpointIpAddress) Adres IP punktu końcowego sieci VPN dla tego centrum danych. struna
provisionError (błąd zaopatrzenia) Błąd związany z aprowizowaniem zasobów. Błąd Kasandry
stan provisioningu Stan zasobu w momencie wywołania operacji. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"
Numer jednostki magazynowej Jednostka SKU maszyny wirtualnej używana dla centrów danych. Wartość domyślna to Standard_DS14_v2 struna

Przykłady użycia

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu cassandraClusters/dataCenters można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

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

Format zasobu

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15-preview"
  name = "string"
  parent_id = "string"
  body = {
    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"
    }
  }
}

Wartości właściwości

Microsoft.DocumentDB/cassandraClusters/dataCenters

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 100
Wzorzec = ^[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*$ (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: cassandraClusters
Właściwości Właściwości zarządzanego centrum danych Cassandra. DataCenterResourceProperties (Właściwości CentrumZasobów)
typ Typ zasobu "Microsoft.DocumentDB/cassandraClusters/dataCenters@2024-05-15-preview"

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_baza) Nazwa wyróżniająca obiektu w celu rozpoczęcia cyklicznego wyszukiwania użytkowników. struna
searchFilterTemplate (szablon filtru) Szablon do użycia do wyszukiwania. Wartością domyślną (cn=%s), gdzie %s zostanie zastąpiona nazwą użytkownika używaną do logowania. struna
serverCertificates (Certyfikaty serwera) certyfikatu []
serverHostname (nazwa_hosta) serwera Nazwa hosta serwera LDAP. struna
serverPort (port serwera) Port serwera LDAP. Int
serviceUserDistinguishedName (nazwa_wyróżniająca_usługi) Nazwa wyróżniająca konta użytkownika wyszukiwania, który może wyszukać szczegóły użytkownika dotyczące uwierzytelniania. struna
serviceUserPassword (hasło użytkownika) Hasło użytkownika wyszukiwania. struna

Błąd Kasandry

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

Certyfikat

Nazwa Opis Wartość
Pem Klucz publiczny sformatowany przez PEM. struna

DataCenterResourceProperties (Właściwości CentrumZasobów)

Nazwa Opis Wartość
authenticationMethodLdapProperties Właściwości metody uwierzytelniania Ldap. Ta funkcja jest dostępna w wersji zapoznawczej. AuthenticationMethodLdapProperties
Strefa dostępności Jeśli centrum danych obsługuje strefę dostępności, zastosuj ją do zestawu Skalowanie maszyn wirtualnych, które hostuje maszyny wirtualne centrum danych cassandra. Bool
backupStorageCustomerKeyUri Wskazuje identyfikator URI klucza klienta do użycia na potrzeby szyfrowania konta magazynu kopii zapasowej. struna
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. struna
dataCenterLocation (lokalizacja centrum danych) Region, w którym należy utworzyć to centrum danych. struna
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 lokalizacji "dataCenterLocation" i musi być w stanie kierować do podsieci określonej we właściwości "delegatedManagementSubnetId" klastra. Ten identyfikator zasobu będzie mieć postać "/subscriptions/<identyfikator subskrypcji>/resourceGroups/<grupy zasobów>/providers/Microsoft.Network/virtualNetworks/<sieci wirtualnej>/subnets/<podsieci>". struna
diskCapacity (pojemność dysku) Liczba dysków dołączonych do każdego węzła. Wartość domyślna to 4. Int
diskSku (jednostka magazynowa diskSku) Jednostka SKU dysku używana dla centrów danych. Wartość domyślna to P30. struna
managedDiskCustomerKeyUri Identyfikator URI klucza używany do szyfrowania dysków zarządzanych. Upewnij się, że tożsamość przypisana przez system klastra została przypisana do odpowiednich uprawnień (klucz get/wrap/unwrap permissions) na kluczu. struna
nodeCount (liczba_węzłów) Liczba węzłów, które powinny znajdować się w centrum danych. Jest to żądana liczba. Po ustawieniu centrum danych 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
privateEndpointIpAddress (adres prywatnyEndpointIpAddress) Adres IP punktu końcowego sieci VPN dla tego centrum danych. struna
provisionError (błąd zaopatrzenia) Błąd związany z aprowizowaniem zasobów. Błąd Kasandry
stan provisioningu Stan zasobu w momencie wywołania operacji. "Anulowano"
"Tworzenie"
"Usuwanie"
"Niepowodzenie"
"Powodzenie"
"Aktualizowanie"
Numer jednostki magazynowej Jednostka SKU maszyny wirtualnej używana dla centrów danych. Wartość domyślna to Standard_DS14_v2 struna