Partager via


@azure/arm-cosmosdbforpostgresql package

Classes

CosmosDBForPostgreSQL

Interfaces

Cluster

Représente un cluster.

ClusterConfigurationListResult

Liste des configurations de cluster.

ClusterForUpdate

Représente un cluster pour la mise à jour.

ClusterListResult

Liste des clusters.

ClusterServer

Représente un serveur dans un cluster.

ClusterServerListResult

Liste des serveurs d’un cluster.

ClusterServerProperties

Propriétés d’un serveur dans le cluster.

Clusters

Interface représentant un cluster.

ClustersCheckNameAvailabilityOptionalParams

Paramètres facultatifs.

ClustersCreateHeaders

Définit des en-têtes pour l’opération Clusters_create.

ClustersCreateOptionalParams

Paramètres facultatifs.

ClustersDeleteHeaders

Définit des en-têtes pour l’opération de Clusters_delete.

ClustersDeleteOptionalParams

Paramètres facultatifs.

ClustersGetOptionalParams

Paramètres facultatifs.

ClustersListByResourceGroupNextOptionalParams

Paramètres facultatifs.

ClustersListByResourceGroupOptionalParams

Paramètres facultatifs.

ClustersListNextOptionalParams

Paramètres facultatifs.

ClustersListOptionalParams

Paramètres facultatifs.

ClustersPromoteReadReplicaHeaders

Définit des en-têtes pour l’opération Clusters_promoteReadReplica.

ClustersPromoteReadReplicaOptionalParams

Paramètres facultatifs.

ClustersRestartHeaders

Définit des en-têtes pour l’opération de Clusters_restart.

ClustersRestartOptionalParams

Paramètres facultatifs.

ClustersStartHeaders

Définit des en-têtes pour l’opération de Clusters_start.

ClustersStartOptionalParams

Paramètres facultatifs.

ClustersStopHeaders

Définit des en-têtes pour l’opération de Clusters_stop.

ClustersStopOptionalParams

Paramètres facultatifs.

ClustersUpdateHeaders

Définit des en-têtes pour l’opération de Clusters_update.

ClustersUpdateOptionalParams

Paramètres facultatifs.

Configuration

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

Configurations

Interface représentant une configuration.

ConfigurationsGetCoordinatorOptionalParams

Paramètres facultatifs.

ConfigurationsGetNodeOptionalParams

Paramètres facultatifs.

ConfigurationsGetOptionalParams

Paramètres facultatifs.

ConfigurationsListByClusterNextOptionalParams

Paramètres facultatifs.

ConfigurationsListByClusterOptionalParams

Paramètres facultatifs.

ConfigurationsListByServerNextOptionalParams

Paramètres facultatifs.

ConfigurationsListByServerOptionalParams

Paramètres facultatifs.

ConfigurationsUpdateOnCoordinatorHeaders

Définit des en-têtes pour l’opération de Configurations_updateOnCoordinator.

ConfigurationsUpdateOnCoordinatorOptionalParams

Paramètres facultatifs.

ConfigurationsUpdateOnNodeHeaders

Définit des en-têtes pour l’opération de Configurations_updateOnNode.

ConfigurationsUpdateOnNodeOptionalParams

Paramètres facultatifs.

CosmosDBForPostgreSQLOptionalParams

Paramètres facultatifs.

ErrorAdditionalInfo

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

ErrorDetail

Détail de l’erreur.

ErrorResponse

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

FirewallRule

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

FirewallRuleListResult

Liste des règles de pare-feu.

FirewallRules

Interface représentant un FirewallRules.

FirewallRulesCreateOrUpdateHeaders

Définit des en-têtes pour l’opération de FirewallRules_createOrUpdate.

FirewallRulesCreateOrUpdateOptionalParams

Paramètres facultatifs.

FirewallRulesDeleteHeaders

Définit des en-têtes pour l’opération de FirewallRules_delete.

FirewallRulesDeleteOptionalParams

Paramètres facultatifs.

FirewallRulesGetOptionalParams

Paramètres facultatifs.

FirewallRulesListByClusterOptionalParams

