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

Rule Sets - Get

参考

Service:: Front Door Service

API Version:: 2023-05-01

获取现有的 AzureFrontDoor 规则集，该规则集名称位于指定的订阅、资源组和配置文件下。

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

URI 参数

名称	在	必需	类型	说明
profileName	path	True	string	资源组中唯一的 Azure Front Door Standard 或 Azure Front Door Premium 配置文件的名称。
resourceGroupName	path	True	string	Azure 订阅中的资源组的名称。 Regex pattern: `^[-\w\._]+$`
ruleSetName	path	True	string	全局唯一的配置文件下的规则集的名称。
subscriptionId	path	True	string	Azure 订阅 ID。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。当前版本为 2023-05-01。

响应

名称	类型	说明
200 OK	RuleSet	确定
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	模拟用户帐户

示例

RuleSets_Get

Sample Request

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


/** Samples for RuleSets Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/RuleSets_Get.json
     */
    /**
     * Sample code: RuleSets_Get.
     *
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void ruleSetsGet(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.cdnProfiles().manager().serviceClient().getRuleSets().getWithResponse("RG", "profile1", "ruleSet1",
            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 rule_sets_get.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.rule_sets.get(
        resource_group_name="RG",
        profile_name="profile1",
        rule_set_name="ruleSet1",
    )
    print(response)


# x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/RuleSets_Get.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/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/RuleSets_Get.json
func ExampleRuleSetsClient_Get() {
	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)
	}
	res, err := clientFactory.NewRuleSetsClient().Get(ctx, "RG", "profile1", "ruleSet1", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %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.RuleSet = armcdn.RuleSet{
	// 	Name: to.Ptr("ruleSet1"),
	// 	Type: to.Ptr("Microsoft.Cdn/profiles/rulesets"),
	// 	ID: to.Ptr("/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1"),
	// 	Properties: &armcdn.RuleSetProperties{
	// 		DeploymentStatus: to.Ptr(armcdn.DeploymentStatusNotStarted),
	// 		ProvisioningState: to.Ptr(armcdn.AfdProvisioningStateSucceeded),
	// 	},
	// }
}

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 Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
 *
 * @summary Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.
 * x-ms-original-file: specification/cdn/resource-manager/Microsoft.Cdn/stable/2023-05-01/examples/RuleSets_Get.json
 */
async function ruleSetsGet() {
  const subscriptionId = process.env["CDN_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["CDN_RESOURCE_GROUP"] || "RG";
  const profileName = "profile1";
  const ruleSetName = "ruleSet1";
  const credential = new DefaultAzureCredential();
  const client = new CdnManagementClient(credential, subscriptionId);
  const result = await client.ruleSets.get(resourceGroupName, profileName, ruleSetName);
  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

{
  "name": "ruleSet1",
  "id": "/subscriptions/subid/resourcegroups/RG/providers/Microsoft.Cdn/profiles/profile1/rulesets/ruleSet1",
  "type": "Microsoft.Cdn/profiles/rulesets",
  "properties": {
    "provisioningState": "Succeeded",
    "deploymentStatus": "NotStarted"
  }
}

定义

名称	说明
AfdErrorResponse	错误响应
AfdProvisioningState	预配状态
DeploymentStatus
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
IdentityType	创建/修改资源的标识类型
RuleSet	友好 RuleSet 名称映射到任何 RuleSet 或机密相关信息。
SystemData	只读系统数据

AfdErrorResponse

错误响应

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

AfdProvisioningState

预配状态

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

DeploymentStatus

名称	类型	说明
Failed	string
InProgress	string
NotStarted	string
Succeeded	string

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

RuleSet

友好 RuleSet 名称映射到任何 RuleSet 或机密相关信息。

名称	类型	说明
id	string	资源 ID。
name	string	资源名称。
properties.deploymentStatus	DeploymentStatus
properties.profileName	string	保存规则集的配置文件的名称。
properties.provisioningState	AfdProvisioningState	预配状态
systemData	SystemData	只读系统数据
type	string	资源类型。

SystemData

只读系统数据

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

Rule Sets - Get

URI 参数

响应

安全性

azure_auth

Scopes

示例

RuleSets_Get

Sample Request

Sample Response

定义

AfdErrorResponse

AfdProvisioningState

DeploymentStatus

ErrorAdditionalInfo

ErrorDetail

IdentityType

RuleSet

SystemData

其他资源