Profiles - Can Migrate

Service:

CDN

API Version:

2023-05-01

Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Cdn/canMigrate?api-version=2023-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	Name of the Resource group within the Azure subscription. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure Subscription ID.
api-version	query	True	string	Version of the API to be used with the client request. Current version is 2023-05-01.

Request Body

Name	Required	Type	Description
classicResourceReference	True	ResourceReference	Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.

Responses

Name	Type	Description
200 OK	CanMigrateResult	OK. The request has succeeded.
202 Accepted		Accepted. The request has been accepted for processing and the operation will complete asynchronously. Headers location: string
Other Status Codes	ErrorResponse	CDN error response describing why the operation failed.

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

Profiles_CanMigrate

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/canMigrate?api-version=2023-05-01

{
  "classicResourceReference": {
    "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"
  }
}

Java

import com.azure.resourcemanager.cdn.models.CanMigrateParameters;
import com.azure.resourcemanager.cdn.models.ResourceReference;

/** Samples for Profiles CanMigrate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_CanMigrate.json
     */
    /**
     * Sample code: Profiles_CanMigrate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void profilesCanMigrate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getProfiles().canMigrate("RG",
            new CanMigrateParameters().withClassicResourceReference(new ResourceReference()
                .withId("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname")),
            com.azure.core.util.Context.NONE);
    }
}

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

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.cdn import CdnManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python profiles_can_migrate.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 = CdnManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.profiles.begin_can_migrate(
        resource_group_name="RG",
        can_migrate_parameters={
            "classicResourceReference": {
                "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"
            }
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_CanMigrate.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

Go

package armcdn_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cdn/armcdn/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/7b551033155a63739b6d28f79b9c07569f6179b8/specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_CanMigrate.json
func ExampleProfilesClient_BeginCanMigrate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcdn.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewProfilesClient().BeginCanMigrate(ctx, "RG", armcdn.CanMigrateParameters{
		ClassicResourceReference: &armcdn.ResourceReference{
			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.CanMigrateResult = armcdn.CanMigrateResult{
	// 	Type: to.Ptr("Microsoft.Cdn/canmigrate"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/yaoshitest/providers/Microsoft.Cdn/operationresults/operationid/profileresults/DummyProfile/canmigrateresults/DummyProfile"),
	// 	Properties: &armcdn.CanMigrateProperties{
	// 		CanMigrate: to.Ptr(true),
	// 		DefaultSKU: to.Ptr(armcdn.CanMigrateDefaultSKUStandardAzureFrontDoor),
	// 	},
	// }
}

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

JavaScript

const { CdnManagementClient } = require("@azure/arm-cdn");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
 *
 * @summary Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_CanMigrate.json
 */
async function profilesCanMigrate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const canMigrateParameters = {
    classicResourceReference: {
      id: "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.profiles.beginCanMigrateAndWait(
    resourceGroupName,
    canMigrateParameters
  );
  console.log(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

{
  "id": "/subscriptions/subid/resourcegroups/yaoshitest/providers/Microsoft.Cdn/operationresults/operationid/profileresults/DummyProfile/canmigrateresults/DummyProfile",
  "type": "Microsoft.Cdn/canmigrate",
  "properties": {
    "canMigrate": true,
    "defaultSku": "Standard_AzureFrontDoor",
    "errors": null
  }
}

Status code:

202

azure-asyncoperation: https://management.azure.com/subscriptions/subid/resourcegroups/resourceGroupName/providers/Microsoft.Cdn/operationresults/operationId?api-version=2023-05-01

Definitions

Name	Description
CanMigrateDefaultSku	Recommended sku for the migration
CanMigrateParameters	Request body for CanMigrate operation.
CanMigrateResult	Result for canMigrate operation.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MigrationErrorType	Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.
ResourceReference	Reference to another resource.

CanMigrateDefaultSku

Recommended sku for the migration

Name	Type	Description
Premium_AzureFrontDoor	string
Standard_AzureFrontDoor	string

CanMigrateParameters

Request body for CanMigrate operation.

Name	Type	Description
classicResourceReference	ResourceReference	Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.

CanMigrateResult

Result for canMigrate operation.

Name	Type	Description
id	string	Resource ID.
properties.canMigrate	boolean	Flag that says if the profile can be migrated
properties.defaultSku	CanMigrateDefaultSku	Recommended sku for the migration
properties.errors	MigrationErrorType[]	List of migration errors
type	string	Resource type.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

MigrationErrorType

Error response indicates CDN service is not able to process the incoming request. The reason is provided in the error message.

Name	Type	Description
code	string	Error code.
errorMessage	string	Error message indicating why the operation failed.
nextSteps	string	Describes what needs to be done to fix the problem
resourceName	string	Resource which has the problem.

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.