Migrations interface
移行を表すインターフェイス。
メソッド
| cancel(string, string, string, Migrations |
アクティブな移行をキャンセルします。 |
| check |
提案された移行名が有効で使用可能かどうかを確認します。 |
| create(string, string, string, Migration, Migrations |
新しい移行を作成します。 |
| get(string, string, string, Migrations |
移行に関する情報を取得します。 |
| list |
ターゲットのフレキシブル サーバーのすべての移行を一覧表示します。 |
| update(string, string, string, Migration |
既存の移行を更新します。 要求本文には、移行定義に存在する変更可能なプロパティの 1 対多を含めることができます。 特定のプロパティの更新により、移行状態の遷移が開始されます。 |
メソッドの詳細
cancel(string, string, string, MigrationsCancelOptionalParams)
アクティブな移行をキャンセルします。
function cancel(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsCancelOptionalParams): Promise<Migration>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- serverName
-
string
サーバーの名前。
- migrationName
-
string
移行の名前。
- options
- MigrationsCancelOptionalParams
オプション パラメーター。
戻り値
Promise<Migration>
checkNameAvailability(string, string, MigrationNameAvailability, MigrationsCheckNameAvailabilityOptionalParams)
提案された移行名が有効で使用可能かどうかを確認します。
function checkNameAvailability(resourceGroupName: string, serverName: string, parameters: MigrationNameAvailability, options?: MigrationsCheckNameAvailabilityOptionalParams): Promise<MigrationNameAvailability>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- serverName
-
string
サーバーの名前。
- parameters
- MigrationNameAvailability
マイグレーション名が有効かつ利用可能かどうかを確認するために必要なパラメータ。
オプション パラメーター。
戻り値
Promise<MigrationNameAvailability>
create(string, string, string, Migration, MigrationsCreateOptionalParams)
新しい移行を作成します。
function create(resourceGroupName: string, serverName: string, migrationName: string, parameters: Migration, options?: MigrationsCreateOptionalParams): Promise<Migration>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- serverName
-
string
サーバーの名前。
- migrationName
-
string
移行の名前。
- parameters
- Migration
移行を作成するために必要なパラメータ。
- options
- MigrationsCreateOptionalParams
オプション パラメーター。
戻り値
Promise<Migration>
get(string, string, string, MigrationsGetOptionalParams)
移行に関する情報を取得します。
function get(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsGetOptionalParams): Promise<Migration>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- serverName
-
string
サーバーの名前。
- migrationName
-
string
移行の名前。
- options
- MigrationsGetOptionalParams
オプション パラメーター。
戻り値
Promise<Migration>
listByTargetServer(string, string, MigrationsListByTargetServerOptionalParams)
ターゲットのフレキシブル サーバーのすべての移行を一覧表示します。
function listByTargetServer(resourceGroupName: string, serverName: string, options?: MigrationsListByTargetServerOptionalParams): PagedAsyncIterableIterator<Migration, Migration[], PageSettings>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- serverName
-
string
サーバーの名前。
オプション パラメーター。
戻り値
update(string, string, string, MigrationResourceForPatch, MigrationsUpdateOptionalParams)
既存の移行を更新します。 要求本文には、移行定義に存在する変更可能なプロパティの 1 対多を含めることができます。 特定のプロパティの更新により、移行状態の遷移が開始されます。
function update(resourceGroupName: string, serverName: string, migrationName: string, parameters: MigrationResourceForPatch, options?: MigrationsUpdateOptionalParams): Promise<Migration>
パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前は大文字と小文字が区別されます。
- serverName
-
string
サーバーの名前。
- migrationName
-
string
移行の名前。
- parameters
- MigrationResourceForPatch
既存の移行を更新するために必要なパラメータ。
- options
- MigrationsUpdateOptionalParams
オプション パラメーター。
戻り値
Promise<Migration>