共用方式為


@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

所有 Azure Resource Manager API 的常見錯誤回應,以傳回失敗作業的錯誤詳細數據。 (這也遵循 OData 錯誤回應格式。)。

FirewallRule

表示叢集防火牆規則。

FirewallRuleListResult

防火牆規則的清單。

FirewallRules

代表 FirewallRules 的介面。

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

Resource

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

Role

表示叢集角色。

RoleListResult

角色清單。

Roles

代表角色的介面。

RolesCreateHeaders

定義Roles_create作業的標頭。

RolesCreateOptionalParams

選擇性參數。

RolesDeleteHeaders

定義Roles_delete作業的標頭。

RolesDeleteOptionalParams

選擇性參數。

RolesGetOptionalParams

選擇性參數。

RolesListByClusterOptionalParams

選擇性參數。

ServerConfiguration

表示組態。

ServerConfigurationListResult

伺服器組態的清單。

ServerNameItem

伺服器的名稱物件。

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 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

使用者
應用程式
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)

假設 byPage 反覆運算器所產生的最後一個 .value,傳回接續令牌,可用來從該點稍後開始分頁。

函式詳細資料

getContinuationToken(unknown)

假設 byPage 反覆運算器所產生的最後一個 .value,傳回接續令牌,可用來從該點稍後開始分頁。

function getContinuationToken(page: unknown): string | undefined

參數

page

unknown

byPage 反覆運算器存取 IteratorResult 上 value 的物件。

傳回

string | undefined

未來呼叫期間可傳遞至 byPage() 的接續令牌。