Share via

Migrations interface

  • Reference
Package:
@azure/arm-postgresql-flexible

Interface representing a Migrations.

Methods

create(string, string, string, string, MigrationResource, MigrationsCreateOptionalParams)

Creates a new migration.
delete(string, string, string, string, MigrationsDeleteOptionalParams)

Deletes a migration.
get(string, string, string, string, MigrationsGetOptionalParams)

Gets details of a migration.
listByTargetServer(string, string, string, MigrationsListByTargetServerOptionalParams)

List all the migrations on a given target server.
update(string, 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.

Method Details

create(string, string, string, string, MigrationResource, MigrationsCreateOptionalParams)

Creates a new migration.

function create(subscriptionId: string, resourceGroupName: string, targetDbServerName: string, migrationName: string, parameters: MigrationResource, options?: MigrationsCreateOptionalParams): Promise<MigrationResource>

Parameters

subscriptionId

string

The subscription ID of the target database server.

resourceGroupName

string

The resource group name of the target database server.

targetDbServerName

string

The name of the target database server.

migrationName

string

The name of the migration.

parameters
MigrationResource

The required parameters for creating a migration.

options
MigrationsCreateOptionalParams

The options parameters.

Returns

Promise<MigrationResource>

delete(string, string, string, string, MigrationsDeleteOptionalParams)

Deletes a migration.

function delete(subscriptionId: string, resourceGroupName: string, targetDbServerName: string, migrationName: string, options?: MigrationsDeleteOptionalParams): Promise<void>

Parameters

subscriptionId

string

The subscription ID of the target database server.

resourceGroupName

string

The resource group name of the target database server.

targetDbServerName

string

The name of the target database server.

migrationName

string

The name of the migration.

options
MigrationsDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, string, MigrationsGetOptionalParams)

Gets details of a migration.

function get(subscriptionId: string, resourceGroupName: string, targetDbServerName: string, migrationName: string, options?: MigrationsGetOptionalParams): Promise<MigrationResource>

Parameters

subscriptionId

string

The subscription ID of the target database server.

resourceGroupName

string

The resource group name of the target database server.

targetDbServerName

string

The name of the target database server.

migrationName

string

The name of the migration.

options
MigrationsGetOptionalParams

The options parameters.

Returns

Promise<MigrationResource>

listByTargetServer(string, string, string, MigrationsListByTargetServerOptionalParams)

List all the migrations on a given target server.

function listByTargetServer(subscriptionId: string, resourceGroupName: string, targetDbServerName: string, options?: MigrationsListByTargetServerOptionalParams): PagedAsyncIterableIterator<MigrationResource, MigrationResource[], PageSettings>

Parameters

subscriptionId

string

The subscription ID of the target database server.

resourceGroupName

string

The resource group name of the target database server.

targetDbServerName

string

The name of the target database server.

options
MigrationsListByTargetServerOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<MigrationResource, MigrationResource[], PageSettings>

update(string, 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(subscriptionId: string, resourceGroupName: string, targetDbServerName: string, migrationName: string, parameters: MigrationResourceForPatch, options?: MigrationsUpdateOptionalParams): Promise<MigrationResource>

Parameters

subscriptionId

string

The subscription ID of the target database server.

resourceGroupName

string

The resource group name of the target database server.

targetDbServerName

string

The name of the target database server.

migrationName

string

The name of the migration.

parameters
MigrationResourceForPatch

The required parameters for updating a migration.

options
MigrationsUpdateOptionalParams

The options parameters.

Returns

Promise<MigrationResource>