@azure/arm-postgresqlhsc package
Классы
| DBforPostgreSQLClient |
Интерфейсы
| AuthConfig |
Конфигурация проверки подлинности кластера. |
| Cluster |
Представляет кластер. |
| ClusterForUpdate |
Представляет кластер для обновления. |
| ClusterProperties |
Свойства кластера. |
| ClusterPropertiesForUpdate |
Свойства, используемые для обновления кластера. |
| ClusterServer |
Представляет сервер в кластере. |
| ClusterServerProperties |
Свойства сервера в кластере. |
| ClustersCheckNameAvailabilityOptionalParams |
Необязательные параметры. |
| ClustersCreateOptionalParams |
Необязательные параметры. |
| ClustersDeleteOptionalParams |
Необязательные параметры. |
| ClustersGetOptionalParams |
Необязательные параметры. |
| ClustersListByResourceGroupOptionalParams |
Необязательные параметры. |
| ClustersListOptionalParams |
Необязательные параметры. |
| ClustersOperations |
Интерфейс, представляющий собой кластерные операции. |
| ClustersPromoteReadReplicaOptionalParams |
Необязательные параметры. |
| ClustersRestartOptionalParams |
Необязательные параметры. |
| ClustersStartOptionalParams |
Необязательные параметры. |
| ClustersStopOptionalParams |
Необязательные параметры. |
| ClustersUpdateOptionalParams |
Необязательные параметры. |
| Configuration |
Представляет сведения о конфигурации для координатора и узла. |
| ConfigurationProperties |
Свойства конфигурации. |
| ConfigurationsGetCoordinatorOptionalParams |
Необязательные параметры. |
| ConfigurationsGetNodeOptionalParams |
Необязательные параметры. |
| ConfigurationsGetOptionalParams |
Необязательные параметры. |
| ConfigurationsListByClusterOptionalParams |
Необязательные параметры. |
| ConfigurationsListByServerOptionalParams |
Необязательные параметры. |
| ConfigurationsOperations |
Интерфейс, представляющий операции конфигурации. |
| ConfigurationsUpdateOnCoordinatorOptionalParams |
Необязательные параметры. |
| ConfigurationsUpdateOnNodeOptionalParams |
Необязательные параметры. |
| DBforPostgreSQLClientOptionalParams |
Необязательные параметры для клиента. |
| DataEncryption |
Свойства шифрования данных кластера. |
| ErrorAdditionalInfo |
Дополнительные сведения об ошибке управления ресурсами. |
| ErrorDetail |
Подробности ошибки. |
| ErrorResponse |
Обычный ответ на ошибку для всех API Azure Resource Manager для возврата деталей ошибок при неудачных операциях. |
| FirewallRule |
Представляет правило брандмауэра кластера. |
| FirewallRuleProperties |
Свойства кластерного межсетевого экрана. |
| FirewallRulesCreateOrUpdateOptionalParams |
Необязательные параметры. |
| FirewallRulesDeleteOptionalParams |
Необязательные параметры. |
| FirewallRulesGetOptionalParams |
Необязательные параметры. |
| FirewallRulesListByClusterOptionalParams |
Необязательные параметры. |
| FirewallRulesOperations |
Интерфейс, представляющий операции FirewallRules. |
| IdentityProperties |
Описывает удостоверение кластера. |
| MaintenanceWindow |
Планирование параметров для регулярных обновлений кластера. |
| NameAvailability |
Представляет доступность имени кластера. |
| NameAvailabilityRequest |
Запрос от клиента для проверки доступности имени кластера. |
| Operation |
Сведения об операции REST API, возвращаемой из API операций поставщика ресурсов |
| OperationDisplay |
Локализованная информация для отображения операции. |
| OperationsListOptionalParams |
Необязательные параметры. |
| OperationsOperations |
Интерфейс, представляющий операции Operations. |
| PageSettings |
Параметры метода byPage |
| PagedAsyncIterableIterator |
Интерфейс, позволяющий асинхронно итерации выполнять итерацию как по страницам, так и по страницам. |
| PrivateEndpoint |
Ресурс частной конечной точки. |
| PrivateEndpointConnection |
Частный ресурс соединения для конечных точек |
| PrivateEndpointConnectionProperties |
Свойства подключения частной конечной точки. |
| PrivateEndpointConnectionSimpleProperties |
Объекты в частном конечном соединении |
| PrivateEndpointConnectionsCreateOrUpdateOptionalParams |
Необязательные параметры. |
| PrivateEndpointConnectionsDeleteOptionalParams |
Необязательные параметры. |
| PrivateEndpointConnectionsGetOptionalParams |
Необязательные параметры. |
| PrivateEndpointConnectionsListByClusterOptionalParams |
Необязательные параметры. |
| PrivateEndpointConnectionsOperations |
Интерфейс, представляющий операции PrivateEndpointConnections. |
| PrivateEndpointProperty |
Свойство для представления идентификатора ресурса частной конечной точки. |
| PrivateLinkResource |
Ресурс приватного канала. |
| PrivateLinkResourceProperties |
Свойства ресурса приватного канала. |
| PrivateLinkResourcesGetOptionalParams |
Необязательные параметры. |
| PrivateLinkResourcesListByClusterOptionalParams |
Необязательные параметры. |
| PrivateLinkResourcesOperations |
Интерфейс, представляющий операции PrivateLinkResources. |
| PrivateLinkServiceConnectionState |
Коллекция сведений о состоянии подключения между потребителем службы и поставщиком. |
| PromoteRequest |
Запрос от клиента для повышения геоизбыточного реплики |
| ProxyResource |
Определение модели ресурсов для ресурса прокси-сервера Azure Resource Manager. У него не будут теги и расположение |
| Resource |
Общие поля, возвращаемые в ответе для всех ресурсов Azure Resource Manager |
| RestorePollerOptions | |
| Role |
Представляет роль кластера. |
| RoleProperties |
Свойства роли кластера. |
| RolePropertiesExternalIdentity |
интерфейс модели RolePropertiesExternalIdentity |
| RolesCreateOptionalParams |
Необязательные параметры. |
| RolesDeleteOptionalParams |
Необязательные параметры. |
| RolesGetOptionalParams |
Необязательные параметры. |
| RolesListByClusterOptionalParams |
Необязательные параметры. |
| RolesOperations |
Интерфейс, представляющий операции ролей. |
| ServerConfiguration |
Представляет конфигурацию. |
| ServerConfigurationProperties |
Свойства конфигурации. |
| ServerNameItem |
Объект name для сервера. |
| ServerProperties |
Свойства сервера. |
| ServerRoleGroupConfiguration |
Представляет значение конфигурации группы ролей сервера. |
| ServersGetOptionalParams |
Необязательные параметры. |
| ServersListByClusterOptionalParams |
Необязательные параметры. |
| ServersOperations |
Интерфейс, представляющий операции сервера. |
| SimplePrivateEndpointConnection |
Подключение к частной конечной точке. |
| SystemData |
Метаданные, относящиеся к созданию и последнему изменении ресурса. |
| TrackedResource |
Определение модели ресурсов для отслеживаемого ресурса Azure Resource Manager с тегами верхнего уровня и расположением |
| UserAssignedIdentity |
Свойства назначаемого пользователем удостоверения |
Псевдонимы типа
| AadEnabledEnum |
Указывает, был ли кластер создан с помощью проверки подлинности AAD. Известные значения, поддерживаемые службой
включена |
| ActionType |
Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API. Известные значения, поддерживаемые службойвнутренних: действия предназначены для внутренних API. |
| ActiveDirectoryAuth |
Тип ActiveDirectoryAuth |
| AzureSupportedClouds |
Поддерживаемые значения для настройки облака в виде строкового литерала |
| CheckNameAvailabilityResourceType |
Тип ресурса, используемый для проверки доступности имени. |
| ConfigurationDataType |
Тип данных конфигурации. Известные значения, поддерживаемые службой
Boolean |
| ContinuablePage |
Интерфейс, описывающий страницу результатов. |
| CreatedByType |
Тип сущности, создающей ресурс. Известные значения, поддерживаемые службой
user: сущность была создана пользователем. |
| DataEncryptionType |
Тип шифрования данных |
| IdentityType |
Тип идентичностиТип |
| Origin |
Предполагаемый исполнитель операции; например, в интерфейсах управления доступом на основе ресурсов (RBAC) и журналов аудита. Значение по умолчанию — user, system Известные значения, поддерживаемые службой
пользователя. Указывает, что операция инициируется пользователем. |
| PasswordAuth |
Тип пароляАутентификация |
| PasswordEnabledEnum |
Указывает, был ли кластер создан паролем или с помощью проверки подлинности AAD. Известные значения, поддерживаемые службой
включена |
| PrincipalType |
Тип principalType |
| PrivateEndpointConnectionProvisioningState |
Текущее состояние подготовки. Известные значения, поддерживаемые службой
Успешно: подключение подготовлено |
| PrivateEndpointServiceConnectionStatus |
Состояние подключения к частной конечной точке. Известные значения, поддерживаемые службой
В ожидании: подключение ожидает подтверждения или отклонения |
| ProvisioningState |
Текущее состояние подготовки. Известные значения, поддерживаемые службой
Успешно |
| RoleType |
Тип ролиТип |
| ServerRole |
Роль сервера. Известные значения, поддерживаемые службой
Координатор |
Перечисления
| AzureClouds |
Enum для описания среды Azure Cloud. |
| KnownAadEnabledEnum |
Указывает, был ли кластер создан с помощью проверки подлинности AAD. |
| KnownActionType |
Расширяемый перечисление. Указывает тип действия. "Внутренний" относится к действиям, которые предназначены только для внутренних API. |
| KnownActiveDirectoryAuth |
Известные значения ActiveDirectoryAuth , которые сервис принимает. |
| KnownConfigurationDataType |
Тип данных конфигурации. |
| KnownCreatedByType |
Тип сущности, создающей ресурс. |
| KnownDataEncryptionType |
Известные значения DataEncryptionType , которые сервис принимает. |
| KnownIdentityType |
Известные значения IdentityType, которые принимает служба. |
| KnownOrigin |
Предполагаемый исполнитель операции; например, в интерфейсах управления доступом на основе ресурсов (RBAC) и журналов аудита. Значение по умолчанию — user, system |
| KnownPasswordAuth |
Известные значения PasswordAuth , которые сервис принимает. |
| KnownPasswordEnabledEnum |
Указывает, был ли кластер создан паролем или с помощью проверки подлинности AAD. |
| KnownPrincipalType |
Известные значения PrincipalType, которые принимает служба. |
| KnownPrivateEndpointConnectionProvisioningState |
Текущее состояние подготовки. |
| KnownPrivateEndpointServiceConnectionStatus |
Состояние подключения к частной конечной точке. |
| KnownProvisioningState |
Текущее состояние подготовки. |
| KnownRoleType |
Известные значения RoleType , которые сервис принимает. |
| KnownServerRole |
Роль сервера. |
| KnownVersions |
Доступные версии API. |
Функции
| is |
Typeguard для RestError |
| restore |
Создает поллер из сериализованного состояния другого поллера. Это может быть полезно, когда вы хотите создать поллеры на другом узле или если поллер должен быть создан после того, как исходный поллер не находится в области видимости. |
Переменные
| Rest |
Настраиваемый тип ошибки для неудачных запросов конвейера. |
Сведения о функции
isRestError(unknown)
Typeguard для RestError
function isRestError(e: unknown): e
Параметры
- e
-
unknown
Что-то поймано предложением catch.
Возвращаемое значение
e
restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
Создает поллер из сериализованного состояния другого поллера. Это может быть полезно, когда вы хотите создать поллеры на другом узле или если поллер должен быть создан после того, как исходный поллер не находится в области видимости.
function restorePoller<TResponse, TResult>(client: DBforPostgreSQLClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
Параметры
- client
- DBforPostgreSQLClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
Возвращаемое значение
PollerLike<OperationState<TResult>, TResult>
Сведения об переменной
RestError
Настраиваемый тип ошибки для неудачных запросов конвейера.
RestError: RestErrorConstructor