AZazure
Service resource
Custom operation
POST

Check service health status

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.

post/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkStatus

Request

  • Base URL
    https://management.azure.com
  • URL
    https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkStatus
  • Auth
    OAuth 2
    Implicit: https://login.microsoftonline.com/common/oauth2/authorize
    Scopes: user_impersonation

Path parameters

groupNamestring required

Name of the resource group

serviceNamestring required

Name of the service

Parameters

../../../../../../common-types/resource-management/v5/types.json#/components/parameters/ApiVersionParameter (unresolved $ref)
../../../../../../common-types/resource-management/v5/types.json#/components/parameters/SubscriptionIdParameter (unresolved $ref)

Response

Azure operation completed successfully.

agentVersionstring

The DMS instance agent version

agentConfigurationunknown
statusstring

The machine-readable status, such as 'Initializing', 'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping', 'Starting', 'FailedToStart', 'FailedToStop' or 'Failed'

vmSizestring

The services virtual machine size, such as 'Standard_D2_v2'

supportedTaskTypesstring[]

The list of supported task types

Changes

No recorded changes to this operation across all 2 revisions of this API.