Profiles - Migrate

Reference

Service:: CDN

API Version:: 2023-05-01

Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.

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

URI Parameters

Name In Required Type Description

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.

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.
profileName	True	string	Name of the new profile that need to be created.
sku	True	Sku	Sku for the migration
migrationWebApplicationFirewallMappings		MigrationWebApplicationFirewallMapping[]	Waf mapping for the migrated profile

Responses

Name	Type	Description
200 OK	MigrateResult	OK. The request has succeeded.
202 Accepted	MigrateResult	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.

Name

Type

Description

200 OK

MigrateResult

OK. The request has succeeded.

202 Accepted

MigrateResult

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_Migrate

Sample Request

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

{
  "sku": {
    "name": "Standard_AzureFrontDoor"
  },
  "classicResourceReference": {
    "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"
  },
  "profileName": "profile1"
}


import com.azure.resourcemanager.cdn.models.MigrationParameters;
import com.azure.resourcemanager.cdn.models.ResourceReference;
import com.azure.resourcemanager.cdn.models.Sku;
import com.azure.resourcemanager.cdn.models.SkuName;

/** Samples for Profiles Migrate. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_Migrate.json
     */
    /**
     * Sample code: Profiles_Migrate.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void profilesMigrate(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getProfiles().migrate("RG",
            new MigrationParameters().withSku(new Sku().withName(SkuName.STANDARD_AZURE_FRONT_DOOR))
                .withClassicResourceReference(new ResourceReference().withId(
                    "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"))
                .withProfileName("profile1"),
            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

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

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cdn
# USAGE
    python profiles_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_migrate(
        resource_group_name="RG",
        migration_parameters={
            "classicResourceReference": {
                "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"
            },
            "profileName": "profile1",
            "sku": {"name": "Standard_AzureFrontDoor"},
        },
    ).result()
    print(response)


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

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_Migrate.json
func ExampleProfilesClient_BeginMigrate() {
	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().BeginMigrate(ctx, "RG", armcdn.MigrationParameters{
		ClassicResourceReference: &armcdn.ResourceReference{
			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname"),
		},
		ProfileName: to.Ptr("profile1"),
		SKU: &armcdn.SKU{
			Name: to.Ptr(armcdn.SKUNameStandardAzureFrontDoor),
		},
	}, 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.MigrateResult = armcdn.MigrateResult{
	// 	Type: to.Ptr("Microsoft.Cdn/migrate"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1"),
	// 	Properties: &armcdn.MigrateResultProperties{
	// 		MigratedProfileResourceID: &armcdn.ResourceReference{
	// 			ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1"),
	// 		},
	// 	},
	// }
}

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

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

/**
 * This sample demonstrates how to Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
 *
 * @summary Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/Profiles_Migrate.json
 */
async function profilesMigrate() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const migrationParameters = {
    classicResourceReference: {
      id: "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoors/frontdoorname",
    },
    profileName: "profile1",
    sku: { name: "Standard_AzureFrontDoor" },
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.profiles.beginMigrateAndWait(resourceGroupName, migrationParameters);
  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/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1",
  "type": "Microsoft.Cdn/migrate",
  "properties": {
    "migratedProfileResourceId": {
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1"
    }
  }
}

Status code:: 202

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

Response Body

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/operationresults/operationid/profileresults/profile1/migrateresults/profile1",
  "type": "Microsoft.Cdn/migrate",
  "properties": {
    "migratedProfileResourceId": {
      "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1"
    }
  }
}

Definitions

Name	Description
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MigrateResult	Result for migrate operation.
MigrationParameters	Request body for Migrate operation.
MigrationWebApplicationFirewallMapping	Web Application Firewall Mapping
ResourceReference	Reference to another resource.
Sku	Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.
SkuName	Name of the pricing tier.

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.

MigrateResult

Result for migrate operation.

Name	Type	Description
id	string	Resource ID.
properties.migratedProfileResourceId	ResourceReference	Arm resource id of the migrated profile
type	string	Resource type.

MigrationParameters

Request body for Migrate operation.

Name	Type	Description
classicResourceReference	ResourceReference	Resource reference of the classic cdn profile or classic frontdoor that need to be migrated.
migrationWebApplicationFirewallMappings	MigrationWebApplicationFirewallMapping[]	Waf mapping for the migrated profile
profileName	string	Name of the new profile that need to be created.
sku	Sku	Sku for the migration

MigrationWebApplicationFirewallMapping

Web Application Firewall Mapping

Name	Type	Description
migratedFrom	ResourceReference	Migration From Waf policy
migratedTo	ResourceReference	Migration to Waf policy

ResourceReference

Reference to another resource.

Name	Type	Description
id	string	Resource ID.

Sku

Standard_Verizon = The SKU name for a Standard Verizon CDN profile. Premium_Verizon = The SKU name for a Premium Verizon CDN profile. Custom_Verizon = The SKU name for a Custom Verizon CDN profile. Standard_Akamai = The SKU name for an Akamai CDN profile. Standard_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using GB based billing model. Standard_Microsoft = The SKU name for a Standard Microsoft CDN profile. Standard_AzureFrontDoor = The SKU name for an Azure Front Door Standard profile. Premium_AzureFrontDoor = The SKU name for an Azure Front Door Premium profile. Standard_955BandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using 95-5 peak bandwidth billing model. Standard_AvgBandWidth_ChinaCdn = The SKU name for a China CDN profile for VOD, Web and download scenarios using monthly average peak bandwidth billing model. StandardPlus_ChinaCdn = The SKU name for a China CDN profile for live-streaming using GB based billing model. StandardPlus_955BandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using 95-5 peak bandwidth billing model. StandardPlus_AvgBandWidth_ChinaCdn = The SKU name for a China CDN live-streaming profile using monthly average peak bandwidth billing model.

Name	Type	Description
name	SkuName	Name of the pricing tier.

SkuName

Name of the pricing tier.

Name	Type	Description
Custom_Verizon	string
Premium_AzureFrontDoor	string
Premium_Verizon	string
StandardPlus_955BandWidth_ChinaCdn	string
StandardPlus_AvgBandWidth_ChinaCdn	string
StandardPlus_ChinaCdn	string
Standard_955BandWidth_ChinaCdn	string
Standard_Akamai	string
Standard_AvgBandWidth_ChinaCdn	string
Standard_AzureFrontDoor	string
Standard_ChinaCdn	string
Standard_Microsoft	string
Standard_Verizon	string

Profiles - Migrate

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Profiles_Migrate

Sample Request

Sample Response

Definitions

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

MigrateResult

MigrationParameters

MigrationWebApplicationFirewallMapping

ResourceReference

Sku

SkuName

Additional resources