Share via


SqlMigrationServices interface

Interface representing a SqlMigrationServices.

Methods

beginCreateOrUpdate(string, string, SqlMigrationService, SqlMigrationServicesCreateOrUpdateOptionalParams)

Create or Update Database Migration Service.

beginCreateOrUpdateAndWait(string, string, SqlMigrationService, SqlMigrationServicesCreateOrUpdateOptionalParams)

Create or Update Database Migration Service.

beginDelete(string, string, SqlMigrationServicesDeleteOptionalParams)

Delete Database Migration Service.

beginDeleteAndWait(string, string, SqlMigrationServicesDeleteOptionalParams)

Delete Database Migration Service.

beginUpdate(string, string, SqlMigrationServiceUpdate, SqlMigrationServicesUpdateOptionalParams)

Update Database Migration Service.

beginUpdateAndWait(string, string, SqlMigrationServiceUpdate, SqlMigrationServicesUpdateOptionalParams)

Update Database Migration Service.

deleteNode(string, string, DeleteNode, SqlMigrationServicesDeleteNodeOptionalParams)

Delete the integration runtime node.

get(string, string, SqlMigrationServicesGetOptionalParams)

Retrieve the Database Migration Service

listAuthKeys(string, string, SqlMigrationServicesListAuthKeysOptionalParams)

Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.

listByResourceGroup(string, SqlMigrationServicesListByResourceGroupOptionalParams)

Retrieve all SQL migration services in the resource group.

listBySubscription(SqlMigrationServicesListBySubscriptionOptionalParams)

Retrieve all SQL migration services in the subscriptions.

listMigrations(string, string, SqlMigrationServicesListMigrationsOptionalParams)

Retrieve the List of database migrations attached to the service.

listMonitoringData(string, string, SqlMigrationServicesListMonitoringDataOptionalParams)

Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.

regenerateAuthKeys(string, string, RegenAuthKeys, SqlMigrationServicesRegenerateAuthKeysOptionalParams)

Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.

Method Details

beginCreateOrUpdate(string, string, SqlMigrationService, SqlMigrationServicesCreateOrUpdateOptionalParams)

Create or Update Database Migration Service.

