Streaming Policies - Get

Служба:

Media Services

Версия API:

2022-08-01

Получение политики потоковой передачи
Получение сведений о политике потоковой передачи в учетной записи Служб мультимедиа

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	Имя учетной записи Служб мультимедиа.
resourceGroupName	path	True	string	Имя группы ресурсов в подписке Azure.
streamingPolicyName	path	True	string	Имя политики потоковой передачи.
subscriptionId	path	True	string	Уникальный идентификатор подписки Microsoft Azure.
api-version	query	True	string	Версия API, используемая с клиентским запросом.

Ответы

Имя	Тип	Описание
200 OK	StreamingPolicy	ОК
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	Класс для указания конфигураций DRM схемы CommonEncryptionCbcs в политике потоковой передачи
CencDrmConfiguration	Класс для указания конфигураций DRM схемы CommonEncryptionCenc в политике потоковой передачи
ClearKeyEncryptionConfiguration	Класс для указания конфигурации ClearKey общих схем шифрования в политике потоковой передачи
CommonEncryptionCbcs	Класс для схемы шифрования CommonEncryptionCbcs
CommonEncryptionCenc	Класс для схемы шифрования конвертов
createdByType	Тип удостоверения, создавшего ресурс.
DefaultKey	Класс для указания свойств ключа содержимого по умолчанию для каждой схемы шифрования
EnabledProtocols	Класс для указания включенных протоколов
EnvelopeEncryption	Класс для схемы шифрования EnvelopeEncryption
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Сообщение об ошибке
NoEncryption	Класс для схемы NoEncryption
StreamingPolicy	Ресурс политики потоковой передачи
StreamingPolicyContentKey	Класс для указания свойств ключа содержимого
StreamingPolicyContentKeys	Класс для указания свойств всех ключей содержимого в политике потоковой передачи
StreamingPolicyFairPlayConfiguration	Класс для указания конфигураций FairPlay в политике потоковой передачи
StreamingPolicyPlayReadyConfiguration	Класс для указания конфигураций PlayReady в политике потоковой передачи
StreamingPolicyWidevineConfiguration	Класс для указания конфигураций Widevine в политике потоковой передачи
systemData	Метаданные, относящиеся к созданию и последнему изменению ресурса.
TrackPropertyCompareOperation	Операция отслеживания условий свойства
TrackPropertyCondition	Класс для указания одного условия свойства track
TrackPropertyType	Тип свойства Track
TrackSelection	Класс для выбора дорожки

CbcsDrmConfiguration

Класс для указания конфигураций DRM схемы CommonEncryptionCbcs в политике потоковой передачи

Имя	Тип	Описание
fairPlay	StreamingPolicyFairPlayConfiguration	Конфигурации FairPlay
playReady	StreamingPolicyPlayReadyConfiguration	Конфигурации PlayReady
widevine	StreamingPolicyWidevineConfiguration	Конфигурации Widevine

CencDrmConfiguration

Класс для указания конфигураций DRM схемы CommonEncryptionCenc в политике потоковой передачи

Имя	Тип	Описание
playReady	StreamingPolicyPlayReadyConfiguration	Конфигурации PlayReady
widevine	StreamingPolicyWidevineConfiguration	Конфигурации Widevine

ClearKeyEncryptionConfiguration

Класс для указания конфигурации ClearKey общих схем шифрования в политике потоковой передачи

Имя	Тип	Описание
customKeysAcquisitionUrlTemplate	string	Шаблон для URL-адреса пользовательской службы, предоставляющей ключи содержимого игрокам конечных пользователей. Не требуется при использовании Служб мультимедиа Azure для выдачи лицензий. Этот шаблон поддерживает заменяемые маркеры, которые служба будет обновлять во время выполнения, устанавливая значение, соответствующее запросу. Поддерживаемое в настоящее время значение маркера — {AlternativeMediaId}, которое заменяется значением StreamingLocatorId.AlternativeMediaId.

CommonEncryptionCbcs

Класс для схемы шифрования CommonEncryptionCbcs

Имя	Тип	Описание
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Необязательная конфигурация, поддерживающая ClearKey в схеме шифрования CommonEncryptionCbcs.
clearTracks	TrackSelection[]	Представление дорожек, которые не должны шифроваться
contentKeys	StreamingPolicyContentKeys	Представление ключа содержимого по умолчанию для каждой схемы шифрования и отдельных ключей содержимого для определенных дорожек
drm	CbcsDrmConfiguration	Настройка DRM для текущей схемы шифрования
enabledProtocols	EnabledProtocols	Представление поддерживаемых протоколов

