@azure/arm-cosmosdbforpostgresql package

Klasy

CosmosDBForPostgreSQL

Interfejsy

Cluster	Reprezentuje klaster.
ClusterConfigurationListResult	Lista konfiguracji klastra.
ClusterForUpdate	Reprezentuje klaster do aktualizacji.
ClusterListResult	Lista klastrów.
ClusterServer	Reprezentuje serwer w klastrze.
ClusterServerListResult	Lista serwerów w klastrze.
ClusterServerProperties	Właściwości serwera w klastrze.
Clusters	Interfejs reprezentujący klastry.
ClustersCheckNameAvailabilityOptionalParams	Parametry opcjonalne.
ClustersCreateHeaders	Definiuje nagłówki dla operacji Clusters_create.
ClustersCreateOptionalParams	Parametry opcjonalne.
ClustersDeleteHeaders	Definiuje nagłówki dla operacji Clusters_delete.
ClustersDeleteOptionalParams	Parametry opcjonalne.
ClustersGetOptionalParams	Parametry opcjonalne.
ClustersListByResourceGroupNextOptionalParams	Parametry opcjonalne.
ClustersListByResourceGroupOptionalParams	Parametry opcjonalne.
ClustersListNextOptionalParams	Parametry opcjonalne.
ClustersListOptionalParams	Parametry opcjonalne.
ClustersPromoteReadReplicaHeaders	Definiuje nagłówki dla operacji Clusters_promoteReadReplica.
ClustersPromoteReadReplicaOptionalParams	Parametry opcjonalne.
ClustersRestartHeaders	Definiuje nagłówki dla operacji Clusters_restart.
ClustersRestartOptionalParams	Parametry opcjonalne.
ClustersStartHeaders	Definiuje nagłówki dla operacji Clusters_start.
ClustersStartOptionalParams	Parametry opcjonalne.
ClustersStopHeaders	Definiuje nagłówki dla operacji Clusters_stop.
ClustersStopOptionalParams	Parametry opcjonalne.
ClustersUpdateHeaders	Definiuje nagłówki dla operacji Clusters_update.
ClustersUpdateOptionalParams	Parametry opcjonalne.
Configuration	Reprezentuje szczegóły konfiguracji dla koordynatora i węzła.
Configurations	Interfejs reprezentujący konfiguracje.
ConfigurationsGetCoordinatorOptionalParams	Parametry opcjonalne.
ConfigurationsGetNodeOptionalParams	Parametry opcjonalne.
ConfigurationsGetOptionalParams	Parametry opcjonalne.
ConfigurationsListByClusterNextOptionalParams	Parametry opcjonalne.
ConfigurationsListByClusterOptionalParams	Parametry opcjonalne.
ConfigurationsListByServerNextOptionalParams	Parametry opcjonalne.
ConfigurationsListByServerOptionalParams	Parametry opcjonalne.
ConfigurationsUpdateOnCoordinatorHeaders	Definiuje nagłówki dla operacji Configurations_updateOnCoordinator.
ConfigurationsUpdateOnCoordinatorOptionalParams	Parametry opcjonalne.
ConfigurationsUpdateOnNodeHeaders	Definiuje nagłówki dla operacji Configurations_updateOnNode.
ConfigurationsUpdateOnNodeOptionalParams	Parametry opcjonalne.
CosmosDBForPostgreSQLOptionalParams	Parametry opcjonalne.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błąd dla wszystkich interfejsów API usługi Azure Resource Manager zwraca szczegóły błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi oData).
FirewallRule	Reprezentuje regułę zapory klastra.
FirewallRuleListResult	Lista reguł zapory.
FirewallRules	Interfejs reprezentujący regułę FirewallRules.
FirewallRulesCreateOrUpdateHeaders	Definiuje nagłówki dla operacji FirewallRules_createOrUpdate.
FirewallRulesCreateOrUpdateOptionalParams	Parametry opcjonalne.
FirewallRulesDeleteHeaders	Definiuje nagłówki dla operacji FirewallRules_delete.
FirewallRulesDeleteOptionalParams	Parametry opcjonalne.
FirewallRulesGetOptionalParams	Parametry opcjonalne.
FirewallRulesListByClusterOptionalParams	Parametry opcjonalne.
MaintenanceWindow	Ustawienia harmonogramu dla regularnych aktualizacji klastra.
NameAvailability	Reprezentuje dostępność nazwy klastra.
NameAvailabilityRequest	Zażądaj od klienta sprawdzenia dostępności nazwy klastra.
Operation	Definicja operacji interfejsu API REST.
OperationDisplay	Wyświetl metadane skojarzone z operacją.
OperationListResult	Lista operacji dostawcy zasobów.
Operations	Interfejs reprezentujący operacje.
OperationsListOptionalParams	Parametry opcjonalne.
PrivateEndpoint	Zasób prywatnego punktu końcowego.
PrivateEndpointConnection	Zasób połączenia prywatnego punktu końcowego.
PrivateEndpointConnectionListResult	Lista połączeń prywatnych punktów końcowych skojarzonych z określonym zasobem.
PrivateEndpointConnections	Interfejs reprezentujący element PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateHeaders	Definiuje nagłówki dla operacji PrivateEndpointConnections_createOrUpdate.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsDeleteHeaders	Definiuje nagłówki dla operacji PrivateEndpointConnections_delete.
PrivateEndpointConnectionsDeleteOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsGetOptionalParams	Parametry opcjonalne.
PrivateEndpointConnectionsListByClusterOptionalParams	Parametry opcjonalne.
PrivateEndpointProperty	Właściwość reprezentująca identyfikator zasobu prywatnego punktu końcowego.
PrivateLinkResource	Zasób łącza prywatnego.
PrivateLinkResourceListResult	Lista zasobów łącza prywatnego.
PrivateLinkResources	Interfejs reprezentujący element PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Parametry opcjonalne.
PrivateLinkResourcesListByClusterOptionalParams	Parametry opcjonalne.
PrivateLinkServiceConnectionState	Kolekcja informacji o stanie połączenia między konsumentem usługi a dostawcą.
ProxyResource	Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów ani lokalizacji
Resource	Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager
Role	Reprezentuje rolę klastra.
RoleListResult	Lista ról.
Roles	Interfejs reprezentujący role.
RolesCreateHeaders	Definiuje nagłówki dla operacji Roles_create.
RolesCreateOptionalParams	Parametry opcjonalne.
RolesDeleteHeaders	Definiuje nagłówki dla operacji Roles_delete.
RolesDeleteOptionalParams	Parametry opcjonalne.
RolesGetOptionalParams	Parametry opcjonalne.
RolesListByClusterOptionalParams	Parametry opcjonalne.
ServerConfiguration	Reprezentuje konfigurację.
ServerConfigurationListResult	Lista konfiguracji serwera.
ServerNameItem	Obiekt nazwy serwera.
ServerProperties	Właściwości serwera.
ServerRoleGroupConfiguration	Reprezentuje wartość konfiguracji grupy ról serwera.
Servers	Interfejs reprezentujący serwery.
ServersGetOptionalParams	Parametry opcjonalne.
ServersListByClusterOptionalParams	Parametry opcjonalne.
SimplePrivateEndpointConnection	Połączenie prywatnego punktu końcowego.
SystemData	Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu.
TrackedResource	Definicja modelu zasobów dla zasobu platformy Azure Resource Manager śledzony zasób najwyższego poziomu, który zawiera "tagi" i "lokalizację"

