@azure/arm-cosmosdbforpostgresql package

Clases

CosmosDBForPostgreSQL

Interfaces

Cluster	Representa un clúster.
ClusterConfigurationListResult	Lista de configuraciones de clúster.
ClusterForUpdate	Representa un clúster para la actualización.
ClusterListResult	Una lista de clústeres.
ClusterServer	Representa un servidor de un clúster.
ClusterServerListResult	Lista de servidores de un clúster.
ClusterServerProperties	Propiedades de un servidor en el clúster.
Clusters	Interfaz que representa un clúster.
ClustersCheckNameAvailabilityOptionalParams	Parámetros opcionales.
ClustersCreateHeaders	Define encabezados para Clusters_create operación.
ClustersCreateOptionalParams	Parámetros opcionales.
ClustersDeleteHeaders	Define encabezados para Clusters_delete operación.
ClustersDeleteOptionalParams	Parámetros opcionales.
ClustersGetOptionalParams	Parámetros opcionales.
ClustersListByResourceGroupNextOptionalParams	Parámetros opcionales.
ClustersListByResourceGroupOptionalParams	Parámetros opcionales.
ClustersListNextOptionalParams	Parámetros opcionales.
ClustersListOptionalParams	Parámetros opcionales.
ClustersPromoteReadReplicaHeaders	Define encabezados para Clusters_promoteReadReplica operación.
ClustersPromoteReadReplicaOptionalParams	Parámetros opcionales.
ClustersRestartHeaders	Define encabezados para Clusters_restart operación.
ClustersRestartOptionalParams	Parámetros opcionales.
ClustersStartHeaders	Define encabezados para Clusters_start operación.
ClustersStartOptionalParams	Parámetros opcionales.
ClustersStopHeaders	Define encabezados para Clusters_stop operación.
ClustersStopOptionalParams	Parámetros opcionales.
ClustersUpdateHeaders	Define encabezados para Clusters_update operación.
ClustersUpdateOptionalParams	Parámetros opcionales.
Configuration	Representa los detalles de configuración para el coordinador y el nodo.
Configurations	Interfaz que representa una configuración.
ConfigurationsGetCoordinatorOptionalParams	Parámetros opcionales.
ConfigurationsGetNodeOptionalParams	Parámetros opcionales.
ConfigurationsGetOptionalParams	Parámetros opcionales.
ConfigurationsListByClusterNextOptionalParams	Parámetros opcionales.
ConfigurationsListByClusterOptionalParams	Parámetros opcionales.
ConfigurationsListByServerNextOptionalParams	Parámetros opcionales.
ConfigurationsListByServerOptionalParams	Parámetros opcionales.
ConfigurationsUpdateOnCoordinatorHeaders	Define encabezados para Configurations_updateOnCoordinator operación.
ConfigurationsUpdateOnCoordinatorOptionalParams	Parámetros opcionales.
ConfigurationsUpdateOnNodeHeaders	Define encabezados para Configurations_updateOnNode operación.
ConfigurationsUpdateOnNodeOptionalParams	Parámetros opcionales.
CosmosDBForPostgreSQLOptionalParams	Parámetros opcionales.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
FirewallRule	Representa una regla de firewall de clúster.
FirewallRuleListResult	Lista de reglas de firewall.
FirewallRules	Interfaz que representa un FirewallRules.
FirewallRulesCreateOrUpdateHeaders	Define encabezados para FirewallRules_createOrUpdate operación.
FirewallRulesCreateOrUpdateOptionalParams	Parámetros opcionales.
FirewallRulesDeleteHeaders	Define encabezados para FirewallRules_delete operación.
FirewallRulesDeleteOptionalParams	Parámetros opcionales.
FirewallRulesGetOptionalParams	Parámetros opcionales.
FirewallRulesListByClusterOptionalParams	Parámetros opcionales.
MaintenanceWindow	Programe la configuración de las actualizaciones periódicas del clúster.
NameAvailability	Representa la disponibilidad del nombre del clúster.
NameAvailabilityRequest	Solicite al cliente que compruebe la disponibilidad del nombre del clúster.
Operation	Definición de la operación de la API REST.
OperationDisplay	Mostrar metadatos asociados a la operación.
OperationListResult	Lista de operaciones del proveedor de recursos.
Operations	Interfaz que representa una operación.
OperationsListOptionalParams	Parámetros opcionales.
PrivateEndpoint	El recurso de punto de conexión privado.
PrivateEndpointConnection	Recurso de conexión de punto de conexión privado.
PrivateEndpointConnectionListResult	Lista de conexiones de punto de conexión privado asociadas al recurso especificado.
PrivateEndpointConnections	Interfaz que representa privateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateHeaders	Define encabezados para PrivateEndpointConnections_createOrUpdate operación.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsDeleteHeaders	Define encabezados para PrivateEndpointConnections_delete operación.
PrivateEndpointConnectionsDeleteOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsGetOptionalParams	Parámetros opcionales.
PrivateEndpointConnectionsListByClusterOptionalParams	Parámetros opcionales.
PrivateEndpointProperty	Propiedad que representa el identificador de recurso del punto de conexión privado.
PrivateLinkResource	Un recurso de vínculo privado.
PrivateLinkResourceListResult	Lista de recursos de private link.
PrivateLinkResources	Interfaz que representa un privateLinkResources.
PrivateLinkResourcesGetOptionalParams	Parámetros opcionales.
PrivateLinkResourcesListByClusterOptionalParams	Parámetros opcionales.
PrivateLinkServiceConnectionState	Colección de información sobre el estado de la conexión entre el consumidor de servicios y el proveedor.
ProxyResource	Definición del modelo de recursos para un recurso de proxy de Azure Resource Manager. No tendrá etiquetas ni una ubicación
Resource	Campos comunes que se devuelven en la respuesta de todos los recursos de Azure Resource Manager
Role	Representa un rol de clúster.
RoleListResult	Una lista de roles.
Roles	Interfaz que representa un rol.
RolesCreateHeaders	Define encabezados para Roles_create operación.
RolesCreateOptionalParams	Parámetros opcionales.
RolesDeleteHeaders	Define encabezados para Roles_delete operación.
RolesDeleteOptionalParams	Parámetros opcionales.
RolesGetOptionalParams	Parámetros opcionales.
RolesListByClusterOptionalParams	Parámetros opcionales.
ServerConfiguration	Representa una configuración.
ServerConfigurationListResult	Lista de configuraciones de servidor.
ServerNameItem	Objeto name de un servidor.
ServerProperties	Propiedades de un servidor.
ServerRoleGroupConfiguration	Representa el valor de configuración del grupo de roles de servidor.
Servers	Interfaz que representa un servidor.
ServersGetOptionalParams	Parámetros opcionales.
ServersListByClusterOptionalParams	Parámetros opcionales.
SimplePrivateEndpointConnection	Una conexión de punto de conexión privado.
SystemData	Metadatos relacionados con la creación y la última modificación del recurso.
TrackedResource	La definición del modelo de recursos de una instancia de Azure Resource Manager ha realizado un seguimiento del recurso de nivel superior que tiene "etiquetas" y una "ubicación".

