@azure/arm-postgresqlhsc package

Interfaces

AuthConfig

Verificatieconfiguratie van een cluster.

Cluster

Vertegenwoordigt een cluster.

ClusterForUpdate

Vertegenwoordigt een cluster voor update.

ClusterProperties

Eigenschappen van het cluster.

ClusterPropertiesForUpdate

De eigenschappen die worden gebruikt om een cluster bij te werken.

ClusterServer

Vertegenwoordigt een server in een cluster.

ClusterServerProperties

De eigenschappen van een server in cluster.

ClustersCheckNameAvailabilityOptionalParams

Optionele parameters.

ClustersCreateOptionalParams

Optionele parameters.

ClustersDeleteOptionalParams

Optionele parameters.

ClustersGetOptionalParams

Optionele parameters.

ClustersListByResourceGroupOptionalParams

Optionele parameters.

ClustersListOptionalParams

Optionele parameters.

ClustersOperations

Interface die een Clusters-bewerkingen vertegenwoordigt.

ClustersPromoteReadReplicaOptionalParams

Optionele parameters.

ClustersRestartOptionalParams

Optionele parameters.

ClustersStartOptionalParams

Optionele parameters.

ClustersStopOptionalParams

Optionele parameters.

ClustersUpdateOptionalParams

Optionele parameters.

Configuration

Vertegenwoordigt configuratiedetails voor coördinator en knooppunt.

ConfigurationProperties

De eigenschappen van configuratie.

ConfigurationsGetCoordinatorOptionalParams

Optionele parameters.

ConfigurationsGetNodeOptionalParams

Optionele parameters.

ConfigurationsGetOptionalParams

Optionele parameters.

ConfigurationsListByClusterOptionalParams

Optionele parameters.

ConfigurationsListByServerOptionalParams

Optionele parameters.

ConfigurationsOperations

Interface die de configuratiebewerkingen vertegenwoordigt.

ConfigurationsUpdateOnCoordinatorOptionalParams

Optionele parameters.

ConfigurationsUpdateOnNodeOptionalParams

Optionele parameters.

DBforPostgreSQLClientOptionalParams

Optionele parameters voor de client.

DataEncryption

De eigenschappen van gegevensversleuteling van een cluster.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

ErrorDetail

Het foutdetail.

ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen.

FirewallRule

Vertegenwoordigt een clusterfirewallregel.

FirewallRuleProperties

De eigenschappen van een clusterfirewall regelen.

FirewallRulesCreateOrUpdateOptionalParams

Optionele parameters.

FirewallRulesDeleteOptionalParams

Optionele parameters.

FirewallRulesGetOptionalParams

Optionele parameters.

FirewallRulesListByClusterOptionalParams

Optionele parameters.

FirewallRulesOperations

Interface die een FirewallRules-bewerking vertegenwoordigt.

IdentityProperties

Beschrijft de identiteit van het cluster.

MaintenanceWindow

Planningsinstellingen voor normale clusterupdates.

NameAvailability

Vertegenwoordigt de beschikbaarheid van de clusternaam.

NameAvailabilityRequest

Aanvraag van de client om de beschikbaarheid van de clusternaam te controleren.

Operation

Details van een REST API-bewerking, geretourneerd door de Resource Provider Operations-API

OperationDisplay

Gelokaliseerde weergave-informatie voor een operatie.

OperationsListOptionalParams

Optionele parameters.

OperationsOperations

Interface die een Operations-bewerkingen vertegenwoordigt.

PageSettings

Opties voor de byPage-methode

PagedAsyncIterableIterator

Een interface die asynchrone iteratieve iteratie mogelijk maakt, zowel tot voltooiing als per pagina.

PrivateEndpoint

De privé-eindpuntresource.

PrivateEndpointConnection

Een privé-eindpuntverbinding resource

PrivateEndpointConnectionProperties

Eigenschappen van de privé-eindpuntverbinding.

PrivateEndpointConnectionSimpleProperties

De eigenschappen in de private endpoint-verbinding

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Optionele parameters.

PrivateEndpointConnectionsDeleteOptionalParams

Optionele parameters.

PrivateEndpointConnectionsGetOptionalParams

Optionele parameters.

PrivateEndpointConnectionsListByClusterOptionalParams

Optionele parameters.

PrivateEndpointConnectionsOperations

Interface die een PrivateEndpointConnections-bewerking vertegenwoordigt.

PrivateEndpointProperty

Eigenschap die de resource-id van het privé-eindpunt vertegenwoordigt.

