@azure/arm-postgresqlhsc package

Rozhraní

AuthConfig

Konfigurace ověřování clusteru

Cluster

Představuje cluster.

ClusterForUpdate

Představuje cluster pro aktualizaci.

ClusterProperties

Vlastnosti clusteru

ClusterPropertiesForUpdate

Vlastnosti používané k aktualizaci clusteru.

ClusterServer

Představuje server v clusteru.

ClusterServerProperties

Vlastnosti serveru v clusteru.

ClustersCheckNameAvailabilityOptionalParams

Volitelné parametry.

ClustersCreateOptionalParams

Volitelné parametry.

ClustersDeleteOptionalParams

Volitelné parametry.

ClustersGetOptionalParams

Volitelné parametry.

ClustersListByResourceGroupOptionalParams

Volitelné parametry.

ClustersListOptionalParams

Volitelné parametry.

ClustersOperations

Rozhraní představující Clustery operací.

ClustersPromoteReadReplicaOptionalParams

Volitelné parametry.

ClustersRestartOptionalParams

Volitelné parametry.

ClustersStartOptionalParams

Volitelné parametry.

ClustersStopOptionalParams

Volitelné parametry.

ClustersUpdateOptionalParams

Volitelné parametry.

Configuration

Představuje podrobnosti konfigurace pro koordinátora a uzel.

ConfigurationProperties

Vlastnosti konfigurace.

ConfigurationsGetCoordinatorOptionalParams

Volitelné parametry.

ConfigurationsGetNodeOptionalParams

Volitelné parametry.

ConfigurationsGetOptionalParams

Volitelné parametry.

ConfigurationsListByClusterOptionalParams

Volitelné parametry.

ConfigurationsListByServerOptionalParams

Volitelné parametry.

ConfigurationsOperations

Rozhraní reprezentující operace Konfigurace.

ConfigurationsUpdateOnCoordinatorOptionalParams

Volitelné parametry.

ConfigurationsUpdateOnNodeOptionalParams

Volitelné parametry.

DBforPostgreSQLClientOptionalParams

Volitelné parametry pro klienta.

DataEncryption

Vlastnosti šifrování dat clusteru.

ErrorAdditionalInfo

Další informace o chybě při správě prostředků

ErrorDetail

Podrobnosti o chybě.

ErrorResponse

Běžná chybová odpověď pro všechna API Azure Resource Manager pro vrácení chybových údajů o neúspěšných operacích.

FirewallRule

Představuje pravidlo brány firewall clusteru.

FirewallRuleProperties

Vlastnosti pravidla clusterového firewallu.

FirewallRulesCreateOrUpdateOptionalParams

Volitelné parametry.

FirewallRulesDeleteOptionalParams

Volitelné parametry.

FirewallRulesGetOptionalParams

Volitelné parametry.

FirewallRulesListByClusterOptionalParams

Volitelné parametry.

FirewallRulesOperations

Rozhraní představující operace brány firewall

IdentityProperties

Popisuje identitu clusteru.

MaintenanceWindow

Naplánujte nastavení pro pravidelné aktualizace clusteru.

NameAvailability

Představuje dostupnost názvu clusteru.

NameAvailabilityRequest

Požádejte klienta o kontrolu dostupnosti názvu clusteru.

Operation

Podrobnosti o operaci ROZHRANÍ REST API vrácené z rozhraní API pro operace poskytovatele prostředků

OperationDisplay

Lokalizované zobrazovací informace pro operaci.

OperationsListOptionalParams

Volitelné parametry.

OperationsOperations

Rozhraní představující Operace operací.

PageSettings

Možnosti pro metodu byPage

PagedAsyncIterableIterator

Rozhraní, které umožňuje asynchronní iterovatelnou iteraci až do dokončení i po stránce.

PrivateEndpoint

Prostředek privátního koncového bodu.

PrivateEndpointConnection

Soukromý zdroj připojení koncového bodu

PrivateEndpointConnectionProperties

Vlastnosti připojení privátního koncového bodu

PrivateEndpointConnectionSimpleProperties

Vlastnosti v připojení k privátnímu koncovému bodu

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsDeleteOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsGetOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsListByClusterOptionalParams

Volitelné parametry.

