@azure/arm-mongocluster package

類別

MongoClusterManagementClient

介面

AdministratorProperties	本機系統管理員登入屬性。
AuthConfigProperties	Mongo 叢集的驗證組態。
BackupProperties	叢集的備份屬性。 這包括最早的還原時間和保留設定。
CheckNameAvailabilityRequest	檢查可用性要求本文。
CheckNameAvailabilityResponse	檢查可用性結果。
ComputeProperties	叢集的計算屬性。 這包括虛擬核心/記憶體，以及套用至叢集中伺服器的規模調整選項。
ConnectionString	mongo 叢集的連接字串
CustomerManagedKeyEncryptionProperties	客戶管理的金鑰加密設置。
DataApiProperties	資料 API 屬性。
DatabaseRole	指派給使用者的資料庫角色定義。
EncryptionProperties	mongo 叢集的加密組態。
EntraIdentityProvider	定義 Microsoft Entra ID Mongo 使用者。
EntraIdentityProviderProperties	Microsoft Entra ID 提供者屬性。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	所有 Azure Resource Manager API 的常見錯誤回應，以傳回失敗作業的錯誤詳細數據。
FirewallRule	表示 Mongo 叢集防火牆規則。
FirewallRuleProperties	mongo 叢集防火牆規則的屬性。
FirewallRulesCreateOrUpdateOptionalParams	選擇性參數。
FirewallRulesDeleteOptionalParams	選擇性參數。
FirewallRulesGetOptionalParams	選擇性參數。
FirewallRulesListByMongoClusterOptionalParams	選擇性參數。
FirewallRulesOperations	代表 FirewallRules 作業的介面。
HighAvailabilityProperties	叢集的高可用性屬性。
IdentityProvider	定義使用者的身分識別提供者定義。
KeyEncryptionKeyIdentity	用於金鑰加密金鑰的身分識別。
ListConnectionStringsResult	指定 mongo 叢集的連接字串。
ManagedServiceIdentity	受控服務識別（系統指派和/或使用者指派的身分識別）
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 的資源模型定義已追蹤最上層資源，其具有「標記」和「位置」
User	代表 Mongo 叢集使用者。
UserAssignedIdentity	使用者指派的身分識別屬性
UserProperties	叢集上 Mongo 使用者資源的定義。
UsersCreateOrUpdateOptionalParams	選擇性參數。
UsersDeleteOptionalParams	選擇性參數。
UsersGetOptionalParams	選擇性參數。
UsersListByMongoClusterOptionalParams	選擇性參數。
UsersOperations	代表使用者作業的介面。

類型別名

