@azure/arm-postgresqlhsc package

Classes

DBforPostgreSQLClient

Interfaces

AuthConfig

Configuração de autenticação de um cluster.
Cluster

Representa um cluster.
ClusterForUpdate

Representa um cluster para atualização.
ClusterProperties

Propriedades do cluster.
ClusterPropertiesForUpdate

As propriedades usadas para atualizar um cluster.
ClusterServer

Representa um servidor em um cluster.
ClusterServerProperties

As propriedades de um servidor em cluster.
ClustersCheckNameAvailabilityOptionalParams

Parâmetros opcionais.
ClustersCreateOptionalParams

Parâmetros opcionais.
ClustersDeleteOptionalParams

Parâmetros opcionais.
ClustersGetOptionalParams

Parâmetros opcionais.
ClustersListByResourceGroupOptionalParams

Parâmetros opcionais.
ClustersListOptionalParams

Parâmetros opcionais.
ClustersOperations

Interface que representa operações de Clusters.
ClustersPromoteReadReplicaOptionalParams

Parâmetros opcionais.
ClustersRestartOptionalParams

Parâmetros opcionais.
ClustersStartOptionalParams

Parâmetros opcionais.
ClustersStopOptionalParams

Parâmetros opcionais.
ClustersUpdateOptionalParams

Parâmetros opcionais.
Configuration

Representa os detalhes de configuração para coordenador e nó.
ConfigurationProperties

As propriedades da configuração.
ConfigurationsGetCoordinatorOptionalParams

Parâmetros opcionais.
ConfigurationsGetNodeOptionalParams

Parâmetros opcionais.
ConfigurationsGetOptionalParams

Parâmetros opcionais.
ConfigurationsListByClusterOptionalParams

Parâmetros opcionais.
ConfigurationsListByServerOptionalParams

Parâmetros opcionais.
ConfigurationsOperations

Interface representando operações de configuração.
ConfigurationsUpdateOnCoordinatorOptionalParams

Parâmetros opcionais.
ConfigurationsUpdateOnNodeOptionalParams

Parâmetros opcionais.
DBforPostgreSQLClientOptionalParams

Parâmetros opcionais para o cliente.
DataEncryption

As propriedades de criptografia de dados de um cluster.
ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro comum para todas as APIs do Azure Resource Manager devolver detalhes de erro para operações falhadas.
FirewallRule

Representa uma regra de firewall de cluster.
FirewallRuleProperties

As propriedades de uma regra de firewall de cluster.
FirewallRulesCreateOrUpdateOptionalParams

Parâmetros opcionais.
FirewallRulesDeleteOptionalParams

Parâmetros opcionais.
FirewallRulesGetOptionalParams

Parâmetros opcionais.
FirewallRulesListByClusterOptionalParams

Parâmetros opcionais.
FirewallRulesOperations

Interface que representa uma operação FirewallRules.
IdentityProperties

Descreve a identidade do cluster.
MaintenanceWindow

Agende configurações para atualizações regulares de cluster.
NameAvailability

Representa a disponibilidade do nome do cluster.
NameAvailabilityRequest

Solicite ao cliente para verificar a disponibilidade do nome do cluster.
Operation

Detalhes de uma operação da API REST, retornados da API de Operações do Provedor de Recursos
OperationDisplay

Informação de visualização localizada para uma operação.
OperationsListOptionalParams

Parâmetros opcionais.
OperationsOperations

Interface que representa uma operação de Operações.
PageSettings

Opções para o método byPage
PagedAsyncIterableIterator

Uma interface que permite iteração assíncrona iterável até a conclusão e por página.
PrivateEndpoint

O recurso de ponto de extremidade privado.
PrivateEndpointConnection

Um recurso privado de ligação de endpoint
PrivateEndpointConnectionProperties

Propriedades da conexão de ponto de extremidade privado.
PrivateEndpointConnectionSimpleProperties

As propriedades na ligação ao ponto final privado
PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Parâmetros opcionais.
PrivateEndpointConnectionsDeleteOptionalParams

