@azure/arm-postgresqlhsc package

Schnittstellen

AuthConfig

Authentifizierungskonfiguration eines Clusters.

Cluster

Stellt einen Cluster dar.

ClusterForUpdate

Stellt einen Cluster für die Aktualisierung dar.

ClusterProperties

Eigenschaften des Clusters.

ClusterPropertiesForUpdate

Die Eigenschaften, die zur Aktualisierung eines Clusters verwendet werden.

ClusterServer

Stellt einen Server in einem Cluster dar.

ClusterServerProperties

Die Eigenschaften eines Servers im Cluster.

ClustersCheckNameAvailabilityOptionalParams

Optionale Parameter.

ClustersCreateOptionalParams

Optionale Parameter.

ClustersDeleteOptionalParams

Optionale Parameter.

ClustersGetOptionalParams

Optionale Parameter.

ClustersListByResourceGroupOptionalParams

Optionale Parameter.

ClustersListOptionalParams

Optionale Parameter.

ClustersOperations

Schnittstelle, die einen Cluster-Betrieb darstellt.

ClustersPromoteReadReplicaOptionalParams

Optionale Parameter.

ClustersRestartOptionalParams

Optionale Parameter.

ClustersStartOptionalParams

Optionale Parameter.

ClustersStopOptionalParams

Optionale Parameter.

ClustersUpdateOptionalParams

Optionale Parameter.

Configuration

Stellt Konfigurationsdetails für Koordinator und Knoten dar.

ConfigurationProperties

Die Eigenschaften der Konfiguration.

ConfigurationsGetCoordinatorOptionalParams

Optionale Parameter.

ConfigurationsGetNodeOptionalParams

Optionale Parameter.

ConfigurationsGetOptionalParams

Optionale Parameter.

ConfigurationsListByClusterOptionalParams

Optionale Parameter.

ConfigurationsListByServerOptionalParams

Optionale Parameter.

ConfigurationsOperations

Schnittstelle stellt die Konfigurationsoperationen dar.

ConfigurationsUpdateOnCoordinatorOptionalParams

Optionale Parameter.

ConfigurationsUpdateOnNodeOptionalParams

Optionale Parameter.

DBforPostgreSQLClientOptionalParams

Optionale Parameter für den Client.

DataEncryption

Die Datenverschlüsselungseigenschaften eines Clusters.

ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

ErrorDetail

Die Fehlerdetails.

ErrorResponse

Übliche Fehlerantwort für alle Azure Resource Manager APIs, um Fehlerdetails bei fehlgeschlagenen Operationen zurückzugeben.

FirewallRule

Stellt eine Clusterfirewallregel dar.

FirewallRuleProperties

Die Eigenschaften einer Cluster-Firewall-Regel.

FirewallRulesCreateOrUpdateOptionalParams

Optionale Parameter.

FirewallRulesDeleteOptionalParams

Optionale Parameter.

FirewallRulesGetOptionalParams

Optionale Parameter.

FirewallRulesListByClusterOptionalParams

Optionale Parameter.

FirewallRulesOperations

Schnittstelle, die firewallRules-Vorgänge darstellt.

IdentityProperties

Beschreibt die Identität des Clusters.

MaintenanceWindow

Planen Sie Einstellungen für regelmäßige Clusterupdates.

NameAvailability

Stellt die Verfügbarkeit des Clusternamens dar.

NameAvailabilityRequest

Fordern Sie vom Client die Verfügbarkeit des Clusternamens an.

Operation

Details eines REST-API-Vorgangs, der von der Ressourcenanbieter-Operations-API zurückgegeben wird

OperationDisplay

Lokalisierte Anzeigeinformationen für eine Operation.

OperationsListOptionalParams

Optionale Parameter.

OperationsOperations

Schnittstelle, die eine Operationsoperation darstellt.

PageSettings

Optionen für die byPage-Methode

PagedAsyncIterableIterator

Eine Schnittstelle, die eine asynchrone, iterierbare Iteration sowohl bis zur Fertigstellung als auch nach Seite ermöglicht.

PrivateEndpoint

Die private Endpunktressource.

PrivateEndpointConnection

Eine private Endpunkt-Verbindungsressource

PrivateEndpointConnectionProperties

Eigenschaften der privaten Endpunktverbindung.

PrivateEndpointConnectionSimpleProperties

Die Eigenschaften in der privaten Endpunktverbindung

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsDeleteOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsGetOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsListByClusterOptionalParams

Optionale Parameter.

PrivateEndpointConnectionsOperations

Schnittstelle, die eine PrivateEndpointConnections-Vorgänge darstellt.

PrivateEndpointProperty

