@azure/arm-postgresqlhsc package

类

接口

AuthConfig	群集的身份验证配置。
Cluster	表示群集。
ClusterForUpdate	表示要更新的群集。
ClusterProperties	群集的属性。
ClusterPropertiesForUpdate	用于更新集群的属性。
ClusterServer	表示群集中的服务器。
ClusterServerProperties	集群中服务器的属性。
ClustersCheckNameAvailabilityOptionalParams	可选参数。
ClustersCreateOptionalParams	可选参数。
ClustersDeleteOptionalParams	可选参数。
ClustersGetOptionalParams	可选参数。
ClustersListByResourceGroupOptionalParams	可选参数。
ClustersListOptionalParams	可选参数。
ClustersOperations	表示 Clusters作的接口。
ClustersPromoteReadReplicaOptionalParams	可选参数。
ClustersRestartOptionalParams	可选参数。
ClustersStartOptionalParams	可选参数。
ClustersStopOptionalParams	可选参数。
ClustersUpdateOptionalParams	可选参数。
Configuration	表示协调器和节点的配置详细信息。
ConfigurationProperties	配置的性质。
ConfigurationsGetCoordinatorOptionalParams	可选参数。
ConfigurationsGetNodeOptionalParams	可选参数。
ConfigurationsGetOptionalParams	可选参数。
ConfigurationsListByClusterOptionalParams	可选参数。
ConfigurationsListByServerOptionalParams	可选参数。
ConfigurationsOperations	表示配置操作的接口。
ConfigurationsUpdateOnCoordinatorOptionalParams	可选参数。
ConfigurationsUpdateOnNodeOptionalParams	可选参数。
DBforPostgreSQLClientOptionalParams	客户端的可选参数。
DataEncryption	群集的数据加密属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详情
ErrorResponse	所有 Azure 资源管理器 API 的通用错误响应，用于返回失败操作的错误细节。
FirewallRule	表示群集防火墙规则。
FirewallRuleProperties	集群防火墙规则的属性。
FirewallRulesCreateOrUpdateOptionalParams	可选参数。
FirewallRulesDeleteOptionalParams	可选参数。
FirewallRulesGetOptionalParams	可选参数。
FirewallRulesListByClusterOptionalParams	可选参数。
FirewallRulesOperations	表示 FirewallRules作的接口。
IdentityProperties	描述群集的标识。
MaintenanceWindow	计划常规群集更新的设置。
NameAvailability	表示群集名称可用性。
NameAvailabilityRequest	从客户端请求检查群集名称可用性。
Operation	从资源提供程序操作 API 返回的 REST API 操作的详细信息
OperationDisplay	作的局部显示信息。
OperationsListOptionalParams	可选参数。
OperationsOperations	表示作作的接口。
PageSettings	byPage 方法的选项
PagedAsyncIterableIterator	允许异步迭代到完成和逐页迭代的接口。
PrivateEndpoint	专用终结点资源。
PrivateEndpointConnection	私有端点连接资源
PrivateEndpointConnectionProperties	专用终结点连接的属性。
PrivateEndpointConnectionSimpleProperties	私有端点连接中的属性
PrivateEndpointConnectionsCreateOrUpdateOptionalParams	可选参数。
PrivateEndpointConnectionsDeleteOptionalParams	可选参数。
PrivateEndpointConnectionsGetOptionalParams	可选参数。
PrivateEndpointConnectionsListByClusterOptionalParams	可选参数。
PrivateEndpointConnectionsOperations	表示 PrivateEndpointConnections 操作的接口。
PrivateEndpointProperty	表示专用终结点的资源 ID 的属性。
PrivateLinkResource	专用链接资源。
PrivateLinkResourceProperties	专用链接资源的属性。
PrivateLinkResourcesGetOptionalParams	可选参数。
PrivateLinkResourcesListByClusterOptionalParams	可选参数。
PrivateLinkResourcesOperations	表示 PrivateLinkResources作的接口。
PrivateLinkServiceConnectionState	有关服务使用者与提供程序之间的连接状态的信息集合。
PromoteRequest	从客户端请求提升异地冗余副本
ProxyResource	Azure 资源管理器代理资源的资源模型定义。它不具有标记和位置
Resource	所有 Azure 资源管理器资源的响应中返回的常见字段
RestorePollerOptions
Role	表示群集角色。
RoleProperties	集群角色的属性。
RolePropertiesExternalIdentity	model interface RolePropertiesExternalIdentity
RolesCreateOptionalParams	可选参数。
RolesDeleteOptionalParams	可选参数。
RolesGetOptionalParams	可选参数。
RolesListByClusterOptionalParams	可选参数。
RolesOperations	表示角色操作的接口。
ServerConfiguration	表示配置。
ServerConfigurationProperties	配置的属性。
ServerNameItem	服务器的名称对象。
ServerProperties	服务器的属性。
ServerRoleGroupConfiguration	表示服务器角色组配置值。
ServersGetOptionalParams	可选参数。
ServersListByClusterOptionalParams	可选参数。
ServersOperations	表示服务器操作的接口。
SimplePrivateEndpointConnection	专用终结点连接。
SystemData	与创建和上次修改资源相关的元数据。
TrackedResource	Azure 资源管理器的资源模型定义跟踪了具有“标记”和“位置”的顶级资源
UserAssignedIdentity	用户分配的标识属性

