Migrations interface
Interface representing a Migrations.
Methods
| cancel(string, string, string, Migrations |
Cancels an active migration. |
| check |
Checks if a proposed migration name is valid and available. |
| create(string, string, string, Migration, Migrations |
Creates a new migration. |
| get(string, string, string, Migrations |
Gets information about a migration. |
| list |
Lists all migrations of a target flexible server. |
| update(string, string, string, Migration |
Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions. |
Method Details
cancel(string, string, string, MigrationsCancelOptionalParams)
Cancels an active migration.
function cancel(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsCancelOptionalParams): Promise<Migration>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- migrationName
-
string
Name of migration.
- options
- MigrationsCancelOptionalParams
The options parameters.
Returns
Promise<Migration>
checkNameAvailability(string, string, MigrationNameAvailability, MigrationsCheckNameAvailabilityOptionalParams)
Checks if a proposed migration name is valid and available.
function checkNameAvailability(resourceGroupName: string, serverName: string, parameters: MigrationNameAvailability, options?: MigrationsCheckNameAvailabilityOptionalParams): Promise<MigrationNameAvailability>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- parameters
- MigrationNameAvailability
Parameters required to check if a migration name is valid and available.
The options parameters.
Returns
Promise<MigrationNameAvailability>
create(string, string, string, Migration, MigrationsCreateOptionalParams)
Creates a new migration.
function create(resourceGroupName: string, serverName: string, migrationName: string, parameters: Migration, options?: MigrationsCreateOptionalParams): Promise<Migration>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- migrationName
-
string
Name of migration.
- parameters
- Migration
Parameters required for creating a migration.
- options
- MigrationsCreateOptionalParams
The options parameters.
Returns
Promise<Migration>
get(string, string, string, MigrationsGetOptionalParams)
Gets information about a migration.
function get(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsGetOptionalParams): Promise<Migration>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- migrationName
-
string
Name of migration.
- options
- MigrationsGetOptionalParams
The options parameters.
Returns
Promise<Migration>
listByTargetServer(string, string, MigrationsListByTargetServerOptionalParams)
Lists all migrations of a target flexible server.
function listByTargetServer(resourceGroupName: string, serverName: string, options?: MigrationsListByTargetServerOptionalParams): PagedAsyncIterableIterator<Migration, Migration[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
The options parameters.
Returns
update(string, string, string, MigrationResourceForPatch, MigrationsUpdateOptionalParams)
Updates an existing migration. The request body can contain one to many of the mutable properties present in the migration definition. Certain property updates initiate migration state transitions.
function update(resourceGroupName: string, serverName: string, migrationName: string, parameters: MigrationResourceForPatch, options?: MigrationsUpdateOptionalParams): Promise<Migration>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serverName
-
string
The name of the server.
- migrationName
-
string
Name of migration.
- parameters
- MigrationResourceForPatch
Parameters required to update an existing migration.
- options
- MigrationsUpdateOptionalParams
The options parameters.
Returns
Promise<Migration>