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

Mediaservices - List Edge Policies

Service:

Media Services

API Version:

2023-01-01

列出与媒体服务帐户关联的媒体边缘策略。
列出与媒体服务帐户关联的所有媒体边缘策略。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/listEdgePolicies?api-version=2023-01-01

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string	媒体服务帐户名称。
resourceGroupName	path	True	string	Azure 订阅中资源组的名称。
subscriptionId	path	True	string	Microsoft Azure 订阅的唯一标识符。
api-version	query	True	string	要与客户端请求一起使用的 API 的版本。

请求正文

名称	类型	说明
deviceId	string	边缘设备的唯一标识符。

响应

名称	类型	说明
200 OK	EdgePolicies	确定
Other Status Codes	ErrorResponse	详细的错误信息。

示例

List the media edge policies.

Sample Request

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contososports/listEdgePolicies?api-version=2023-01-01

{
  "deviceId": "contosiothubhost_contosoiotdevice"
}

Java

import com.azure.resourcemanager.mediaservices.models.ListEdgePoliciesInput;

/** Samples for Mediaservices ListEdgePolicies. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Accounts/stable/2023-01-01/examples/accounts-list-media-edge-policies.json
     */
    /**
     * Sample code: List the media edge policies.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listTheMediaEdgePolicies(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .mediaservices()
            .listEdgePoliciesWithResponse(
                "contosorg",
                "contososports",
                new ListEdgePoliciesInput().withDeviceId("contosiothubhost_contosoiotdevice"),
                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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.Media;
using Azure.ResourceManager.Media.Models;
using Azure.ResourceManager.Resources;

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Accounts/stable/2023-01-01/examples/accounts-list-media-edge-policies.json
// this example is just showing the usage of "Mediaservices_ListEdgePolicies" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this MediaServicesAccountResource created on azure
// for more information of creating MediaServicesAccountResource, please refer to the document of MediaServicesAccountResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "contosorg";
string accountName = "contososports";
ResourceIdentifier mediaServicesAccountResourceId = MediaServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
MediaServicesAccountResource mediaServicesAccount = client.GetMediaServicesAccountResource(mediaServicesAccountResourceId);

// invoke the operation
EdgePoliciesRequestContent content = new EdgePoliciesRequestContent()
{
    DeviceId = "contosiothubhost_contosoiotdevice",
};
MediaServicesEdgePolicies result = await mediaServicesAccount.GetEdgePoliciesAsync(content);

Console.WriteLine($"Succeeded: {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

{
  "usageDataCollectionPolicy": {
    "dataCollectionFrequency": "PT10M",
    "dataReportingFrequency": "PT1H",
    "maxAllowedUnreportedUsageDuration": "PT36H",
    "eventHubDetails": {
      "name": "ams-x",
      "namespace": "ams-y-1-1",
      "token": "SharedAccessSignature sr=sb%3a%2f%2fams-x.servicebus.windows.net%2fams-y-1-1%2fPublishers%2f96a510a1-0565-492a-a67f-83d1aed1d1f6_SampleDeviceId&sig=signature_value%3d&se=1584073736&skn=EdgeUsageData"
    }
  }
}

定义

名称	说明
EdgePolicies
EdgeUsageDataCollectionPolicy
EdgeUsageDataEventHub
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponse	错误响应
ListEdgePoliciesInput

EdgePolicies

名称	类型	说明
usageDataCollectionPolicy	EdgeUsageDataCollectionPolicy

EdgeUsageDataCollectionPolicy

名称	类型	说明
dataCollectionFrequency	string	ISO 8601 持续时间格式的使用数据收集频率，例如 PT10M 、PT5H。
dataReportingFrequency	string	ISO 8601 持续时间格式的使用情况数据报告频率，例如 PT10M 、PT5H。
eventHubDetails	EdgeUsageDataEventHub	将报告使用情况的事件中心的详细信息。
maxAllowedUnreportedUsageDuration	string	设备功能不会因不报告使用情况数据而受到影响的最长时间。

EdgeUsageDataEventHub

名称	类型	说明
name	string	将报告使用情况的事件中心的名称。
namespace	string	将在其中报告使用情况的事件中心的命名空间。
token	string	与事件中心交互所需的 SAS 令牌。

ErrorAdditionalInfo

资源管理错误附加信息。

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

ErrorDetail

错误详细信息。

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

ErrorResponse

错误响应

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

ListEdgePoliciesInput

名称	类型	说明
deviceId	string	边缘设备的唯一标识符。