@azure/arm-mongocluster package

類別

MongoClusterManagementClient

介面

AdministratorProperties	本機系統管理員登入屬性。
BackupProperties	叢集的備份屬性。 這包括最早的還原時間和保留設定。
CheckNameAvailabilityRequest	檢查可用性要求本文。
CheckNameAvailabilityResponse	檢查可用性結果。
ComputeProperties	叢集的計算屬性。 這包括虛擬核心/記憶體，以及套用至叢集中伺服器的規模調整選項。
ConnectionString	mongo 叢集的連接字串
FirewallRule	表示 Mongo 叢集防火牆規則。
FirewallRuleProperties	mongo 叢集防火牆規則的屬性。
FirewallRulesCreateOrUpdateOptionalParams	選擇性參數。
FirewallRulesDeleteOptionalParams	選擇性參數。
FirewallRulesGetOptionalParams	選擇性參數。
FirewallRulesListByMongoClusterOptionalParams	選擇性參數。
FirewallRulesOperations	代表 FirewallRules 作業的介面。
HighAvailabilityProperties	叢集的高可用性屬性。
ListConnectionStringsResult	指定 mongo 叢集的連接字串。
MongoCluster	表示 Mongo 叢集資源。
MongoClusterManagementClientOptionalParams	用戶端的選擇性參數。
MongoClusterProperties	mongo 叢集的屬性。
MongoClusterReplicaParameters	用於複本作業的參數。
MongoClusterRestoreParameters	用於還原作業的參數
MongoClusterUpdate	用於 MongoCluster 更新作業的類型。
MongoClusterUpdateProperties	MongoCluster 的可更新屬性。
MongoClustersCheckNameAvailabilityOptionalParams	選擇性參數。
MongoClustersCreateOrUpdateOptionalParams	選擇性參數。
MongoClustersDeleteOptionalParams	選擇性參數。
MongoClustersGetOptionalParams	選擇性參數。
MongoClustersListByResourceGroupOptionalParams	選擇性參數。
MongoClustersListConnectionStringsOptionalParams	選擇性參數。
MongoClustersListOptionalParams	選擇性參數。
MongoClustersOperations	表示 MongoClusters 作業的介面。
MongoClustersPromoteOptionalParams	選擇性參數。
MongoClustersUpdateOptionalParams	選擇性參數。
Operation	從資源提供者作業 API API 傳回的 REST API 作業詳細數據
OperationDisplay	和作業的當地語系化顯示資訊。
OperationsListOptionalParams	選擇性參數。
OperationsOperations	表示作業作業的介面。
PageSettings	byPage 方法的選項
PagedAsyncIterableIterator	介面，可讓異步反覆運算同時完成和逐頁執行。
PrivateEndpoint	私人端點資源。
PrivateEndpointConnection	私人端點聯機資源
PrivateEndpointConnectionProperties	私人端點連線的屬性。
PrivateEndpointConnectionResource	您可以使用特定屬性類型來建立具象 Proxy 資源類型。
PrivateEndpointConnectionsCreateOptionalParams	選擇性參數。
PrivateEndpointConnectionsDeleteOptionalParams	選擇性參數。
PrivateEndpointConnectionsGetOptionalParams	選擇性參數。
PrivateEndpointConnectionsListByMongoClusterOptionalParams	選擇性參數。
PrivateEndpointConnectionsOperations	表示 PrivateEndpointConnections 作業的介面。
PrivateLinkResource	您可以使用特定屬性類型來建立具象 Proxy 資源類型。
PrivateLinkResourceProperties	私人鏈接資源的屬性。
PrivateLinkServiceConnectionState	服務取用者與提供者之間連線狀態的相關信息集合。
PrivateLinksListByMongoClusterOptionalParams	選擇性參數。
PrivateLinksOperations	表示 PrivateLinks 作業的介面。
PromoteReplicaRequest	升級複本要求屬性。
ProxyResource	Azure Resource Manager Proxy 資源的資源模型定義。 它不會有標記和位置
Replica	表示 Mongo 叢集複本。
ReplicasListByParentOptionalParams	選擇性參數。
ReplicasOperations	表示複本作業的介面。
ReplicationProperties	Mongo 叢集的複本屬性。
Resource	回應中針對所有 Azure Resource Manager 資源傳回的常見欄位
RestorePollerOptions
ShardingProperties	叢集的分區化屬性。 這包括叢集的分區計數和調整選項。
StorageProperties	叢集的記憶體屬性。 這包括套用至叢集中伺服器的數據記憶體大小和調整。
SystemData	與建立和上次修改資源相關的元數據。
TrackedResource	Azure Resource Manager 的資源模型定義已追蹤最上層資源，其具有「標記」和「位置」

