你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

AFD Profiles - Upgrade

Service:

Front Door Service

API Version:

2023-05-01

将配置文件从 Standard_AzureFrontDoor 升级到 Premium_AzureFrontDoor。

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

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string	资源组中唯一的 Azure Front Door Standard 或 Azure Front Door Premium 的名称。 Regex pattern: ^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。 Regex pattern: ^[-\w\._\(\)]+$
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。 当前版本为 2023-05-01。

请求正文

名称	必需	类型	说明
wafMappingList	True	ProfileChangeSkuWafMapping[]	Web 应用程序防火墙 (配置文件升级的 WAF) 和安全策略映射

响应

名称	类型	说明
200 OK	Profile	没问题。 请求已成功。
202 Accepted	Profile	已接受。 已接受请求进行处理，操作将以异步方式完成。 Headers location: string
Other Status Codes	AfdErrorResponse	描述操作失败原因的 Azure Front Door 错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

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

Scopes

名称	说明
user_impersonation	模拟用户帐户

示例

AFDProfiles_Upgrade

Sample Request

HTTP

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

{
  "wafMappingList": [
    {
      "securityPolicyName": "securityPolicy1",
      "changeToWafPolicy": {
        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2"
      }
    }
  ]
}

Java

import com.azure.resourcemanager.cdn.models.ProfileChangeSkuWafMapping;
import com.azure.resourcemanager.cdn.models.ProfileUpgradeParameters;
import com.azure.resourcemanager.cdn.models.ResourceReference;
import java.util.Arrays;

/** Samples for AfdProfiles Upgrade. */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_Upgrade.json
     */
    /**
     * Sample code: AFDProfiles_Upgrade.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void aFDProfilesUpgrade(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getAfdProfiles().upgrade("RG", "profile1",
            new ProfileUpgradeParameters().withWafMappingList(Arrays.asList(new ProfileChangeSkuWafMapping()
                .withSecurityPolicyName("securityPolicy1")
                .withChangeToWafPolicy(new ResourceReference().withId(
                    "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2")))),
            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 afd_profiles_upgrade.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.afd_profiles.begin_upgrade(
        resource_group_name="RG",
        profile_name="profile1",
        profile_upgrade_parameters={
            "wafMappingList": [
                {
                    "changeToWafPolicy": {
                        "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2"
                    },
                    "securityPolicyName": "securityPolicy1",
                }
            ]
        },
    ).result()
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_Upgrade.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/AFDProfiles_Upgrade.json
func ExampleAFDProfilesClient_BeginUpgrade() {
	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.NewAFDProfilesClient().BeginUpgrade(ctx, "RG", "profile1", armcdn.ProfileUpgradeParameters{
		WafMappingList: []*armcdn.ProfileChangeSKUWafMapping{
			{
				ChangeToWafPolicy: &armcdn.ResourceReference{
					ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2"),
				},
				SecurityPolicyName: to.Ptr("securityPolicy1"),
			}},
	}, 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.Profile = armcdn.Profile{
	// 	Name: to.Ptr("profile1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1"),
	// 	Location: to.Ptr("Global"),
	// 	Tags: map[string]*string{
	// 	},
	// 	Kind: to.Ptr("frontdoor"),
	// 	Properties: &armcdn.ProfileProperties{
	// 		ExtendedProperties: map[string]*string{
	// 		},
	// 		FrontDoorID: to.Ptr("id"),
	// 		OriginResponseTimeoutSeconds: to.Ptr[int32](60),
	// 		ProvisioningState: to.Ptr(armcdn.ProfileProvisioningStateSucceeded),
	// 		ResourceState: to.Ptr(armcdn.ProfileResourceState("Enabled")),
	// 	},
	// 	SKU: &armcdn.SKU{
	// 		Name: to.Ptr(armcdn.SKUNameStandardAzureFrontDoor),
	// 	},
	// }
}

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 Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.
 *
 * @summary Upgrade a profile from Standard_AzureFrontDoor to Premium_AzureFrontDoor.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/AFDProfiles_Upgrade.json
 */