Aliasy typu

ClustersCheckNameAvailabilityResponse	Zawiera dane odpowiedzi dla operacji checkNameAvailability.
ClustersCreateResponse	Zawiera dane odpowiedzi dla operacji tworzenia.
ClustersGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ClustersListByResourceGroupNextResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroupNext.
ClustersListByResourceGroupResponse	Zawiera dane odpowiedzi dla operacji listByResourceGroup.
ClustersListNextResponse	Zawiera dane odpowiedzi dla operacji listDalej.
ClustersListResponse	Zawiera dane odpowiedzi dla operacji listy.
ClustersPromoteReadReplicaResponse	Zawiera dane odpowiedzi dla operacji promoteReadReplica.
ClustersRestartResponse	Zawiera dane odpowiedzi dla operacji ponownego uruchamiania.
ClustersUpdateResponse	Zawiera dane odpowiedzi dla operacji aktualizacji.
ConfigurationDataType	Definiuje wartości configurationDataType. ZnaneConfigurationDataType można używać zamiennie z parametrem ConfigurationDataType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Boolean Numeryczne Liczba całkowita Wyliczenie
ConfigurationsGetCoordinatorResponse	Zawiera dane odpowiedzi dla operacji getCoordinator.
ConfigurationsGetNodeResponse	Zawiera dane odpowiedzi dla operacji getNode.
ConfigurationsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ConfigurationsListByClusterNextResponse	Zawiera dane odpowiedzi dla operacji listByClusterNext.
ConfigurationsListByClusterResponse	Zawiera dane odpowiedzi dla operacji listByCluster.
ConfigurationsListByServerNextResponse	Zawiera dane odpowiedzi dla operacji listByServerNext.
ConfigurationsListByServerResponse	Zawiera dane odpowiedzi dla operacji listByServer.
ConfigurationsUpdateOnCoordinatorResponse	Zawiera dane odpowiedzi dla operacji updateOnCoordinator.
ConfigurationsUpdateOnNodeResponse	Zawiera dane odpowiedzi dla operacji updateOnNode.
CreatedByType	Definiuje wartości dla właściwości CreatedByType. Funkcja KnownCreatedByType może być używana zamiennie z elementem CreatedByType. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Użytkownik Aplikacja ManagedIdentity Klucz
FirewallRulesCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
FirewallRulesDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
FirewallRulesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
FirewallRulesListByClusterResponse	Zawiera dane odpowiedzi dla operacji listByCluster.
OperationOrigin	Definiuje wartości elementu OperationOrigin. ZnaneOperationOrigin można używać zamiennie z operacją OperationOrigin. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Nieokreślone użytkownik system
OperationsListResponse	Zawiera dane odpowiedzi dla operacji listy.
PrivateEndpointConnectionProvisioningState	Definiuje wartości elementu PrivateEndpointConnectionProvisioningState. Element KnownPrivateEndpointConnectionProvisioningState może być używany zamiennie z parametrem PrivateEndpointConnectionProvisioningState. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Powodzenie Tworzenie Usuwanie Niepowodzenie
PrivateEndpointConnectionsCreateOrUpdateResponse	Zawiera dane odpowiedzi dla operacji createOrUpdate.
PrivateEndpointConnectionsDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
PrivateEndpointConnectionsGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
PrivateEndpointConnectionsListByClusterResponse	Zawiera dane odpowiedzi dla operacji listByCluster.
PrivateEndpointServiceConnectionStatus	Definiuje wartości parametru PrivateEndpointServiceConnectionStatus. ZnanePrivateEndpointServiceConnectionStatus można używać zamiennie z parametrem PrivateEndpointServiceConnectionStatus. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Oczekujące Approved (Zatwierdzono) Odrzucone
PrivateLinkResourcesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
PrivateLinkResourcesListByClusterResponse	Zawiera dane odpowiedzi dla operacji listByCluster.
ProvisioningState	Definiuje wartości parametru ProvisioningState. Wartość KnownProvisioningState może być używana zamiennie z parametrem ProvisioningState. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Powodzenie Anulowane Ruch przychodzący Niepowodzenie
RolesCreateResponse	Zawiera dane odpowiedzi dla operacji tworzenia.
RolesDeleteResponse	Zawiera dane odpowiedzi dla operacji usuwania.
RolesGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
RolesListByClusterResponse	Zawiera dane odpowiedzi dla operacji listByCluster.
ServerRole	Definiuje wartości elementu ServerRole. ZnaneServerRole można używać zamiennie z ServerRole. To wyliczenie zawiera znane wartości obsługiwane przez usługę. Znane wartości obsługiwane przez usługę Koordynator Pracownik
ServersGetResponse	Zawiera dane odpowiedzi dla operacji pobierania.
ServersListByClusterResponse	Zawiera dane odpowiedzi dla operacji listByCluster.

