@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 uma operação 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 gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta comum de erro para todas as APIs do Azure Resource Manager devolver detalhes de erro em 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

Agendar configurações para atualizações regulares do cluster.
NameAvailability

Representa a disponibilidade do nome do cluster.
NameAvailabilityRequest

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

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

Informações localizadas de exibição para uma operação.
OperationsListOptionalParams

Parâmetros opcionais.
OperationsOperations

Interface representando 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 tanto para conclusão quanto por página.
PrivateEndpoint

O recurso de ponto de extremidade privado.
PrivateEndpointConnection

Um recurso privado de conexão para endpoints
PrivateEndpointConnectionProperties

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

As propriedades na conexão de endpoint 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 coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
PromoteRequest

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

A definição do modelo de recurso para um recurso proxy do Azure Resource Manager. Ele não terá marcas 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 operações de Roles.
ServerConfiguration

Representa uma configuração.
ServerConfigurationProperties

As propriedades de uma configuração.
ServerNameItem

O objeto de nome de um servidor.
ServerProperties

As propriedades de um servidor.
ServerRoleGroupConfiguration

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

Parâmetros opcionais.
ServersListByClusterOptionalParams

Parâmetros opcionais.
ServersOperations

Interface representando as operações de um servidor.
SimplePrivateEndpointConnection

Uma conexão de ponto de extremidade privado.
SystemData

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

A definição do modelo de recurso para um recurso de nível superior rastreado pelo Azure Resource Manager que tem 'marcas' 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.
KnownAadEnabledEnum pode ser usado de forma intercambiável com AadEnabledEnum, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

habilitado
desabilitado
ActionType

Enumeração 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Interno: as ações são para APIs somente internas.
ActiveDirectoryAuth

Tipo de ActiveDirectoryAuth
AzureSupportedClouds

Os valores com suporte 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 nomes.
ConfigurationDataType

Tipo de dados da configuração.
KnownConfigurationDataType podem ser usados de forma intercambiável com ConfigurationDataType, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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 RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos logs de auditoria. O valor padrão é "user,system"
KnownOrigin pode ser usado de forma intercambiável com a Origem, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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,do 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.
KnowPasswordEnabledEnum pode ser usado de forma intercambiável com PasswordEnabledEnum, esse enum contém os valores conhecidos que o serviço suporta.

Valores conhecidos compatíveis com o serviço

habilitado
desabilitado
PrincipalType

Tipo de PrincipalType
PrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.
KnownPrivateEndpointConnectionProvisioningState pode ser usado de forma intercambiável com PrivateEndpointConnectionProvisioningState, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Êxito: a conexão foi provisionada
Criando: A conexão está sendo criada
Eliminando: A conexão está sendo excluída
Falha: Falha no provisionamento de conexão
PrivateEndpointServiceConnectionStatus

O status da conexão do ponto de extremidade privado.
KnownPrivateEndpointServiceConnectionStatus pode ser usado de forma intercambiável com PrivateEndpointServiceConnectionStatus, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o 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, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte.

Valores conhecidos compatíveis com o serviço

Êxito
Cancelado
InProgress
Falha
RoleType

Tipo de Função
ServerRole

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

Valores conhecidos compatíveis com o serviço

Coordenador
Trabalhador

Enumerações

AzureClouds

Um enum para descrever ambientes de nuvem Azure.
KnownAadEnabledEnum

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

Enumeração 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 do DataEncryptionType que o serviço aceita.
KnownIdentityType

Valores conhecidos de IdentityType que o serviço aceita.
KnownOrigin

O executor pretendido da operação; como no RBAC (Controle de Acesso Baseado em Recursos) e na experiência do usuário dos 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

Valores conhecidos de PrincipalType que o serviço aceita.
KnownPrivateEndpointConnectionProvisioningState

O estado de provisionamento atual.
KnownPrivateEndpointServiceConnectionStatus

O status da conexão do 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 sondador a partir do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondagens em um host diferente ou quando uma sondagem precisa ser construída depois que a original não estiver no escopo.

Variáveis

RestError

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

Detalhes da função

isRestError(unknown)

Typeguard para RestError

function isRestError(e: unknown): e

Parâmetros

e

unknown

Algo pego por uma cláusula catch.

Retornos

e

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

Cria um sondador a partir do estado serializado de outro sondador. Isso pode ser útil quando você deseja criar sondagens em um host diferente ou quando uma sondagem precisa ser construída depois que a original não estiver 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>

Retornos

PollerLike<OperationState<TResult>, TResult>

Detalhes da variável

RestError

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

RestError: RestErrorConstructor

Tipo

RestErrorConstructor