PrivateEndpointConnectionsOperations

Rozhraní představující PrivateEndpointConnections operace.

PrivateEndpointProperty

Vlastnost představující ID prostředku privátního koncového bodu

PrivateLinkResource

Prostředek privátního propojení.

PrivateLinkResourceProperties

Vlastnosti prostředku privátního propojení

PrivateLinkResourcesGetOptionalParams

Volitelné parametry.

PrivateLinkResourcesListByClusterOptionalParams

Volitelné parametry.

PrivateLinkResourcesOperations

Rozhraní představující operace PrivateLinkResources.

PrivateLinkServiceConnectionState

Kolekce informací o stavu připojení mezi příjemcem služeb a poskytovatelem.

PromoteRequest

Žádost od klienta o zvýšení úrovně geograficky redundantní repliky

ProxyResource

Definice modelu prostředků pro prostředek proxy serveru Azure Resource Manageru. Nebude obsahovat značky a umístění.

Resource

Běžná pole vrácená v odpovědi pro všechny prostředky Azure Resource Manageru

RestorePollerOptions
Role

Představuje roli clusteru.

RoleProperties

Vlastnosti shlukové role.

RolePropertiesExternalIdentity

rozhraní modelu RolePropertiesExternalIdentity

RolesCreateOptionalParams

Volitelné parametry.

RolesDeleteOptionalParams

Volitelné parametry.

RolesGetOptionalParams

Volitelné parametry.

RolesListByClusterOptionalParams

Volitelné parametry.

RolesOperations

Rozhraní reprezentující operace rolí.

ServerConfiguration

Představuje konfiguraci.

ServerConfigurationProperties

Vlastnosti konfigurace.

ServerNameItem

Objekt name pro server.

ServerProperties

Vlastnosti serveru.

ServerRoleGroupConfiguration

Představuje hodnotu konfigurace skupiny rolí serveru.

ServersGetOptionalParams

Volitelné parametry.

ServersListByClusterOptionalParams

Volitelné parametry.

ServersOperations

Rozhraní reprezentující operace serveru.

SimplePrivateEndpointConnection

Připojení privátního koncového bodu.

SystemData

Metadata týkající se vytvoření a poslední změny prostředku.

TrackedResource

Definice modelu prostředků pro Prostředek Azure Resource Manageru sledovala prostředek nejvyšší úrovně, který má značky a umístění.

UserAssignedIdentity

Vlastnosti identity přiřazené uživatelem

Aliasy typu

AadEnabledEnum

Určuje, jestli byl cluster vytvořen pomocí ověřování AAD.
KnownAadEnabledEnum lze používat zaměnitelně s AadEnabledEnum, toto enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

povolené
zakázáno

ActionType

Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.
PoleActionType lze použít zaměnitelně s ActionType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Interní: Akce jsou určené pouze pro interní rozhraní API.

ActiveDirectoryAuth

Typ ActiveDirectoryAuth

AzureSupportedClouds

Podporované hodnoty pro nastavení cloudu jako typ řetězcového literálu

CheckNameAvailabilityResourceType

Typ prostředku použitý pro ověření dostupnosti názvu.

ConfigurationDataType

Datový typ konfigurace.
PoleConfigurationDataType lze použít zaměnitelně s ConfigurationDataType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Boolean
Numeric
Celé číslo
Výčet

ContinuablePage

Rozhraní, které popisuje stránku výsledků.

CreatedByType

Druh entity, která prostředek vytvořila.
Pole KnownCreatedByType lze použít zaměnitelně s CreatedByType, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Uživatel: Entita byla vytvořena uživatelem.
Aplikace: Entita byla vytvořena aplikací.
ManagedIdentity: Entita byla vytvořena spravovanou identitou.
Klíč: Entita byla vytvořena klíčem.

DataEncryptionType

Typ šifrování dat

IdentityType

Typ identityType

Origin

Zamýšlený vykonavatel operace; například v řízení přístupu založeném na prostředcích (RBAC) a v uživatelském rozhraní auditních protokolů. Výchozí hodnota je user, system.
PoleOrigin lze použít zaměnitelně s Origin, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

uživatel: Označuje, že operace je inicializována uživatelem.
systémová: Označuje, že operace je inicializována systémem.
uživatel, systémová: Označuje, že operace je inicializována uživatelem nebo systémem.

