@azure/arm-postgresqlhsc package

Interfaces

AuthConfig

Configuration de l’authentification d’un cluster.

Cluster

Représente un cluster.

ClusterForUpdate

Représente un cluster pour la mise à jour.

ClusterProperties

Propriétés du cluster.

ClusterPropertiesForUpdate

Les propriétés utilisées pour mettre à jour un cluster.

ClusterServer

Représente un serveur dans un cluster.

ClusterServerProperties

Les propriétés d’un serveur dans un cluster.

ClustersCheckNameAvailabilityOptionalParams

Paramètres facultatifs.

ClustersCreateOptionalParams

Paramètres facultatifs.

ClustersDeleteOptionalParams

Paramètres facultatifs.

ClustersGetOptionalParams

Paramètres facultatifs.

ClustersListByResourceGroupOptionalParams

Paramètres facultatifs.

ClustersListOptionalParams

Paramètres facultatifs.

ClustersOperations

Interface représentant une opération Clusters.

ClustersPromoteReadReplicaOptionalParams

Paramètres facultatifs.

ClustersRestartOptionalParams

Paramètres facultatifs.

ClustersStartOptionalParams

Paramètres facultatifs.

ClustersStopOptionalParams

Paramètres facultatifs.

ClustersUpdateOptionalParams

Paramètres facultatifs.

Configuration

Représente les détails de configuration du coordinateur et du nœud.

ConfigurationProperties

Les propriétés de la configuration.

ConfigurationsGetCoordinatorOptionalParams

Paramètres facultatifs.

ConfigurationsGetNodeOptionalParams

Paramètres facultatifs.

ConfigurationsGetOptionalParams

Paramètres facultatifs.

ConfigurationsListByClusterOptionalParams

Paramètres facultatifs.

ConfigurationsListByServerOptionalParams

Paramètres facultatifs.

ConfigurationsOperations

Interface représentant une opération de configuration.

ConfigurationsUpdateOnCoordinatorOptionalParams

Paramètres facultatifs.

ConfigurationsUpdateOnNodeOptionalParams

Paramètres facultatifs.

DBforPostgreSQLClientOptionalParams

Paramètres facultatifs pour le client.

DataEncryption

Propriétés de chiffrement des données d’un cluster.

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées.

FirewallRule

Représente une règle de pare-feu de cluster.

FirewallRuleProperties

Les propriétés d’une règle de pare-feu de cluster.

FirewallRulesCreateOrUpdateOptionalParams

Paramètres facultatifs.

FirewallRulesDeleteOptionalParams

Paramètres facultatifs.

FirewallRulesGetOptionalParams

Paramètres facultatifs.

FirewallRulesListByClusterOptionalParams

Paramètres facultatifs.

FirewallRulesOperations

Interface représentant des opérations FirewallRules.

IdentityProperties

Décrit l’identité du cluster.

MaintenanceWindow

Planifiez les paramètres des mises à jour régulières du cluster.

NameAvailability

Représente la disponibilité du nom du cluster.

NameAvailabilityRequest

Demander au client de vérifier la disponibilité du nom du cluster.

Operation

Détails d’une opération d’API REST, retournée par l’API d’opérations du fournisseur de ressources

OperationDisplay

Informations d’affichage localisées pour une opération.

OperationsListOptionalParams

Paramètres facultatifs.

OperationsOperations

Interface représentant une opération d’opérations.

PageSettings

Options de la méthode byPage

PagedAsyncIterableIterator

Interface qui permet une itération itérable asynchrone à la fois à l’achèvement et à la page.

PrivateEndpoint

Ressource de point de terminaison privé.

PrivateEndpointConnection

Une ressource de connexion privée pour un point de terminaison

PrivateEndpointConnectionProperties

Propriétés de la connexion de point de terminaison privé.

PrivateEndpointConnectionSimpleProperties

Les propriétés dans la connexion privée des points de terminaison

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsDeleteOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsGetOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsListByClusterOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsOperations

Interface représentant des opérations PrivateEndpointConnections.

PrivateEndpointProperty

Propriété qui représente l’ID de ressource du point de terminaison privé.