类型别名

AadEnabledEnum	指示是否已使用 AAD 身份验证创建群集。 KnownAadEnabledEnum 可以与 AadEnabledEnum 互换使用，该枚举包含服务支持的已知值。服务支持的已知值启用禁用
ActionType	可扩展枚举。指示操作类型。 “内部”是指仅适用于内部 API 的操作。 KnownActionType 可与 ActionType 互换使用，此枚举包含服务支持的已知值。服务支持的已知值内部：操作适用于仅限内部的 API。
ActiveDirectoryAuth	ActiveDirectoryAuth 的类型
AzureSupportedClouds	云设置为字符串文字类型的支持值
CheckNameAvailabilityResourceType	用于名称可用性验证的资源类型。
ConfigurationDataType	配置的数据类型。 KnownConfigurationDataType 可与 ConfigurationDataType 互换使用，此枚举包含服务支持的已知值。服务支持的已知值布尔值 Numeric 整数枚举
ContinuablePage	描述结果页的接口。
CreatedByType	创建资源的实体类型。 KnownCreatedByType 可与 CreatedByType 互换使用，此枚举包含服务支持的已知值。服务支持的已知值用户：实体是由用户创建的。应用程序：实体是由应用程序创建的。 ManagedIdentity：实体是由托管标识创建的。密钥：实体是由密钥创建的。
DataEncryptionType	数据加密类型类型
IdentityType	身份类型类型
Origin	操作的预期执行者；例如在基于资源的访问控制（RBAC）和审核日志的用户体验中。默认值为“user，system” KnownOrigin 可与 Origin 互换使用，此枚举包含服务支持的已知值。服务支持的已知值用户：指示操作是由用户启动的。系统：指示操作是由系统启动的。用户，系统：指示操作是由用户或系统启动的。
PasswordAuth	密码认证类型
PasswordEnabledEnum	指示是使用密码还是使用 AAD 身份验证创建群集。 KnownPasswordEnabledEnum 可以与 PasswordEnabledEnum 互换使用，该枚举包含服务支持的已知值。服务支持的已知值启用禁用
PrincipalType	主体类型类型
PrivateEndpointConnectionProvisioningState	当前预配状态。 KnownPrivateEndpointConnectionProvisioningState 可与 PrivateEndpointConnectionProvisioningState 互换使用，此枚举包含服务支持的已知值。服务支持的已知值已成功：已预配连接创建：正在创建连接删除：正在删除连接失败：连接预配失败
PrivateEndpointServiceConnectionStatus	专用终结点连接状态。 KnownPrivateEndpointServiceConnectionStatus 可与 PrivateEndpointServiceConnectionStatus 互换使用，此枚举包含服务支持的已知值。服务支持的已知值待处理：连接正在等待批准或拒绝已批准：已批准连接拒绝：连接被拒绝
ProvisioningState	当前预配状态。 KnownProvisioningState 可与 ProvisioningState 互换，此枚举包含服务支持的已知值。服务支持的已知值成功 Canceled InProgress Failed
RoleType	角色类型类型
ServerRole	服务器的角色。 KnownServerRole 可以与 ServerRole 互换使用，该枚举包含服务支持的已知值。服务支持的已知值协调员工作线程

枚举

AzureClouds	一个用来描述Azure云环境的enum。
KnownAadEnabledEnum	指示是否已使用 AAD 身份验证创建群集。
KnownActionType	可扩展枚举。指示操作类型。 “内部”是指仅适用于内部 API 的操作。
KnownActiveDirectoryAuth	服务接受的已知 ActiveDirectoryAuth 值。
KnownConfigurationDataType	配置的数据类型。
KnownCreatedByType	创建资源的实体类型。
KnownDataEncryptionType	服务接受的已知DataEncryptionType 值。
KnownIdentityType	IdentityType 服务的已知值。
KnownOrigin	操作的预期执行者；例如在基于资源的访问控制（RBAC）和审核日志的用户体验中。默认值为“user，system”
KnownPasswordAuth	服务接受的已知密码认证值。
KnownPasswordEnabledEnum	指示是使用密码还是使用 AAD 身份验证创建群集。
KnownPrincipalType	服务的 PrincipalType 的已知值。
KnownPrivateEndpointConnectionProvisioningState	当前预配状态。
KnownPrivateEndpointServiceConnectionStatus	专用终结点连接状态。
KnownProvisioningState	当前预配状态。
KnownRoleType	服务接受的已知 RoleType 值。
KnownServerRole	服务器的角色。
KnownVersions	可用的 API 版本。

函数

isRestError(unknown)	RestError 的 Typeguard
restorePoller<TResponse, TResult>(DBforPostgreSQLClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	从另一个轮询器的序列化状态创建轮询器。当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时，这会很有用。

变量

RestError

失败管道请求的自定义错误类型。

isRestError(unknown)

RestError 的 Typeguard

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

类型

RestErrorConstructor

@azure/arm-postgresqlhsc package

类

接口

类型别名

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

服务支持的已知值

枚举

函数

变量

函数详细信息

isRestError(unknown)

参数

返回

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

参数

返回

变量详细信息

RestError

类型

反馈