Cosmos DB dla interfejsu API REST PostgreSQL

Azure Cosmos DB for Postgres to w pełni zarządzana, natywna dla chmury rozproszona baza danych SQL dla aplikacji transakcyjnych.

Interfejsy API REST (Representational State Transfer) dostawcy zasobów umożliwiają programowe zarządzanie zasobami usługi Azure Cosmos DB. Główne obsługiwane kategorie to:

  • Wdrażanie klastra, zarządzanie nim lub podwyższanie poziomu.
  • Zarządzanie konfiguracjami węzłów roboczych koordynatora \.
  • Zarządzanie regułami zapory.
  • Zarządzanie połączeniami prywatnych punktów końcowych i zasobami łącza prywatnego.
  • Zarządzanie rolami.

Autoryzacja

Wszystkie wywołania REST usługi Azure Resource Manager wymagają prawidłowego tokenu autoryzacji w nagłówku żądania, aby zakończyło się pomyślnie. Aby uzyskać szczegółowe informacje na temat uzyskiwania tego tokenu autoryzacji, zobacz Tworzenie żądania: uzyskiwanie tokenu dostępu .

Jak wykonywać wywołania interfejsu API REST

Istnieje kilka sposobów wykonywania wywołań interfejsu API REST dla dowolnej usługi platformy Azure, w tym usługi Azure Cosmos DB for PostgreSQL. Możesz użyć Postmana jako najbardziej uniwersalnego, uniwersalnego narzędzia do wywołań interfejsu API REST. Możesz również użyć curl dla niektórych innych scenariuszy, w tym skryptów nienadzorowanych, takich jak te używane w automatyzacji devops. Możesz również użyć polecenia "az rest" jako łatwego sposobu wykonywania wywołań interfejsu API REST z interfejsu wiersza polecenia platformy Azure.

Symbole zastępcze i wartości

Poniższe informacje są wspólne dla wszystkich zadań, które można wykonać przy użyciu tych interfejsów API REST:

  • Zastąp {api-version} najnowszą dostępną wersję interfejsu API , taką jak 2022-11-08.
  • Zastąp {subscriptionId} ciąg identyfikatorem subskrypcji w identyfikatorze URI. Ta wartość jest identyfikatorem GUID unikatowym dla Twojej subskrypcji, takim jak 6B29FC40-CA47-1067-B31D-00DD010662DA. Znajdź identyfikator subskrypcji przy użyciu bloku Subskrypcje Azure Portal.
  • Zastąp element {resourceGroupName} grupą zasobów. Aby uzyskać więcej informacji, zobacz Używanie grup zasobów do zarządzania zasobami platformy Azure.
  • Zastąp {clusterName} ciąg nazwą klastra usługi Azure Cosmos DB for PostgreSQL. Użyj krótkiej nazwy, takiej jak mydemocluster.
  • Ustaw nagłówek Content-Type na wartość application/json.
  • Ustaw nagłówek autoryzacji na token internetowy JSON uzyskany z usługi Azure Active Directory. Aby uzyskać więcej informacji, zobacz sekcję Autoryzacja.

Wartości

Skorzystaj z poniższej dokumentacji, aby określić obsługiwane wartości dla różnych wywołań interfejsu API REST dla klastrów i węzłów usługi Azure Cosmos DB for PostgreSQL.

