Поделиться через

@azure/arm-cosmosdbforpostgresql package

Классы

CosmosDBForPostgreSQL

Интерфейсы

Cluster

Представляет кластер.
ClusterConfigurationListResult

Список конфигураций кластера.
ClusterForUpdate

Представляет кластер для обновления.
ClusterListResult

Список кластеров.
ClusterServer

Представляет сервер в кластере.
ClusterServerListResult

Список серверов в кластере.
ClusterServerProperties

Свойства сервера в кластере.
Clusters

Интерфейс, представляющий кластеры.
ClustersCheckNameAvailabilityOptionalParams

Необязательные параметры.
ClustersCreateHeaders

Определяет заголовки для операции Clusters_create.
ClustersCreateOptionalParams

Необязательные параметры.
ClustersDeleteHeaders

Определяет заголовки для операции Clusters_delete.
ClustersDeleteOptionalParams

Необязательные параметры.
ClustersGetOptionalParams

Необязательные параметры.
ClustersListByResourceGroupNextOptionalParams

Необязательные параметры.
ClustersListByResourceGroupOptionalParams

Необязательные параметры.
ClustersListNextOptionalParams

Необязательные параметры.
ClustersListOptionalParams

Необязательные параметры.
ClustersPromoteReadReplicaHeaders

Определяет заголовки для операции Clusters_promoteReadReplica.
ClustersPromoteReadReplicaOptionalParams

Необязательные параметры.
ClustersRestartHeaders

Определяет заголовки для операции Clusters_restart.
ClustersRestartOptionalParams

Необязательные параметры.
ClustersStartHeaders

Определяет заголовки для операции Clusters_start.
ClustersStartOptionalParams

Необязательные параметры.
ClustersStopHeaders

Определяет заголовки для операции Clusters_stop.
ClustersStopOptionalParams

Необязательные параметры.
ClustersUpdateHeaders

Определяет заголовки для операции Clusters_update.
ClustersUpdateOptionalParams

Необязательные параметры.
Configuration

Представляет сведения о конфигурации для координатора и узла.
Configurations

Интерфейс, представляющий конфигурации.
ConfigurationsGetCoordinatorOptionalParams

Необязательные параметры.
ConfigurationsGetNodeOptionalParams

Необязательные параметры.
ConfigurationsGetOptionalParams

Необязательные параметры.
ConfigurationsListByClusterNextOptionalParams

Необязательные параметры.
ConfigurationsListByClusterOptionalParams

Необязательные параметры.
ConfigurationsListByServerNextOptionalParams

Необязательные параметры.
ConfigurationsListByServerOptionalParams

Необязательные параметры.
ConfigurationsUpdateOnCoordinatorHeaders

Определяет заголовки для операции Configurations_updateOnCoordinator.
ConfigurationsUpdateOnCoordinatorOptionalParams

Необязательные параметры.
ConfigurationsUpdateOnNodeHeaders

Определяет заголовки для операции Configurations_updateOnNode.
ConfigurationsUpdateOnNodeOptionalParams

Необязательные параметры.
CosmosDBForPostgreSQLOptionalParams

Необязательные параметры.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
FirewallRule

Представляет правило брандмауэра кластера.
FirewallRuleListResult

Список правил брандмауэра.
FirewallRules

Интерфейс, представляющий БрандмауэрRules.
FirewallRulesCreateOrUpdateHeaders

Определяет заголовки для операции FirewallRules_createOrUpdate.
FirewallRulesCreateOrUpdateOptionalParams

Необязательные параметры.
FirewallRulesDeleteHeaders

Определяет заголовки для операции FirewallRules_delete.
FirewallRulesDeleteOptionalParams

Необязательные параметры.
FirewallRulesGetOptionalParams

Необязательные параметры.
FirewallRulesListByClusterOptionalParams

Необязательные параметры.
MaintenanceWindow

Планирование параметров для регулярных обновлений кластера.
NameAvailability

Представляет доступность имени кластера.
NameAvailabilityRequest

Запрос от клиента для проверки доступности имени кластера.
Operation

Определение операции REST API.
OperationDisplay

Отображение метаданных, связанных с операцией.
OperationListResult

Список операций поставщика ресурсов.
Operations

Интерфейс, представляющий операции.
OperationsListOptionalParams

