Streaming Policies - Get

Serviço:

Media Services

Versão da API:

2022-08-01

Obter uma Política de Transmissão em Fluxo
Obter os detalhes de uma Política de Transmissão em Fluxo na conta dos Serviços de Multimédia

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
accountName	path	True	string	O nome da conta dos Serviços de Multimédia.
resourceGroupName	path	True	string	O nome do grupo de recursos na subscrição do Azure.
streamingPolicyName	path	True	string	O nome da Política de Transmissão em Fluxo.
subscriptionId	path	True	string	O identificador exclusivo de uma subscrição do Microsoft Azure.
api-version	query	True	string	A versão da API a ser utilizada com o pedido de cliente.

Respostas

Name	Tipo	Description
200 OK	StreamingPolicy	OK
Other Status Codes	ErrorResponse	Informações detalhadas sobre o erro.

Exemplos

Get a Streaming Policy by name

Pedido de amostra

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

Resposta da amostra

Código de estado:

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
      }
    }
  }
}

Definições

Name	Description
CbcsDrmConfiguration	Classe para especificar as configurações de DRM do esquema CommonEncryptionCbcs na Política de Transmissão em Fluxo
CencDrmConfiguration	Classe para especificar as configurações de DRM do esquema CommonEncryptionCenc na Política de Transmissão em Fluxo
ClearKeyEncryptionConfiguration	Classe para especificar a configuração ClearKey de esquemas de encriptação comuns na Política de Transmissão em Fluxo
CommonEncryptionCbcs	Classe para o esquema de encriptação CommonEncryptionCbcs
CommonEncryptionCenc	Classe para esquema de encriptação de envelopes
createdByType	O tipo de identidade que criou o recurso.
DefaultKey	Classe para especificar propriedades da chave de conteúdo predefinida para cada esquema de encriptação
EnabledProtocols	Classe para especificar que protocolos estão ativados
EnvelopeEncryption	Class for EnvelopeEncryption encryption scheme (Classe para EnvelopeEncryption encryption scheme)
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta a erros
NoEncryption	Class for NoEncryption scheme (Classe para o esquema NoEncryption)
StreamingPolicy	Um recurso de Política de Transmissão em Fluxo
StreamingPolicyContentKey	Classe para especificar propriedades da chave de conteúdo
StreamingPolicyContentKeys	Classe para especificar propriedades de todas as chaves de conteúdo na Política de Transmissão em Fluxo
StreamingPolicyFairPlayConfiguration	Classe para especificar configurações do FairPlay na Política de Transmissão em Fluxo
StreamingPolicyPlayReadyConfiguration	Classe para especificar configurações do PlayReady na Política de Transmissão em Fluxo
StreamingPolicyWidevineConfiguration	Classe para especificar configurações do Widevine na Política de Transmissão em Fluxo
systemData	Metadados relativos à criação e última modificação do recurso.
TrackPropertyCompareOperation	Controlar a operação de condição de propriedade
TrackPropertyCondition	Classe para especificar uma condição de propriedade de registo
TrackPropertyType	Controlar o tipo de propriedade
TrackSelection	Classe para selecionar uma faixa

CbcsDrmConfiguration

Classe para especificar as configurações de DRM do esquema CommonEncryptionCbcs na Política de Transmissão em Fluxo

Name	Tipo	Description
fairPlay	StreamingPolicyFairPlayConfiguration	Configurações do FairPlay
playReady	StreamingPolicyPlayReadyConfiguration	Configurações do PlayReady
widevine	StreamingPolicyWidevineConfiguration	Configurações widevine

CencDrmConfiguration

Classe para especificar as configurações de DRM do esquema CommonEncryptionCenc na Política de Transmissão em Fluxo

Name	Tipo	Description
playReady	StreamingPolicyPlayReadyConfiguration	Configurações do PlayReady
widevine	StreamingPolicyWidevineConfiguration	Configurações widevine

ClearKeyEncryptionConfiguration

Classe para especificar a configuração ClearKey de esquemas de encriptação comuns na Política de Transmissão em Fluxo