Paramètres facultatifs.

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éfinition de l’opération d’API REST.

OperationDisplay

Afficher les métadonnées associées à l’opération.

OperationListResult

Liste des opérations du fournisseur de ressources.

Operations

Interface représentant une opération.

OperationsListOptionalParams

Paramètres facultatifs.

PrivateEndpoint

Ressource de point de terminaison privé.

PrivateEndpointConnection

Ressource de connexion de point de terminaison privé.

PrivateEndpointConnectionListResult

Liste des connexions de point de terminaison privé associées à la ressource spécifiée.

PrivateEndpointConnections

Interface représentant un PrivateEndpointConnections.

PrivateEndpointConnectionsCreateOrUpdateHeaders

Définit des en-têtes pour l’opération de PrivateEndpointConnections_createOrUpdate.

PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsDeleteHeaders

Définit des en-têtes pour l’opération PrivateEndpointConnections_delete.

PrivateEndpointConnectionsDeleteOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsGetOptionalParams

Paramètres facultatifs.

PrivateEndpointConnectionsListByClusterOptionalParams

Paramètres facultatifs.

PrivateEndpointProperty

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

PrivateLinkResource

Ressource de liaison privée.

PrivateLinkResourceListResult

Liste des ressources de liaison privée.

PrivateLinkResources

Interface représentant un PrivateLinkResources.

PrivateLinkResourcesGetOptionalParams

Paramètres facultatifs.

PrivateLinkResourcesListByClusterOptionalParams

Paramètres facultatifs.

PrivateLinkServiceConnectionState

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

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

Role

Représente un rôle de cluster.

RoleListResult

Liste des rôles.

Roles

Interface représentant un rôle.

RolesCreateHeaders

Définit des en-têtes pour l’opération Roles_create.

RolesCreateOptionalParams

Paramètres facultatifs.

RolesDeleteHeaders

Définit des en-têtes pour l’opération Roles_delete.

RolesDeleteOptionalParams

Paramètres facultatifs.

RolesGetOptionalParams

Paramètres facultatifs.

RolesListByClusterOptionalParams

Paramètres facultatifs.

ServerConfiguration

Représente une configuration.

ServerConfigurationListResult

Liste des configurations de serveur.

ServerNameItem

Objet name pour un serveur.

ServerProperties

Propriétés d’un serveur.

ServerRoleGroupConfiguration

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

Servers

Interface représentant un serveur.

ServersGetOptionalParams

Paramètres facultatifs.

ServersListByClusterOptionalParams

Paramètres facultatifs.

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 »

Alias de type

ClustersCheckNameAvailabilityResponse

Contient des données de réponse pour l’opération checkNameAvailability.

ClustersCreateResponse

Contient des données de réponse pour l’opération de création.

ClustersGetResponse

Contient des données de réponse pour l’opération d’obtention.

ClustersListByResourceGroupNextResponse

Contient des données de réponse pour l’opération listByResourceGroupNext.

ClustersListByResourceGroupResponse

Contient des données de réponse pour l’opération listByResourceGroup.

ClustersListNextResponse

Contient des données de réponse pour l’opération listNext.

ClustersListResponse

Contient des données de réponse pour l’opération de liste.

ClustersPromoteReadReplicaResponse

Contient des données de réponse pour l’opération promoteReadReplica.

ClustersRestartResponse

Contient des données de réponse pour l’opération de redémarrage.

ClustersUpdateResponse

Contient des données de réponse pour l’opération de mise à jour.

ConfigurationDataType

Définit des valeurs pour ConfigurationDataType.
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
numérique
entier
énumération

ConfigurationsGetCoordinatorResponse

Contient des données de réponse pour l’opération getCoordinator.

ConfigurationsGetNodeResponse

Contient des données de réponse pour l’opération getNode.

ConfigurationsGetResponse

Contient des données de réponse pour l’opération d’obtention.

ConfigurationsListByClusterNextResponse

Contient des données de réponse pour l’opération listByClusterNext.

ConfigurationsListByClusterResponse

Contient des données de réponse pour l’opération listByCluster.

