ServicesOperations interface

Interface representing a Services operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginStart
beginStartAndWait
beginStop
beginStopAndWait
beginUpdate
beginUpdateAndWait
checkChildrenNameAvailability

This method checks whether a proposed nested resource name is valid and available.

checkNameAvailability

This method checks whether a proposed top-level resource name is valid and available.

checkStatus

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This action performs a health check and returns the status of the service and virtual machine size.

createOrUpdate

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The PUT method creates a new service or updates an existing one. When a service is updated, existing child resources (i.e. tasks) are unaffected. Services currently support a single kind, "vm", which refers to a VM-based service, although other kinds may be added in the future. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy"). The provider will reply when successful with 200 OK or 201 Created. Long-running operations use the provisioningState property.

delete

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The DELETE method deletes a service. Any running tasks will be canceled.

get

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The GET method retrieves information about a service instance.

list

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This method returns a list of service resources in a subscription.

listByResourceGroup

The Services resource is the top-level resource that represents the Azure Database Migration Service (classic). This method returns a list of service resources in a resource group.

listSkus

The services resource is the top-level resource that represents the Database Migration Service (classic). The skus action returns the list of SKUs that a service resource can be updated to.

start

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This action starts the service and the service can be used for data migration.

stop

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This action stops the service and the service cannot be used for data migration. The service owner won't be billed when the service is stopped.

update

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The PATCH method updates an existing service. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy").

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataMigrationService>, DataMigrationService>>

Property Value

(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataMigrationService>, DataMigrationService>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<DataMigrationService>

Property Value

(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams) => Promise<DataMigrationService>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams) => Promise<void>

Property Value

(groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams) => Promise<void>

beginStart

Warning

This API is now deprecated.

use start instead

beginStart: (groupName: string, serviceName: string, options?: ServicesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(groupName: string, serviceName: string, options?: ServicesStartOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStartAndWait

Warning

This API is now deprecated.

use start instead

beginStartAndWait: (groupName: string, serviceName: string, options?: ServicesStartOptionalParams) => Promise<void>

Property Value

(groupName: string, serviceName: string, options?: ServicesStartOptionalParams) => Promise<void>

beginStop

Warning

This API is now deprecated.

use stop instead

beginStop: (groupName: string, serviceName: string, options?: ServicesStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(groupName: string, serviceName: string, options?: ServicesStopOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginStopAndWait

Warning

This API is now deprecated.

use stop instead

beginStopAndWait: (groupName: string, serviceName: string, options?: ServicesStopOptionalParams) => Promise<void>

Property Value

(groupName: string, serviceName: string, options?: ServicesStopOptionalParams) => Promise<void>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataMigrationService>, DataMigrationService>>

Property Value

(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<DataMigrationService>, DataMigrationService>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams) => Promise<DataMigrationService>

Property Value

(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams) => Promise<DataMigrationService>

checkChildrenNameAvailability

This method checks whether a proposed nested resource name is valid and available.

checkChildrenNameAvailability: (groupName: string, serviceName: string, parameters: NameAvailabilityRequest, options?: ServicesCheckChildrenNameAvailabilityOptionalParams) => Promise<NameAvailabilityResponse>

Property Value

(groupName: string, serviceName: string, parameters: NameAvailabilityRequest, options?: ServicesCheckChildrenNameAvailabilityOptionalParams) => Promise<NameAvailabilityResponse>

checkNameAvailability

This method checks whether a proposed top-level resource name is valid and available.

checkNameAvailability: (location: string, parameters: NameAvailabilityRequest, options?: ServicesCheckNameAvailabilityOptionalParams) => Promise<NameAvailabilityResponse>

Property Value

(location: string, parameters: NameAvailabilityRequest, options?: ServicesCheckNameAvailabilityOptionalParams) => Promise<NameAvailabilityResponse>

checkStatus

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This action performs a health check and returns the status of the service and virtual machine size.

checkStatus: (groupName: string, serviceName: string, options?: ServicesCheckStatusOptionalParams) => Promise<DataMigrationServiceStatusResponse>

Property Value

(groupName: string, serviceName: string, options?: ServicesCheckStatusOptionalParams) => Promise<DataMigrationServiceStatusResponse>

createOrUpdate

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The PUT method creates a new service or updates an existing one. When a service is updated, existing child resources (i.e. tasks) are unaffected. Services currently support a single kind, "vm", which refers to a VM-based service, although other kinds may be added in the future. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy"). The provider will reply when successful with 200 OK or 201 Created. Long-running operations use the provisioningState property.

createOrUpdate: (groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<DataMigrationService>, DataMigrationService>

Property Value

(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams) => PollerLike<OperationState<DataMigrationService>, DataMigrationService>

delete

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The DELETE method deletes a service. Any running tasks will be canceled.

delete: (groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The GET method retrieves information about a service instance.

get: (groupName: string, serviceName: string, options?: ServicesGetOptionalParams) => Promise<DataMigrationService>

Property Value

(groupName: string, serviceName: string, options?: ServicesGetOptionalParams) => Promise<DataMigrationService>

list

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This method returns a list of service resources in a subscription.

list: (options?: ServicesListOptionalParams) => PagedAsyncIterableIterator<DataMigrationService, DataMigrationService[], PageSettings>

Property Value

(options?: ServicesListOptionalParams) => PagedAsyncIterableIterator<DataMigrationService, DataMigrationService[], PageSettings>

listByResourceGroup

The Services resource is the top-level resource that represents the Azure Database Migration Service (classic). This method returns a list of service resources in a resource group.

listByResourceGroup: (groupName: string, options?: ServicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DataMigrationService, DataMigrationService[], PageSettings>

Property Value

(groupName: string, options?: ServicesListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<DataMigrationService, DataMigrationService[], PageSettings>

listSkus

The services resource is the top-level resource that represents the Database Migration Service (classic). The skus action returns the list of SKUs that a service resource can be updated to.

listSkus: (groupName: string, serviceName: string, options?: ServicesListSkusOptionalParams) => PagedAsyncIterableIterator<AvailableServiceSku, AvailableServiceSku[], PageSettings>

Property Value

(groupName: string, serviceName: string, options?: ServicesListSkusOptionalParams) => PagedAsyncIterableIterator<AvailableServiceSku, AvailableServiceSku[], PageSettings>

start

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This action starts the service and the service can be used for data migration.

start: (groupName: string, serviceName: string, options?: ServicesStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(groupName: string, serviceName: string, options?: ServicesStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). This action stops the service and the service cannot be used for data migration. The service owner won't be billed when the service is stopped.

stop: (groupName: string, serviceName: string, options?: ServicesStopOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(groupName: string, serviceName: string, options?: ServicesStopOptionalParams) => PollerLike<OperationState<void>, void>

update

The services resource is the top-level resource that represents the Azure Database Migration Service (classic). The PATCH method updates an existing service. This method can change the kind, SKU, and network of the service, but if tasks are currently running (i.e. the service is busy), this will fail with 400 Bad Request ("ServiceIsBusy").

update: (groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams) => PollerLike<OperationState<DataMigrationService>, DataMigrationService>

Property Value

(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams) => PollerLike<OperationState<DataMigrationService>, DataMigrationService>