MigrationsOperations interface

Interface representing a Migrations operations.

Properties

cancel

Cancels an active migration.

checkNameAvailability

Checks if a proposed migration name is valid and available.

create

Creates a new migration.

get

Gets information about a migration.

listByTargetServer

Lists all migrations of a target flexible server.

update

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.

Property Details

cancel

Cancels an active migration.

cancel: (resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsCancelOptionalParams) => Promise<void | Migration>

Property Value

(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsCancelOptionalParams) => Promise<void | Migration>

checkNameAvailability

Checks if a proposed migration name is valid and available.

checkNameAvailability: (resourceGroupName: string, serverName: string, parameters: MigrationNameAvailability, options?: MigrationsCheckNameAvailabilityOptionalParams) => Promise<MigrationNameAvailability>

Property Value

(resourceGroupName: string, serverName: string, parameters: MigrationNameAvailability, options?: MigrationsCheckNameAvailabilityOptionalParams) => Promise<MigrationNameAvailability>

create

Creates a new migration.

create: (resourceGroupName: string, serverName: string, migrationName: string, parameters: Migration, options?: MigrationsCreateOptionalParams) => Promise<Migration>

Property Value

(resourceGroupName: string, serverName: string, migrationName: string, parameters: Migration, options?: MigrationsCreateOptionalParams) => Promise<Migration>

get

Gets information about a migration.

get: (resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsGetOptionalParams) => Promise<Migration>

Property Value

(resourceGroupName: string, serverName: string, migrationName: string, options?: MigrationsGetOptionalParams) => Promise<Migration>

listByTargetServer

Lists all migrations of a target flexible server.

listByTargetServer: (resourceGroupName: string, serverName: string, options?: MigrationsListByTargetServerOptionalParams) => PagedAsyncIterableIterator<Migration, Migration[], PageSettings>

Property Value

(resourceGroupName: string, serverName: string, options?: MigrationsListByTargetServerOptionalParams) => PagedAsyncIterableIterator<Migration, Migration[], PageSettings>

update

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.

update: (resourceGroupName: string, serverName: string, migrationName: string, parameters: MigrationResourceForPatch, options?: MigrationsUpdateOptionalParams) => Promise<Migration>

Property Value

(resourceGroupName: string, serverName: string, migrationName: string, parameters: MigrationResourceForPatch, options?: MigrationsUpdateOptionalParams) => Promise<Migration>