Name	Tipo	Description
customKeysAcquisitionUrlTemplate	string	Modelo para o URL do serviço personalizado que fornece chaves de conteúdo aos leitores de utilizadores finais. Não é necessário ao utilizar os Serviços de Multimédia do Azure para emitir licenças. O modelo suporta tokens substituíveis que o serviço irá atualizar no runtime com o valor específico do pedido. O valor do token atualmente suportado é {AlternativeMediaId}, que é substituído pelo valor de StreamingLocatorId.AlternativeMediaId.

CommonEncryptionCbcs

Classe para o esquema de encriptação CommonEncryptionCbcs

Name	Tipo	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Configuração opcional que suporta ClearKey no esquema de encriptação CommonEncryptionCbcs.
clearTracks	TrackSelection[]	Representar as faixas que não devem ser encriptadas
contentKeys	StreamingPolicyContentKeys	Representar a chave de conteúdo predefinida para cada esquema de encriptação e chaves de conteúdo separadas para faixas específicas
drm	CbcsDrmConfiguration	Configuração de DRMs para o esquema de encriptação atual
enabledProtocols	EnabledProtocols	Representar protocolos suportados

CommonEncryptionCenc

Classe para esquema de encriptação de envelopes

Name	Tipo	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Configuração opcional que suporta ClearKey no esquema de encriptação CommonEncryptionCenc.
clearTracks	TrackSelection[]	Representar as faixas que não devem ser encriptadas
contentKeys	StreamingPolicyContentKeys	Representar a chave de conteúdo predefinida para cada esquema de encriptação e chaves de conteúdo separadas para faixas específicas
drm	CencDrmConfiguration	Configuração de DRMs para o esquema de encriptação CommonEncryptionCenc
enabledProtocols	EnabledProtocols	Representar protocolos suportados

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

Classe para especificar propriedades da chave de conteúdo predefinida para cada esquema de encriptação

Name	Tipo	Description
label	string	A etiqueta pode ser utilizada para especificar a Chave de Conteúdo ao criar um Localizador de Transmissão em Fluxo
policyName	string	Política utilizada pela Chave Predefinida

EnabledProtocols

Classe para especificar que protocolos estão ativados

Name	Tipo	Description
dash	boolean	Ativar ou não o protocolo DASH
download	boolean	Ativar o protocolo Transferir ou não
hls	boolean	Ativar ou não o protocolo HLS
smoothStreaming	boolean	Ativar ou não o protocolo SmoothStreaming

EnvelopeEncryption

Class for EnvelopeEncryption encryption scheme (Classe para EnvelopeEncryption encryption scheme)

Name	Tipo	Description
clearTracks	TrackSelection[]	Representar as faixas que não devem ser encriptadas
contentKeys	StreamingPolicyContentKeys	Representar a chave de conteúdo predefinida para cada esquema de encriptação e chaves de conteúdo separadas para faixas específicas
customKeyAcquisitionUrlTemplate	string	Modelo para o URL do serviço personalizado que fornece chaves aos leitores de utilizadores finais. Não é necessário ao utilizar os Serviços de Multimédia do Azure para emitir chaves. O modelo suporta tokens substituíveis que o serviço irá atualizar no runtime com o valor específico do pedido. Os valores de token atualmente suportados são {AlternativeMediaId}, que é substituído pelo valor de StreamingLocatorId.AlternativeMediaId e {ContentKeyId}, que é substituído pelo valor do identificador da chave que está a ser pedida.
enabledProtocols	EnabledProtocols	Representar protocolos suportados

ErrorAdditionalInfo

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta a erros

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

NoEncryption

Class for NoEncryption scheme (Classe para o esquema NoEncryption)

Name	Tipo	Description
enabledProtocols	EnabledProtocols	Representar protocolos suportados

StreamingPolicy

Um recurso de Política de Transmissão em Fluxo

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.commonEncryptionCbcs	CommonEncryptionCbcs	Configuração de CommonEncryptionCbcs
properties.commonEncryptionCenc	CommonEncryptionCenc	Configuração do CommonEncryptionCenc
properties.created	string	Hora de criação da Política de Transmissão em Fluxo
properties.defaultContentKeyPolicyName	string	ContentKey Predefinido utilizado pela Política de Transmissão em Fluxo atual
properties.envelopeEncryption	EnvelopeEncryption	Configuração de EnvelopeEncryption
properties.noEncryption	NoEncryption	Configurações do NoEncryption
systemData	systemData	Os metadados do sistema relacionados com este recurso.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

