Streaming Policies - Get

サービス:

Media Services

API バージョン:

2022-08-01

ストリーミング ポリシーを取得する
Media Services アカウントでストリーミング ポリシーの詳細を取得する

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}?api-version=2022-08-01

URI パラメーター

名前	/	必須	型	説明
accountName	path	True	string	Media Services アカウント名。
resourceGroupName	path	True	string	Azure サブスクリプション内のリソース グループの名前。
streamingPolicyName	path	True	string	ストリーミング ポリシー名。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションの一意識別子。
api-version	query	True	string	クライアント要求で使用される API のバージョン。

応答

名前	型	説明
200 OK	StreamingPolicy	OK
Other Status Codes	ErrorResponse	詳細なエラー情報。

例

Get a Streaming Policy by name

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingPolicies/clearStreamingPolicy?api-version=2022-08-01

Java

/**
 * Samples for StreamingPolicies Get.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy
     * -get-by-name.json
     */
    /**
     * Sample code: Get a Streaming Policy by name.
     * 
     * @param manager Entry point to MediaServicesManager.
     */
    public static void getAStreamingPolicyByName(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager.streamingPolicies().getWithResponse("contosorg", "contosomedia", "clearStreamingPolicy",
            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.media import AzureMediaServices

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-media
# USAGE
    python streamingpolicygetbyname.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 = AzureMediaServices(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.streaming_policies.get(
        resource_group_name="contoso",
        account_name="contosomedia",
        streaming_policy_name="clearStreamingPolicy",
    )
    print(response)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy-get-by-name.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 armmediaservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/mediaservices/armmediaservices/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e7bf3adfa2d5e5cdbb804eec35279501794f461c/specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy-get-by-name.json
func ExampleStreamingPoliciesClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armmediaservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewStreamingPoliciesClient().Get(ctx, "contoso", "contosomedia", "clearStreamingPolicy", 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.StreamingPolicy = armmediaservices.StreamingPolicy{
	// 	Name: to.Ptr("clearStreamingPolicy"),
	// 	Type: to.Ptr("Microsoft.Media/mediaservices/streamingPolicies"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy"),
	// 	Properties: &armmediaservices.StreamingPolicyProperties{
	// 		Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-08T18:29:30.850Z"); return t}()),
	// 		NoEncryption: &armmediaservices.NoEncryption{
	// 			EnabledProtocols: &armmediaservices.EnabledProtocols{
	// 				Dash: to.Ptr(true),
	// 				Download: to.Ptr(true),
	// 				Hls: to.Ptr(true),
	// 				SmoothStreaming: to.Ptr(true),
	// 			},
	// 		},
	// 	},
	// }
}

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 { AzureMediaServices } = require("@azure/arm-mediaservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Get the details of a Streaming Policy in the Media Services account
 *
 * @summary Get the details of a Streaming Policy in the Media Services account
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy-get-by-name.json
 */
async function getAStreamingPolicyByName() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const streamingPolicyName = "clearStreamingPolicy";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const result = await client.streamingPolicies.get(
    resourceGroupName,
    accountName,
    streamingPolicyName
  );
  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

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;

// Generated from example definition: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-policy-get-by-name.json
// this example is just showing the usage of "StreamingPolicies_Get" 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 = "contoso";
string accountName = "contosomedia";
ResourceIdentifier mediaServicesAccountResourceId = MediaServicesAccountResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName);
MediaServicesAccountResource mediaServicesAccount = client.GetMediaServicesAccountResource(mediaServicesAccountResourceId);

// get the collection of this StreamingPolicyResource
StreamingPolicyCollection collection = mediaServicesAccount.GetStreamingPolicies();

// invoke the operation
string streamingPolicyName = "clearStreamingPolicy";
bool result = await collection.ExistsAsync(streamingPolicyName);

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

応答のサンプル

状態コード:

200

{
  "name": "clearStreamingPolicy",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy",
  "type": "Microsoft.Media/mediaservices/streamingPolicies",
  "properties": {
    "created": "2018-08-08T18:29:30.8501486Z",
    "noEncryption": {
      "enabledProtocols": {
        "download": true,
        "dash": true,
        "hls": true,
        "smoothStreaming": true
      }
    }
  }
}

定義

名前	説明
CbcsDrmConfiguration	ストリーミング ポリシーで CommonEncryptionCbcs スキームの DRM 構成を指定するクラス
CencDrmConfiguration	ストリーミング ポリシーで CommonEncryptionCenc スキームの DRM 構成を指定するクラス
ClearKeyEncryptionConfiguration	ストリーミング ポリシーで一般的な暗号化スキームの ClearKey 構成を指定するクラス
CommonEncryptionCbcs	CommonEncryptionCbcs 暗号化スキームのクラス
CommonEncryptionCenc	エンベロープ暗号化スキームのクラス
createdByType	リソースを作成した ID の種類。
DefaultKey	各暗号化スキームの既定のコンテンツ キーのプロパティを指定するクラス
EnabledProtocols	有効にするプロトコルを指定するクラス
EnvelopeEncryption	EnvelopeEncryption 暗号化スキームのクラス
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
NoEncryption	NoEncryption スキームのクラス
StreamingPolicy	ストリーミング ポリシー リソース
StreamingPolicyContentKey	コンテンツ キーのプロパティを指定するクラス
StreamingPolicyContentKeys	ストリーミング ポリシー内のすべてのコンテンツ キーのプロパティを指定するクラス
StreamingPolicyFairPlayConfiguration	ストリーミング ポリシーで FairPlay の構成を指定するクラス
StreamingPolicyPlayReadyConfiguration	ストリーミング ポリシーで PlayReady の構成を指定するクラス
StreamingPolicyWidevineConfiguration	ストリーミング ポリシーで Widevine の構成を指定するクラス
systemData	リソースの作成と最後の変更に関連するメタデータ。
TrackPropertyCompareOperation	プロパティ条件の追跡操作
TrackPropertyCondition	1 つのトラック プロパティ条件を指定するクラス
TrackPropertyType	Track プロパティの種類
TrackSelection	トラックを選択するクラス

CbcsDrmConfiguration

ストリーミング ポリシーで CommonEncryptionCbcs スキームの DRM 構成を指定するクラス

名前	型	説明
fairPlay	StreamingPolicyFairPlayConfiguration	FairPlay の構成
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady の構成
widevine	StreamingPolicyWidevineConfiguration	Widevine の構成

CencDrmConfiguration

ストリーミング ポリシーで CommonEncryptionCenc スキームの DRM 構成を指定するクラス

名前	型	説明
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady の構成
widevine	StreamingPolicyWidevineConfiguration	Widevine の構成

ClearKeyEncryptionConfiguration

ストリーミング ポリシーで一般的な暗号化スキームの ClearKey 構成を指定するクラス

名前	型	説明
customKeysAcquisitionUrlTemplate	string	エンド ユーザー プレーヤーにコンテンツ キーを配信するカスタム サービスの URL のテンプレート。 ライセンスの発行に Azure Media Services を使用するときは必要ありません。 このテンプレートでは、置換できるトークンがサポートされ、実行時にサービスによって要求固有の値に更新されます。 現在サポートされているトークン値は {AlternativeMediaId} で、StreamingLocatorId.AlternativeMediaId の値に置き換えられます。

CommonEncryptionCbcs

CommonEncryptionCbcs 暗号化スキームのクラス

名前	型	説明
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	CommonEncryptionCbcs 暗号化スキームで ClearKey をサポートするオプションの構成。
clearTracks	TrackSelection[]	暗号化すべきではないトラックを表す
contentKeys	StreamingPolicyContentKeys	各暗号化スキームの既定のコンテンツ キーと、特定のトラック用の個別のコンテンツ キーを表す
drm	CbcsDrmConfiguration	現在の暗号化スキームの DRM の構成
enabledProtocols	EnabledProtocols	サポートされているプロトコルの表し方

CommonEncryptionCenc

エンベロープ暗号化スキームのクラス

名前	型	説明
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	CommonEncryptionCenc 暗号化スキームで ClearKey をサポートするオプションの構成。
clearTracks	TrackSelection[]	暗号化すべきではないトラックを表す
contentKeys	StreamingPolicyContentKeys	各暗号化スキームの既定のコンテンツ キーと、特定のトラック用の個別のコンテンツ キーを表す
drm	CencDrmConfiguration	CommonEncryptionCenc 暗号化スキームの DRM の構成
enabledProtocols	EnabledProtocols	サポートされているプロトコルの表し方

createdByType

リソースを作成した ID の種類。

名前	型	説明
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

各暗号化スキームの既定のコンテンツ キーのプロパティを指定するクラス

名前	型	説明
label	string	ストリーミング ロケーターを作成するときに、ラベルを使用してコンテンツ キーを指定できます
policyName	string	既定のキーで使用されるポリシー

EnabledProtocols

有効にするプロトコルを指定するクラス

名前	型	説明
dash	boolean	DASH プロトコルを有効にするかどうか
download	boolean	ダウンロード プロトコルを有効にするかどうか
hls	boolean	HLS プロトコルを有効にするかどうか
smoothStreaming	boolean	SmoothStreaming プロトコルを有効にするかどうか

EnvelopeEncryption

EnvelopeEncryption 暗号化スキームのクラス

名前	型	説明
clearTracks	TrackSelection[]	暗号化すべきではないトラックを表す
contentKeys	StreamingPolicyContentKeys	各暗号化スキームの既定のコンテンツ キーと、特定のトラック用の個別のコンテンツ キーを表す
customKeyAcquisitionUrlTemplate	string	エンド ユーザー プレーヤーにキーを配信するカスタム サービスの URL のテンプレート。 キーの発行に Azure Media Services を使用するときは必要ありません。 このテンプレートでは、置換できるトークンがサポートされ、実行時にサービスによって要求固有の値に更新されます。 現在サポートされているトークンの値は、StreamingLocatorId.AlternativeMediaId の値で置換される {AlternativeMediaId} と、要求対象のキーの ID 値で置換される {ContentKeyId} です。
enabledProtocols	EnabledProtocols	サポートされているプロトコルの表し方

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーのターゲット。

ErrorResponse

エラー応答

名前	型	説明
error	ErrorDetail	error オブジェクト。

NoEncryption

NoEncryption スキームのクラス

名前	型	説明
enabledProtocols	EnabledProtocols	サポートされているプロトコルの表し方

StreamingPolicy

ストリーミング ポリシー リソース

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.commonEncryptionCbcs	CommonEncryptionCbcs	CommonEncryptionCbcs の構成
properties.commonEncryptionCenc	CommonEncryptionCenc	CommonEncryptionCenc の構成
properties.created	string	ストリーミング ポリシーの作成時刻
properties.defaultContentKeyPolicyName	string	現在のストリーミング ポリシーによって使用される既定の ContentKey
properties.envelopeEncryption	EnvelopeEncryption	EnvelopeEncryption の構成
properties.noEncryption	NoEncryption	NoEncryption の構成
systemData	systemData	このリソースに関連するシステム メタデータ。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

StreamingPolicyContentKey

コンテンツ キーのプロパティを指定するクラス

名前	型	説明
label	string	ストリーミング ロケーターを作成するときに、ラベルを使用してコンテンツ キーを指定できます
policyName	string	コンテンツ キーで使用されるポリシー
tracks	TrackSelection[]	このコンテンツ キーを使用するトラック

StreamingPolicyContentKeys

ストリーミング ポリシー内のすべてのコンテンツ キーのプロパティを指定するクラス

名前	型	説明
defaultKey	DefaultKey	暗号化スキームの既定のコンテンツ キー
keyToTrackMappings	StreamingPolicyContentKey[]	トラックを表すには、個別のコンテンツ キーが必要です

StreamingPolicyFairPlayConfiguration

ストリーミング ポリシーで FairPlay の構成を指定するクラス

名前	型	説明
allowPersistentLicense	boolean	すべてのライセンスが永続的かどうか
customLicenseAcquisitionUrlTemplate	string	エンド ユーザー プレーヤーにライセンスを配信するカスタム サービスの URL のテンプレート。 ライセンスの発行に Azure Media Services を使用するときは必要ありません。 このテンプレートでは、置換できるトークンがサポートされ、実行時にサービスによって要求固有の値に更新されます。 現在サポートされているトークンの値は、StreamingLocatorId.AlternativeMediaId の値で置換される {AlternativeMediaId} と、要求対象のキーの ID 値で置換される {ContentKeyId} です。

StreamingPolicyPlayReadyConfiguration

ストリーミング ポリシーで PlayReady の構成を指定するクラス

名前	型	説明
customLicenseAcquisitionUrlTemplate	string	エンド ユーザー プレーヤーにライセンスを配信するカスタム サービスの URL のテンプレート。 ライセンスの発行に Azure Media Services を使用するときは必要ありません。 このテンプレートでは、置換できるトークンがサポートされ、実行時にサービスによって要求固有の値に更新されます。 現在サポートされているトークンの値は、StreamingLocatorId.AlternativeMediaId の値で置換される {AlternativeMediaId} と、要求対象のキーの ID 値で置換される {ContentKeyId} です。
playReadyCustomAttributes	string	PlayReady のカスタム属性

StreamingPolicyWidevineConfiguration

ストリーミング ポリシーで Widevine の構成を指定するクラス

名前	型	説明
customLicenseAcquisitionUrlTemplate	string	エンド ユーザー プレーヤーにライセンスを配信するカスタム サービスの URL のテンプレート。 ライセンスの発行に Azure Media Services を使用するときは必要ありません。 このテンプレートでは、置換できるトークンがサポートされ、実行時にサービスによって要求固有の値に更新されます。 現在サポートされているトークンの値は、StreamingLocatorId.AlternativeMediaId の値で置換される {AlternativeMediaId} と、要求対象のキーの ID 値で置換される {ContentKeyId} です。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前	型	説明
createdAt	string	リソース作成のタイムスタンプ (UTC)。
createdBy	string	リソースを作成した ID。
createdByType	createdByType	リソースを作成した ID の種類。
lastModifiedAt	string	リソースの最終変更のタイムスタンプ (UTC)
lastModifiedBy	string	リソースを最後に変更した ID。
lastModifiedByType	createdByType	リソースを最後に変更した ID の種類。

TrackPropertyCompareOperation

プロパティ条件の追跡操作

名前	型	説明
Equal	string	等しい演算
Unknown	string	不明なトラック プロパティの比較操作

TrackPropertyCondition

1 つのトラック プロパティ条件を指定するクラス

名前	型	説明
operation	TrackPropertyCompareOperation	プロパティ条件の操作を追跡する
property	TrackPropertyType	プロパティの種類を追跡する
value	string	プロパティ値を追跡する

TrackPropertyType

Track プロパティの種類

名前	型	説明
FourCC	string	FourCC を追跡する
Unknown	string	不明なトラック プロパティ

TrackSelection

トラックを選択するクラス

名前	型	説明
trackSelections	TrackPropertyCondition[]	TrackSelections は、トラックを指定できるトラック プロパティ条件リストです