@azure/arm-postgresqlhsc package

Gränssnitt

AuthConfig

Autentiseringskonfiguration för ett kluster.

Cluster

Representerar ett kluster.

ClusterForUpdate

Representerar ett kluster för uppdatering.

ClusterProperties

Egenskaper för klustret.

ClusterPropertiesForUpdate

Egenskaperna som används för att uppdatera ett kluster.

ClusterServer

Representerar en server i ett kluster.

ClusterServerProperties

Egenskaperna hos en server i kluster.

ClustersCheckNameAvailabilityOptionalParams

Valfria parametrar.

ClustersCreateOptionalParams

Valfria parametrar.

ClustersDeleteOptionalParams

Valfria parametrar.

ClustersGetOptionalParams

Valfria parametrar.

ClustersListByResourceGroupOptionalParams

Valfria parametrar.

ClustersListOptionalParams

Valfria parametrar.

ClustersOperations

Gränssnitt som representerar en klusteråtgärd.

ClustersPromoteReadReplicaOptionalParams

Valfria parametrar.

ClustersRestartOptionalParams

Valfria parametrar.

ClustersStartOptionalParams

Valfria parametrar.

ClustersStopOptionalParams

Valfria parametrar.

ClustersUpdateOptionalParams

Valfria parametrar.

Configuration

Representerar konfigurationsinformation för koordinator och nod.

ConfigurationProperties

Konfigurationens egenskaper.

ConfigurationsGetCoordinatorOptionalParams

Valfria parametrar.

ConfigurationsGetNodeOptionalParams

Valfria parametrar.

ConfigurationsGetOptionalParams

Valfria parametrar.

ConfigurationsListByClusterOptionalParams

Valfria parametrar.

ConfigurationsListByServerOptionalParams

Valfria parametrar.

ConfigurationsOperations

Gränssnitt som representerar konfigurationsoperationer.

ConfigurationsUpdateOnCoordinatorOptionalParams

Valfria parametrar.

ConfigurationsUpdateOnNodeOptionalParams

Valfria parametrar.

DBforPostgreSQLClientOptionalParams

Valfria parametrar för klienten.

DataEncryption

Datakrypteringsegenskaperna för ett kluster.

ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.

ErrorDetail

Felinformationen.

ErrorResponse

Vanligt felsvar för alla Azure Resource Manager API:er för att returnera feldetaljer vid misslyckade operationer.

FirewallRule

Representerar en brandväggsregel för kluster.

FirewallRuleProperties

Egenskaperna hos en klusterbrandvägg regel.

FirewallRulesCreateOrUpdateOptionalParams

Valfria parametrar.

FirewallRulesDeleteOptionalParams

Valfria parametrar.

FirewallRulesGetOptionalParams

Valfria parametrar.

FirewallRulesListByClusterOptionalParams

Valfria parametrar.

FirewallRulesOperations

Gränssnitt som representerar en FirewallRules-åtgärder.

IdentityProperties

Beskriver klustrets identitet.

MaintenanceWindow

Schemalägg inställningar för regelbundna klusteruppdateringar.

NameAvailability

Representerar tillgänglighet för klusternamn.

NameAvailabilityRequest

Begär från klienten för att kontrollera tillgängligheten för klusternamn.

Operation

Information om en REST API-åtgärd som returneras från API:et för resursprovideråtgärder

OperationDisplay

Lokaliserad visningsinformation för en operation.

OperationsListOptionalParams

Valfria parametrar.

OperationsOperations

Gränssnitt som representerar en driftåtgärd.

PageSettings

Alternativ för byPage-metoden

PagedAsyncIterableIterator

Ett gränssnitt som tillåter asynkron iteration både för slutförande och efter sida.

PrivateEndpoint

Den privata slutpunktsresursen.

PrivateEndpointConnection

En privat slutpunktsanslutningsresurs

PrivateEndpointConnectionProperties

Egenskaper för den privata slutpunktsanslutningen.

PrivateEndpointConnectionSimpleProperties

Egenskaperna i privat slutpunktsanslutning

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Valfria parametrar.

PrivateEndpointConnectionsDeleteOptionalParams

Valfria parametrar.

PrivateEndpointConnectionsGetOptionalParams

Valfria parametrar.