ConfigurationsListByServerNextResponse

Contient des données de réponse pour l’opération listByServerNext.

ConfigurationsListByServerResponse

Contient des données de réponse pour l’opération listByServer.

ConfigurationsUpdateOnCoordinatorResponse

Contient des données de réponse pour l’opération updateOnCoordinator.

ConfigurationsUpdateOnNodeResponse

Contient des données de réponse pour l’opération updateOnNode.

CreatedByType

Définit des valeurs pour CreatedByType.
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
application
managedIdentity
clé

FirewallRulesCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

FirewallRulesDeleteResponse

Contient des données de réponse pour l’opération de suppression.

FirewallRulesGetResponse

Contient des données de réponse pour l’opération d’obtention.

FirewallRulesListByClusterResponse

Contient des données de réponse pour l’opération listByCluster.

OperationOrigin

Définit des valeurs pour OperationOrigin.
KnownOperationOrigin peut être utilisé de manière interchangeable avec OperationOrigin, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

NotSpecified
utilisateur
système

OperationsListResponse

Contient des données de réponse pour l’opération de liste.

PrivateEndpointConnectionProvisioningState

Définit des valeurs pour PrivateEndpointConnectionProvisioningState.
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
création d'
suppression de
échec

PrivateEndpointConnectionsCreateOrUpdateResponse

Contient des données de réponse pour l’opération createOrUpdate.

PrivateEndpointConnectionsDeleteResponse

Contient des données de réponse pour l’opération de suppression.

PrivateEndpointConnectionsGetResponse

Contient des données de réponse pour l’opération d’obtention.

PrivateEndpointConnectionsListByClusterResponse

Contient des données de réponse pour l’opération listByCluster.

PrivateEndpointServiceConnectionStatus

Définit des valeurs pour PrivateEndpointServiceConnectionStatus.
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
approuvé
rejeté

PrivateLinkResourcesGetResponse

Contient des données de réponse pour l’opération d’obtention.

PrivateLinkResourcesListByClusterResponse

Contient des données de réponse pour l’opération listByCluster.

ProvisioningState

Définit des valeurs pour ProvisioningState.
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
échec

RolesCreateResponse

Contient des données de réponse pour l’opération de création.

RolesDeleteResponse

Contient des données de réponse pour l’opération de suppression.

RolesGetResponse

Contient des données de réponse pour l’opération d’obtention.

RolesListByClusterResponse

Contient des données de réponse pour l’opération listByCluster.

ServerRole

Définit des valeurs pour ServerRole.
KnownServerRole peut être utilisé de manière interchangeable avec ServerRole, cette énumération contient les valeurs connues que le service prend en charge.

Valeurs connues prises en charge par le service

coordinateur
Worker

ServersGetResponse

Contient des données de réponse pour l’opération d’obtention.

ServersListByClusterResponse

Contient des données de réponse pour l’opération listByCluster.

Énumérations

KnownConfigurationDataType

Valeurs connues de ConfigurationDataType que le service accepte.

KnownCreatedByType

Valeurs connues de CreatedByType que le service accepte.

KnownOperationOrigin

Valeurs connues de OperationOrigin que le service accepte.

KnownPrivateEndpointConnectionProvisioningState

Valeurs connues de PrivateEndpointConnectionProvisioningState que le service accepte.

KnownPrivateEndpointServiceConnectionStatus

Valeurs connues de PrivateEndpointServiceConnectionStatus que le service accepte.

KnownProvisioningState

Valeurs connues de ProvisioningState que le service accepte.

KnownServerRole

Valeurs connues de ServerRole que le service accepte.

Functions

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

Informations relatives à la fonction

getContinuationToken(unknown)

Étant donné la dernière .value produite par l’itérateur byPage, retourne un jeton de continuation qui peut être utilisé pour commencer la pagination à partir de ce point ultérieurement.

function getContinuationToken(page: unknown): string | undefined

Paramètres

page

unknown

Objet qui accède à value sur IteratorResult à partir d’un itérateur byPage.

Retours

string | undefined

Jeton de continuation qui peut être transmis à byPage() pendant les appels futurs.