@azure/arm-postgresqlhsc package
Klasy
| DBforPostgreSQLClient |
Interfejsy
| AuthConfig |
Konfiguracja uwierzytelniania klastra. |
| Cluster |
Reprezentuje klaster. |
| ClusterForUpdate |
Reprezentuje klaster do aktualizacji. |
| ClusterProperties |
Właściwości klastra. |
| ClusterPropertiesForUpdate |
Właściwości używane do aktualizacji klastra. |
| ClusterServer |
Reprezentuje serwer w klastrze. |
| ClusterServerProperties |
Właściwości serwera w klastrze. |
| ClustersCheckNameAvailabilityOptionalParams |
Parametry opcjonalne. |
| ClustersCreateOptionalParams |
Parametry opcjonalne. |
| ClustersDeleteOptionalParams |
Parametry opcjonalne. |
| ClustersGetOptionalParams |
Parametry opcjonalne. |
| ClustersListByResourceGroupOptionalParams |
Parametry opcjonalne. |
| ClustersListOptionalParams |
Parametry opcjonalne. |
| ClustersOperations |
Interfejs reprezentujący operacje klastrów. |
| ClustersPromoteReadReplicaOptionalParams |
Parametry opcjonalne. |
| ClustersRestartOptionalParams |
Parametry opcjonalne. |
| ClustersStartOptionalParams |
Parametry opcjonalne. |
| ClustersStopOptionalParams |
Parametry opcjonalne. |
| ClustersUpdateOptionalParams |
Parametry opcjonalne. |
| Configuration |
Reprezentuje szczegóły konfiguracji koordynatora i węzła. |
| ConfigurationProperties |
Właściwości konfiguracji. |
| ConfigurationsGetCoordinatorOptionalParams |
Parametry opcjonalne. |
| ConfigurationsGetNodeOptionalParams |
Parametry opcjonalne. |
| ConfigurationsGetOptionalParams |
Parametry opcjonalne. |
| ConfigurationsListByClusterOptionalParams |
Parametry opcjonalne. |
| ConfigurationsListByServerOptionalParams |
Parametry opcjonalne. |
| ConfigurationsOperations |
Interfejs reprezentujący operacje Konfiguracje. |
| ConfigurationsUpdateOnCoordinatorOptionalParams |
Parametry opcjonalne. |
| ConfigurationsUpdateOnNodeOptionalParams |
Parametry opcjonalne. |
| DBforPostgreSQLClientOptionalParams |
Parametry opcjonalne dla klienta. |
| DataEncryption |
Właściwości szyfrowania danych klastra. |
| ErrorAdditionalInfo |
Dodatkowe informacje o błędzie zarządzania zasobami. |
| ErrorDetail |
Szczegóły błędu. |
| ErrorResponse |
Wspólna odpowiedź na błędy dla wszystkich API Azure Resource Manager zwraca szczegóły błędów dla nieudanych operacji. |
| FirewallRule |
Reprezentuje regułę zapory klastra. |
| FirewallRuleProperties |
Właściwości reguły zapory klastrowej. |
| FirewallRulesCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| FirewallRulesDeleteOptionalParams |
Parametry opcjonalne. |
| FirewallRulesGetOptionalParams |
Parametry opcjonalne. |
| FirewallRulesListByClusterOptionalParams |
Parametry opcjonalne. |
| FirewallRulesOperations |
Interfejs reprezentujący operacje FirewallRules. |
| IdentityProperties |
Opisuje tożsamość klastra. |
| MaintenanceWindow |
Zaplanuj ustawienia regularnych aktualizacji klastra. |
| NameAvailability |
Reprezentuje dostępność nazwy klastra. |
| NameAvailabilityRequest |
Zażądaj od klienta sprawdzenia dostępności nazwy klastra. |
| Operation |
Szczegóły operacji interfejsu API REST zwrócone z interfejsu API operacji dostawcy zasobów |
| OperationDisplay |
Zlokalizowane informacje wyświetlane dla operacji. |
| OperationsListOptionalParams |
Parametry opcjonalne. |
| OperationsOperations |
Interfejs reprezentujący operacje Operations. |
| PageSettings |
Opcje dla metody byPage |
| PagedAsyncIterableIterator |
Interfejs, który umożliwia iterację asynchronialną zarówno do ukończenia, jak i według strony. |
| PrivateEndpoint |
Zasób prywatnego punktu końcowego. |
| PrivateEndpointConnection |
Prywatny zasób połączenia końcowego |
| PrivateEndpointConnectionProperties |
Właściwości połączenia prywatnego punktu końcowego. |
| PrivateEndpointConnectionSimpleProperties |
Właściwości w połączeniu z prywatnym punktem końcowym |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsGetOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsListByClusterOptionalParams |
Parametry opcjonalne. |
| PrivateEndpointConnectionsOperations |
Interfejs reprezentujący operacje PrivateEndpointConnections. |
| PrivateEndpointProperty |
Właściwość reprezentująca identyfikator zasobu prywatnego punktu końcowego. |
| PrivateLinkResource |
Zasób łącza prywatnego. |
| PrivateLinkResourceProperties |
Właściwości zasobu łącza prywatnego. |
| PrivateLinkResourcesGetOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResourcesListByClusterOptionalParams |
Parametry opcjonalne. |
| PrivateLinkResourcesOperations |
Interfejs reprezentujący operacje PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
Zbiór informacji o stanie połączenia między użytkownikiem usługi a dostawcą. |
| PromoteRequest |
Żądanie od klienta podwyższania poziomu repliki geograficznie nadmiarowej |
| ProxyResource |
Definicja modelu zasobów dla zasobu serwera proxy usługi Azure Resource Manager. Nie będzie on miał tagów i lokalizacji |
| Resource |
Typowe pola zwracane w odpowiedzi dla wszystkich zasobów usługi Azure Resource Manager |
| RestorePollerOptions | |
| Role |
Reprezentuje rolę klastra. |
| RoleProperties |
Właściwości roli klastrowej. |
| RolePropertiesExternalIdentity |
interfejs modelu RolePropertiesExternalIdentity |
| RolesCreateOptionalParams |
Parametry opcjonalne. |
| RolesDeleteOptionalParams |
Parametry opcjonalne. |
| RolesGetOptionalParams |
Parametry opcjonalne. |
| RolesListByClusterOptionalParams |
Parametry opcjonalne. |
| RolesOperations |
Interfejs reprezentujący operacje Roles. |
| ServerConfiguration |
Reprezentuje konfigurację. |
| ServerConfigurationProperties |
Właściwości konfiguracji. |
| ServerNameItem |
Obiekt nazwy serwera. |
| ServerProperties |
Właściwości serwera. |
| ServerRoleGroupConfiguration |
Reprezentuje wartość konfiguracji grupy ról serwera. |
| ServersGetOptionalParams |
Parametry opcjonalne. |
| ServersListByClusterOptionalParams |
Parametry opcjonalne. |
| ServersOperations |
Interfejs reprezentujący operacje serwera. |
| SimplePrivateEndpointConnection |
Połączenie prywatnego punktu końcowego. |
| SystemData |
Metadane dotyczące tworzenia i ostatniej modyfikacji zasobu. |
| TrackedResource |
Definicja modelu zasobów dla zasobu usługi Azure Resource Manager śledziła zasób najwyższego poziomu, który ma "tagi" i "lokalizację" |
| UserAssignedIdentity |
Właściwości tożsamości przypisanej przez użytkownika |
Aliasy typu
| AadEnabledEnum |
Wskazuje, czy klaster został utworzony przy użyciu uwierzytelniania usługi AAD. Znane wartości obsługiwane przez usługę
włączone |
| ActionType |
Rozszerzalne wyliczenie. Wskazuje typ akcji. „Internal” oznacza działania przeznaczone wyłącznie dla interfejsów API do użytku wewnętrznego. Znane wartości obsługiwane przez usługęwewnętrzny: akcje dotyczą interfejsów API tylko do użytku wewnętrznego. |
| ActiveDirectoryAuth |
Typ ActiveDirectoryAuth |
| AzureSupportedClouds |
Obsługiwane wartości ustawienia chmury jako typ literału ciągu |
| CheckNameAvailabilityResourceType |
Typ zasobu używany do weryfikowania dostępności nazw. |
| ConfigurationDataType |
Typ danych konfiguracji. Znane wartości obsługiwane przez usługę
Boolean |
| ContinuablePage |
Interfejs opisujący stronę wyników. |
| CreatedByType |
Rodzaj jednostki, która utworzyła zasób. Znane wartości obsługiwane przez usługę
użytkownik: jednostka została utworzona przez użytkownika. |
| DataEncryptionType |
Typ szyfrowania danych |
| IdentityType |
Typ tożsamości |
| Origin |
Zamierzony podmiot wykonujący operację; na przykład w interfejsie użytkownika kontroli dostępu opartej na zasobach (RBAC) oraz dzienników audytu. Wartość domyślna to "użytkownik,system" Znane wartości obsługiwane przez usługę
użytkownika: wskazuje, że operacja jest inicjowana przez użytkownika. |
| PasswordAuth |
Typ PasswordAuth |
| PasswordEnabledEnum |
Wskazuje, czy klaster został utworzony przy użyciu hasła, czy uwierzytelniania usługi AAD. Znane wartości obsługiwane przez usługę
włączone |
| PrincipalType |
Typ PrincipalType |
| PrivateEndpointConnectionProvisioningState |
Bieżący stan aprowizacji. Znane wartości obsługiwane przez usługę
Powodzenie: połączenie zostało zainicjowane |
| PrivateEndpointServiceConnectionStatus |
Stan połączenia prywatnego punktu końcowego. Znane wartości obsługiwane przez usługę
Oczekujące: połączenie oczekujące na zatwierdzenie lub odrzucenie |
| ProvisioningState |
Bieżący stan aprowizacji. Znane wartości obsługiwane przez usługę
Powodzenie |
| RoleType |
Typ roliTyp |
| ServerRole |
Rola serwera. Znane wartości obsługiwane przez usługę
Koordynator |
Wyliczenia
| AzureClouds |
Enum opisujące środowiska Azure Cloud. |
| KnownAadEnabledEnum |
Wskazuje, czy klaster został utworzony przy użyciu uwierzytelniania usługi AAD. |
| KnownActionType |
Rozszerzalne wyliczenie. Wskazuje typ akcji. „Internal” oznacza działania przeznaczone wyłącznie dla interfejsów API do użytku wewnętrznego. |
| KnownActiveDirectoryAuth |
Znane wartości ActiveDirectoryAuth , które usługa akceptuje. |
| KnownConfigurationDataType |
Typ danych konfiguracji. |
| KnownCreatedByType |
Rodzaj jednostki, która utworzyła zasób. |
| KnownDataEncryptionType |
Znane wartości DataEncryptionType akceptowane przez usługę. |
| KnownIdentityType |
Znane wartości IdentityType akceptowane przez usługę. |
| KnownOrigin |
Zamierzony podmiot wykonujący operację; na przykład w interfejsie użytkownika kontroli dostępu opartej na zasobach (RBAC) oraz dzienników audytu. Wartość domyślna to "użytkownik,system" |
| KnownPasswordAuth |
Znane wartości PasswordAuth , które usługa akceptuje. |
| KnownPasswordEnabledEnum |
Wskazuje, czy klaster został utworzony przy użyciu hasła, czy uwierzytelniania usługi AAD. |
| KnownPrincipalType |
Znane wartości PrincipalType akceptowane przez usługę. |
| KnownPrivateEndpointConnectionProvisioningState |
Bieżący stan aprowizacji. |
| KnownPrivateEndpointServiceConnectionStatus |
Stan połączenia prywatnego punktu końcowego. |
| KnownProvisioningState |
Bieżący stan aprowizacji. |
| KnownRoleType |
Znane wartości typu roli , które usługa akceptuje. |
| KnownServerRole |
Rola serwera. |
| KnownVersions |
Dostępne wersje interfejsu API. |
Funkcje
| is |
Funkcja Typeguard dla błędu RestError |
| restore |
Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie. |
Zmienne
| Rest |
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem. |
Szczegóły funkcji
isRestError(unknown)
Funkcja Typeguard dla błędu RestError
function isRestError(e: unknown): e
Parametry
- e
-
unknown
Coś złapanego przez klauzulę catch.
Zwraca
e
restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Tworzy obiekt poller na podstawie serializowanego stanu innego programu poller. Może to być przydatne, gdy chcesz utworzyć filtry na innym hoście lub gdy program poller musi zostać skonstruowany po tym, jak oryginalny nie jest w zakresie.
function restorePoller<TResponse, TResult>(client: DBforPostgreSQLClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parametry
- client
- DBforPostgreSQLClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Zwraca
PollerLike<OperationState<TResult>, TResult>
Szczegóły zmiennej
RestError
Niestandardowy typ błędu dla żądań potoku, który zakończył się niepowodzeniem.
RestError: RestErrorConstructor