PrivateLinkResource

Een private link-resource.

PrivateLinkResourceProperties

Eigenschappen van een private link-resource.

PrivateLinkResourcesGetOptionalParams

Optionele parameters.

PrivateLinkResourcesListByClusterOptionalParams

Optionele parameters.

PrivateLinkResourcesOperations

Interface die een PrivateLinkResources-bewerking vertegenwoordigt.

PrivateLinkServiceConnectionState

Een verzameling informatie over de status van de verbinding tussen serviceconsumer en provider.

PromoteRequest

Aanvraag van client om geo-redundante replica te promoten

ProxyResource

De definitie van het resourcemodel voor een Azure Resource Manager-proxyresource. Het heeft geen tags en een locatie

Resource

Algemene velden die worden geretourneerd in het antwoord voor alle Azure Resource Manager-resources

RestorePollerOptions
Role

Vertegenwoordigt een clusterrol.

RoleProperties

De eigenschappen van een clusterrol.

RolePropertiesExternalIdentity

modelinterface RolePropertiesExternalIdentity

RolesCreateOptionalParams

Optionele parameters.

RolesDeleteOptionalParams

Optionele parameters.

RolesGetOptionalParams

Optionele parameters.

RolesListByClusterOptionalParams

Optionele parameters.

RolesOperations

Interface die een Role-operatie vertegenwoordigt.

ServerConfiguration

Vertegenwoordigt een configuratie.

ServerConfigurationProperties

De eigenschappen van een configuratie.

ServerNameItem

Het naamobject voor een server.

ServerProperties

De eigenschappen van een server.

ServerRoleGroupConfiguration

Vertegenwoordigt de configuratiewaarde van de serverfunctiegroep.

ServersGetOptionalParams

Optionele parameters.

ServersListByClusterOptionalParams

Optionele parameters.

ServersOperations

Interface die de operaties van een server vertegenwoordigt.

SimplePrivateEndpointConnection

Een privé-eindpuntverbinding.

SystemData

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

TrackedResource

De definitie van het resourcemodel voor een azure Resource Manager heeft een resource op het hoogste niveau bijgehouden met tags en een locatie

UserAssignedIdentity

Door de gebruiker toegewezen identiteitseigenschappen

Type-aliassen

AadEnabledEnum

Geeft aan of het cluster is gemaakt met behulp van AAD-verificatie.
KnownAadEnabledEnum kan door elkaar worden gebruikt met AadEnabledEnum; dit enum bevat de bekende waarden die de dienst ondersteunt.

Bekende waarden die door de service worden ondersteund

ingeschakeld
uitgeschakeld

ActionType

Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.
KnownActionType kan door elkaar worden gebruikt met ActionType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Interne: Acties zijn voor interne API's.

ActiveDirectoryAuth

Type of ActiveDirectoryAuth

AzureSupportedClouds

De ondersteunde waarden voor cloudinstelling als een letterlijk tekenreekstype

CheckNameAvailabilityResourceType

Het resourcetype dat wordt gebruikt voor de verificatie van de beschikbaarheid van namen.

ConfigurationDataType

Gegevenstype van de configuratie.
KnownConfigurationDataType kan door elkaar worden gebruikt met ConfigurationDataType, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Boolean
Numeric
geheel getal
opsomming

ContinuablePage

Een interface die een pagina met resultaten beschrijft.

CreatedByType

Het type entiteit dat de resource heeft gemaakt.
KnownCreatedByType kan door elkaar worden gebruikt met CreatedByType, bevat deze enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

Gebruiker: De entiteit is gemaakt door een gebruiker.
Toepassing: de entiteit is gemaakt door een toepassing.
ManagedIdentity: de entiteit is gemaakt door een beheerde identiteit.
Sleutel: De entiteit is gemaakt door een sleutel.

DataEncryptionType

Type van DataEncryptionType

IdentityType

Type IdentiteitType

Origin

De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'
KnownOrigin- kan door elkaar worden gebruikt met Origin, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

gebruiker: geeft aan dat de bewerking door een gebruiker wordt gestart.
systeem: Geeft aan dat de bewerking door een systeem wordt gestart.
gebruiker, systeem: Geeft aan dat de bewerking wordt gestart door een gebruiker of systeem.

PasswordAuth

Type of PasswordAuth

PasswordEnabledEnum

