共用方式為


@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
user
系統

OperationsListResponse

包含清單作業的回應資料。

PrivateEndpointConnectionProvisioningState

定義 PrivateEndpointConnectionProvisioningState 的值。
KnownPrivateEndpointConnectionProvisioningState 可與 PrivateEndpointConnectionProvisioningState 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

已成功
建立中
刪除中
已失敗

PrivateEndpointConnectionsCreateOrUpdateResponse

包含 createOrUpdate 作業的回應資料。

PrivateEndpointConnectionsDeleteResponse

包含刪除作業的回應資料。

PrivateEndpointConnectionsGetResponse

包含取得作業的回應資料。

PrivateEndpointConnectionsListByClusterResponse

包含 listByCluster 作業的回應資料。

PrivateEndpointServiceConnectionStatus

定義 PrivateEndpointServiceConnectionStatus 的值。
KnownPrivateEndpointServiceConnectionStatus 可與 PrivateEndpointServiceConnectionStatus 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

擱置中
已核准
已拒絕

PrivateLinkResourcesGetResponse

包含取得作業的回應資料。

PrivateLinkResourcesListByClusterResponse

包含 listByCluster 作業的回應資料。

ProvisioningState

定義 ProvisioningState 的值。
KnownProvisioningState 可以與 ProvisioningState 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

已成功
Canceled
InProgress
已失敗

RolesCreateResponse

包含建立作業的回應資料。

RolesDeleteResponse

包含刪除作業的回應資料。

RolesGetResponse

包含取得作業的回應資料。

RolesListByClusterResponse

包含 listByCluster 作業的回應資料。

ServerRole

定義 ServerRole 的值。
KnownServerRole 可與 ServerRole 交換使用,此列舉包含服務支援的已知值。

服務支援的已知值

Coordinator
工作者

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 () 的接續權杖。