async function afdProfilesUpgrade() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const profileUpgradeParameters = {
    wafMappingList: [
      {
        changeToWafPolicy: {
          id: "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Network/frontdoorwebapplicationfirewallpolicies/waf2",
        },
        securityPolicyName: "securityPolicy1",
      },
    ],
  };
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.afdProfiles.beginUpgradeAndWait(
    resourceGroupName,
    profileName,
    profileUpgradeParameters
  );
  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/profiles/profile1",
  "type": "Microsoft.Cdn/profiles",
  "name": "profile1",
  "location": "Global",
  "kind": "frontdoor",
  "tags": {},
  "sku": {
    "name": "Standard_AzureFrontDoor"
  },
  "properties": {
    "extendedProperties": {},
    "frontDoorId": "id",
    "originResponseTimeoutSeconds": 60,
    "provisioningState": "Succeeded",
    "resourceState": "Enabled"
  }
}

Status code:

202

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

Response Body

{
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1",
  "type": "Microsoft.Cdn/profiles",
  "name": "profile1",
  "location": "Global",
  "kind": "frontdoor",
  "tags": {},
  "sku": {
    "name": "Standard_AzureFrontDoor"
  },
  "properties": {
    "originResponseTimeoutSeconds": 60,
    "frontDoorId": "id",
    "extendedProperties": {},
    "resourceState": "Upgrading",
    "provisioningState": "Succeeded"
  }
}

定义

名称	说明
AfdErrorResponse	错误响应
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
IdentityType	创建/修改资源的标识类型
ManagedServiceIdentity	托管服务标识 (系统分配的标识和/或用户分配的标识)
ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
Profile	配置文件是共享相同设置的终结点的逻辑分组。
ProfileChangeSkuWafMapping	配置文件升级所需的参数。
ProfileProvisioningState	配置文件的预配状态。
ProfileResourceState	配置文件的资源状态。
ProfileUpgradeParameters	配置文件升级所需的参数。
ResourceReference	对另一个资源的引用。
Sku	Standard_Verizon = 标准 Verizon CDN 配置文件的 SKU 名称。 Premium_Verizon = Premium Verizon CDN 配置文件的 SKU 名称。 Custom_Verizon = 自定义 Verizon CDN 配置文件的 SKU 名称。 Standard_Akamai = Akamai CDN 配置文件的 SKU 名称。 Standard_ChinaCdn = 使用基于 GB 的计费模型进行 VOD、Web 和下载方案的中国 CDN 配置文件的 SKU 名称。 Standard_Microsoft = 标准 Microsoft CDN 配置文件的 SKU 名称。 Standard_AzureFrontDoor = Azure Front Door 标准配置文件的 SKU 名称。 Premium_AzureFrontDoor = Azure Front Door Premium 配置文件的 SKU 名称。 Standard_955BandWidth_ChinaCdn = 使用 95-5 峰值带宽计费模型的 VOD、Web 和下载方案的中国 CDN 配置文件的 SKU 名称。 Standard_AvgBandWidth_ChinaCdn = 使用每月平均峰值带宽计费模型的 VOD、Web 和下载方案的中国 CDN 配置文件的 SKU 名称。 StandardPlus_ChinaCdn = 使用基于 GB 的计费模型进行实时流式传输的中国 CDN 配置文件的 SKU 名称。 StandardPlus_955BandWidth_ChinaCdn = 使用 95-5 峰值带宽计费模型的中国 CDN 实时流式处理配置文件的 SKU 名称。 StandardPlus_AvgBandWidth_ChinaCdn = 使用每月平均峰值带宽计费模型的中国 CDN 实时流式处理配置文件的 SKU 名称。
SkuName	定价层的名称。
SystemData	只读系统数据
UserAssignedIdentity	用户分配的标识属性

AfdErrorResponse

错误响应

名称	类型	说明
error	ErrorDetail	错误对象。

ErrorAdditionalInfo

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

IdentityType

创建/修改资源的标识类型

名称	类型	说明
application	string
key	string
managedIdentity	string
user	string

ManagedServiceIdentity

托管服务标识 (系统分配的标识和/或用户分配的标识)

名称	类型	说明
principalId	string	系统分配的标识的服务主体 ID。 仅为系统分配的标识提供此属性。
tenantId	string	系统分配的标识的租户 ID。 仅为系统分配的标识提供此属性。
type	ManagedServiceIdentityType	托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。
userAssignedIdentities	<string,  UserAssignedIdentity>	User-Assigned 标识 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将是采用以下格式的 ARM 资源 ID：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}。 字典值可以是请求中 ({}) 的空对象。

ManagedServiceIdentityType

托管服务标识的类型 (其中允许 systemAssigned 和 UserAssigned 类型) 。

名称	类型	说明
None	string
SystemAssigned	string
SystemAssigned, UserAssigned	string
UserAssigned	string