PasswordAuth

Typ PasswordAuth

PasswordEnabledEnum

Určuje, jestli byl cluster vytvořen pomocí hesla nebo pomocí ověřování AAD.
KnownPasswordEnabledEnum lze používat zaměnitelně s PasswordEnabledEnum, toto enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

povolené
zakázáno

PrincipalType

Typ principalTyp

PrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.
PolePrivateEndpointConnectionProvisioningState lze použít zaměnitelně s PrivateEndpointConnectionProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Úspěch: Připojení bylo zřízeno
Vytváření: Vytváří se spojení
Smazání: Připojení se odstraňuje
Nezdařilo se: Zřizování připojení se nezdařilo

PrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.
KnownPrivateEndpointServiceConnectionStatus lze použít zaměnitelně s PrivateEndpointServiceConnectionStatus, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Čeká na vyřízení: Připojení čeká na schválení nebo zamítnutí
Schváleno: Připojení schváleno
Odmítnuto: Připojení odmítnuto

ProvisioningState

Aktuální stav zřizování.
KnownProvisioningState lze použít zaměnitelně s ProvisioningState, tento výčet obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Uspěl
Zrušeno
InProgress
Neúspěch

RoleType

Typ roleTyp

ServerRole

Role serveru.
KnownServerRole lze používat zaměnitelně se ServerRole, toto enum obsahuje známé hodnoty, které služba podporuje.

Známé hodnoty podporované službou

Koordinátor
Pracovní podproces

Výčty

AzureClouds

Enum pro popis prostředí Azure Cloud.

KnownAadEnabledEnum

Určuje, jestli byl cluster vytvořen pomocí ověřování AAD.

KnownActionType

Rozšiřitelný výčt. Označuje typ akce. Interní označuje akce, které jsou určené pouze pro interní rozhraní API.

KnownActiveDirectoryAuth

Známé hodnoty ActiveDirectoryAuth , které služba přijímá.

KnownConfigurationDataType

Datový typ konfigurace.

KnownCreatedByType

Druh entity, která prostředek vytvořila.

KnownDataEncryptionType

Známé hodnoty DataEncryptionType služby, které služba přijímá.

KnownIdentityType

Známé hodnoty IdentityType, které služba přijímá.

KnownOrigin

Zamýšlený vykonavatel operace; například v řízení přístupu založeném na prostředcích (RBAC) a v uživatelském rozhraní auditních protokolů. Výchozí hodnota je user, system.

KnownPasswordAuth

Známé hodnoty PasswordAuth , které služba přijímá.

KnownPasswordEnabledEnum

Určuje, jestli byl cluster vytvořen pomocí hesla nebo pomocí ověřování AAD.

KnownPrincipalType

Známé hodnoty typu PrincipalType, které služba přijímá.

KnownPrivateEndpointConnectionProvisioningState

Aktuální stav zřizování.

KnownPrivateEndpointServiceConnectionStatus

Stav připojení privátního koncového bodu.

KnownProvisioningState

Aktuální stav zřizování.

KnownRoleType

Známé hodnoty typu role , které služba přijímá.

KnownServerRole

Role serveru.

KnownVersions

Dostupné verze rozhraní API.

Funkce

isRestError(unknown)

Typeguard pro RestError

restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Vytvoří poller ze serializovaného stavu jiného poller. To může být užitečné, když chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller poté, co původní server není v oboru.

Proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

Podrobnosti funkce

isRestError(unknown)

Typeguard pro RestError

function isRestError(e: unknown): e

Parametry

e

unknown

Něco zachyceného klauzulí catch.

Návraty

e

restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Vytvoří poller ze serializovaného stavu jiného poller. To může být užitečné, když chcete vytvořit pollery na jiném hostiteli nebo je třeba vytvořit poller poté, co původní server není v oboru.

function restorePoller<TResponse, TResult>(client: DBforPostgreSQLClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parametry

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

Návraty

PollerLike<OperationState<TResult>, TResult>

Podrobnosti proměnné

RestError

Vlastní typ chyby pro neúspěšné požadavky kanálu.

RestError: RestErrorConstructor

Typ