Alias de tipos

ClustersCheckNameAvailabilityResponse	Contiene datos de respuesta para la operación checkNameAvailability.
ClustersCreateResponse	Contiene datos de respuesta para la operación de creación.
ClustersGetResponse	Contiene datos de respuesta para la operación get.
ClustersListByResourceGroupNextResponse	Contiene datos de respuesta para la operación listByResourceGroupNext.
ClustersListByResourceGroupResponse	Contiene datos de respuesta para la operación listByResourceGroup.
ClustersListNextResponse	Contiene datos de respuesta para la operación listNext.
ClustersListResponse	Contiene datos de respuesta para la operación de lista.
ClustersPromoteReadReplicaResponse	Contiene datos de respuesta para la operación promoteReadReplica.
ClustersRestartResponse	Contiene datos de respuesta para la operación de reinicio.
ClustersUpdateResponse	Contiene datos de respuesta para la operación de actualización.
ConfigurationDataType	Define los valores de ConfigurationDataType. KnownConfigurationDataType se puede usar indistintamente con ConfigurationDataType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Boolean Numérico Entero Enumeration
ConfigurationsGetCoordinatorResponse	Contiene datos de respuesta para la operación getCoordinator.
ConfigurationsGetNodeResponse	Contiene datos de respuesta para la operación getNode.
ConfigurationsGetResponse	Contiene datos de respuesta para la operación get.
ConfigurationsListByClusterNextResponse	Contiene datos de respuesta para la operación listByClusterNext.
ConfigurationsListByClusterResponse	Contiene datos de respuesta para la operación listByCluster.
ConfigurationsListByServerNextResponse	Contiene datos de respuesta para la operación listByServerNext.
ConfigurationsListByServerResponse	Contiene datos de respuesta para la operación listByServer.
ConfigurationsUpdateOnCoordinatorResponse	Contiene datos de respuesta para la operación updateOnCoordinator.
ConfigurationsUpdateOnNodeResponse	Contiene datos de respuesta para la operación updateOnNode.
CreatedByType	Define los valores de CreatedByType. KnownCreatedByType se puede usar indistintamente con CreatedByType, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio User Aplicación ManagedIdentity Clave
FirewallRulesCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
FirewallRulesDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
FirewallRulesGetResponse	Contiene datos de respuesta para la operación get.
FirewallRulesListByClusterResponse	Contiene datos de respuesta para la operación listByCluster.
OperationOrigin	Define valores para OperationOrigin. KnownOperationOrigin se puede usar indistintamente con OperationOrigin, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio NotSpecified user sistema
OperationsListResponse	Contiene datos de respuesta para la operación de lista.
PrivateEndpointConnectionProvisioningState	Define valores para PrivateEndpointConnectionProvisioningState. KnownPrivateEndpointConnectionProvisioningState se puede usar indistintamente con PrivateEndpointConnectionProvisioningState, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Correcto Creating Eliminando Erróneo
PrivateEndpointConnectionsCreateOrUpdateResponse	Contiene datos de respuesta para la operación createOrUpdate.
PrivateEndpointConnectionsDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
PrivateEndpointConnectionsGetResponse	Contiene datos de respuesta para la operación get.
PrivateEndpointConnectionsListByClusterResponse	Contiene datos de respuesta para la operación listByCluster.
PrivateEndpointServiceConnectionStatus	Define valores para PrivateEndpointServiceConnectionStatus. KnownPrivateEndpointServiceConnectionStatus se puede usar indistintamente con PrivateEndpointServiceConnectionStatus, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Pendiente Aprobado Rechazada
PrivateLinkResourcesGetResponse	Contiene datos de respuesta para la operación get.
PrivateLinkResourcesListByClusterResponse	Contiene datos de respuesta para la operación listByCluster.
ProvisioningState	Define valores para ProvisioningState. KnownProvisioningState se puede usar indistintamente con ProvisioningState; esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Correcto Canceled InProgress Erróneo
RolesCreateResponse	Contiene datos de respuesta para la operación de creación.
RolesDeleteResponse	Contiene datos de respuesta para la operación de eliminación.
RolesGetResponse	Contiene datos de respuesta para la operación get.
RolesListByClusterResponse	Contiene datos de respuesta para la operación listByCluster.
ServerRole	Define valores para ServerRole. KnownServerRole se puede usar indistintamente con ServerRole, esta enumeración contiene los valores conocidos que admite el servicio. Valores conocidos admitidos por el servicio Coordinador Trabajo
ServersGetResponse	Contiene datos de respuesta para la operación get.
ServersListByClusterResponse	Contiene datos de respuesta para la operación listByCluster.

