@azure/arm-postgresqlhsc package
Clases
| DBforPostgreSQLClient |
Interfaces
| AuthConfig |
Configuración de autenticación de un clúster. |
| Cluster |
Representa un clúster. |
| ClusterForUpdate |
Representa un clúster para la actualización. |
| ClusterProperties |
Propiedades del clúster. |
| ClusterPropertiesForUpdate |
Las propiedades utilizadas para actualizar un clúster. |
| ClusterServer |
Representa un servidor de un clúster. |
| ClusterServerProperties |
Las propiedades de un servidor en el clúster. |
| ClustersCheckNameAvailabilityOptionalParams |
Parámetros opcionales. |
| ClustersCreateOptionalParams |
Parámetros opcionales. |
| ClustersDeleteOptionalParams |
Parámetros opcionales. |
| ClustersGetOptionalParams |
Parámetros opcionales. |
| ClustersListByResourceGroupOptionalParams |
Parámetros opcionales. |
| ClustersListOptionalParams |
Parámetros opcionales. |
| ClustersOperations |
Interfaz que representa las operaciones de Clusters. |
| ClustersPromoteReadReplicaOptionalParams |
Parámetros opcionales. |
| ClustersRestartOptionalParams |
Parámetros opcionales. |
| ClustersStartOptionalParams |
Parámetros opcionales. |
| ClustersStopOptionalParams |
Parámetros opcionales. |
| ClustersUpdateOptionalParams |
Parámetros opcionales. |
| Configuration |
Representa los detalles de configuración para el coordinador y el nodo. |
| ConfigurationProperties |
Las propiedades de la configuración. |
| ConfigurationsGetCoordinatorOptionalParams |
Parámetros opcionales. |
| ConfigurationsGetNodeOptionalParams |
Parámetros opcionales. |
| ConfigurationsGetOptionalParams |
Parámetros opcionales. |
| ConfigurationsListByClusterOptionalParams |
Parámetros opcionales. |
| ConfigurationsListByServerOptionalParams |
Parámetros opcionales. |
| ConfigurationsOperations |
Interfaz que representa una operación de configuración. |
| ConfigurationsUpdateOnCoordinatorOptionalParams |
Parámetros opcionales. |
| ConfigurationsUpdateOnNodeOptionalParams |
Parámetros opcionales. |
| DBforPostgreSQLClientOptionalParams |
Parámetros opcionales para el cliente. |
| DataEncryption |
Propiedades de cifrado de datos de un clúster. |
| ErrorAdditionalInfo |
Información adicional sobre el error de administración de recursos. |
| ErrorDetail |
Detalle del error. |
| ErrorResponse |
Respuesta común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. |
| FirewallRule |
Representa una regla de firewall de clúster. |
| FirewallRuleProperties |
Las propiedades de una regla de firewall de clúster. |
| FirewallRulesCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| FirewallRulesDeleteOptionalParams |
Parámetros opcionales. |
| FirewallRulesGetOptionalParams |
Parámetros opcionales. |
| FirewallRulesListByClusterOptionalParams |
Parámetros opcionales. |
| FirewallRulesOperations |
Interfaz que representa una operación FirewallRules. |
| IdentityProperties |
Describe la identidad del clúster. |
| MaintenanceWindow |
Programe la configuración de las actualizaciones de clúster normales. |
| NameAvailability |
Representa la disponibilidad del nombre del clúster. |
| NameAvailabilityRequest |
Solicite al cliente que compruebe la disponibilidad del nombre del clúster. |
| Operation |
Detalles de una operación de API REST, devuelta desde la API de operaciones del proveedor de recursos |
| OperationDisplay |
Información de visualización localizada para una operación. |
| OperationsListOptionalParams |
Parámetros opcionales. |
| OperationsOperations |
Interfaz que representa operaciones de operaciones. |
| PageSettings |
Opciones para el método byPage |
| PagedAsyncIterableIterator |
Interfaz que permite la iteración asincrónica tanto a la finalización como a la página. |
| PrivateEndpoint |
Recurso de punto de conexión privado. |
| PrivateEndpointConnection |
Un recurso privado de conexión de endpoint |
| PrivateEndpointConnectionProperties |
Propiedades de la conexión de punto de conexión privado. |
| PrivateEndpointConnectionSimpleProperties |
Las propiedades en la conexión de punto final privado |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsGetOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsListByClusterOptionalParams |
Parámetros opcionales. |
| PrivateEndpointConnectionsOperations |
Interfaz que representa una operación PrivateEndpointConnections. |
| PrivateEndpointProperty |
Propiedad para representar el identificador de recurso del punto de conexión privado. |
| PrivateLinkResource |
Un recurso de vínculo privado. |
| PrivateLinkResourceProperties |
Propiedades de un recurso de vínculo privado. |
| PrivateLinkResourcesGetOptionalParams |
Parámetros opcionales. |
| PrivateLinkResourcesListByClusterOptionalParams |
Parámetros opcionales. |
| PrivateLinkResourcesOperations |
Interfaz que representa una operación PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
Colección de información sobre el estado de la conexión entre el consumidor del servicio y el proveedor. |
| PromoteRequest |
Solicitud del cliente para promover la réplica con redundancia geográfica |
| ProxyResource |
Definición del modelo de recursos para un recurso 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 |
| RestorePollerOptions | |
| Role |
Representa un rol de clúster. |
| RoleProperties |
Las propiedades de un rol de clúster. |
| RolePropertiesExternalIdentity |
interfaz de modelo RolPropiedadesIdentidad externa |
| RolesCreateOptionalParams |
Parámetros opcionales. |
| RolesDeleteOptionalParams |
Parámetros opcionales. |
| RolesGetOptionalParams |
Parámetros opcionales. |
| RolesListByClusterOptionalParams |
Parámetros opcionales. |
| RolesOperations |
Interfaz que representa una operación de Roles. |
| ServerConfiguration |
Representa una configuración. |
| ServerConfigurationProperties |
Propiedades de una configuración. |
| ServerNameItem |
El objeto name de un servidor. |
| ServerProperties |
Las propiedades de un servidor. |
| ServerRoleGroupConfiguration |
Representa el valor de configuración del grupo de roles de servidor. |
| ServersGetOptionalParams |
Parámetros opcionales. |
| ServersListByClusterOptionalParams |
Parámetros opcionales. |
| ServersOperations |
Interfaz que representa las operaciones de un servidor. |
| SimplePrivateEndpointConnection |
Una conexión de punto de conexión privado. |
| SystemData |
Metadatos relativos a la creación y última modificación del recurso. |
| TrackedResource |
La definición del modelo de recursos para un recurso de nivel superior con seguimiento de Azure Resource Manager que tiene "etiquetas" y una "ubicación". |
| UserAssignedIdentity |
Propiedades de identidad asignadas por el usuario |
Alias de tipos
| AadEnabledEnum |
Indica si el clúster se creó mediante la autenticación de AAD. Valores conocidos admitidos por el servicio
habilitado |
| ActionType |
Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas. Valores conocidos admitidos por el serviciointerno: las acciones son para las API solo internas. |
| ActiveDirectoryAuth |
Tipo de ActiveDirectoryAuth |
| AzureSupportedClouds |
Los valores admitidos para la configuración de nube como un tipo literal de cadena |
| CheckNameAvailabilityResourceType |
Tipo de recurso utilizado para la comprobación de la disponibilidad de nombres. |
| ConfigurationDataType |
Tipo de datos de la configuración. Valores conocidos admitidos por el servicio
Boolean |
| ContinuablePage |
Interfaz que describe una página de resultados. |
| CreatedByType |
Tipo de entidad que creó el recurso. Valores conocidos admitidos por el servicio
Usuario: un usuario creó la entidad. |
| DataEncryptionType |
Tipo de Tipo de DatosCifrado |
| IdentityType |
Tipo de Identidad |
| Origin |
El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema" Valores conocidos admitidos por el servicio
usuario: indica que un usuario inicia la operación. |
| PasswordAuth |
Tipo de contraseñaAuth |
| PasswordEnabledEnum |
Indica si el clúster se creó con una contraseña o mediante la autenticación de AAD. Valores conocidos admitidos por el servicio
habilitado |
| PrincipalType |
Tipo de PrincipalType |
| PrivateEndpointConnectionProvisioningState |
Estado de aprovisionamiento actual. Valores conocidos admitidos por el servicio
correcto: se ha aprovisionado la conexión |
| PrivateEndpointServiceConnectionStatus |
Estado de conexión del punto de conexión privado. Valores conocidos admitidos por el servicio
Pendiente: Conexión en espera de aprobación o rechazo |
| ProvisioningState |
Estado de aprovisionamiento actual. Valores conocidos admitidos por el servicio
Éxito |
| RoleType |
Tipo de rol |
| ServerRole |
Rol de un servidor. Valores conocidos admitidos por el servicio
Coordinador |
Enumeraciones
| AzureClouds |
Un enum para describir los entornos de Azure Cloud. |
| KnownAadEnabledEnum |
Indica si el clúster se creó mediante la autenticación de AAD. |
| KnownActionType |
Enumeración extensible. Indica el tipo de acción. "Interno" hace referencia a las acciones que son solo para las API internas. |
| KnownActiveDirectoryAuth |
Valores conocidos de ActiveDirectoryAuth que el servicio acepta. |
| KnownConfigurationDataType |
Tipo de datos de la configuración. |
| KnownCreatedByType |
Tipo de entidad que creó el recurso. |
| KnownDataEncryptionType |
Valores conocidos de DataEncryptionType que el servicio acepta. |
| KnownIdentityType |
Los valores conocidos de IdentityType que acepta el servicio. |
| KnownOrigin |
El ejecutor previsto de la operación, como en el control de acceso basado en recursos (RBAC) y en la experiencia de usuario de los registros de auditoría. El valor predeterminado es "usuario, sistema" |
| KnownPasswordAuth |
Valores conocidos de PasswordAuth que el servicio acepta. |
| KnownPasswordEnabledEnum |
Indica si el clúster se creó con una contraseña o mediante la autenticación de AAD. |
| KnownPrincipalType |
Los valores conocidos de PrincipalType que acepta el servicio. |
| KnownPrivateEndpointConnectionProvisioningState |
Estado de aprovisionamiento actual. |
| KnownPrivateEndpointServiceConnectionStatus |
Estado de conexión del punto de conexión privado. |
| KnownProvisioningState |
Estado de aprovisionamiento actual. |
| KnownRoleType |
Valores conocidos del RoleType que el servicio acepta. |
| KnownServerRole |
Rol de un servidor. |
| KnownVersions |
Las versiones de API disponibles. |
Funciones
| is |
Typeguard para RestError |
| restore |
Crea un sondeador a partir del estado serializado de otro sondeador. Esto puede ser útil cuando desea crear sondeadores en un host diferente o cuando es necesario construir un sondeador después de que el original no esté en el ámbito. |
Variables
| Rest |
Tipo de error personalizado para solicitudes de canalización con error. |
Detalles de la función
isRestError(unknown)
Typeguard para RestError
function isRestError(e: unknown): e
Parámetros
- e
-
unknown
Algo capturado por una cláusula catch.
Devoluciones
e
restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Crea un sondeador a partir del estado serializado de otro sondeador. Esto puede ser útil cuando desea crear sondeadores en un host diferente o cuando es necesario construir un sondeador después de que el original no esté en el ámbito.
function restorePoller<TResponse, TResult>(client: DBforPostgreSQLClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Parámetros
- client
- DBforPostgreSQLClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Devoluciones
PollerLike<OperationState<TResult>, TResult>
Detalles de variables
RestError
Tipo de error personalizado para solicitudes de canalización con error.
RestError: RestErrorConstructor