Services interface
Interface representing a Services.
Methods
| begin |
The services resource is the top-level resource that represents the Database Migration Service. 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. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. 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. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. 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. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. 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. |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. 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"). |
| begin |
The services resource is the top-level resource that represents the Database Migration Service. 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"). |
| check |
This method checks whether a proposed nested resource name is valid and available. |
| check |
This method checks whether a proposed top-level resource name is valid and available. |
| check |
The services resource is the top-level resource that represents the Database Migration Service. This action performs a health check and returns the status of the service and virtual machine size. |
| get(string, string, Services |
The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance. |
| list(Services |
The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a subscription. |
| list |
The Services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a resource group. |
| list |
The services resource is the top-level resource that represents the Database Migration Service. The skus action returns the list of SKUs that a service resource can be updated to. |
Method Details
beginCreateOrUpdate(string, string, DataMigrationService, ServicesCreateOrUpdateOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. 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.
function beginCreateOrUpdate(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<DataMigrationService>, DataMigrationService>>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- DataMigrationService
Information about the service
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DataMigrationService>, DataMigrationService>>
beginCreateOrUpdateAndWait(string, string, DataMigrationService, ServicesCreateOrUpdateOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. 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.
function beginCreateOrUpdateAndWait(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesCreateOrUpdateOptionalParams): Promise<DataMigrationService>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- DataMigrationService
Information about the service
The options parameters.
Returns
Promise<DataMigrationService>
beginDelete(string, string, ServicesDeleteOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.
function beginDelete(groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, ServicesDeleteOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. The DELETE method deletes a service. Any running tasks will be canceled.
function beginDeleteAndWait(groupName: string, serviceName: string, options?: ServicesDeleteOptionalParams): Promise<void>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginStart(string, string, ServicesStartOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration.
function beginStart(groupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesStartOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, ServicesStartOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. This action starts the service and the service can be used for data migration.
function beginStartAndWait(groupName: string, serviceName: string, options?: ServicesStartOptionalParams): Promise<void>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesStartOptionalParams
The options parameters.
Returns
Promise<void>
beginStop(string, string, ServicesStopOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. 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.
function beginStop(groupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesStopOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, ServicesStopOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. 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.
function beginStopAndWait(groupName: string, serviceName: string, options?: ServicesStopOptionalParams): Promise<void>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesStopOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, DataMigrationService, ServicesUpdateOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. 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").
function beginUpdate(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams): Promise<PollerLike<PollOperationState<DataMigrationService>, DataMigrationService>>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- DataMigrationService
Information about the service
- options
- ServicesUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<DataMigrationService>, DataMigrationService>>
beginUpdateAndWait(string, string, DataMigrationService, ServicesUpdateOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. 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").
function beginUpdateAndWait(groupName: string, serviceName: string, parameters: DataMigrationService, options?: ServicesUpdateOptionalParams): Promise<DataMigrationService>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- DataMigrationService
Information about the service
- options
- ServicesUpdateOptionalParams
The options parameters.
Returns
Promise<DataMigrationService>
checkChildrenNameAvailability(string, string, NameAvailabilityRequest, ServicesCheckChildrenNameAvailabilityOptionalParams)
This method checks whether a proposed nested resource name is valid and available.
function checkChildrenNameAvailability(groupName: string, serviceName: string, parameters: NameAvailabilityRequest, options?: ServicesCheckChildrenNameAvailabilityOptionalParams): Promise<NameAvailabilityResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- NameAvailabilityRequest
Requested name to validate
The options parameters.
Returns
Promise<NameAvailabilityResponse>
checkNameAvailability(string, NameAvailabilityRequest, ServicesCheckNameAvailabilityOptionalParams)
This method checks whether a proposed top-level resource name is valid and available.
function checkNameAvailability(location: string, parameters: NameAvailabilityRequest, options?: ServicesCheckNameAvailabilityOptionalParams): Promise<NameAvailabilityResponse>Parameters
- location
-
string
The Azure region of the operation
- parameters
- NameAvailabilityRequest
Requested name to validate
The options parameters.
Returns
Promise<NameAvailabilityResponse>
checkStatus(string, string, ServicesCheckStatusOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. This action performs a health check and returns the status of the service and virtual machine size.
function checkStatus(groupName: string, serviceName: string, options?: ServicesCheckStatusOptionalParams): Promise<DataMigrationServiceStatusResponse>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
The options parameters.
Returns
Promise<DataMigrationServiceStatusResponse>
get(string, string, ServicesGetOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.
function get(groupName: string, serviceName: string, options?: ServicesGetOptionalParams): Promise<DataMigrationService>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesGetOptionalParams
The options parameters.
Returns
Promise<DataMigrationService>
list(ServicesListOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a subscription.
function list(options?: ServicesListOptionalParams): PagedAsyncIterableIterator<DataMigrationService, DataMigrationService[], PageSettings>Parameters
- options
- ServicesListOptionalParams
The options parameters.
Returns
listByResourceGroup(string, ServicesListByResourceGroupOptionalParams)
The Services resource is the top-level resource that represents the Database Migration Service. This method returns a list of service resources in a resource group.
function listByResourceGroup(groupName: string, options?: ServicesListByResourceGroupOptionalParams): PagedAsyncIterableIterator<DataMigrationService, DataMigrationService[], PageSettings>Parameters
- groupName
-
string
Name of the resource group
The options parameters.
Returns
listSkus(string, string, ServicesListSkusOptionalParams)
The services resource is the top-level resource that represents the Database Migration Service. The skus action returns the list of SKUs that a service resource can be updated to.
function listSkus(groupName: string, serviceName: string, options?: ServicesListSkusOptionalParams): PagedAsyncIterableIterator<AvailableServiceSku, AvailableServiceSku[], PageSettings>Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- ServicesListSkusOptionalParams
The options parameters.
