Services - Create Or Update

Service:

Data Migration

API Version:

2022-03-30-preview

Create or update DMS (classic) Instance
The services resource is the top-level resource that represents the Azure Database Migration Service (classic). 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.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.DataMigration/services/{serviceName}?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

Request Body

Name	Type	Description
etag	string	HTTP strong entity tag value. Ignored if submitted
kind	string	The resource kind. Only 'vm' (the default) is supported.
location	string
properties.autoStopDelay	string	The time delay before the service is auto-stopped when idle.
properties.deleteResourcesOnStop	boolean	Whether service resources should be deleted when stopped. (Turned on by default)
properties.publicKey	string	The public key of the service, used to encrypt secrets sent to the service
properties.virtualNicId	string	The ID of the Microsoft.Network/networkInterfaces resource which the service have
properties.virtualSubnetId	string	The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
sku	ServiceSku	Service SKU
tags	object

Responses

Name	Type	Description
200 OK	DataMigrationService	Service updated
201 Created	DataMigrationService	Service created (use provisioningState)
202 Accepted		Update accepted
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_CreateOrUpdate

Sample Request

HTTP

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

{
  "properties": {
    "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default"
  },
  "sku": {
    "name": "Basic_1vCore"
  },
  "location": "southcentralus"
}

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_create_or_update.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.begin_create_or_update(
        group_name="DmsSdkRg",
        service_name="DmsSdkService",
        parameters={
            "location": "southcentralus",
            "properties": {
                "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default"
            },
            "sku": {"name": "Basic_1vCore"},
        },
    ).result()
    print(response)


# x-ms-original-file: specification/datamigration/resource-manager/Microsoft.DataMigration/preview/2022-03-30-preview/examples/Services_CreateOrUpdate.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_CreateOrUpdate.json
// this example is just showing the usage of "Services_CreateOrUpdate" 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 ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "fc04246f-04c5-437e-ac5e-206a19e7193f";
string groupName = "DmsSdkRg";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, groupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this DataMigrationServiceResource
DataMigrationServiceCollection collection = resourceGroupResource.GetDataMigrationServices();

// invoke the operation
string serviceName = "DmsSdkService";
DataMigrationServiceData data = new DataMigrationServiceData(new AzureLocation("southcentralus"))
{
    Sku = new ServiceSku()
    {
        Name = "Basic_1vCore",
    },
    VirtualSubnetId = "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default",
};
ArmOperation<DataMigrationServiceResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, serviceName, data);
DataMigrationServiceResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
DataMigrationServiceData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

{
  "properties": {
    "provisioningState": "Accepted",
    "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default"
  },
  "etag": "9QuK/U0GvTJpjIrlOzITXVy68+bmmQ3bFkHudLxmkUw=",
  "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService",
  "location": "southcentralus",
  "name": "DmsSdkService",
  "sku": {
    "name": "Basic_1vCore",
    "size": "1 vCore",
    "tier": "Basic"
  },
  "type": "Microsoft.DataMigration/services"
}

Status code:

201

{
  "properties": {
    "provisioningState": "Accepted",
    "virtualSubnetId": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkTestNetwork/providers/Microsoft.Network/virtualNetworks/DmsSdkTestNetwork/subnets/default"
  },
  "etag": "9QuK/U0GvTJpjIrlOzITXVy68+bmmQ3bFkHudLxmkUw=",
  "id": "/subscriptions/fc04246f-04c5-437e-ac5e-206a19e7193f/resourceGroups/DmsSdkRg/providers/Microsoft.DataMigration/services/DmsSdkService",
  "location": "southcentralus",
  "name": "DmsSdkService",
  "sku": {
    "name": "Basic_1vCore",
    "size": "1 vCore",
    "tier": "Basic"
  },
  "type": "Microsoft.DataMigration/services"
}

Status code:

202

Definitions

Name	Description
ApiError	Error information.
createdByType
DataMigrationService	An Azure Database Migration Service (classic) resource
ODataError	Error information in OData format.
ServiceProvisioningState	The resource's provisioning state
ServiceSku	An Azure SKU instance
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

DataMigrationService

An Azure Database Migration Service (classic) resource

Name	Type	Description
etag	string	HTTP strong entity tag value. Ignored if submitted
id	string
kind	string	The resource kind. Only 'vm' (the default) is supported.
location	string
name	string
properties.autoStopDelay	string	The time delay before the service is auto-stopped when idle.
properties.deleteResourcesOnStop	boolean	Whether service resources should be deleted when stopped. (Turned on by default)
properties.provisioningState	ServiceProvisioningState	The resource's provisioning state
properties.publicKey	string	The public key of the service, used to encrypt secrets sent to the service
properties.virtualNicId	string	The ID of the Microsoft.Network/networkInterfaces resource which the service have
properties.virtualSubnetId	string	The ID of the Microsoft.Network/virtualNetworks/subnets resource to which the service should be joined
sku	ServiceSku	Service SKU
systemData	SystemData	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string

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

ServiceProvisioningState

The resource's provisioning state

Name	Type	Description
Accepted	string
Deleting	string
Deploying	string
Failed	string
FailedToStart	string
FailedToStop	string
Starting	string
Stopped	string
Stopping	string
Succeeded	string

ServiceSku

An Azure SKU instance

Name	Type	Description
capacity	integer	The capacity of the SKU, if it supports scaling
family	string	The SKU family, used when the service has multiple performance classes within a tier, such as 'A', 'D', etc. for virtual machines
name	string	The unique name of the SKU, such as 'P3'
size	string	The size of the SKU, used when the name alone does not denote a service size or when a SKU has multiple performance classes within a family, e.g. 'A1' for virtual machines
tier	string	The tier of the SKU, such as 'Basic', 'General Purpose', or 'Business Critical'

SystemData

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