Services class
Class representing a Services.
Constructors
Services(Data |
Create 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 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 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"). |
check |
This method checks whether a proposed nested resource name is valid and available. |
check |
|
check |
|
check |
This method checks whether a proposed top-level resource name is valid and available. |
check |
|
check |
|
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. |
check |
|
check |
|
create |
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. |
delete |
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. |
get(string, string, Request |
The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance. |
get(string, string, Request |
|
get(string, string, Service |
|
list(Request |
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(Request |
|
list(Service |
|
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 |
|
list |
|
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 |
|
list |
|
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 subscription. |
list |
|
list |
|
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. |
list |
|
list |
|
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. |
list |
|
list |
|
start(string, string, Request |
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. |
stop(string, string, Request |
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. |
update(Data |
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"). |
Constructor Details
Services(DataMigrationServiceClientContext)
Create a Services.
new Services(client: DataMigrationServiceClientContext)
Parameters
Reference to the service client.
Method Details
beginCreateOrUpdate(DataMigrationService, string, string, RequestOptionsBase)
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(parameters: DataMigrationService, groupName: string, serviceName: string, options?: RequestOptionsBase): Promise<LROPoller>
Parameters
- parameters
- DataMigrationService
Information about the service
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginDeleteMethod(string, string, ServicesBeginDeleteMethodOptionalParams)
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 beginDeleteMethod(groupName: string, serviceName: string, options?: ServicesBeginDeleteMethodOptionalParams): Promise<LROPoller>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginStart(string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<LROPoller>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginStop(string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<LROPoller>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
beginUpdate(DataMigrationService, string, string, RequestOptionsBase)
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(parameters: DataMigrationService, groupName: string, serviceName: string, options?: RequestOptionsBase): Promise<LROPoller>
Parameters
- parameters
- DataMigrationService
Information about the service
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<@azure/ms-rest-azure-js.LROPoller>
Promise<msRestAzure.LROPoller>
checkChildrenNameAvailability(string, string, NameAvailabilityRequest, RequestOptionsBase)
This method checks whether a proposed nested resource name is valid and available.
function checkChildrenNameAvailability(groupName: string, serviceName: string, parameters: NameAvailabilityRequest, options?: RequestOptionsBase): Promise<ServicesCheckChildrenNameAvailabilityResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- NameAvailabilityRequest
Requested name to validate
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ServicesCheckChildrenNameAvailabilityResponse>
checkChildrenNameAvailability(string, string, NameAvailabilityRequest, RequestOptionsBase, ServiceCallback<NameAvailabilityResponse>)
function checkChildrenNameAvailability(groupName: string, serviceName: string, parameters: NameAvailabilityRequest, options: RequestOptionsBase, callback: ServiceCallback<NameAvailabilityResponse>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- NameAvailabilityRequest
Requested name to validate
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
checkChildrenNameAvailability(string, string, NameAvailabilityRequest, ServiceCallback<NameAvailabilityResponse>)
function checkChildrenNameAvailability(groupName: string, serviceName: string, parameters: NameAvailabilityRequest, callback: ServiceCallback<NameAvailabilityResponse>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- parameters
- NameAvailabilityRequest
Requested name to validate
- callback
The callback
checkNameAvailability(string, NameAvailabilityRequest, RequestOptionsBase)
This method checks whether a proposed top-level resource name is valid and available.
function checkNameAvailability(location: string, parameters: NameAvailabilityRequest, options?: RequestOptionsBase): Promise<ServicesCheckNameAvailabilityResponse>
Parameters
- location
-
string
The Azure region of the operation
- parameters
- NameAvailabilityRequest
Requested name to validate
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ServicesCheckNameAvailabilityResponse>
checkNameAvailability(string, NameAvailabilityRequest, RequestOptionsBase, ServiceCallback<NameAvailabilityResponse>)
function checkNameAvailability(location: string, parameters: NameAvailabilityRequest, options: RequestOptionsBase, callback: ServiceCallback<NameAvailabilityResponse>)
Parameters
- location
-
string
The Azure region of the operation
- parameters
- NameAvailabilityRequest
Requested name to validate
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
checkNameAvailability(string, NameAvailabilityRequest, ServiceCallback<NameAvailabilityResponse>)
function checkNameAvailability(location: string, parameters: NameAvailabilityRequest, callback: ServiceCallback<NameAvailabilityResponse>)
Parameters
- location
-
string
The Azure region of the operation
- parameters
- NameAvailabilityRequest
Requested name to validate
- callback
The callback
checkStatus(string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ServicesCheckStatusResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesCheckStatusResponse>
Promise<Models.ServicesCheckStatusResponse>
checkStatus(string, string, RequestOptionsBase, ServiceCallback<DataMigrationServiceStatusResponse>)
function checkStatus(groupName: string, serviceName: string, options: RequestOptionsBase, callback: ServiceCallback<DataMigrationServiceStatusResponse>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
The callback
checkStatus(string, string, ServiceCallback<DataMigrationServiceStatusResponse>)
function checkStatus(groupName: string, serviceName: string, callback: ServiceCallback<DataMigrationServiceStatusResponse>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
The callback
createOrUpdate(DataMigrationService, string, string, RequestOptionsBase)
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 createOrUpdate(parameters: DataMigrationService, groupName: string, serviceName: string, options?: RequestOptionsBase): Promise<ServicesCreateOrUpdateResponse>
Parameters
- parameters
- DataMigrationService
Information about the service
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesCreateOrUpdateResponse>
Promise<Models.ServicesCreateOrUpdateResponse>
deleteMethod(string, string, ServicesDeleteMethodOptionalParams)
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 deleteMethod(groupName: string, serviceName: string, options?: ServicesDeleteMethodOptionalParams): Promise<RestResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
get(string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ServicesGetResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesGetResponse>
Promise<Models.ServicesGetResponse>
get(string, string, RequestOptionsBase, ServiceCallback<DataMigrationService>)
function get(groupName: string, serviceName: string, options: RequestOptionsBase, callback: ServiceCallback<DataMigrationService>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
get(string, string, ServiceCallback<DataMigrationService>)
function get(groupName: string, serviceName: string, callback: ServiceCallback<DataMigrationService>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- callback
The callback
list(RequestOptionsBase)
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?: RequestOptionsBase): Promise<ServicesListResponse>
Parameters
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesListResponse>
Promise<Models.ServicesListResponse>
list(RequestOptionsBase, ServiceCallback<DataMigrationServiceList>)
function list(options: RequestOptionsBase, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
list(ServiceCallback<DataMigrationServiceList>)
function list(callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- callback
The callback
listByResourceGroup(string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ServicesListByResourceGroupResponse>
Parameters
- groupName
-
string
Name of the resource group
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesListByResourceGroupResponse>
Promise<Models.ServicesListByResourceGroupResponse>
listByResourceGroup(string, RequestOptionsBase, ServiceCallback<DataMigrationServiceList>)
function listByResourceGroup(groupName: string, options: RequestOptionsBase, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- groupName
-
string
Name of the resource group
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByResourceGroup(string, ServiceCallback<DataMigrationServiceList>)
function listByResourceGroup(groupName: string, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- groupName
-
string
Name of the resource group
- callback
The callback
listByResourceGroupNext(string, RequestOptionsBase)
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 listByResourceGroupNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ServicesListByResourceGroupNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<Models.ServicesListByResourceGroupNextResponse>
listByResourceGroupNext(string, RequestOptionsBase, ServiceCallback<DataMigrationServiceList>)
function listByResourceGroupNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listByResourceGroupNext(string, ServiceCallback<DataMigrationServiceList>)
function listByResourceGroupNext(nextPageLink: string, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listNext(string, RequestOptionsBase)
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 listNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ServicesListNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesListNextResponse>
Promise<Models.ServicesListNextResponse>
listNext(string, RequestOptionsBase, ServiceCallback<DataMigrationServiceList>)
function listNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listNext(string, ServiceCallback<DataMigrationServiceList>)
function listNext(nextPageLink: string, callback: ServiceCallback<DataMigrationServiceList>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
listSkus(string, string, RequestOptionsBase)
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?: RequestOptionsBase): Promise<ServicesListSkusResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesListSkusResponse>
Promise<Models.ServicesListSkusResponse>
listSkus(string, string, RequestOptionsBase, ServiceCallback<ServiceSkuList>)
function listSkus(groupName: string, serviceName: string, options: RequestOptionsBase, callback: ServiceCallback<ServiceSkuList>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listSkus(string, string, ServiceCallback<ServiceSkuList>)
function listSkus(groupName: string, serviceName: string, callback: ServiceCallback<ServiceSkuList>)
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- callback
The callback
listSkusNext(string, RequestOptionsBase)
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 listSkusNext(nextPageLink: string, options?: RequestOptionsBase): Promise<ServicesListSkusNextResponse>
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesListSkusNextResponse>
Promise<Models.ServicesListSkusNextResponse>
listSkusNext(string, RequestOptionsBase, ServiceCallback<ServiceSkuList>)
function listSkusNext(nextPageLink: string, options: RequestOptionsBase, callback: ServiceCallback<ServiceSkuList>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- options
- RequestOptionsBase
The optional parameters
- callback
The callback
listSkusNext(string, ServiceCallback<ServiceSkuList>)
function listSkusNext(nextPageLink: string, callback: ServiceCallback<ServiceSkuList>)
Parameters
- nextPageLink
-
string
The NextLink from the previous successful call to List operation.
- callback
The callback
start(string, string, RequestOptionsBase)
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 start(groupName: string, serviceName: string, options?: RequestOptionsBase): Promise<RestResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
stop(string, string, RequestOptionsBase)
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 stop(groupName: string, serviceName: string, options?: RequestOptionsBase): Promise<RestResponse>
Parameters
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<RestResponse>
Promise<msRest.RestResponse>
update(DataMigrationService, string, string, RequestOptionsBase)
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 update(parameters: DataMigrationService, groupName: string, serviceName: string, options?: RequestOptionsBase): Promise<ServicesUpdateResponse>
Parameters
- parameters
- DataMigrationService
Information about the service
- groupName
-
string
Name of the resource group
- serviceName
-
string
Name of the service
- options
- RequestOptionsBase
The optional parameters
Returns
Promise<ServicesUpdateResponse>
Promise<Models.ServicesUpdateResponse>