@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 から返される REST API 操作の詳細
OperationDisplay	ローカライズされた表示情報と操作。
OperationsListOptionalParams	省略可能なパラメーター。
OperationsOperations	操作操作を表すインターフェイス。
PageSettings	byPage メソッドのオプション
PagedAsyncIterableIterator	完了とページごとの非同期反復を可能にするインターフェイス。
PrivateEndpoint	プライベート エンドポイント リソース。
PrivateEndpointConnection	プライベート エンドポイント接続リソース
PrivateEndpointConnectionProperties	プライベート エンドポイント接続のプロパティ。
PrivateEndpointConnectionResource	具体的なプロキシ リソースの種類は、特定のプロパティ型を使用してこの型にエイリアスを設定することで作成できます。
PrivateEndpointConnectionsCreateOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsDeleteOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsGetOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsListByMongoClusterOptionalParams	省略可能なパラメーター。
PrivateEndpointConnectionsOperations	PrivateEndpointConnections 操作を表すインターフェイス。
PrivateLinkResource	具体的なプロキシ リソースの種類は、特定のプロパティ型を使用してこの型にエイリアスを設定することで作成できます。
PrivateLinkResourceProperties	プライベート リンク リソースのプロパティ。
PrivateLinkServiceConnectionState	サービス コンシューマーとプロバイダー間の接続の状態に関する情報のコレクション。
PrivateLinksListByMongoClusterOptionalParams	省略可能なパラメーター。
PrivateLinksOperations	PrivateLinks 操作を表すインターフェイス。
PromoteReplicaRequest	レプリカ要求のプロパティを昇格します。
ProxyResource	Azure Resource Manager プロキシ リソースのリソース モデル定義。 タグと場所はありません
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 と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 無効な AlreadyExists を する
ContinuablePage	結果のページを記述するインターフェイス。
CreateMode	Mongo クラスターが作成されるモード。 KnownCreateMode を CreateMode と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 既定の を する PointInTimeRestore GeoReplica レプリカ
CreatedByType	リソースを作成したエンティティの種類。 KnownCreatedByType を CreatedByType と同じ意味で使用できる、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 ユーザー アプリケーション ManagedIdentity キーの
HighAvailabilityMode	クラスターの高可用性モード。 KnownHighAvailabilityMode HighAvailabilityMode と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Disabled 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 と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 Enabled Disabled
ReplicationRole	Mongo クラスターのレプリケーション ロール。 KnownReplicationRole ReplicationRole と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 プライマリ の AsyncReplica の geoAsyncReplica の
ReplicationState	レプリカとソース クラスターの間のレプリケーション リンクの状態。 KnownReplicationState ReplicationState と同じ意味で使用できますが、この列挙型には、サービスがサポートする既知の値が含まれています。 サービスでサポートされている既知の値 アクティブな の キャッチアップ プロビジョニング 更新 壊れた 再構成

列挙型

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>