Tworzenie i aktualizowanie klastra

  • properties.postgresqlVersion: główna wersja bazy danych PostgreSQL we wszystkich węzłach w klastrze. Określ obsługiwaną główną wersję bazy danych PostgreSQL. Na przykład "15". Zobacz listę obsługiwanych wersji Postgres. Klaster jest tworzony przy użyciu najnowszej pomocniczej wersji bazy danych PostgreSQL i najnowszej odpowiedniej wersji Citus dostępnej w wybranym regionie.
  • properties.citusVersion: wersja rozszerzenia Citus, która jest zainstalowana we wszystkich węzłach w klastrze. Na przykład "11.3". Zobacz aktualnie obsługiwaną wersję Citus.
    • Ta właściwość jest opcjonalna dla nowej aprowizacji klastra. Jeśli ta właściwość zostanie pominięta, zostanie zainstalowana najnowsza wersja narzędzia Citus obsługiwana dla określonej głównej wersji bazy danych PostgreSQL.
    • Podstawowym przypadkiem tej właściwości jest uaktualnienie wersji Citus, takie jak 11.0 do 11.3. Po wydaniu zaktualizowanej wersji Citus dla głównej wersji bazy danych PostgreSQL w klastrze można użyć wywołania interfejsu API aktualizacji klastra , aby uaktualnić tylko wersję Citus do najnowszej obsługiwanej dla bieżącej głównej wersji bazy danych PostgreSQL.
  • properties.administratorLoginPassword: hasło dla roli "citus" we wszystkich węzłach w klastrze. Hasło musi spełniać następujące wymagania
    • Długość: co najmniej 8 znaków i maksymalnie 128 znaków
    • Złożoność: Musi zawierać znaki z każdej z następujących kategorii:
      • Wielkie litery angielskie
      • Małe litery angielskie
      • Liczby (0–9)
      • Znaki inne niż alfanumeryczne (!, $, #, %itp.)
    • Nazwa roli w haśle: nie może zawierać całości lub części nazwy roli. Część nazwy roli jest zdefiniowana jako co najmniej trzy kolejne znaki alfanumeryczne
  • properties.coordinatorServerEdition: typ zasobów obliczeniowych w koordynatorze klastra z jednym węzłem lub wieloma węzłami. Użyj następujących wartości dla obsługiwanych zasobów obliczeniowych z jednym węzłem i wieloma węzłami
    • Pojedynczy węzeł
      • Możliwość rozszerzenia, 1 rdzeń wirtualny: BurstableMemoryOptimized
      • Możliwość rozszerzenia, 2 rdzenie wirtualne: Możliwość rozszerzeniaGeneralPurpose
      • Bez możliwości zwiększenia wydajności, wszystkie obsługiwane rdzenie wirtualne: GeneralPurpose
    • Wiele węzłów
      • Bez możliwości zwiększenia wydajności, wszystkie obsługiwane rdzenie wirtualne: GeneralPurpose
  • properties.coordinatorVCores: liczba rdzeni wirtualnych obliczeniowych w koordynatorze klastra z jednym węzłem lub wieloma węzłami. Zobacz obsługiwane wartości na tej stronie.
  • properties.coordinatorStorageQuotaInMb: rozmiar magazynu w MiB w jednym węźle lub w koordynatorze w klastrze z wieloma węzłami. Zobacz obsługiwane rozmiary magazynów dla konfiguracji z jednym węzłem i wieloma węzłami. Na przykład, aby określić 128 GiB pamięci masowej, użyj wartości "131072" (128 GiB * 1024 = 131072 MiB).
  • properties.nodeServerEdition: typ obliczeń w węzłach roboczych. Obsługiwana jest tylko wartość "MemoryOptimized".
  • properties.nodeVCores: liczba rdzeni wirtualnych obliczeniowych w każdym węźle procesu roboczego w klastrze z wieloma węzłami. Zobacz obsługiwane wartości na tej stronie.
  • properties.nodeStorageQuotaInMb: rozmiar magazynu w MiB w węźle roboczym w klastrze wielowęzłowym. Zobacz obsługiwane rozmiary magazynów konfiguracje wielowęzłowe. Na przykład, aby określić 2 TiB magazynu, użyj wartości "2097152" (2 TiB * 1024 = 2048 GiB * 1024 = 2097152 MiB).
  • properties.coordinatorEnablePublicIpAccess: Po ustawieniu wartości "False" ta właściwość wyłącza publiczny dostęp do koordynatora klastra.
  • properties.nodeEnablePublicIpAccess: wartość domyślna tej właściwości to "false", co skutecznie wyłącza bezpośredni dostęp publiczny do węzłów roboczych. Aby włączyć opcjonalny bezpośredni dostęp do węzłów roboczych w klastrach wielowęzłowych, należy ustawić tę właściwość na wartość "True" i utworzyć reguły zapory dla tych publicznych adresów IP. Wszystkie reguły zapory mają zastosowanie do koordynatora i wszystkich węzłów roboczych.

Tworzenie reguły zapory sieciowej

  • properties.startIpAddress oraz properties.endIpAddress
    • Aby utworzyć regułę zapory dla pojedynczego publicznego adresu IP, określ ten adres IP jako wartość zarówno dla startIpAddress, jak i endIpAddress.
    • Aby zezwolić na połączenia z dowolnego adresu IP zarządzanego przez platformę Azure, określ wartość "0.0.0.0" zarówno dla wartości startIpAddress, jak i endIpAddress. Należy pamiętać, że ta reguła zapory zezwala na połączenia z subskrypcji platformy Azure innych klientów.

Tworzenie roli

  • properties.password: hasło dla roli Postgres, która ma zostać utworzona we wszystkich węzłach w klastrze. Hasło musi spełniać następujące wymagania
    • Długość: co najmniej 8 znaków i maksymalnie 128 znaków
    • Złożoność: Musi zawierać znaki z każdej z następujących kategorii:
      • Wielkie litery angielskie
      • Małe litery angielskie
      • Liczby (0–9)
      • Znaki inne niż alfanumeryczne (!, $, #, %itp.)
    • Nazwa roli w haśle: nie może zawierać całości lub części nazwy roli. Część nazwy roli jest zdefiniowana jako co najmniej trzy kolejne znaki alfanumeryczne
  • Last updated on