Profile

配置文件是共享相同设置的终结点的逻辑分组。

名称	类型	说明
id	string	资源 ID。
identity	ManagedServiceIdentity	托管服务标识 (系统分配的标识和/或用户分配的标识) 。
kind	string	配置文件的类型。 由门户用于区分传统 CDN 配置文件和新的 AFD 配置文件。
location	string	资源位置。
name	string	资源名称。
properties.extendedProperties	object	表示配置文件的其他属性的 Key-Value 对。
properties.frontDoorId	string	前门的 ID。
properties.originResponseTimeoutSeconds	integer	将请求转发到源时发送和接收超时。 达到超时后，请求将失败并返回。
properties.provisioningState	ProfileProvisioningState	配置文件的预配状态。
properties.resourceState	ProfileResourceState	配置文件的资源状态。
sku	Sku	定价层 (定义 Azure Front Door 标准版或高级版或 CDN 提供商、功能列表和配置文件的费率) 。
systemData	SystemData	只读系统数据
tags	object	资源标记。
type	string	资源类型。

ProfileChangeSkuWafMapping

配置文件升级所需的参数。

名称	类型	说明
changeToWafPolicy	ResourceReference	安全策略要使用的新 waf 资源。
securityPolicyName	string	安全策略名称。

ProfileProvisioningState

配置文件的预配状态。

名称	类型	说明
Creating	string
Deleting	string
Failed	string
Succeeded	string
Updating	string

ProfileResourceState

配置文件的资源状态。

名称	类型	说明
AbortingMigration	string
Active	string
CommittingMigration	string
Creating	string
Deleting	string
Disabled	string
Migrated	string
Migrating	string
PendingMigrationCommit	string

ProfileUpgradeParameters

配置文件升级所需的参数。

名称	类型	说明
wafMappingList	ProfileChangeSkuWafMapping[]	Web 应用程序防火墙 (配置文件升级的 WAF) 和安全策略映射

ResourceReference

对另一个资源的引用。

名称	类型	说明
id	string	资源 ID。

Sku

Standard_Verizon = 标准 Verizon CDN 配置文件的 SKU 名称。 Premium_Verizon = Premium Verizon CDN 配置文件的 SKU 名称。 Custom_Verizon = 自定义 Verizon CDN 配置文件的 SKU 名称。 Standard_Akamai = Akamai CDN 配置文件的 SKU 名称。 Standard_ChinaCdn = 使用基于 GB 的计费模型进行 VOD、Web 和下载方案的中国 CDN 配置文件的 SKU 名称。 Standard_Microsoft = 标准 Microsoft CDN 配置文件的 SKU 名称。 Standard_AzureFrontDoor = Azure Front Door 标准配置文件的 SKU 名称。 Premium_AzureFrontDoor = Azure Front Door Premium 配置文件的 SKU 名称。 Standard_955BandWidth_ChinaCdn = 使用 95-5 峰值带宽计费模型的 VOD、Web 和下载方案的中国 CDN 配置文件的 SKU 名称。 Standard_AvgBandWidth_ChinaCdn = 使用每月平均峰值带宽计费模型的 VOD、Web 和下载方案的中国 CDN 配置文件的 SKU 名称。 StandardPlus_ChinaCdn = 使用基于 GB 的计费模型进行实时流式传输的中国 CDN 配置文件的 SKU 名称。 StandardPlus_955BandWidth_ChinaCdn = 使用 95-5 峰值带宽计费模型的中国 CDN 实时流式处理配置文件的 SKU 名称。 StandardPlus_AvgBandWidth_ChinaCdn = 使用每月平均峰值带宽计费模型的中国 CDN 实时流式处理配置文件的 SKU 名称。

名称	类型	说明
name	SkuName	定价层的名称。

SkuName

定价层的名称。

名称	类型	说明
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

SystemData

只读系统数据

名称	类型	说明
createdAt	string	资源的创建时间戳 (UTC)
createdBy	string	创建资源的标识的标识符
createdByType	IdentityType	创建资源的标识类型
lastModifiedAt	string	资源上次修改的时间戳 (UTC)
lastModifiedBy	string	上次修改资源的标识的标识符
lastModifiedByType	IdentityType	上次修改资源的标识类型

UserAssignedIdentity

用户分配的标识属性

名称	类型	说明
clientId	string	分配的标识的客户端 ID。
principalId	string	已分配标识的主体 ID。