Необязательные параметры.
PrivateEndpoint

Ресурс частной конечной точки.
PrivateEndpointConnection

Ресурс подключения к частной конечной точке.
PrivateEndpointConnectionListResult

Список подключений частной конечной точки, связанных с указанным ресурсом.
PrivateEndpointConnections

Интерфейс, представляющий PrivateEndpointConnections.
PrivateEndpointConnectionsCreateOrUpdateHeaders

Определяет заголовки для операции PrivateEndpointConnections_createOrUpdate.
PrivateEndpointConnectionsCreateOrUpdateOptionalParams

Необязательные параметры.
PrivateEndpointConnectionsDeleteHeaders

Определяет заголовки для операции PrivateEndpointConnections_delete.
PrivateEndpointConnectionsDeleteOptionalParams

Необязательные параметры.
PrivateEndpointConnectionsGetOptionalParams

Необязательные параметры.
PrivateEndpointConnectionsListByClusterOptionalParams

Необязательные параметры.
PrivateEndpointProperty

Свойство для представления идентификатора ресурса частной конечной точки.
PrivateLinkResource

Ресурс приватного канала.
PrivateLinkResourceListResult

Список ресурсов приватного канала.
PrivateLinkResources

Интерфейс, представляющий PrivateLinkResources.
PrivateLinkResourcesGetOptionalParams

Необязательные параметры.
PrivateLinkResourcesListByClusterOptionalParams

Необязательные параметры.
PrivateLinkServiceConnectionState

Коллекция сведений о состоянии подключения между потребителем службы и поставщиком.
ProxyResource

Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение
Resource

Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager
Role

Представляет роль кластера.
RoleListResult

Список ролей.
Roles

Интерфейс, представляющий роли.
RolesCreateHeaders

Определяет заголовки для операции Roles_create.
RolesCreateOptionalParams

Необязательные параметры.
RolesDeleteHeaders

Определяет заголовки для операции Roles_delete.
RolesDeleteOptionalParams

Необязательные параметры.
RolesGetOptionalParams

Необязательные параметры.
RolesListByClusterOptionalParams

Необязательные параметры.
ServerConfiguration

Представляет конфигурацию.
ServerConfigurationListResult

Список конфигураций сервера.
ServerNameItem

Объект name для сервера.
ServerProperties

Свойства сервера.
ServerRoleGroupConfiguration

Представляет значение конфигурации группы ролей сервера.
Servers

Интерфейс, представляющий серверы.
ServersGetOptionalParams

Необязательные параметры.
ServersListByClusterOptionalParams

Необязательные параметры.
SimplePrivateEndpointConnection

Подключение к частной конечной точке.
SystemData

Метаданные, относящиеся к созданию и последнему изменении ресурса.
TrackedResource

Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением

Псевдонимы типа

ClustersCheckNameAvailabilityResponse

Содержит данные ответа для операции checkNameAvailability.
ClustersCreateResponse

Содержит данные ответа для операции создания.
ClustersGetResponse

Содержит данные ответа для операции получения.
ClustersListByResourceGroupNextResponse

Содержит данные ответа для операции listByResourceGroupNext.
ClustersListByResourceGroupResponse

Содержит данные ответа для операции listByResourceGroup.
ClustersListNextResponse

Содержит данные ответа для операции listNext.
ClustersListResponse

Содержит данные ответа для операции списка.
ClustersPromoteReadReplicaResponse

Содержит данные ответа для операции promoteReadReplica.
ClustersRestartResponse

Содержит данные ответа для операции перезапуска.
ClustersUpdateResponse

Содержит данные ответа для операции обновления.
ConfigurationDataType

Определяет значения для ConfigurationDataType.
KnownConfigurationDataType можно использовать взаимозаменяемо с ConfigurationDataType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

логические
числовой
целочисленного
перечисление

ConfigurationsGetCoordinatorResponse

Содержит данные ответа для операции getCoordinator.
ConfigurationsGetNodeResponse

Содержит данные ответа для операции getNode.
ConfigurationsGetResponse

Содержит данные ответа для операции получения.
ConfigurationsListByClusterNextResponse

Содержит данные ответа для операции listByClusterNext.
ConfigurationsListByClusterResponse

Содержит данные ответа для операции listByCluster.
ConfigurationsListByServerNextResponse