PrivateEndpointConnectionsListByClusterOptionalParams

Valfria parametrar.

PrivateEndpointConnectionsOperations

Gränssnitt som representerar en PrivateEndpointConnections-åtgärder.

PrivateEndpointProperty

Egenskap som representerar resurs-ID för den privata slutpunkten.

PrivateLinkResource

En privat länkresurs.

PrivateLinkResourceProperties

Egenskaper för en privat länkresurs.

PrivateLinkResourcesGetOptionalParams

Valfria parametrar.

PrivateLinkResourcesListByClusterOptionalParams

Valfria parametrar.

PrivateLinkResourcesOperations

Gränssnitt som representerar en PrivateLinkResources-åtgärd.

PrivateLinkServiceConnectionState

En samling med information om tillståndet för anslutningen mellan tjänstkonsumenten och leverantören.

PromoteRequest

Begäran från klienten om att främja geo-redundant replik

ProxyResource

Resursmodelldefinitionen för en Azure Resource Manager-proxyresurs. Det kommer inte att ha taggar och en plats

Resource

Vanliga fält som returneras i svaret för alla Azure Resource Manager-resurser

RestorePollerOptions
Role

Representerar en klusterroll.

RoleProperties

Egenskaperna hos en klusterroll.

RolePropertiesExternalIdentity

modellgränssnitt RolePropertiesExternalIdentity

RolesCreateOptionalParams

Valfria parametrar.

RolesDeleteOptionalParams

Valfria parametrar.

RolesGetOptionalParams

Valfria parametrar.

RolesListByClusterOptionalParams

Valfria parametrar.

RolesOperations

Gränssnitt som representerar rolloperationer.

ServerConfiguration

Representerar en konfiguration.

ServerConfigurationProperties

Egenskaperna för en konfiguration.

ServerNameItem

Namnobjektet för en server.

ServerProperties

Serverns egenskaper.

ServerRoleGroupConfiguration

Representerar konfigurationsvärdet för serverrollgrupper.

ServersGetOptionalParams

Valfria parametrar.

ServersListByClusterOptionalParams

Valfria parametrar.

ServersOperations

Gränssnitt som representerar serverns operationer.

SimplePrivateEndpointConnection

En privat slutpunktsanslutning.

SystemData

Metadata som rör skapande och senaste ändring av resursen.

TrackedResource

Resursmodelldefinitionen för en Azure Resource Manager-spårad resurs på den översta nivån som har "taggar" och en "plats"

UserAssignedIdentity

Användartilldelade identitetsegenskaper

Typalias

AadEnabledEnum

Anger om klustret skapades med AAD-autentisering.
KnownAadEnabledEnum kan användas omväxlande med AadEnabledEnum, detta enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

aktiverat
inaktiverad

ActionType

Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er.
KnownActionType- kan användas utbytbart med ActionType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

intern: Åtgärder gäller endast interna API:er.

ActiveDirectoryAuth

Typ av ActiveDirectoryAuth

AzureSupportedClouds

De värden som stöds för molninställningen som en strängliteraltyp

CheckNameAvailabilityResourceType

Resurstyp som används för verifiering av namntillgänglighet.

ConfigurationDataType

Datatyp för konfigurationen.
KnownConfigurationDataType kan användas utbytbart med ConfigurationDataType innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Boolesk
Numeric
Heltal
uppräkning

ContinuablePage

Ett gränssnitt som beskriver en resultatsida.

CreatedByType

Den typ av entitet som skapade resursen.
KnownCreatedByType- kan användas utbytbart med CreateByType innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Användare: Entiteten skapades av en användare.
Application: Entiteten skapades av ett program.
ManagedIdentity: Entiteten skapades av en hanterad identitet.
Nyckel: Entiteten skapades av en nyckel.

DataEncryptionType

Typ av DataKrypteringTyp

IdentityType

Typ av identitetTyp

Origin

Den som ska utföra operationen; såsom i resursbaserad behörighetskontroll (RBAC) och användarupplevelsen för granskningsloggar. Standardvärdet är "user,system"
KnownOrigin- kan användas omväxlande med Origin innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

användare: Anger att åtgärden initieras av en användare.
system: Anger att åtgärden initieras av ett system.
användare, system: Anger att åtgärden initieras av en användare eller ett system.

