@azure/arm-mongocluster package
インターフェイス
| 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 |
ユーザーの ID プロバイダー定義を定義します。 |
| KeyEncryptionKeyIdentity |
キー暗号化キーに使用される ID。 |
| ListConnectionStringsResult |
指定された mongo クラスターの接続文字列。 |
| ManagedServiceIdentity |
マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) |
| 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 のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました |
| User |
Mongo クラスターユーザーを表します。 |
| UserAssignedIdentity |
ユーザー割り当て ID プロパティ |
| UserProperties |
クラスタ上のMongoユーザーリソースの定義。 |
| UsersCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| UsersDeleteOptionalParams |
省略可能なパラメーター。 |
| UsersGetOptionalParams |
省略可能なパラメーター。 |
| UsersListByMongoClusterOptionalParams |
省略可能なパラメーター。 |
| UsersOperations |
ユーザーの操作を表すインターフェイス。 |
型エイリアス
| ActionType |
拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 サービスでサポートされている既知の値内部: アクションは内部専用 API 用です。 |
| AuthenticationMode |
Mongo クラスターでサポートされている認証モード。 サービスでサポートされている既知の値
NativeAuth: 認証メカニズム「SCRAM-SHA-256」でユーザー名とパスワードを使用するネイティブ mongo 認証モード。 |
| AzureSupportedClouds |
文字列リテラル型としてのクラウド設定でサポートされている値 |
| CheckNameAvailabilityReason |
名前が使用できない原因として考えられます。 サービスでサポートされている既知の値
無効な: 名前が無効です。 |
| ContinuablePage |
結果のページを記述するインターフェイス。 |
| CreateMode |
Mongo クラスターが作成されるモード。 サービスでサポートされている既知の値
デフォルト: 新しい mongo クラスターを作成します。 |
| CreatedByType |
リソースを作成したエンティティの種類。 サービスでサポートされている既知の値
ユーザー: エンティティはユーザーによって作成されました。 |
| DataApiMode |
Mongo Data API に適用するモード。 サービスでサポートされている既知の値
有効: Mongo Data API はクラスターに対して有効になっています。 |
| EntraPrincipalType |
Mongo ユーザーが使用できる Microsoft Entra ID プリンシパルの種類。 サービスでサポートされている既知の値
user: Entra ユーザータイプ。 |
| HighAvailabilityMode |
クラスターの高可用性モード。 サービスでサポートされている既知の値
無効: 高可用性モードは無効です。 このモードは、障害またはメンテナンス中に可用性への影響を確認できるため、本番環境には推奨されません。 |
| IdentityProviderType |
ユーザー ID が属することができる ID プロバイダーの種類。 サービスでサポートされている既知の値MicrosoftEntraID: Microsoft Entra ID プロバイダー。 |
| IdentityProviderUnion |
IdentityProviderUnion のエイリアス |
| KeyEncryptionKeyIdentityType |
キー暗号化キーの ID の種類。 サービスでサポートされている既知の値UserAssignedIdentity: ユーザー割り当て ID。 |
| ManagedServiceIdentityType |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 サービスでサポートされている既知の値
なし: マネージド ID はありません。 |
| MongoClusterStatus |
Mongo クラスター リソースの状態。 サービスでサポートされている既知の値
準備完了: mongo クラスターリソースを使用する準備ができています。 |
| Origin |
操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です サービスでサポートされている既知の値
ユーザー: 操作がユーザーによって開始されたことを示します。 |
| PreviewFeature |
Mongo クラスターで有効にできるプレビュー機能。 サービスでサポートされている既知の値GeoReplicas: geo レプリカのプレビュー機能を有効にします。 この機能は、geo レプリカ クラスターをリンクできるようにするために、新しいクラスターの作成時に設定する必要があります。 |
| PrivateEndpointConnectionProvisioningState |
現在のプロビジョニング状態。 サービスでサポートされている既知の値
成功した: 接続がプロビジョニングされました |
| PrivateEndpointServiceConnectionStatus |
プライベート エンドポイント接続の状態。 サービスでサポートされている既知の値
保留中: 承認または拒否を待機している接続 |
| PromoteMode |
昇格操作に適用するモード。 サービスでサポートされている既知の値スイッチオーバー: 昇格により、現在のレプリカクラスターがプライマリロールに切り替わり、元のプライマリクラスターがレプリカロールに切り替わり、レプリケーションリンクが維持されます。 |
| PromoteOption |
昇格操作に適用するオプション。 サービスでサポートされている既知の値強制: [昇格] オプションは、レプリカがプライマリに追いつくのを待たずに昇格を強制します。 これによりデータが失われる可能性があるため、ディザスター リカバリー シナリオ中にのみ使用してください。 |
| ProvisioningState |
最後に受け入れられた操作のプロビジョニング状態。 サービスでサポートされている既知の値
成功した: リソースが作成されました。 |
| PublicNetworkAccess |
この Mongo クラスターに対してパブリック エンドポイント アクセスが許可されているかどうか。 値は省略可能で、既定値は 'Enabled' です サービスでサポートされている既知の値
有効: 設定すると、mongo クラスターにはプライベートおよびパブリックのメソッドでアクセスできます。 |
| ReplicationRole |
Mongo クラスターのレプリケーション ロール。 サービスでサポートされている既知の値
プライマリ: クラスターはプライマリレプリカです。 |
| ReplicationState |
レプリカとソース クラスターの間のレプリケーション リンクの状態。 サービスでサポートされている既知の値
アクティブ: レプリケーション・リンクがアクティブです。 |
| StorageType |
mongo クラスターをプロビジョニングできるストレージのタイプ。 サービスでサポートされている既知の値
PremiumSSD: 高パフォーマンス ワークロード向けの Premium SSD。 |
| UserRole |
ユーザーに割り当てることができる組み込みのデータベース ロール。 サービスでサポートされている既知の値root: ターゲット スコープに対するルート ロールのアクセス許可。 |
列挙型
| AzureClouds |
Azure クラウド環境を記述する列挙型。 |
| KnownActionType |
拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 |
| KnownAuthenticationMode |
Mongo クラスターでサポートされている認証モード。 |
| KnownCheckNameAvailabilityReason |
名前が使用できない原因として考えられます。 |
| KnownCreateMode |
Mongo クラスターが作成されるモード。 |
| KnownCreatedByType |
リソースを作成したエンティティの種類。 |
| KnownDataApiMode |
Mongo Data API に適用するモード。 |
| KnownEntraPrincipalType |
Mongo ユーザーが使用できる Microsoft Entra ID プリンシパルの種類。 |
| KnownHighAvailabilityMode |
クラスターの高可用性モード。 |
| KnownIdentityProviderType |
ユーザー ID が属することができる ID プロバイダーの種類。 |
| KnownKeyEncryptionKeyIdentityType |
キー暗号化キーの ID の種類。 |
| KnownManagedServiceIdentityType |
マネージド サービス ID の種類 (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 バージョン。 |
関数
| restore |
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。 |
関数の詳細
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>