Содержит данные ответа для операции listByServerNext.
ConfigurationsListByServerResponse

Содержит данные ответа для операции listByServer.
ConfigurationsUpdateOnCoordinatorResponse

Содержит данные ответа для операции updateOnCoordinator.
ConfigurationsUpdateOnNodeResponse

Содержит данные ответа для операции updateOnNode.
CreatedByType

Определяет значения для CreatedByType.
KnownCreatedByType можно использовать взаимозаменяемо с CreatedByType, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

user
приложения
ManagedIdentity
ключ

FirewallRulesCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
FirewallRulesDeleteResponse

Содержит данные ответа для операции удаления.
FirewallRulesGetResponse

Содержит данные ответа для операции получения.
FirewallRulesListByClusterResponse

Содержит данные ответа для операции listByCluster.
OperationOrigin

Определяет значения для OperationOrigin.
KnownOperationOrigin можно использовать взаимозаменяемо с OperationOrigin, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

NotSpecified
пользователя
системные
OperationsListResponse

Содержит данные ответа для операции списка.
PrivateEndpointConnectionProvisioningState

Определяет значения для PrivateEndpointConnectionProvisioningState.
KnownPrivateEndpointConnectionProvisioningState можно использовать взаимозаменяемо с PrivateEndpointConnectionProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

успешно выполнено
создание
удаление
Сбой
PrivateEndpointConnectionsCreateOrUpdateResponse

Содержит данные ответа для операции createOrUpdate.
PrivateEndpointConnectionsDeleteResponse

Содержит данные ответа для операции удаления.
PrivateEndpointConnectionsGetResponse

Содержит данные ответа для операции получения.
PrivateEndpointConnectionsListByClusterResponse

Содержит данные ответа для операции listByCluster.
PrivateEndpointServiceConnectionStatus

Определяет значения для PrivateEndpointServiceConnectionStatus.
KnownPrivateEndpointServiceConnectionStatus можно использовать взаимозаменяемо с PrivateEndpointServiceConnectionStatus, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

ожидающих
утвержденные
отклоненные
PrivateLinkResourcesGetResponse

Содержит данные ответа для операции получения.
PrivateLinkResourcesListByClusterResponse

Содержит данные ответа для операции listByCluster.
ProvisioningState

Определяет значения для ProvisioningState.
KnownProvisioningState можно использовать взаимозаменяемо с ProvisioningState, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

успешно выполнено
отменено
InProgress
Сбой
RolesCreateResponse

Содержит данные ответа для операции создания.
RolesDeleteResponse

Содержит данные ответа для операции удаления.
RolesGetResponse

Содержит данные ответа для операции получения.
RolesListByClusterResponse

Содержит данные ответа для операции listByCluster.
ServerRole

Определяет значения для ServerRole.
KnownServerRole можно использовать взаимозаменяемо с ServerRole, этот перечисление содержит известные значения, поддерживаемые службой.

Известные значения, поддерживаемые службой

координатора
рабочей роли
ServersGetResponse

Содержит данные ответа для операции получения.
ServersListByClusterResponse

Содержит данные ответа для операции listByCluster.

Перечисления

KnownConfigurationDataType

Известные значения ConfigurationDataType, которые принимает служба.
KnownCreatedByType

Известные значения CreatedByType, которые принимает служба.
KnownOperationOrigin

Известные значения OperationOrigin, которые служба принимает.
KnownPrivateEndpointConnectionProvisioningState

Известные значения PrivateEndpointConnectionProvisioningState, которые служба принимает.
KnownPrivateEndpointServiceConnectionStatus

Известные значения PrivateEndpointServiceConnectionStatus, которые принимает служба.
KnownProvisioningState

Известные значения ProvisioningState, которые принимает служба.
KnownServerRole

Известные значения ServerRole, которые принимает служба.

Функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

Сведения о функции

getContinuationToken(unknown)

Учитывая последний .value, созданный byPage итератором, возвращает маркер продолжения, который можно использовать для начала разбиения по страницам с этой точки позже.

function getContinuationToken(page: unknown): string | undefined

Параметры

page

unknown

Объект от доступа к value на итераторе IteratorResult из byPage итератора.

Возвращаемое значение

string | undefined

Маркер продолжения, который можно передать в byPage() во время будущих вызовов.