function beginCreateOrUpdate(resourceGroupName: string, sqlMigrationServiceName: string, parameters: SqlMigrationService, options?: SqlMigrationServicesCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SqlMigrationService>, SqlMigrationService>>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

parameters
SqlMigrationService

Details of SqlMigrationService resource.

options
SqlMigrationServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SqlMigrationService>, SqlMigrationService>>

beginCreateOrUpdateAndWait(string, string, SqlMigrationService, SqlMigrationServicesCreateOrUpdateOptionalParams)

Create or Update Database Migration Service.

function beginCreateOrUpdateAndWait(resourceGroupName: string, sqlMigrationServiceName: string, parameters: SqlMigrationService, options?: SqlMigrationServicesCreateOrUpdateOptionalParams): Promise<SqlMigrationService>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

parameters
SqlMigrationService

Details of SqlMigrationService resource.

options
SqlMigrationServicesCreateOrUpdateOptionalParams

The options parameters.

Returns

beginDelete(string, string, SqlMigrationServicesDeleteOptionalParams)

Delete Database Migration Service.

function beginDelete(resourceGroupName: string, sqlMigrationServiceName: string, options?: SqlMigrationServicesDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

options
SqlMigrationServicesDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait(string, string, SqlMigrationServicesDeleteOptionalParams)

Delete Database Migration Service.

function beginDeleteAndWait(resourceGroupName: string, sqlMigrationServiceName: string, options?: SqlMigrationServicesDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

options
SqlMigrationServicesDeleteOptionalParams

The options parameters.

Returns

Promise<void>

beginUpdate(string, string, SqlMigrationServiceUpdate, SqlMigrationServicesUpdateOptionalParams)

Update Database Migration Service.

function beginUpdate(resourceGroupName: string, sqlMigrationServiceName: string, parameters: SqlMigrationServiceUpdate, options?: SqlMigrationServicesUpdateOptionalParams): Promise<SimplePollerLike<OperationState<SqlMigrationService>, SqlMigrationService>>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

parameters
SqlMigrationServiceUpdate

Details of SqlMigrationService resource.

options
SqlMigrationServicesUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<SqlMigrationService>, SqlMigrationService>>

beginUpdateAndWait(string, string, SqlMigrationServiceUpdate, SqlMigrationServicesUpdateOptionalParams)

Update Database Migration Service.

function beginUpdateAndWait(resourceGroupName: string, sqlMigrationServiceName: string, parameters: SqlMigrationServiceUpdate, options?: SqlMigrationServicesUpdateOptionalParams): Promise<SqlMigrationService>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

parameters
SqlMigrationServiceUpdate

Details of SqlMigrationService resource.

options
SqlMigrationServicesUpdateOptionalParams

The options parameters.

Returns

deleteNode(string, string, DeleteNode, SqlMigrationServicesDeleteNodeOptionalParams)

Delete the integration runtime node.

function deleteNode(resourceGroupName: string, sqlMigrationServiceName: string, parameters: DeleteNode, options?: SqlMigrationServicesDeleteNodeOptionalParams): Promise<DeleteNode>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

parameters
DeleteNode

Details of SqlMigrationService resource.

options
SqlMigrationServicesDeleteNodeOptionalParams

The options parameters.

Returns

Promise<DeleteNode>

get(string, string, SqlMigrationServicesGetOptionalParams)

Retrieve the Database Migration Service

function get(resourceGroupName: string, sqlMigrationServiceName: string, options?: SqlMigrationServicesGetOptionalParams): Promise<SqlMigrationService>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

options
SqlMigrationServicesGetOptionalParams

The options parameters.

Returns

listAuthKeys(string, string, SqlMigrationServicesListAuthKeysOptionalParams)

Retrieve the List of Authentication Keys for Self Hosted Integration Runtime.

function listAuthKeys(resourceGroupName: string, sqlMigrationServiceName: string, options?: SqlMigrationServicesListAuthKeysOptionalParams): Promise<AuthenticationKeys>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

options
SqlMigrationServicesListAuthKeysOptionalParams

The options parameters.

Returns

listByResourceGroup(string, SqlMigrationServicesListByResourceGroupOptionalParams)

Retrieve all SQL migration services in the resource group.

function listByResourceGroup(resourceGroupName: string, options?: SqlMigrationServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SqlMigrationService, SqlMigrationService[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

Returns

listBySubscription(SqlMigrationServicesListBySubscriptionOptionalParams)

Retrieve all SQL migration services in the subscriptions.

function listBySubscription(options?: SqlMigrationServicesListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SqlMigrationService, SqlMigrationService[], PageSettings>

Parameters

Returns

listMigrations(string, string, SqlMigrationServicesListMigrationsOptionalParams)

Retrieve the List of database migrations attached to the service.

function listMigrations(resourceGroupName: string, sqlMigrationServiceName: string, options?: SqlMigrationServicesListMigrationsOptionalParams): PagedAsyncIterableIterator<DatabaseMigration, DatabaseMigration[], PageSettings>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

options
SqlMigrationServicesListMigrationsOptionalParams

The options parameters.

Returns

listMonitoringData(string, string, SqlMigrationServicesListMonitoringDataOptionalParams)

Retrieve the registered Integration Runtime nodes and their monitoring data for a given Database Migration Service.

function listMonitoringData(resourceGroupName: string, sqlMigrationServiceName: string, options?: SqlMigrationServicesListMonitoringDataOptionalParams): Promise<IntegrationRuntimeMonitoringData>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

Returns

regenerateAuthKeys(string, string, RegenAuthKeys, SqlMigrationServicesRegenerateAuthKeysOptionalParams)

Regenerate a new set of Authentication Keys for Self Hosted Integration Runtime.

function regenerateAuthKeys(resourceGroupName: string, sqlMigrationServiceName: string, parameters: RegenAuthKeys, options?: SqlMigrationServicesRegenerateAuthKeysOptionalParams): Promise<RegenAuthKeys>

Parameters

resourceGroupName

string

Name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.

sqlMigrationServiceName

string

Name of the SQL Migration Service.

parameters
RegenAuthKeys

Details of SqlMigrationService resource.

Returns

Promise<RegenAuthKeys>