@azure/arm-cosmosdbforpostgresql package

Classes

CosmosDBForPostgreSQL

Interfaces

Cluster	Representa um cluster.
ClusterConfigurationListResult	Uma lista de configurações de cluster.
ClusterForUpdate	Representa um cluster para atualização.
ClusterListResult	Uma lista de clusters.
ClusterServer	Representa um servidor em um cluster.
ClusterServerListResult	Uma lista de servidores em um cluster.
ClusterServerProperties	As propriedades de um servidor no cluster.
Clusters	Interface que representa um Clusters.
ClustersCheckNameAvailabilityOptionalParams	Parâmetros opcionais.
ClustersCreateHeaders	Define cabeçalhos para Clusters_create operação.
ClustersCreateOptionalParams	Parâmetros opcionais.
ClustersDeleteHeaders	Define cabeçalhos para Clusters_delete operação.
ClustersDeleteOptionalParams	Parâmetros opcionais.
ClustersGetOptionalParams	Parâmetros opcionais.
ClustersListByResourceGroupNextOptionalParams	Parâmetros opcionais.
ClustersListByResourceGroupOptionalParams	Parâmetros opcionais.
ClustersListNextOptionalParams	Parâmetros opcionais.
ClustersListOptionalParams	Parâmetros opcionais.
ClustersPromoteReadReplicaHeaders	Define cabeçalhos para Clusters_promoteReadReplica operação.
ClustersPromoteReadReplicaOptionalParams	Parâmetros opcionais.
ClustersRestartHeaders	Define cabeçalhos para Clusters_restart operação.
ClustersRestartOptionalParams	Parâmetros opcionais.
ClustersStartHeaders	Define cabeçalhos para Clusters_start operação.
ClustersStartOptionalParams	Parâmetros opcionais.
ClustersStopHeaders	Define cabeçalhos para Clusters_stop operação.
ClustersStopOptionalParams	Parâmetros opcionais.
ClustersUpdateHeaders	Define cabeçalhos para Clusters_update operação.
ClustersUpdateOptionalParams	Parâmetros opcionais.
Configuration	Representa detalhes de configuração para coordenador e nó.
Configurations	Interface que representa uma configuração.
ConfigurationsGetCoordinatorOptionalParams	Parâmetros opcionais.
ConfigurationsGetNodeOptionalParams	Parâmetros opcionais.
ConfigurationsGetOptionalParams	Parâmetros opcionais.
ConfigurationsListByClusterNextOptionalParams	Parâmetros opcionais.
ConfigurationsListByClusterOptionalParams	Parâmetros opcionais.
ConfigurationsListByServerNextOptionalParams	Parâmetros opcionais.
ConfigurationsListByServerOptionalParams	Parâmetros opcionais.
ConfigurationsUpdateOnCoordinatorHeaders	Define cabeçalhos para Configurations_updateOnCoordinator operação.
ConfigurationsUpdateOnCoordinatorOptionalParams	Parâmetros opcionais.
ConfigurationsUpdateOnNodeHeaders	Define cabeçalhos para Configurations_updateOnNode operação.
ConfigurationsUpdateOnNodeOptionalParams	Parâmetros opcionais.
CosmosDBForPostgreSQLOptionalParams	Parâmetros opcionais.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	Os detalhes do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro de operações com falha. (Isso também segue o formato de resposta de erro OData.).
FirewallRule	Representa uma regra de firewall de cluster.
FirewallRuleListResult	Uma lista de regras de firewall.
FirewallRules	Interface que representa um FirewallRules.
FirewallRulesCreateOrUpdateHeaders	Define cabeçalhos para FirewallRules_createOrUpdate operação.
FirewallRulesCreateOrUpdateOptionalParams	Parâmetros opcionais.
FirewallRulesDeleteHeaders	Define cabeçalhos para FirewallRules_delete operação.
FirewallRulesDeleteOptionalParams	Parâmetros opcionais.
FirewallRulesGetOptionalParams	Parâmetros opcionais.
FirewallRulesListByClusterOptionalParams	Parâmetros opcionais.
MaintenanceWindow	Agendar configurações para atualizações de cluster regulares.
NameAvailability	Representa a disponibilidade do nome do cluster.
NameAvailabilityRequest	Solicite do cliente para marcar disponibilidade do nome do cluster.
Operation	Definição da operação da API REST.
OperationDisplay	Exibir metadados associados à operação.
OperationListResult	Uma lista de operações do provedor de recursos.
Operations	Interface que representa uma Operação.
OperationsListOptionalParams	Parâmetros opcionais.
PrivateEndpoint	O recurso de ponto de extremidade privado.
PrivateEndpointConnection	O recurso de conexão de ponto de extremidade privado.
PrivateEndpointConnectionListResult	Lista de conexões de ponto de extremidade privado associadas ao recurso especificado.
PrivateEndpointConnections	Interface que representa um PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateHeaders	Define cabeçalhos para PrivateEndpointConnections_createOrUpdate operação.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsDeleteHeaders	Define cabeçalhos para PrivateEndpointConnections_delete operação.
PrivateEndpointConnectionsDeleteOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsGetOptionalParams	Parâmetros opcionais.
PrivateEndpointConnectionsListByClusterOptionalParams	Parâmetros opcionais.
PrivateEndpointProperty	Propriedade para representar a ID do recurso do ponto de extremidade privado.
PrivateLinkResource	Um recurso de link privado.
PrivateLinkResourceListResult	Uma lista de recursos de link privado.
PrivateLinkResources	Interface que representa um PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams	Parâmetros opcionais.
PrivateLinkResourcesListByClusterOptionalParams	Parâmetros opcionais.
PrivateLinkServiceConnectionState	Uma coleção de informações sobre o estado da conexão entre o consumidor de serviço e o provedor.
ProxyResource	A definição do modelo de recurso para um recurso de proxy de Resource Manager do Azure. Ele não terá marcas e um local
Resource	Campos comuns retornados na resposta para todos os recursos de Resource Manager do Azure
Role	Representa uma função de cluster.
RoleListResult	Uma lista de funções.
Roles	Interface que representa uma Funções.
RolesCreateHeaders	Define cabeçalhos para Roles_create operação.
RolesCreateOptionalParams	Parâmetros opcionais.
RolesDeleteHeaders	Define cabeçalhos para Roles_delete operação.
RolesDeleteOptionalParams	Parâmetros opcionais.
RolesGetOptionalParams	Parâmetros opcionais.
RolesListByClusterOptionalParams	Parâmetros opcionais.
ServerConfiguration	Representa uma configuração.
ServerConfigurationListResult	Uma lista de configurações de servidor.
ServerNameItem	O objeto name de um servidor.
ServerProperties	As propriedades de um servidor.
ServerRoleGroupConfiguration	Representa o valor de configuração do grupo de função de servidor.
Servers	Interface que representa um Servers.
ServersGetOptionalParams	Parâmetros opcionais.
ServersListByClusterOptionalParams	Parâmetros opcionais.
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 Resource Manager do Azure que tem 'marcas' e um 'local'