ActionType	可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。 KnownActionType 可以與 ActionType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 內部：動作適用於僅限內部的 API。
AuthenticationMode	Mongo 叢集支援的驗證模式。 KnownAuthenticationMode 可以與 AuthenticationMode 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 NativeAuth：使用使用者名稱和密碼的原生 mongo 身份驗證模式，並具有身份驗證機制「SCRAM-SHA-256」。 MicrosoftEntraID：使用指派給叢集和驗證機制 'MONGODB-OIDC' 的 Entra 使用者的 Microsoft Entra ID 驗證模式。
AzureSupportedClouds	雲端設定為字串常值類型的支援值
CheckNameAvailabilityReason	名稱無法使用的可能原因。 KnownCheckNameAvailabilityReason 可以與 CheckNameAvailabilityReason 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 無效：名稱無效。 AlreadyExists：名稱已存在。
ContinuablePage	描述結果頁面的介面。
CreateMode	使用 建立 Mongo 叢集的模式。 KnownCreateMode 可以與 CreateMode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 預設值：建立新的mongo叢集。 PointInTimeRestore：從還原時間點建立 mongo 叢集。 GeoReplica：在與來源叢集不同的地理區域中建立複本叢集。 複本：在與來源叢集相同的地理區域中建立複本叢集。
CreatedByType	建立資源的實體種類。 KnownCreatedByType 可以與 CreatedByType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者：實體是由使用者建立的。 應用程式：實體是由應用程式所建立。 ManagedIdentity：實體是由受控識別所建立。 金鑰：實體是由金鑰所建立。
DataApiMode	套用至 Mongo Data API 的模式。 KnownDataApiMode 可以與 DataApiMode 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 已啟用：已為叢集啟用 Mongo Data API。 已停用：叢集已停用 Mongo Data API。
EntraPrincipalType	適用於 Mongo 使用者的 Microsoft Entra ID 主體類型。 KnownEntraPrincipalType 可以與 EntraPrincipalType 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 user：Entra 使用者類型。 servicePrincipal：Entra 服務主體類型。
HighAvailabilityMode	叢集的高可用性模式。 KnownHighAvailabilityMode 可以與 HighAvailabilityMode 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 已停用：已停用高可用性模式。 此模式可以在故障或維護期間看到可用性影響，不建議用於生產環境。 SameZone：已啟用高可用性模式，其中分區中的每部伺服器都放置在相同的可用性區域中。 ZoneRedundantPreferred：如果區域中可用的可用區域容量，則已啟用高可用性模式，並偏好 ZoneRedundant，否則會回復為使用 SameZone 佈建。
IdentityProviderType	使用者身分可以所屬的身分識別提供者類型。 KnownIdentityProviderType 可以與 IdentityProviderType 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 MicrosoftEntraID：Microsoft Entra ID 提供者。
IdentityProviderUnion	IdentityProviderUnion 的別名
KeyEncryptionKeyIdentityType	金鑰加密金鑰的身分類型。 KnownKeyEncryptionKeyIdentityType 可以與 KeyEncryptionKeyIdentityType 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 UserAssignedIdentity：使用者指派的身分識別。
ManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。 KnownManagedServiceIdentityType 可以與 ManagedServiceIdentityType 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 無：沒有受控識別。 SystemAssigned：系統指派的受控識別。 UserAssigned：使用者指派的受控識別。 SystemAssigned，UserAssigned：系統和使用者指派的受控識別。
MongoClusterStatus	Mongo 叢集資源的狀態。 KnownMongoClusterStatus 可與 MongoClusterStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 就緒：mongo 叢集資源已準備好可供使用。 佈建：正在佈建 mongo 叢集資源。 更新中：mongo 叢集資源正在更新中。 啟動中：mongo 叢集資源正在啟動。 正在停止：mongo 叢集資源正在停止。 已停止：mongo 叢集資源已停止。 捨棄：正在捨棄 mongo 叢集資源。
Origin	作業的預期執行程式;如同資源型訪問控制 （RBAC） 和稽核記錄 UX。 默認值為 “user，system” KnownOrigin 可以與 Origin 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 使用者：指出作業是由使用者起始。 系統：表示作業是由系統起始。 使用者、系統：指出作業是由使用者或系統起始。
PreviewFeature	可在 Mongo 叢集上啟用的預覽功能。 KnownPreviewFeature 可以與 PreviewFeature 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 GeoReplicas：啟用 Geo 複本預覽功能。 此功能必須在新叢集的建立時設定，才能將異地複本叢集連結至該叢集。
PrivateEndpointConnectionProvisioningState	目前的布建狀態。 KnownPrivateEndpointConnectionProvisioningState 可以與 PrivateEndpointConnectionProvisioningState 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功：連線已佈建 建立中：正在建立連線 刪除：正在刪除連線 失敗：連線佈建失敗
PrivateEndpointServiceConnectionStatus	私人端點連線狀態。 KnownPrivateEndpointServiceConnectionStatus 可以與 PrivateEndpointServiceConnectionStatus 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 擱置中：連線正在等待核准或拒絕 已核准：連線已核准 已拒絕：連線已拒絕
PromoteMode	要套用至升階作業的模式。 KnownPromoteMode 可以與 PromoteMode 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 切換：升級會將目前的複本叢集切換為主要角色，而原始主要叢集將切換為複本角色，以維護複寫連結。
PromoteOption	套用至升級作業的選項。 KnownPromoteOption 可以與 PromoteOption 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 強制：升級選項會強制升級，而不等待複本趕上主要複本。 這可能會導致資料遺失，因此只能在災難復原案例期間使用。
ProvisioningState	上次接受作業的佈建狀態。 KnownProvisioningState 可以與 ProvisioningState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 成功：已建立資源。 失敗：資源建立失敗。 已取消：已取消資源建立。 InProgress：資源上的作業正在進行中。 更新中：資源上的更新作業正在進行中。 捨棄：資源上的捨棄作業正在進行中。
PublicNetworkAccess	此 Mongo 叢集是否允許公用端點存取。 值為選擇性值，預設值為 'Enabled' KnownPublicNetworkAccess 可以與 PublicNetworkAccess 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 啟用：如果設定，則可以透過私有和公用方法存取mongo叢集。 已停用：如果已設定，私人端點是獨佔存取方法。
ReplicationRole	mongo 叢集的復寫角色。 KnownReplicationRole 可以與 ReplicationRole 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 主要：叢集是主要複本。 AsyncReplica：叢集是本機非同步複本。 GeoAsyncReplica：叢集是異地非同步複本。
ReplicationState	複本與來源叢集之間的復寫鏈接狀態。 KnownReplicationState 可以與 ReplicationState 交替使用，此列舉包含服務支援的已知值。 服務支援的已知值 作用中：抄寫連結處於作用中狀態。 追趕：複本正在趕上主要。 這可能會在建立複本或觸發升級之後發生。 佈建：正在建立主要複本和複寫連結。 更新中：由於複本上的變更或升級，正在更新複寫連結。 中斷：複寫連結已中斷，可能需要重新建立複本。 重新設定：由於升級事件，複製連結正在重新設定。
StorageType	mongo 叢集可佈建的儲存類型。 KnownStorageType 可以與 StorageType 交換使用，此列舉包含服務支援的已知值。 服務支援的已知值 PremiumSSD：適用於高效能工作負載的進階 SSD。 PremiumSSDv2：進階 SSD v2，適用於 IO 密集型工作負載。 這是一個預覽選項，並且有額外的限制。
UserRole	可指派給使用者的內建資料庫角色。 KnownUserRole 可以與 UserRole 互換使用，此列舉包含服務支援的已知值。 服務支援的已知值 root：目標範圍的根角色權限。

