ServicesOperations Class
ServicesOperations operations.
You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.
- Inheritance
-
builtins.objectServicesOperations
Constructor
ServicesOperations(client, config, serializer, deserializer)
Parameters
- client
Client for service requests.
- config
Configuration of service client.
- serializer
An object model serializer.
- deserializer
An object model deserializer.
Variables
- models
Alias to model classes used in this operation group.
Methods
| begin_create_or_update |
Create or update DMS Instance. 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_delete |
Delete DMS Service Instance. 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_start |
Start service. 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_stop |
Stop service. 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_update |
Create or update DMS Service Instance. 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_children_name_availability |
Check nested resource name validity and availability. This method checks whether a proposed nested resource name is valid and available. |
| check_name_availability |
Check name validity and availability. This method checks whether a proposed top-level resource name is valid and available. |
| check_status |
Check service health status. 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 |
Get DMS Service Instance. The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance. |
| list |
Get services in subscription. 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_by_resource_group |
Get services in resource group. 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_skus |
Get compatible SKUs. 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. |
begin_create_or_update
Create or update DMS Instance.
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_create_or_update(group_name: str, service_name: str, parameters: _models.DataMigrationService, **kwargs: Any) -> LROPoller[_models.DataMigrationService]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either DataMigrationService or the result of cls(response)
Return type
Exceptions
begin_delete
Delete DMS Service Instance.
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_delete(group_name: str, service_name: str, delete_running_tasks: Optional[bool] = None, **kwargs: Any) -> LROPoller[None]
Parameters
- delete_running_tasks
- bool
Delete the resource even if it contains running tasks.
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_start
Start service.
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_start(group_name: str, service_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_stop
Stop service.
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_stop(group_name: str, service_name: str, **kwargs: Any) -> LROPoller[None]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Create or update DMS Service Instance.
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_update(group_name: str, service_name: str, parameters: _models.DataMigrationService, **kwargs: Any) -> LROPoller[_models.DataMigrationService]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
- continuation_token
- str
A continuation token to restart a poller from a saved state.
- polling
- bool or PollingMethod
By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
- polling_interval
- int
Default waiting time between two polls for LRO operations if no Retry-After header is present.
Returns
An instance of LROPoller that returns either DataMigrationService or the result of cls(response)
Return type
Exceptions
check_children_name_availability
Check nested resource name validity and availability.
This method checks whether a proposed nested resource name is valid and available.
check_children_name_availability(group_name: str, service_name: str, parameters: _models.NameAvailabilityRequest, **kwargs: Any) -> _models.NameAvailabilityResponse
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NameAvailabilityResponse, or the result of cls(response)
Return type
Exceptions
check_name_availability
Check name validity and availability.
This method checks whether a proposed top-level resource name is valid and available.
check_name_availability(location: str, parameters: _models.NameAvailabilityRequest, **kwargs: Any) -> _models.NameAvailabilityResponse
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
NameAvailabilityResponse, or the result of cls(response)
Return type
Exceptions
check_status
Check service health status.
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_status(group_name: str, service_name: str, **kwargs: Any) -> _models.DataMigrationServiceStatusResponse
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DataMigrationServiceStatusResponse, or the result of cls(response)
Return type
Exceptions
get
Get DMS Service Instance.
The services resource is the top-level resource that represents the Database Migration Service. The GET method retrieves information about a service instance.
get(group_name: str, service_name: str, **kwargs: Any) -> _models.DataMigrationService
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
DataMigrationService, or the result of cls(response)
Return type
Exceptions
list
Get services in subscription.
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(**kwargs: Any) -> Iterable[_models.DataMigrationServiceList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DataMigrationServiceList or the result of cls(response)
Return type
Exceptions
list_by_resource_group
Get services in resource group.
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_by_resource_group(group_name: str, **kwargs: Any) -> Iterable[_models.DataMigrationServiceList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either DataMigrationServiceList or the result of cls(response)
Return type
Exceptions
list_skus
Get compatible SKUs.
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_skus(group_name: str, service_name: str, **kwargs: Any) -> Iterable[_models.ServiceSkuList]
Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either ServiceSkuList or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.datamigration.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\datamigration\\models\\__init__.py'>
Feedback
Submit and view feedback for