Aliases de tipo

ClustersCheckNameAvailabilityResponse	Contém dados de resposta para a operação checkNameAvailability.
ClustersCreateResponse	Contém dados de resposta para a operação de criação.
ClustersGetResponse	Contém dados de resposta para a operação get.
ClustersListByResourceGroupNextResponse	Contém dados de resposta para a operação listByResourceGroupNext.
ClustersListByResourceGroupResponse	Contém dados de resposta para a operação listByResourceGroup.
ClustersListNextResponse	Contém dados de resposta para a operação listNext.
ClustersListResponse	Contém dados de resposta para a operação de lista.
ClustersPromoteReadReplicaResponse	Contém dados de resposta para a operação promoteReadReplica.
ClustersRestartResponse	Contém dados de resposta para a operação de reinicialização.
ClustersUpdateResponse	Contém dados de resposta para a operação de atualização.
ConfigurationDataType	Define valores para ConfigurationDataType. KnownConfigurationDataType pode ser usado 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 Booliano Numérica Inteiro Enumeração
ConfigurationsGetCoordinatorResponse	Contém dados de resposta para a operação getCoordinator.
ConfigurationsGetNodeResponse	Contém dados de resposta para a operação getNode.
ConfigurationsGetResponse	Contém dados de resposta para a operação get.
ConfigurationsListByClusterNextResponse	Contém dados de resposta para a operação listByClusterNext.
ConfigurationsListByClusterResponse	Contém dados de resposta para a operação listByCluster.
ConfigurationsListByServerNextResponse	Contém dados de resposta para a operação listByServerNext.
ConfigurationsListByServerResponse	Contém dados de resposta para a operação listByServer.
ConfigurationsUpdateOnCoordinatorResponse	Contém dados de resposta para a operação updateOnCoordinator.
ConfigurationsUpdateOnNodeResponse	Contém dados de resposta para a operação updateOnNode.
CreatedByType	Define valores para CreatedByType. 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 Usuário Aplicativo ManagedIdentity Chave
FirewallRulesCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
FirewallRulesDeleteResponse	Contém dados de resposta para a operação de exclusão.
FirewallRulesGetResponse	Contém dados de resposta para a operação get.
FirewallRulesListByClusterResponse	Contém dados de resposta para a operação listByCluster.
OperationOrigin	Define valores para OperationOrigin. KnownOperationOrigin pode ser usado intercambiável com OperationOrigin, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço NotSpecified user sistema
OperationsListResponse	Contém dados de resposta para a operação de lista.
PrivateEndpointConnectionProvisioningState	Define valores para PrivateEndpointConnectionProvisioningState. 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 Criando Excluir Com falha
PrivateEndpointConnectionsCreateOrUpdateResponse	Contém dados de resposta para a operação createOrUpdate.
PrivateEndpointConnectionsDeleteResponse	Contém dados de resposta para a operação de exclusão.
PrivateEndpointConnectionsGetResponse	Contém dados de resposta para a operação get.
PrivateEndpointConnectionsListByClusterResponse	Contém dados de resposta para a operação listByCluster.
PrivateEndpointServiceConnectionStatus	Define valores para PrivateEndpointServiceConnectionStatus. 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 Aprovado Rejeitado
PrivateLinkResourcesGetResponse	Contém dados de resposta para a operação get.
PrivateLinkResourcesListByClusterResponse	Contém dados de resposta para a operação listByCluster.
ProvisioningState	Define valores para ProvisioningState. 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 Com falha
RolesCreateResponse	Contém dados de resposta para a operação de criação.
RolesDeleteResponse	Contém dados de resposta para a operação de exclusão.
RolesGetResponse	Contém dados de resposta para a operação get.
RolesListByClusterResponse	Contém dados de resposta para a operação listByCluster.
ServerRole	Define valores para ServerRole. KnownServerRole pode ser usado intercambiável com ServerRole, essa enumeração contém os valores conhecidos aos quais o serviço dá suporte. Valores conhecidos compatíveis com o serviço Coordenador Trabalho
ServersGetResponse	Contém dados de resposta para a operação get.
ServersListByClusterResponse	Contém dados de resposta para a operação listByCluster.

Enumerações

KnownConfigurationDataType	Valores conhecidos de ConfigurationDataType que o serviço aceita.
KnownCreatedByType	Valores conhecidos de CreatedByType que o serviço aceita.
KnownOperationOrigin	Valores conhecidos de OperationOrigin que o serviço aceita.
KnownPrivateEndpointConnectionProvisioningState	Valores conhecidos de PrivateEndpointConnectionProvisioningState que o serviço aceita.
KnownPrivateEndpointServiceConnectionStatus	Valores conhecidos de PrivateEndpointServiceConnectionStatus que o serviço aceita.
KnownProvisioningState	Valores conhecidos de ProvisioningState que o serviço aceita.
KnownServerRole	Valores conhecidos de ServerRole que o serviço aceita.

Funções

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

Detalhes da função

getContinuationToken(unknown)

Dado o último .value produzido pelo byPage iterador, retorna um token de continuação que pode ser usado para iniciar a paginação a partir desse ponto mais tarde.

function getContinuationToken(page: unknown): string | undefined

Parâmetros

page

unknown

Um objeto de acesso value no IteratorResult de um byPage iterador.

Retornos

string | undefined

O token de continuação que pode ser passado porPage() durante chamadas futuras.