列舉

AzureClouds	描述 Azure 雲端環境的列舉。
KnownActionType	可延伸列舉。 表示動作類型。 「內部」是指僅供內部 API 使用的動作。
KnownAuthenticationMode	Mongo 叢集支援的驗證模式。
KnownCheckNameAvailabilityReason	名稱無法使用的可能原因。
KnownCreateMode	使用 建立 Mongo 叢集的模式。
KnownCreatedByType	建立資源的實體種類。
KnownDataApiMode	套用至 Mongo Data API 的模式。
KnownEntraPrincipalType	適用於 Mongo 使用者的 Microsoft Entra ID 主體類型。
KnownHighAvailabilityMode	叢集的高可用性模式。
KnownIdentityProviderType	使用者身分可以所屬的身分識別提供者類型。
KnownKeyEncryptionKeyIdentityType	金鑰加密金鑰的身分類型。
KnownManagedServiceIdentityType	受控服務識別的類型（允許 SystemAssigned 和 UserAssigned 類型）。
KnownMongoClusterStatus	Mongo 叢集資源的狀態。
KnownOrigin	作業的預期執行程式;如同資源型訪問控制 （RBAC） 和稽核記錄 UX。 默認值為 “user，system”
KnownPreviewFeature	可在 Mongo 叢集上啟用的預覽功能。
KnownPrivateEndpointConnectionProvisioningState	目前的布建狀態。
KnownPrivateEndpointServiceConnectionStatus	私人端點連線狀態。
KnownPromoteMode	要套用至升階作業的模式。
KnownPromoteOption	套用至升級作業的選項。
KnownProvisioningState	上次接受作業的佈建狀態。
KnownPublicNetworkAccess	此 Mongo 叢集是否允許公用端點存取。 值是選用的，預設值為「已啟用」
KnownReplicationRole	mongo 叢集的復寫角色。
KnownReplicationState	複本與來源叢集之間的復寫鏈接狀態。
KnownStorageType	mongo 叢集可佈建的儲存類型。
KnownUserRole	可指派給使用者的內建資料庫角色。
KnownVersions	可用的 API 版本。

函式

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>