Geeft aan of het cluster is gemaakt met een wachtwoord of met behulp van AAD-verificatie.
KnownPasswordEnabledEnum kan door elkaar worden gebruikt met PasswordEnabledEnum; dit enum bevat de bekende waarden die de dienst ondersteunt.

Bekende waarden die door de service worden ondersteund

ingeschakeld
uitgeschakeld

PrincipalType

Type of PrincipalType

PrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.
KnownPrivateEndpointConnectionProvisioningState kan door elkaar worden gebruikt met PrivateEndpointConnectionProvisioningState, bevat dit enum de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

geslaagde: verbinding is ingericht
Maken van: Er wordt een verbinding gemaakt
verwijderen: verbinding wordt verwijderd
mislukte: het inrichten van verbindingen is mislukt

PrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.
KnownPrivateEndpointServiceConnectionStatus kan door elkaar worden gebruikt met PrivateEndpointServiceConnectionStatus, bevat dit enum de bekende waarden die door de service worden ondersteund.

Bekende waarden die door de service worden ondersteund

In behandeling: Verbinding in afwachting van goedkeuring of afwijzing
Goedgekeurd: Verbinding goedgekeurd
geweigerde: verbinding geweigerd

ProvisioningState

De huidige inrichtingsstatus.
KnownProvisioningState kan door elkaar worden gebruikt met ProvisioningState, bevat deze opsomming de bekende waarden die de service ondersteunt.

Bekende waarden die door de service worden ondersteund

Geslaagd
Geannuleerd
In uitvoering
Mislukt

RoleType

Type RolType

ServerRole

De rol van een server.
KnownServerRole kan uitwisselbaar worden gebruikt met ServerRole; deze enum bevat de bekende waarden die de dienst ondersteunt.

Bekende waarden die door de service worden ondersteund

Coördinator
Werknemer

Enums

AzureClouds

Een enum om Azure Cloud-omgevingen te beschrijven.

KnownAadEnabledEnum

Geeft aan of het cluster is gemaakt met behulp van AAD-verificatie.

KnownActionType

Uitbreidbare opsomming. Geeft het actietype aan. 'Intern' verwijst naar acties die alleen voor interne API's zijn.

KnownActiveDirectoryAuth

Bekende waarden van ActiveDirectoryAuth die de service accepteert.

KnownConfigurationDataType

Gegevenstype van de configuratie.

KnownCreatedByType

Het type entiteit dat de resource heeft gemaakt.

KnownDataEncryptionType

Bekende waarden van DataEncryptionType die de service accepteert.

KnownIdentityType

Bekende waarden van IdentityType die de service accepteert.

KnownOrigin

De beoogde uitvoerder van de bewerking; zoals in RBAC (Resource Based Access Control) en auditlogboeken UX. De standaardwaarde is 'gebruiker,systeem'

KnownPasswordAuth

Bekende waarden van PasswordAuth die de dienst accepteert.

KnownPasswordEnabledEnum

Geeft aan of het cluster is gemaakt met een wachtwoord of met behulp van AAD-verificatie.

KnownPrincipalType

Bekende waarden van PrincipalType die de service accepteert.

KnownPrivateEndpointConnectionProvisioningState

De huidige inrichtingsstatus.

KnownPrivateEndpointServiceConnectionStatus

De verbindingsstatus van het privé-eindpunt.

KnownProvisioningState

De huidige inrichtingsstatus.

KnownRoleType

Bekende waarden van RoleType die de service accepteert.

KnownServerRole

De rol van een server.

KnownVersions

De beschikbare API-versies.

Functies

isRestError(unknown)

Typeguard voor RestError

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

Hiermee maakt u een opiniepeiler op basis van de geserialiseerde status van een andere opiniepeiler. Dit kan handig zijn wanneer u pollers op een andere host wilt maken of wanneer een poller moet worden geconstrueerd nadat de oorspronkelijke niet binnen het bereik valt.

Variabelen

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

Functiedetails

isRestError(unknown)

Typeguard voor RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Iets betrapt door een catch-component.

Retouren

e

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

Hiermee maakt u een opiniepeiler op basis van de geserialiseerde status van een andere opiniepeiler. Dit kan handig zijn wanneer u pollers op een andere host wilt maken of wanneer een poller moet worden geconstrueerd nadat de oorspronkelijke niet binnen het bereik valt.

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

Parameters

serializedState

string

sourceOperation

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

Retouren

PollerLike<OperationState<TResult>, TResult>

Variabele details

RestError

Een aangepast fouttype voor mislukte pijplijnaanvragen.

RestError: RestErrorConstructor

Type