Eigenschaft, die die Ressourcen-ID des privaten Endpunkts darstellt.

PrivateLinkResource

Eine private Verknüpfungsressource.

PrivateLinkResourceProperties

Eigenschaften einer privaten Verknüpfungsressource.

PrivateLinkResourcesGetOptionalParams

Optionale Parameter.

PrivateLinkResourcesListByClusterOptionalParams

Optionale Parameter.

PrivateLinkResourcesOperations

Schnittstelle, die einen PrivateLinkResources-Vorgang darstellt.

PrivateLinkServiceConnectionState

Eine Sammlung von Informationen über den Status der Verbindung zwischen Service Consumer und Provider.

PromoteRequest

Anforderung vom Client zum Höherstufen eines georedundanten Replikats

ProxyResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Proxyressource. Es enthält keine Tags und einen Speicherort.

Resource

Allgemeine Felder, die in der Antwort für alle Azure Resource Manager-Ressourcen zurückgegeben werden

RestorePollerOptions
Role

Stellt eine Clusterrolle dar.

RoleProperties

Die Eigenschaften einer Clusterrolle.

RolePropertiesExternalIdentity

Modellschnittstelle RolePropertiesExternalIdentity

RolesCreateOptionalParams

Optionale Parameter.

RolesDeleteOptionalParams

Optionale Parameter.

RolesGetOptionalParams

Optionale Parameter.

RolesListByClusterOptionalParams

Optionale Parameter.

RolesOperations

Schnittstelle stellt die Operationen einer Rolle dar.

ServerConfiguration

Stellt eine Konfiguration dar.

ServerConfigurationProperties

Die Eigenschaften einer Konfiguration.

ServerNameItem

Das Name-Objekt für einen Server.

ServerProperties

Die Eigenschaften eines Servers.

ServerRoleGroupConfiguration

Stellt den Konfigurationswert der Serverrollengruppe dar.

ServersGetOptionalParams

Optionale Parameter.

ServersListByClusterOptionalParams

Optionale Parameter.

ServersOperations

Schnittstelle stellt die Operationen eines Servers dar.

SimplePrivateEndpointConnection

Eine private Endpunktverbindung.

SystemData

Metadaten zur Erstellung und letzten Änderung der Ressource.

TrackedResource

Die Ressourcenmodelldefinition für eine Azure Resource Manager-Ressource auf oberster Ebene mit "Tags" und einem "Speicherort"

UserAssignedIdentity

Benutzer zugewiesene Identitätseigenschaften

Typaliase

AadEnabledEnum

Gibt an, ob der Cluster mithilfe der AAD-Authentifizierung erstellt wurde.
KnownAadEnabledEnum kann austauschbar mit AadEnabledEnum verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

aktiviert
deaktivierte

ActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.
KnownActionType- austauschbar mit ActionType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Interne: Aktionen gelten nur für interne APIs.

ActiveDirectoryAuth

Art von ActiveDirectoryAuth

AzureSupportedClouds

Die unterstützten Werte für die Cloud-Einstellung als Zeichenfolgenliteraltyp

CheckNameAvailabilityResourceType

Ressourcentyp, der für die Überprüfung der Verfügbarkeit von Namen verwendet wird.

ConfigurationDataType

Datentyp der Konfiguration.
KnownConfigurationDataType austauschbar mit ConfigurationDataType verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Boolean
Numeric
Integer
Enumeration

ContinuablePage

Eine Schnittstelle, die eine Seite mit Ergebnissen beschreibt.

CreatedByType

Die Art der Entität, die die Ressource erstellt hat.
KnownCreatedByType kann austauschbar mit CreatedByType verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer: Die Entität wurde von einem Benutzer erstellt.
Anwendung: Die Entität wurde von einer Anwendung erstellt.
ManagedIdentity: Die Entität wurde von einer verwalteten Identität erstellt.
Schlüssel: Die Entität wurde durch einen Schlüssel erstellt.

DataEncryptionType

Art von DatenVerschlüsselungTyp

IdentityType

Art der IdentitätTyp

Origin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"
KnownOrigin austauschbar mit Origin verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Benutzer-: Gibt an, dass der Vorgang von einem Benutzer initiiert wird.
System-: Gibt an, dass der Vorgang von einem System initiiert wird.
Benutzer,System: Gibt an, dass der Vorgang von einem Benutzer oder System initiiert wird.

PasswordAuth

Art von PasswortAuth

PasswordEnabledEnum

Gibt an, ob der Cluster mit einem Kennwort oder mit AAD-Authentifizierung erstellt wurde.
KnownPasswordEnabledEnum kann austauschbar mit PasswordEnabledEnum verwendet werden, dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