CommonEncryptionCenc

Класс для схемы шифрования конвертов

Имя	Тип	Описание
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Необязательная конфигурация, поддерживающая ClearKey в схеме шифрования CommonEncryptionCenc.
clearTracks	TrackSelection[]	Представление дорожек, которые не должны шифроваться
contentKeys	StreamingPolicyContentKeys	Представление ключа содержимого по умолчанию для каждой схемы шифрования и отдельных ключей содержимого для определенных дорожек
drm	CencDrmConfiguration	Настройка DRM для схемы шифрования CommonEncryptionCenc
enabledProtocols	EnabledProtocols	Представление поддерживаемых протоколов

createdByType

Тип удостоверения, создавшего ресурс.

Имя	Тип	Описание
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 для выдачи ключей. Этот шаблон поддерживает заменяемые маркеры, которые служба будет обновлять во время выполнения, устанавливая значение, соответствующее запросу. В настоящее время поддерживаются значения маркера {AlternativeMediaId}, который заменяется значением StreamingLocatorId.AlternativeMediaId, и {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	Полный идентификатор ресурса. Например: /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 для выдачи лицензий. Этот шаблон поддерживает заменяемые маркеры, которые служба будет обновлять во время выполнения, устанавливая значение, соответствующее запросу. В настоящее время поддерживаются значения маркера {AlternativeMediaId}, который заменяется значением StreamingLocatorId.AlternativeMediaId и {ContentKeyId}, который заменяется значением идентификатора запрашиваемого ключа.

StreamingPolicyPlayReadyConfiguration

Класс для указания конфигураций PlayReady в политике потоковой передачи

Имя	Тип	Описание
customLicenseAcquisitionUrlTemplate	string	Шаблон для URL-адреса пользовательской службы, предоставляющей лицензии игрокам конечных пользователей. Не требуется при использовании Служб мультимедиа Azure для выдачи лицензий. Этот шаблон поддерживает заменяемые маркеры, которые служба будет обновлять во время выполнения, устанавливая значение, соответствующее запросу. В настоящее время поддерживаются значения маркера {AlternativeMediaId}, который заменяется значением StreamingLocatorId.AlternativeMediaId, и {ContentKeyId}, который заменяется значением идентификатора запрашиваемого ключа.
playReadyCustomAttributes	string	Настраиваемые атрибуты для PlayReady

StreamingPolicyWidevineConfiguration

Класс для указания конфигураций Widevine в политике потоковой передачи

Имя	Тип	Описание
customLicenseAcquisitionUrlTemplate	string	Шаблон для URL-адреса пользовательской службы, предоставляющей лицензии игрокам конечных пользователей. Не требуется при использовании Служб мультимедиа Azure для выдачи лицензий. Этот шаблон поддерживает заменяемые маркеры, которые служба будет обновлять во время выполнения, устанавливая значение, соответствующее запросу. В настоящее время поддерживаются значения маркера {AlternativeMediaId}, который заменяется значением StreamingLocatorId.AlternativeMediaId, и {ContentKeyId}, который заменяется значением идентификатора запрашиваемого ключа.

systemData

Метаданные, относящиеся к созданию и последнему изменению ресурса.

Имя	Тип	Описание
createdAt	string	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string	Метка времени последнего изменения ресурса (UTC)
lastModifiedBy	string	Удостоверение, которое последним изменял ресурс.
lastModifiedByType	createdByType	Тип удостоверения, которое последним изменял ресурс.

TrackPropertyCompareOperation

Операция отслеживания условий свойства

Имя	Тип	Описание
Equal	string	Операция равенства
Unknown	string	Операция сравнения свойств неизвестной дорожки

TrackPropertyCondition

Класс для указания одного условия свойства track

Имя	Тип	Описание
operation	TrackPropertyCompareOperation	Отслеживание операции с условием свойства
property	TrackPropertyType	Отслеживание типа свойства
value	string	Отслеживание значения свойства

TrackPropertyType

Тип свойства Track

Имя	Тип	Описание
FourCC	string	Отслеживание FourCC
Unknown	string	Неизвестное свойство дорожки

TrackSelection

Класс для выбора дорожки

Имя	Тип	Описание
trackSelections	TrackPropertyCondition[]	TrackSelections — это список условий свойств отслеживания, который может указывать дорожки