PasswordAuth

Typ av PasswordAuth

PasswordEnabledEnum

Anger om klustret skapades med ett lösenord eller med hjälp av AAD-autentisering.
KnownPasswordEnabledEnum kan användas omväxlande med PasswordEnabledEnum, detta enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

aktiverat
inaktiverad

PrincipalType

Typ av huvudtyp

PrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.
KnownPrivateEndpointConnectionProvisioningState kan användas utbytbart med PrivateEndpointConnectionProvisioningState innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades: Anslutningen har etablerats
Skapa: Anslutningen skapas
tar bort: Anslutningen tas bort
misslyckades: Anslutningsetablering misslyckades

PrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.
KnownPrivateEndpointServiceConnectionStatus kan användas utbytbart med PrivateEndpointServiceConnectionStatus innehåller det här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

Väntar: Anslutning väntar på godkännande eller avslag
Godkänd: Anslutningsgodkänd
avvisade: Anslutningen avvisades

ProvisioningState

Det aktuella etableringstillståndet.
KnownProvisioningState kan användas omväxlande med ProvisioningState innehåller den här uppräkningen de kända värden som tjänsten stöder.

Kända värden som stöds av tjänsten

lyckades
Avbrutna
InProgress
Misslyckades

RoleType

Typ av rollTyp

ServerRole

Rollen för en server.
KnownServerRole kan användas omväxlande med ServerRole, denna enum innehåller de kända värden som tjänsten stödjer.

Kända värden som stöds av tjänsten

Koordinator
Arbetare

Uppräkningar

AzureClouds

Ett enum för att beskriva Azure Cloud-miljöer.

KnownAadEnabledEnum

Anger om klustret skapades med AAD-autentisering.

KnownActionType

Utökningsbar uppräkning. Anger åtgärdstypen. "Intern" avser åtgärder som endast gäller interna API:er.

KnownActiveDirectoryAuth

Kända värden i ActiveDirectoryAuth som tjänsten accepterar.

KnownConfigurationDataType

Datatyp för konfigurationen.

KnownCreatedByType

Den typ av entitet som skapade resursen.

KnownDataEncryptionType

Kända värden av DataEncryptionType som tjänsten accepterar.

KnownIdentityType

Kända värden för IdentityType- som tjänsten accepterar.

KnownOrigin

Den som ska utföra operationen; såsom i resursbaserad behörighetskontroll (RBAC) och användarupplevelsen för granskningsloggar. Standardvärdet är "user,system"

KnownPasswordAuth

Kända värden för PasswordAuth som tjänsten accepterar.

KnownPasswordEnabledEnum

Anger om klustret skapades med ett lösenord eller med hjälp av AAD-autentisering.

KnownPrincipalType

Kända värden för PrincipalType- som tjänsten accepterar.

KnownPrivateEndpointConnectionProvisioningState

Det aktuella etableringstillståndet.

KnownPrivateEndpointServiceConnectionStatus

Anslutningsstatus för privat slutpunkt.

KnownProvisioningState

Det aktuella etableringstillståndet.

KnownRoleType

Kända värden av RoleType som tjänsten accepterar.

KnownServerRole

Rollen för en server.

KnownVersions

Tillgängliga API-versioner.

Funktioner

isRestError(unknown)

Typeguard för RestError

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

Skapar en avsökare från det serialiserade tillståndet för en annan avsökning. Detta kan vara användbart när du vill skapa avsökare på en annan värd eller om en avsökning måste konstrueras efter att den ursprungliga inte omfattas.

Variabler

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

Funktionsinformation

isRestError(unknown)

Typeguard för RestError

function isRestError(e: unknown): e

Parametrar

e

unknown

Något som fångas av en fångstklausul.

Returer

e

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

Skapar en avsökare från det serialiserade tillståndet för en annan avsökning. Detta kan vara användbart när du vill skapa avsökare på en annan värd eller om en avsökning måste konstrueras efter att den ursprungliga inte omfattas.

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

Parametrar

serializedState

string

sourceOperation

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

Returer

PollerLike<OperationState<TResult>, TResult>

Variabelinformation

RestError

En anpassad feltyp för misslyckade pipelinebegäranden.

RestError: RestErrorConstructor

Typ