Parâmetros opcionais.
PrivateEndpointConnectionsGetOptionalParams

Parâmetros opcionais.
PrivateEndpointConnectionsListByClusterOptionalParams

Parâmetros opcionais.
PrivateEndpointConnectionsOperations

Interface que representa uma operação PrivateEndpointConnections.
PrivateEndpointProperty

Propriedade para representar a id do recurso do ponto de extremidade privado.
PrivateLinkResource

Um recurso de link privado.
PrivateLinkResourceProperties

Propriedades de um recurso de link privado.
PrivateLinkResourcesGetOptionalParams

Parâmetros opcionais.
PrivateLinkResourcesListByClusterOptionalParams

Parâmetros opcionais.
PrivateLinkResourcesOperations

Interface que representa uma operação PrivateLinkResources.
PrivateLinkServiceConnectionState

Uma recolha de informações sobre o estado da ligação entre o consumidor e o prestador de serviços.
PromoteRequest

Solicitação do cliente para promover réplica com redundância geográfica
ProxyResource

A definição de modelo de recurso para um recurso de proxy do Azure Resource Manager. Ele não terá tags e um local
Resource

Campos comuns que são retornados na resposta para todos os recursos do Azure Resource Manager
RestorePollerOptions
Role

Representa uma função de cluster.
RoleProperties

As propriedades de um papel de cluster.
RolePropertiesExternalIdentity

interface do modelo RolePropertiesExternalIdentity
RolesCreateOptionalParams

Parâmetros opcionais.
RolesDeleteOptionalParams

Parâmetros opcionais.
RolesGetOptionalParams

Parâmetros opcionais.
RolesListByClusterOptionalParams

Parâmetros opcionais.
RolesOperations

Interface representando as operações de um Role.
ServerConfiguration

Representa uma configuração.
ServerConfigurationProperties

As propriedades de uma configuração.
ServerNameItem

O objeto name de um servidor.
ServerProperties

As propriedades de um servidor.
ServerRoleGroupConfiguration

Representa o valor de configuração do grupo de funções de servidor.
ServersGetOptionalParams

Parâmetros opcionais.
ServersListByClusterOptionalParams

Parâmetros opcionais.
ServersOperations

Interface que representa as operações de um servidor.
SimplePrivateEndpointConnection

Uma conexão de ponto de extremidade privada.
SystemData

Metadados referentes à criação e última modificação do recurso.
TrackedResource

A definição do modelo de recursos para um recurso de nível superior rastreado do Azure Resource Manager que tem 'tags' e um 'local'
UserAssignedIdentity

Propriedades de identidade atribuídas pelo usuário

Aliases de Tipo

AadEnabledEnum

Indica se o cluster foi criado usando a autenticação do AAD.
KnowAadEnabledEnum pode ser usado de forma intercambiável com AadEnabledEnum, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

ativado
desativado
ActionType

Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownActionType pode ser usado de forma intercambiável com ActionType, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

interno: As ações são apenas para APIs internas.
ActiveDirectoryAuth

Tipo de ActiveDirectoryAuth
AzureSupportedClouds

Os valores suportados para a configuração de nuvem como um tipo literal de cadeia de caracteres
CheckNameAvailabilityResourceType

Tipo de recurso usado para verificação de disponibilidade de nome.
ConfigurationDataType

Tipo de dados da configuração.
KnownConfigurationDataType pode ser usado de forma intercambiável com ConfigurationDataType, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Boolean
Numeric
Inteiro
Enumeração
ContinuablePage

Uma interface que descreve uma página de resultados.
CreatedByType

O tipo de entidade que criou o recurso.
KnownCreatedByType pode ser usado de forma intercambiável com CreatedByType, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

User: A entidade foi criada por um usuário.
Application: A entidade foi criada por um aplicativo.
ManagedIdentity: A entidade foi criada por uma identidade gerenciada.
Key: A entidade foi criada por uma chave.
DataEncryptionType

