@azure/arm-mongodbatlas package
クラス
| AtlasClient |
インターフェイス
| AtlasClientOptionalParams |
クライアントの省略可能なパラメーター。 |
| ErrorAdditionalInfo |
リソース管理エラーの追加情報。 |
| ErrorDetail |
エラーの詳細。 |
| ErrorResponse |
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 |
| ManagedServiceIdentity |
マネージド サービス ID (システム割り当て ID またはユーザー割り当て ID) |
| MarketplaceDetails |
組織の Marketplace の詳細 |
| OfferDetails |
ユーザーが選択したマーケットプレースのオファーの詳細 |
| Operation |
リソース プロバイダー操作 API から返される REST API 操作の詳細 |
| OperationDisplay |
ローカライズされた表示情報と操作。 |
| OperationsListOptionalParams |
省略可能なパラメーター。 |
| OperationsOperations |
操作操作を表すインターフェイス。 |
| OrganizationProperties |
組織に固有のプロパティ |
| OrganizationResource |
Azure 組織のリソース モデル定義 |
| OrganizationResourceUpdate |
OrganizationResource の更新操作に使用される型。 |
| OrganizationResourceUpdateProperties |
OrganizationResource の更新可能なプロパティ。 |
| OrganizationsCreateOrUpdateOptionalParams |
省略可能なパラメーター。 |
| OrganizationsDeleteOptionalParams |
省略可能なパラメーター。 |
| OrganizationsGetOptionalParams |
省略可能なパラメーター。 |
| OrganizationsListByResourceGroupOptionalParams |
省略可能なパラメーター。 |
| OrganizationsListBySubscriptionOptionalParams |
省略可能なパラメーター。 |
| OrganizationsOperations |
組織の操作を表すインターフェイス。 |
| OrganizationsUpdateOptionalParams |
省略可能なパラメーター。 |
| PageSettings |
byPage メソッドのオプション |
| PagedAsyncIterableIterator |
完了とページごとの非同期反復を可能にするインターフェイス。 |
| PartnerProperties |
MongoDB 固有のプロパティ |
| Resource |
すべての Azure Resource Manager リソースの応答で返される共通フィールド |
| RestorePollerOptions | |
| SystemData |
リソースの作成と最後の変更に関連するメタデータ。 |
| TrackedResource |
Azure Resource Manager のリソース モデル定義は、"タグ" と "場所" を持つ最上位リソースを追跡しました |
| UserAssignedIdentity |
ユーザー割り当て ID プロパティ |
| UserDetails |
組織のユーザーの詳細 |
型エイリアス
| ActionType |
拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 サービスでサポートされている既知の値内部: アクションは内部専用 API 用です。 |
| ContinuablePage |
結果のページを記述するインターフェイス。 |
| CreatedByType |
リソースを作成したエンティティの種類。 サービスでサポートされている既知の値
ユーザー: エンティティはユーザーによって作成されました。 |
| ManagedServiceIdentityType |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 サービスでサポートされている既知の値
なし: マネージド ID はありません。 |
| MarketplaceSubscriptionStatus |
リソースの Marketplace サブスクリプションの状態。 サービスでサポートされている既知の値
PendingFulfillmentStart: 購入済みですが、まだアクティブ化されていません |
| Origin |
操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です サービスでサポートされている既知の値
ユーザー: 操作がユーザーによって開始されたことを示します。 |
| ResourceProvisioningState |
リソースの種類のプロビジョニング状態。 サービスでサポートされている既知の値
成功した: リソースが作成されました。 |
列挙型
| KnownActionType |
拡張可能な列挙型。 アクションの種類を示します。 "内部" とは、内部のみの API に対するアクションを指します。 |
| KnownCreatedByType |
リソースを作成したエンティティの種類。 |
| KnownManagedServiceIdentityType |
マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 |
| KnownMarketplaceSubscriptionStatus |
リソースの Marketplace サブスクリプションの状態。 |
| KnownOrigin |
操作の目的の実行プログラム。リソース ベースのアクセス制御 (RBAC) と監査ログ UX と同様です。 既定値は "user,system" です |
| KnownResourceProvisioningState |
リソースの種類のプロビジョニング状態。 |
| KnownVersions |
MongoDB.Atlas リソースモデルでサポートされているバージョン |
関数
| restore |
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。 |
関数の詳細
restorePoller<TResponse, TResult>(AtlasClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
別のポーラーのシリアル化された状態からポーリングャーを作成します。 これは、別のホストに投票者を作成する場合や、元のホストがスコープ内にない後にポーリングャーを構築する必要がある場合に便利です。
function restorePoller<TResponse, TResult>(client: AtlasClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
パラメーター
- client
- AtlasClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
戻り値
PollerLike<OperationState<TResult>, TResult>