Profiles - Can Migrate

Service:

CDN

API Version:

2024-02-01

Überprüft, ob das CDN-Profil zum Azure Frontdoor-Profil (Standard/Premium) migriert werden kann.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string	Name der Ressourcengruppe innerhalb des Azure-Abonnements. Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Die Azure-Abonnement-ID.
api-version	query	True	string	Version der API, die mit der Clientanforderung verwendet werden soll. Die aktuelle Version ist 2024-02-01.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
classicResourceReference	True	ResourceReference	Ressourcenreferenz des klassischen CDN-Profils oder der klassischen Frontdoor, die migriert werden müssen.

Antworten

Name	Typ	Beschreibung
200 OK	CanMigrateResult	OK. Die Anforderung wurde erfolgreich durchgeführt.
202 Accepted		Akzeptiert: Die Anforderung wurde für die Verarbeitung akzeptiert, und der Vorgang wird asynchron abgeschlossen. Headers location: string
Other Status Codes	ErrorResponse	CDN-Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

Profiles_CanMigrate

Sample Request

HTTP

POST https://management.azure.com/subscriptions/subid/resourceGroups/RG/providers/Microsoft.Cdn/canMigrate?api-version=2024-02-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/2024-02-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

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/92de53a5f1e0e03c94b40475d2135d97148ed014/specification/cdn/resource-manager/Microsoft.Cdn/stable/2024-02-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/2024-02-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=2024-02-01

Definitionen

Name	Beschreibung
CanMigrateDefaultSku	Empfohlene SKU für die Migration
CanMigrateParameters	Anforderungstext für den CanMigrate-Vorgang.
CanMigrateResult	Ergebnis für den CanMigrate-Vorgang.
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
MigrationErrorType	Die Fehlerantwort gibt an, dass der CDN-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.
ResourceReference	Verweis auf eine andere Ressource.

CanMigrateDefaultSku

Empfohlene SKU für die Migration

Name	Typ	Beschreibung
Premium_AzureFrontDoor	string
Standard_AzureFrontDoor	string

CanMigrateParameters

Anforderungstext für den CanMigrate-Vorgang.

Name	Typ	Beschreibung
classicResourceReference	ResourceReference	Ressourcenreferenz des klassischen CDN-Profils oder der klassischen Frontdoor, die migriert werden müssen.

CanMigrateResult

Ergebnis für den CanMigrate-Vorgang.

Name	Typ	Beschreibung
id	string	Ressourcen-ID
properties.canMigrate	boolean	Flag, das angibt, ob das Profil migriert werden kann
properties.defaultSku	CanMigrateDefaultSku	Empfohlene SKU für die Migration
properties.errors	MigrationErrorType[]	Liste der Migrationsfehler
type	string	Der Ressourcentyp.

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

MigrationErrorType

Die Fehlerantwort gibt an, dass der CDN-Dienst die eingehende Anforderung nicht verarbeiten kann. Der Grund wird in der Fehlermeldung angegeben.

Name	Typ	Beschreibung
code	string	Fehlercode
errorMessage	string	Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.
nextSteps	string	Beschreibt, was getan werden muss, um das Problem zu beheben
resourceName	string	Ressource, die das Problem hat.

ResourceReference

Verweis auf eine andere Ressource.

Name	Typ	Beschreibung
id	string	Ressourcen-ID