aktiviert
deaktivierte

PrincipalType

Typ des Hauptprinzips Typ

PrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.
KnownPrivateEndpointConnectionProvisioningState kann austauschbar mit PrivateEndpointConnectionProvisioningState verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erfolgreich: Die Verbindung wurde bereitgestellt.
Erstellen von: Verbindung wird erstellt
Löschen von: Die Verbindung wird gelöscht.
Fehlgeschlagene: Fehler bei der Verbindungsbereitstellung

PrivateEndpointServiceConnectionStatus

Der Status der privaten Endpunktverbindung.
KnownPrivateEndpointServiceConnectionStatus kann austauschbar mit PrivateEndpointServiceConnectionStatus verwendet werden, diese Enumeration enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Ausstehend: Verbindung wartet auf Genehmigung oder Ablehnung
Genehmigte: Verbindung genehmigt
Abgelehnte: Abgelehnte Verbindung

ProvisioningState

Der aktuelle Bereitstellungsstatus.
KnownProvisioningState austauschbar mit ProvisioningState verwendet werden kann, enthält diese Enumeration die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Erfolgreich
Abgesagt
InProgress
Fehler

RoleType

Rollentyp

ServerRole

Die Rolle eines Servers.
KnownServerRole kann austauschbar mit ServerRole verwendet werden; dieses Enum enthält die bekannten Werte, die der Dienst unterstützt.

Bekannte Werte, die vom Dienst unterstützt werden

Koordinator
Worker

Enumerationen

AzureClouds

Ein Enum zur Beschreibung von Azure Cloud-Umgebungen.

KnownAadEnabledEnum

Gibt an, ob der Cluster mithilfe der AAD-Authentifizierung erstellt wurde.

KnownActionType

Erweiterbare Enumeration. Gibt den Aktionstyp an. "Intern" bezieht sich auf Aktionen, die nur für interne APIs gelten.

KnownActiveDirectoryAuth

Bekannte Werte von ActiveDirectoryAuth , die der Dienst akzeptiert.

KnownConfigurationDataType

Datentyp der Konfiguration.

KnownCreatedByType

Die Art der Entität, die die Ressource erstellt hat.

KnownDataEncryptionType

Bekannte Werte von DataEncryptionType, die der Dienst akzeptiert.

KnownIdentityType

Bekannte Werte von IdentityType, die der Dienst akzeptiert.

KnownOrigin

Der beabsichtigte Ausführungsführer des Vorgangs; wie bei der ressourcenbasierten Zugriffssteuerung (Resource Based Access Control, RBAC) und der UX für Überwachungsprotokolle. Standardwert ist "User,System"

KnownPasswordAuth

Bekannte Werte von PasswordAuth , die der Dienst akzeptiert.

KnownPasswordEnabledEnum

Gibt an, ob der Cluster mit einem Kennwort oder mit AAD-Authentifizierung erstellt wurde.

KnownPrincipalType

Bekannte Werte von PrincipalType, die der Dienst akzeptiert.

KnownPrivateEndpointConnectionProvisioningState

Der aktuelle Bereitstellungsstatus.

KnownPrivateEndpointServiceConnectionStatus

Der Status der privaten Endpunktverbindung.

KnownProvisioningState

Der aktuelle Bereitstellungsstatus.

KnownRoleType

Bekannte Werte von RoleType, die der Dienst akzeptiert.

KnownServerRole

Die Rolle eines Servers.

KnownVersions

Die verfügbaren API-Versionen.

Functions

isRestError(unknown)

Typeguard für RestError

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Poller auf einem anderen Host erstellen möchten oder wenn ein Poller erstellt werden muss, nachdem der ursprüngliche Poller nicht im Gültigkeitsbereich ist.

Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

Details zur Funktion

isRestError(unknown)

Typeguard für RestError

function isRestError(e: unknown): e

Parameter

e

unknown

Etwas, das von einer Catch-Klausel abgefangen wird.

Gibt zurück

e

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

Erstellt einen Poller aus dem serialisierten Zustand eines anderen Pollers. Dies kann nützlich sein, wenn Sie Poller auf einem anderen Host erstellen möchten oder wenn ein Poller erstellt werden muss, nachdem der ursprüngliche Poller nicht im Gültigkeitsbereich ist.

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

Parameter

serializedState

string

sourceOperation

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

Gibt zurück

PollerLike<OperationState<TResult>, TResult>

Details zu Variablen

RestError

Ein benutzerdefinierter Fehlertyp für fehlgeschlagene Pipelineanforderungen.

RestError: RestErrorConstructor

Typ