Tipo de DataEncryptionType
IdentityType

Tipo de IdentidadeTipo
Origin

O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com Origin, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

usuário: Indica que a operação é iniciada por um usuário.
sistema: Indica que a operação é iniciada por um sistema.
usuário, sistema: Indica que a operação é iniciada por um usuário ou sistema.
PasswordAuth

Tipo de PasswordAuth
PasswordEnabledEnum

Indica se o cluster foi criado com uma senha ou usando a autenticação do AAD.
O KnowPasswordEnabledEnum pode ser usado de forma intercambiável com o PasswordEnabledEnum, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

ativado
desativado
PrincipalType

Tipo de PrincipalType
PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.
KnownPrivateEndpointConnectionProvisioningState pode ser usado de forma intercambiável com PrivateEndpointConnectionProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

bem-sucedido : A conexão foi provisionada
Criando: A conexão está sendo criada
Excluindo: A conexão está sendo excluída
Falha: Falha no provisionamento de conexão
PrivateEndpointServiceConnectionStatus

O status da conexão de ponto de extremidade privado.
KnownPrivateEndpointServiceConnectionStatus pode ser usado de forma intercambiável com PrivateEndpointServiceConnectionStatus, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Pendente: Conexão aguardando aprovação ou rejeição
Aprovado: Conexão aprovada
Rejeitado: Conexão rejeitada
ProvisioningState

O estado de provisionamento atual.
KnownProvisioningState pode ser usado de forma intercambiável com ProvisioningState, esse enum contém os valores conhecidos suportados pelo serviço.

Valores conhecidos suportados pelo serviço

Bem-sucedido
Canceled
Em curso
Failed
RoleType

Tipo de Função
ServerRole

A função de um servidor.
KnowServerRole pode ser usado de forma intercambiável com ServerRole, este enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos suportados pelo serviço

Coordenador
Trabalhador

Enumerações

AzureClouds

Um enum para descrever ambientes Azure Cloud.
KnownAadEnabledEnum

Indica se o cluster foi criado usando a autenticação do AAD.
KnownActionType

Enum extensível. Indica o tipo de ação. "Interno" refere-se a ações que são apenas para APIs internas.
KnownActiveDirectoryAuth

Valores conhecidos do ActiveDirectoryAuth que o serviço aceita.
KnownConfigurationDataType

Tipo de dados da configuração.
KnownCreatedByType

O tipo de entidade que criou o recurso.
KnownDataEncryptionType

Valores conhecidos de DataEncryptionType que o serviço aceita.
KnownIdentityType

Os valores conhecidos de IdentityType que o serviço aceita.
KnownOrigin

O executor pretendido da operação; como no Controle de Acesso Baseado em Recursos (RBAC) e na UX de logs de auditoria. O valor padrão é "user,system"
KnownPasswordAuth

Valores conhecidos do PasswordAuth que o serviço aceita.
KnownPasswordEnabledEnum

Indica se o cluster foi criado com uma senha ou usando a autenticação do AAD.
KnownPrincipalType

Os valores conhecidos de PrincipalType que o serviço aceita.
KnownPrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.
KnownPrivateEndpointServiceConnectionStatus

O status da conexão de ponto de extremidade privado.
KnownProvisioningState

O estado de provisionamento atual.
KnownRoleType

Valores conhecidos do RoleType que o serviço aceita.
KnownServerRole

A função de um servidor.
KnownVersions

As versões de API disponíveis.

Funções

isRestError(unknown)

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

Variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

Detalhes de Função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo apanhado por uma cláusula de captura.

Devoluções

e

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

Cria um poller a partir do estado serializado de outro poller. Isso pode ser útil quando você deseja criar pollers em um host diferente ou um poller precisa ser construído depois que o original não está no escopo.

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>

Devoluções

PollerLike<OperationState<TResult>, TResult>

Detalhes das variáveis

RestError

Um tipo de erro personalizado para solicitações de pipeline com falha.

RestError: RestErrorConstructor

Tipo

RestErrorConstructor