Wyliczenia

KnownConfigurationDataType	Znane wartości ConfigurationDataType , które akceptuje usługa.
KnownCreatedByType	Znane wartości CreatedByType , które akceptuje usługa.
KnownOperationOrigin	Znane wartości OperacjiOrigin , które akceptuje usługa.
KnownPrivateEndpointConnectionProvisioningState	Znane wartości PrivateEndpointConnectionProvisioningState , które akceptuje usługa.
KnownPrivateEndpointServiceConnectionStatus	Znane wartości PrivateEndpointServiceConnectionStatus , które akceptuje usługa.
KnownProvisioningState	Znane wartości provisioningState , które akceptuje usługa.
KnownServerRole	Znane wartości ServerRole akceptowane przez usługę.

Funkcje

getContinuationToken(unknown)

Biorąc pod uwagę ostatnio .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

Szczegóły funkcji

getContinuationToken(unknown)

Biorąc pod uwagę ostatnio .value wygenerowany przez byPage iterator, zwraca token kontynuacji, którego można użyć do rozpoczęcia stronicowania z tego punktu później.

function getContinuationToken(page: unknown): string | undefined

Parametry

page

unknown

Obiekt z dostępu value do iteratoraResult z iteratora byPage .

Zwraca

string | undefined

Token kontynuacji, który można przekazać do metody byPage() podczas przyszłych wywołań.