@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 Resource Manager API 的常見錯誤回應,用於回傳失敗操作的錯誤細節。

FirewallRule

表示叢集防火牆規則。

FirewallRuleProperties

叢集防火牆規則的特性。

FirewallRulesCreateOrUpdateOptionalParams

選擇性參數。

FirewallRulesDeleteOptionalParams

選擇性參數。

FirewallRulesGetOptionalParams

選擇性參數。

FirewallRulesListByClusterOptionalParams

選擇性參數。

FirewallRulesOperations

代表 FirewallRules 作業的介面。

IdentityProperties

描述叢集的身分識別。

MaintenanceWindow

排程一般叢集更新的設定。

NameAvailability

表示叢集名稱可用性。

NameAvailabilityRequest

要求從客戶端檢查叢集名稱可用性。

Operation

從資源提供者作業 API API 傳回的 REST API 作業詳細數據

OperationDisplay

操作的在地顯示資訊。

OperationsListOptionalParams

選擇性參數。

OperationsOperations

代表作業作業的介面。

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 Proxy 資源的資源模型定義。 它不會有標記和位置

Resource

回應中針對所有 Azure Resource Manager 資源傳回的常見欄位

RestorePollerOptions
Role

表示叢集角色。

RoleProperties

叢集角色的性質。

RolePropertiesExternalIdentity

model interface RolePropertiesExternalIdentity

RolesCreateOptionalParams

選擇性參數。

RolesDeleteOptionalParams

選擇性參數。

RolesGetOptionalParams

選擇性參數。

RolesListByClusterOptionalParams

選擇性參數。

RolesOperations

介面代表角色操作。

ServerConfiguration

表示組態。

ServerConfigurationProperties

組態的屬性。

ServerNameItem

伺服器的名稱物件。

ServerProperties

伺服器的特性。

ServerRoleGroupConfiguration

表示伺服器角色群組組態值。

ServersGetOptionalParams

選擇性參數。

ServersListByClusterOptionalParams

選擇性參數。

ServersOperations

介面代表伺服器操作。

SimplePrivateEndpointConnection

私人端點連線。

SystemData

與建立和上次修改資源相關的元數據。

TrackedResource

Azure Resource Manager 的資源模型定義已追蹤最上層資源,其具有「標記」和「位置」

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) 和稽核記錄 UX。 默認值為 “user,system”
KnownOrigin 可以與 Origin 互換使用,此列舉包含服務支援的已知值。

服務支援的已知值

使用者:指出作業是由使用者起始。
系統:表示作業是由系統起始。
使用者、系統:指出作業是由使用者或系統起始。

PasswordAuth

密碼認證類型

PasswordEnabledEnum

指出叢集是使用密碼還是使用 AAD 驗證來建立。
KnownPasswordEnabledEnum 可與 PasswordEnabledEnum 互換使用,該枚舉包含服務支援的已知值。

服務支援的已知值

已啟用
已停用

PrincipalType

主體類型類型

PrivateEndpointConnectionProvisioningState

目前的布建狀態。
KnownPrivateEndpointConnectionProvisioningState 可以與 PrivateEndpointConnectionProvisioningState 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

成功:連線已佈建
建立中:正在建立連線
刪除:正在刪除連線
失敗:連線佈建失敗

PrivateEndpointServiceConnectionStatus

私人端點連線狀態。
KnownPrivateEndpointServiceConnectionStatus 可以與 PrivateEndpointServiceConnectionStatus 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

置中:連線正在等待核准或拒絕
已核准:連線已核准
已拒絕:連線已拒絕

ProvisioningState

目前的布建狀態。
KnownProvisioningState 可以與 ProvisioningState 交替使用,此列舉包含服務支援的已知值。

服務支援的已知值

成功
已取消
InProgress
失敗

RoleType

角色類型

ServerRole

伺服器的角色。
KnownServerRole 可與 ServerRole 互換使用,此枚舉包含服務所支援的已知值。

服務支援的已知值

協調員
工作人員

列舉

AzureClouds

一個用來描述 Azure Cloud 環境的 enum。

KnownAadEnabledEnum

指出是否已使用 AAD 驗證建立叢集。

KnownActionType

可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。

KnownActiveDirectoryAuth

服務接受的已知 ActiveDirectoryAuth 值。

KnownConfigurationDataType

組態的數據類型。

KnownCreatedByType

建立資源的實體種類。

KnownDataEncryptionType

服務接受的 已知 DataEncryptionType 值。

KnownIdentityType

IdentityType 服務的已知值。

KnownOrigin

作業的預期執行程式;如同資源型 存取控制 (RBAC) 和稽核記錄 UX。 默認值為 “user,system”

KnownPasswordAuth

服務接受的已知 PasswordAuth 值。

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>

參數

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

傳回

PollerLike<OperationState<TResult>, TResult>

變數詳細資料

RestError

失敗管線要求的自定義錯誤類型。

RestError: RestErrorConstructor

類型