PrivateLinkResource

Ressource de liaison privée.

PrivateLinkResourceProperties

Propriétés d’une ressource de liaison privée.

PrivateLinkResourcesGetOptionalParams

Paramètres facultatifs.

PrivateLinkResourcesListByClusterOptionalParams

Paramètres facultatifs.

PrivateLinkResourcesOperations

Interface représentant une opération PrivateLinkResources.

PrivateLinkServiceConnectionState

Collection d’informations sur l’état de la connexion entre le consommateur de services et le fournisseur.

PromoteRequest

Demander au client de promouvoir le réplica géoredondant

ProxyResource

Définition du modèle de ressource pour une ressource proxy Azure Resource Manager. Il n’aura pas de balises et un emplacement

Resource

Champs courants retournés dans la réponse pour toutes les ressources Azure Resource Manager

RestorePollerOptions
Role

Représente un rôle de cluster.

RoleProperties

Les propriétés d’un rôle en cluster.

RolePropertiesExternalIdentity

interface de modèle RôlePropriétésIdentité externe

RolesCreateOptionalParams

Paramètres facultatifs.

RolesDeleteOptionalParams

Paramètres facultatifs.

RolesGetOptionalParams

Paramètres facultatifs.

RolesListByClusterOptionalParams

Paramètres facultatifs.

RolesOperations

Interface représentant une opération de rôles.

ServerConfiguration

Représente une configuration.

ServerConfigurationProperties

Propriétés d’une configuration.

ServerNameItem

Objet name pour un serveur.

ServerProperties

Les propriétés d’un serveur.

ServerRoleGroupConfiguration

Représente la valeur de configuration du groupe de rôles serveur.

ServersGetOptionalParams

Paramètres facultatifs.

ServersListByClusterOptionalParams

Paramètres facultatifs.

ServersOperations

Interface représentant les opérations d’un serveur.

SimplePrivateEndpointConnection

Connexion de point de terminaison privé.

SystemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

TrackedResource

Définition du modèle de ressource pour une ressource de niveau supérieur suivi d’Azure Resource Manager qui a des « balises » et un « emplacement »

UserAssignedIdentity

Propriétés d’identité attribuées par l’utilisateur

Alias de type

AadEnabledEnum

Indique si le cluster a été créé à l’aide de l’authentification AAD.
KnownAadEnabledEnum peut être utilisé de manière interchangeable avec AadEnabledEnum, ce enum contenant les valeurs connues que le service supporte.

Valeurs connues prises en charge par le service

activé
désactivé

ActionType

Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.
KnownActionType peut être utilisé de manière interchangeable avec ActionType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

interne : les actions sont destinées aux API internes uniquement.

ActiveDirectoryAuth

Type d’ActiveDirectoryAuth

AzureSupportedClouds

Valeurs prises en charge pour le paramètre cloud en tant que type littéral de chaîne

CheckNameAvailabilityResourceType

Type de ressource utilisé pour la vérification de la disponibilité du nom.

ConfigurationDataType

Type de données de la configuration.
KnownConfigurationDataType peut être utilisé de manière interchangeable avec ConfigurationDataType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Booléen
Numeric
Integer
Énumération

ContinuablePage

Interface qui décrit une page de résultats.

CreatedByType

Type d’entité qui a créé la ressource.
KnownCreatedByType peut être utilisé de manière interchangeable avec CreatedByType, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

'utilisateur: l’entité a été créée par un utilisateur.
Application: l’entité a été créée par une application.
ManagedIdentity: l’entité a été créée par une identité managée.
Key: l’entité a été créée par une clé.

DataEncryptionType

Type de DataEncryptionType

IdentityType

Type d’identité

Origin

Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système »
KnownOrigin peut être utilisé de manière interchangeable avec Origin, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

'utilisateur: indique que l’opération est lancée par un utilisateur.
système: indique que l’opération est lancée par un système.
utilisateur,système: indique que l’opération est lancée par un utilisateur ou un système.

PasswordAuth

Type de PasswordAuth

PasswordEnabledEnum