StreamingPolicyContentKey

Classe para especificar propriedades da chave de conteúdo

Name	Tipo	Description
label	string	A etiqueta pode ser utilizada para especificar a Chave de Conteúdo ao criar um Localizador de Transmissão em Fluxo
policyName	string	Política utilizada pela Chave de Conteúdo
tracks	TrackSelection[]	Faixas que utilizam esta chave de conteúdo

StreamingPolicyContentKeys

Classe para especificar propriedades de todas as chaves de conteúdo na Política de Transmissão em Fluxo

Name	Tipo	Description
defaultKey	DefaultKey	Chave de conteúdo predefinida para um esquema de encriptação
keyToTrackMappings	StreamingPolicyContentKey[]	Representar faixas precisa de uma chave de conteúdo separada

StreamingPolicyFairPlayConfiguration

Classe para especificar configurações do FairPlay na Política de Transmissão em Fluxo

Name	Tipo	Description
allowPersistentLicense	boolean	Todas as licenças para serem persistentes ou não
customLicenseAcquisitionUrlTemplate	string	Modelo para o URL do serviço personalizado que fornece licenças aos utilizadores finais. Não é necessário ao utilizar os Serviços de Multimédia do Azure para emitir licenças. O modelo suporta tokens substituíveis que o serviço irá atualizar no runtime com o valor específico do pedido. Os valores de token atualmente suportados são {AlternativeMediaId}, que é substituído pelo valor de StreamingLocatorId.AlternativeMediaId e {ContentKeyId}, que é substituído pelo valor do identificador da chave que está a ser pedida.

StreamingPolicyPlayReadyConfiguration

Classe para especificar configurações do PlayReady na Política de Transmissão em Fluxo

Name	Tipo	Description
customLicenseAcquisitionUrlTemplate	string	Modelo para o URL do serviço personalizado que fornece licenças aos leitores de utilizadores finais. Não é necessário ao utilizar os Serviços de Multimédia do Azure para emitir licenças. O modelo suporta tokens substituíveis que o serviço irá atualizar no runtime com o valor específico do pedido. Os valores de token atualmente suportados são {AlternativeMediaId}, que é substituído pelo valor de StreamingLocatorId.AlternativeMediaId e {ContentKeyId}, que é substituído pelo valor do identificador da chave que está a ser pedida.
playReadyCustomAttributes	string	Atributos personalizados para PlayReady

StreamingPolicyWidevineConfiguration

Classe para especificar configurações do Widevine na Política de Transmissão em Fluxo

Name	Tipo	Description
customLicenseAcquisitionUrlTemplate	string	Modelo para o URL do serviço personalizado que fornece licenças aos leitores de utilizadores finais. Não é necessário ao utilizar os Serviços de Multimédia do Azure para emitir licenças. O modelo suporta tokens substituíveis que o serviço irá atualizar no runtime com o valor específico do pedido. Os valores de token atualmente suportados são {AlternativeMediaId}, que é substituído pelo valor de StreamingLocatorId.AlternativeMediaId e {ContentKeyId}, que é substituído pelo valor do identificador da chave que está a ser pedida.

systemData

Metadados relativos à criação e última modificação do recurso.

Name	Tipo	Description
createdAt	string	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

TrackPropertyCompareOperation

Controlar a operação de condição de propriedade

Name	Tipo	Description
Equal	string	Operação de igual
Unknown	string	Operação de comparação de propriedades de registo desconhecida

TrackPropertyCondition

Classe para especificar uma condição de propriedade de registo

Name	Tipo	Description
operation	TrackPropertyCompareOperation	Controlar a operação de condição de propriedade
property	TrackPropertyType	Controlar tipo de propriedade
value	string	Controlar o valor da propriedade

TrackPropertyType

Controlar o tipo de propriedade

Name	Tipo	Description
FourCC	string	Controlar FourCC
Unknown	string	Propriedade de faixa desconhecida

TrackSelection

Classe para selecionar uma faixa

Name	Tipo	Description
trackSelections	TrackPropertyCondition[]	TrackSelections é uma lista de condição de propriedade de registo que pode especificar faixas