Enumeraciones

KnownConfigurationDataType	Valores conocidos de ConfigurationDataType que acepta el servicio.
KnownCreatedByType	Valores conocidos de CreatedByType que acepta el servicio.
KnownOperationOrigin	Valores conocidos de OperationOrigin que acepta el servicio.
KnownPrivateEndpointConnectionProvisioningState	Valores conocidos de PrivateEndpointConnectionProvisioningState que acepta el servicio.
KnownPrivateEndpointServiceConnectionStatus	Valores conocidos de PrivateEndpointServiceConnectionStatus que acepta el servicio.
KnownProvisioningState	Valores conocidos de ProvisioningState que acepta el servicio.
KnownServerRole	Valores conocidos de ServerRole que acepta el servicio.

Funciones

getContinuationToken(unknown)

Dado el último .value generado por el byPage iterador, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

Detalles de la función

getContinuationToken(unknown)

Dado el último .value generado por el byPage iterador, devuelve un token de continuación que se puede usar para comenzar la paginación desde ese punto más adelante.

function getContinuationToken(page: unknown): string | undefined

Parámetros

page

unknown

Objeto desde el que se accede value a IteratorResult desde un byPage iterador.

Devoluciones

string | undefined

Token de continuación que se puede pasar a byPage() durante futuras llamadas.