Services - Check Status

Service:

Data Migration

API Version:

2022-03-30-preview

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 https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}/checkStatus?api-version=2022-03-30-preview

URI Parameters

Name	In	Required	Type	Description
groupName	path	True	string	Name of the resource group
serviceName	path	True	string	Name of the service
subscriptionId	path	True	string	Subscription ID that identifies an Azure subscription.
api-version	query	True	string	Version of the API

Responses

Name	Type	Description
200 OK	DataMigrationServiceStatusResponse	Health checked
Other Status Codes	ApiError	Error

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Services_CheckStatus

Sample Request

HTTP

POST https://management.azure.com/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService/checkStatus?api-version=2022-03-30-preview

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.datamigration import DataMigrationManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datamigration
# USAGE
    python services_check_status.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = DataMigrationManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="fc04246f-04c5-437e-ac5e-206a19e7193f",
    )

    response = client.services.check_status(
        group_name="DmsSdkRg",
        service_name="DmsSdkService",
    )
    print(response)


# x-ms-original-file: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Services_CheckStatus.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.DataMigration;
using Azure.ResourceManager.DataMigration.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Services_CheckStatus.json
// this example is just showing the usage of "Services_CheckStatus" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this DataMigrationServiceResource created on azure
// for more information of creating DataMigrationServiceResource, please refer to the document of DataMigrationServiceResource
string subscriptionId = "fc04246f-04c5-437e-ac5e-206a19e7193f";
string groupName = "DmsSdkRg";
string serviceName = "DmsSdkService";
ResourceIdentifier dataMigrationServiceResourceId = DataMigrationServiceResource.CreateResourceIdentifier(subscriptionId, groupName, serviceName);
DataMigrationServiceResource dataMigrationService = client.GetDataMigrationServiceResource(dataMigrationServiceResourceId);

// invoke the operation
DataMigrationServiceStatusResponse result = await dataMigrationService.CheckStatusAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "agentVersion": "3.3.3871.6",
  "status": "Online",
  "vmSize": "Standard_A4_v2",
  "supportedTaskTypes": [
    "diagnostic.count",
    "diagnostic.echo",
    "diagnostic.error",
    "diagnostic.fastCount",
    "ConnectToSource.SqlServer.Sync",
    "SyncMigrationOperationalTelemetry.LogCollector",
    "GetUserTables.AzureSqlDb.Sync",
    "ConnectToTarget.SqlDb.Sync",
    "Migrate.MySql.AzureDbForMySql.Sync",
    "Migrate.SqlServer.AzureSqlDb.Sync",
    "ValidateMigrationInput.SqlServer.SqlDb.Sync",
    "DataMigration.AzureSqlDbPostMigrationValidationScenarioId",
    "GetTDECertificates.Sql",
    "Migrate.SqlServer.AzureSqlDbMI",
    "ValidateMigrationInput.SqlServer.AzureSqlDbMI",
    "ConnectToTarget.AzureDbForMySql",
    "ConnectToSource.SqlServer",
    "GetUserTables.Sql",
    "ConnectToTarget.AzureSqlDbMI",
    "ConnectToTarget.SqlDb",
    "Migrate.SqlServer.SqlDb",
    "ConnectToSource.MySql"
  ]
}

Definitions

Name	Description
ApiError	Error information.
createdByType
DataMigrationServiceStatusResponse	Service health status
ODataError	Error information in OData format.
SystemData

ApiError

Error information.

Name	Type	Description
error	ODataError	Error information in OData format
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.

createdByType

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataMigrationServiceStatusResponse

Service health status

Name	Type	Description
agentConfiguration	object	Agent Configuration
agentVersion	string	The DMS instance agent version
status	string	The machine-readable status, such as 'Initializing', 'Offline', 'Online', 'Deploying', 'Deleting', 'Stopped', 'Stopping', 'Starting', 'FailedToStart', 'FailedToStop' or 'Failed'
supportedTaskTypes	string[]	The list of supported task types
vmSize	string	The services virtual machine size, such as 'Standard_D2_v2'

ODataError

Error information in OData format.

Name	Type	Description
code	string	The machine-readable description of the error, such as 'InvalidRequest' or 'InternalServerError'
details	ODataError[]	Inner errors that caused this error
message	string	The human-readable description of the error

SystemData

Name	Type	Description
createdAt	string
createdBy	string
createdByType	createdByType
lastModifiedAt	string
lastModifiedBy	string
lastModifiedByType	createdByType