Indique si le cluster a été créé avec un mot de passe ou à l’aide de l’authentification AAD.
KnownPasswordEnabledEnum peut être utilisé de manière interchangeable avec PasswordEnabledEnum, ce enum contient les valeurs connues prises en charge par le service.

Valeurs connues prises en charge par le service

activé
désactivé

PrincipalType

Type de PrincipalType

PrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.
KnownPrivateEndpointConnectionProvisioningState peut être utilisé de manière interchangeable avec PrivateEndpointConnectionProvisioningState, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

réussi: la connexion a été provisionnée
Création de: la connexion est en cours de création
suppression de: la connexion est supprimée
échec: le provisionnement de connexions a échoué

PrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.
KnownPrivateEndpointServiceConnectionStatus peut être utilisé de manière interchangeable avec PrivateEndpointServiceConnectionStatus, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

En attente : Connexion en attente d’approbation ou de rejet
approuvé : connexion approuvée
rejeté : connexion rejetée

ProvisioningState

État d’approvisionnement actuel.
KnownProvisioningState peut être utilisé de manière interchangeable avec ProvisioningState, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

Réussi
Annulé
InProgress
Échoué

RoleType

Type de rôleType

ServerRole

Rôle d’un serveur.
KnownServerRole peut être utilisé de manière interchangeable avec ServerRole, cet enum contient les valeurs connues que le service supporte.

Valeurs connues prises en charge par le service

Coordinateur
Collaborateur

Énumérations

AzureClouds

Un enum pour décrire les environnements Azure Cloud.

KnownAadEnabledEnum

Indique si le cluster a été créé à l’aide de l’authentification AAD.

KnownActionType

Énumération extensible. Indique le type d’action. « Interne » fait référence aux actions destinées aux API internes uniquement.

KnownActiveDirectoryAuth

Valeurs connues d’ActiveDirectoryAuth que le service accepte.

KnownConfigurationDataType

Type de données de la configuration.

KnownCreatedByType

Type d’entité qui a créé la ressource.

KnownDataEncryptionType

Valeurs connues de DataEncryptionType que le service accepte.

KnownIdentityType

Valeurs connues de IdentityType que le service accepte.

KnownOrigin

Exécuteur prévu de l’opération ; comme dans le contrôle d’accès en fonction des ressources (RBAC) et l’expérience utilisateur des journaux d’audit. La valeur par défaut est « utilisateur, système »

KnownPasswordAuth

Valeurs connues de PasswordAuth que le service accepte.

KnownPasswordEnabledEnum

Indique si le cluster a été créé avec un mot de passe ou à l’aide de l’authentification AAD.

KnownPrincipalType

Valeurs connues de PrincipalType que le service accepte.

KnownPrivateEndpointConnectionProvisioningState

État d’approvisionnement actuel.

KnownPrivateEndpointServiceConnectionStatus

État de la connexion de point de terminaison privé.

KnownProvisioningState

État d’approvisionnement actuel.

KnownRoleType

Valeurs connues du type de rôle que le service accepte.

KnownServerRole

Rôle d’un serveur.

KnownVersions

Versions d’API disponibles.

Functions

isRestError(unknown)

Typeguard pour RestError

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

Crée un collecteur à partir de l’état sérialisé d’un autre collecteur. Cela peut être utile lorsque vous souhaitez créer des collecteurs sur un autre hôte ou qu’un collecteur doit être construit après que l’analyseur d’origine n’est pas dans l’étendue.

Variables

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

Informations relatives à la fonction

isRestError(unknown)

Typeguard pour RestError

function isRestError(e: unknown): e

Paramètres

e

unknown

Quelque chose d’intercepté par une clause catch.

Retours

e

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

Crée un collecteur à partir de l’état sérialisé d’un autre collecteur. Cela peut être utile lorsque vous souhaitez créer des collecteurs sur un autre hôte ou qu’un collecteur doit être construit après que l’analyseur d’origine n’est pas dans l’étendue.

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

Paramètres

serializedState

string

sourceOperation

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

Retours

PollerLike<OperationState<TResult>, TResult>

Détails de variable

RestError

Type d’erreur personnalisé pour les demandes de pipeline ayant échoué.

RestError: RestErrorConstructor

Type