類型別名

ActionType	可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。 KnownActionType 可以與 ActionType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 內部
CheckNameAvailabilityReason	名稱無法使用的可能原因。 KnownCheckNameAvailabilityReason 可以與 CheckNameAvailabilityReason 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 無效的 已存在
ContinuablePage	描述結果頁面的介面。
CreateMode	使用 建立 Mongo 叢集的模式。 KnownCreateMode 可以與 CreateMode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 預設 PointInTimeRestore GeoReplica 複本
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者 應用程式 ManagedIdentity 金鑰
HighAvailabilityMode	叢集的高可用性模式。 KnownHighAvailabilityMode 可以與 HighAvailabilityMode 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 停用 SameZone ZoneRedundantPreferred
MongoClusterStatus	Mongo 叢集資源的狀態。 KnownMongoClusterStatus 可與 MongoClusterStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 就緒 布建 更新 開始 停止 已停止 捨棄
Origin	作業的預期執行程式;如同資源型訪問控制 （RBAC） 和稽核記錄 UX。 默認值為 “user，system” KnownOrigin 可以與 Origin 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者 系統 用戶，系統
PreviewFeature	可在 Mongo 叢集上啟用的預覽功能。 KnownPreviewFeature 可以與 PreviewFeature 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 GeoReplicas
PrivateEndpointConnectionProvisioningState	目前的布建狀態。 KnownPrivateEndpointConnectionProvisioningState 可以與 PrivateEndpointConnectionProvisioningState 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功 建立 刪除 失敗
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。 KnownPrivateEndpointServiceConnectionStatus 可以與 PrivateEndpointServiceConnectionStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 暫止 已核准 拒絕
PromoteMode	要套用至升階作業的模式。 KnownPromoteMode 可以與 PromoteMode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 切換
PromoteOption	套用至升級作業的選項。 KnownPromoteOption 可以與 PromoteOption 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 強制
ProvisioningState	資源類型的布建狀態。 KnownProvisioningState 可以與 ResourceProvisioningState 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功 失敗 已取消 InProgress 更新 捨棄
PublicNetworkAccess	此 Mongo 叢集是否允許公用端點存取。 值為選擇性值，預設值為 'Enabled' KnownPublicNetworkAccess 可以與 PublicNetworkAccess 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 已啟用 停用
ReplicationRole	mongo 叢集的復寫角色。 KnownReplicationRole 可以與 ReplicationRole 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 主要 AsyncReplica GeoAsyncReplica
ReplicationState	複本與來源叢集之間的復寫鏈接狀態。 KnownReplicationState 可以與 ReplicationState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 Active catchup 布建 更新 中斷 重新設定

列舉

KnownActionType	服務接受的已知 ActionType 值。
KnownCheckNameAvailabilityReason	服務的已知值 CheckNameAvailabilityReason。
KnownCreateMode	服務的已知值 CreateMode。
KnownCreatedByType	服務接受的 CreatedByType 已知值。
KnownHighAvailabilityMode	HighAvailabilityMode 服務的已知值。
KnownMongoClusterStatus	MongoClusterStatus 服務接受的已知值。
KnownOrigin	服務的已知 Origin 值。
KnownPreviewFeature	PreviewFeature 服務的已知值。
KnownPrivateEndpointConnectionProvisioningState	PrivateEndpointConnectionProvisioningState 服務的已知值。
KnownPrivateEndpointServiceConnectionStatus	PrivateEndpointServiceConnectionStatus 服務的已知值。
KnownPromoteMode	服務接受 PromoteMode 的已知值。
KnownPromoteOption	服務接受的 PromoteOption 已知值。
KnownProvisioningState	服務接受的 ProvisioningState 已知值。
KnownPublicNetworkAccess	服務的已知值 PublicNetworkAccess。
KnownReplicationRole	ReplicationRole 服務的已知值。
KnownReplicationState	服務的已知值 ReplicationState。

函式

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

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

函式詳細資料

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

從另一個輪詢程式的串行化狀態建立輪詢器。 當您想要在不同的主機上建立輪詢器，或在原始輪詢器不在範圍內之後建構投票器時，這非常有用。

function restorePoller<TResponse, TResult>(client: MongoClusterManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

參數

client

MongoClusterManagementClient

serializedState

string

sourceOperation

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

options

RestorePollerOptions<TResult, PathUncheckedResponse>

傳回

PollerLike<OperationState<TResult>, TResult>