Streaming Policies - Get

Servicio:

Media Services

Versión de la API:

2022-08-01

Obtener una directiva de streaming
Obtener los detalles de una directiva de streaming en la cuenta de Media Services

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
accountName	path	True	string	Nombre de la cuenta de Media Services.
resourceGroupName	path	True	string	Nombre del grupo de recursos dentro de la suscripción de Azure.
streamingPolicyName	path	True	string	Nombre de la directiva de streaming.
subscriptionId	path	True	string	Identificador único de una suscripción de Microsoft Azure.
api-version	query	True	string	Versión de la API que se va a usar con la solicitud de cliente.

Respuestas

Nombre	Tipo	Description
200 OK	StreamingPolicy	Aceptar
Other Status Codes	ErrorResponse	Información detallada del error.

Ejemplos

Get a Streaming Policy by name

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
CbcsDrmConfiguration	Clase para especificar configuraciones drm del esquema CommonEncryptionCbcs en la directiva de streaming
CencDrmConfiguration	Clase para especificar configuraciones drm del esquema CommonEncryptionCenc en la directiva de streaming
ClearKeyEncryptionConfiguration	Clase para especificar la configuración clearKey de esquemas de cifrado comunes en la directiva de streaming
CommonEncryptionCbcs	Clase para el esquema de cifrado CommonEncryptionCbcs
CommonEncryptionCenc	Clase para el esquema de cifrado de sobre
createdByType	Tipo de identidad que creó el recurso.
DefaultKey	Clase para especificar las propiedades de la clave de contenido predeterminada para cada esquema de cifrado
EnabledProtocols	Clase para especificar qué protocolos están habilitados
EnvelopeEncryption	Clase para el esquema de cifrado EnvelopeEncryption
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
NoEncryption	Clase para el esquema NoEncryption
StreamingPolicy	Un recurso de directiva de streaming
StreamingPolicyContentKey	Clase para especificar las propiedades de la clave de contenido
StreamingPolicyContentKeys	Clase para especificar propiedades de todas las claves de contenido en la directiva de streaming
StreamingPolicyFairPlayConfiguration	Clase para especificar configuraciones de FairPlay en la directiva de streaming
StreamingPolicyPlayReadyConfiguration	Clase para especificar configuraciones de PlayReady en la directiva de streaming
StreamingPolicyWidevineConfiguration	Clase para especificar configuraciones de Widevine en la directiva de streaming
systemData	Metadatos relacionados con la creación y la última modificación del recurso.
TrackPropertyCompareOperation	Realizar un seguimiento de la operación de condición de propiedad
TrackPropertyCondition	Clase para especificar una condición de propiedad de seguimiento
TrackPropertyType	Tipo de propiedad Track
TrackSelection	Clase para seleccionar una pista

CbcsDrmConfiguration

Clase para especificar configuraciones drm del esquema CommonEncryptionCbcs en la directiva de streaming

Nombre	Tipo	Description
fairPlay	StreamingPolicyFairPlayConfiguration	Configuraciones de FairPlay
playReady	StreamingPolicyPlayReadyConfiguration	Configuraciones de PlayReady
widevine	StreamingPolicyWidevineConfiguration	Configuraciones de Widevine

CencDrmConfiguration

Clase para especificar configuraciones drm del esquema CommonEncryptionCenc en la directiva de streaming

Nombre	Tipo	Description
playReady	StreamingPolicyPlayReadyConfiguration	Configuraciones de PlayReady
widevine	StreamingPolicyWidevineConfiguration	Configuraciones de Widevine

ClearKeyEncryptionConfiguration

Clase para especificar la configuración clearKey de esquemas de cifrado comunes en la directiva de streaming

Nombre	Tipo	Description
customKeysAcquisitionUrlTemplate	string	Plantilla para la dirección URL del servicio personalizado que entrega claves de contenido a los reproductores del usuario final. No se requiere cuando se usa Azure Media Services para emitir las licencias. La plantilla admite tokens reemplazables que el servicio actualizará en tiempo de ejecución con el valor específico de la solicitud. El valor de token admitido actualmente es {AlternativeMediaId}, que se reemplaza por el valor de StreamingLocatorId.AlternativeMediaId.

CommonEncryptionCbcs

Clase para el esquema de cifrado CommonEncryptionCbcs

Nombre	Tipo	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Configuración opcional que admite ClearKey en el esquema de cifrado CommonEncryptionCbcs.
clearTracks	TrackSelection[]	Representación de las pistas que no se deben cifrar
contentKeys	StreamingPolicyContentKeys	Representa la clave de contenido predeterminada para cada esquema de cifrado y claves de contenido independientes para pistas específicas
drm	CbcsDrmConfiguration	Configuración de DRM para el esquema de cifrado actual
enabledProtocols	EnabledProtocols	Representación de protocolos admitidos

CommonEncryptionCenc

Clase para el esquema de cifrado de sobre

Nombre	Tipo	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Configuración opcional que admite ClearKey en el esquema de cifrado CommonEncryptionCenc.
clearTracks	TrackSelection[]	Representación de las pistas que no se deben cifrar
contentKeys	StreamingPolicyContentKeys	Representa la clave de contenido predeterminada para cada esquema de cifrado y claves de contenido independientes para pistas específicas
drm	CencDrmConfiguration	Configuración de DRM para el esquema de cifrado CommonEncryptionCenc
enabledProtocols	EnabledProtocols	Representación de protocolos admitidos

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

Clase para especificar las propiedades de la clave de contenido predeterminada para cada esquema de cifrado

Nombre	Tipo	Description
label	string	La etiqueta se puede usar para especificar la clave de contenido al crear un localizador de streaming
policyName	string	Directiva usada por la clave predeterminada

EnabledProtocols

Clase para especificar qué protocolos están habilitados

Nombre	Tipo	Description
dash	boolean	Habilitar el protocolo DASH o no
download	boolean	Habilitar el protocolo de descarga o no
hls	boolean	Habilitación del protocolo HLS o no
smoothStreaming	boolean	Habilitación del protocolo SmoothStreaming o no

EnvelopeEncryption

Clase para el esquema de cifrado EnvelopeEncryption

Nombre	Tipo	Description
clearTracks	TrackSelection[]	Representación de las pistas que no se deben cifrar
contentKeys	StreamingPolicyContentKeys	Representa la clave de contenido predeterminada para cada esquema de cifrado y claves de contenido independientes para pistas específicas
customKeyAcquisitionUrlTemplate	string	Plantilla para la dirección URL del servicio personalizado que entrega claves a los jugadores del usuario final. No se requiere cuando se usa Azure Media Services para la emisión de claves. La plantilla admite tokens reemplazables que el servicio actualizará en tiempo de ejecución con el valor específico de la solicitud. Los valores de token que se admiten actualmente son {AlternativeMediaId}, que se reemplaza por el valor de StreamingLocatorId.AlternativeMediaId, y {ContentKeyId}, que se reemplaza por el valor de identificador de la clave solicitada.
enabledProtocols	EnabledProtocols	Representación de protocolos admitidos

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

NoEncryption

Clase para el esquema NoEncryption

Nombre	Tipo	Description
enabledProtocols	EnabledProtocols	Representación de protocolos admitidos

StreamingPolicy

Un recurso de directiva de streaming

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.commonEncryptionCbcs	CommonEncryptionCbcs	Configuración de CommonEncryptionCbcs
properties.commonEncryptionCenc	CommonEncryptionCenc	Configuración de CommonEncryptionCenc
properties.created	string	Hora de creación de la directiva de streaming
properties.defaultContentKeyPolicyName	string	ContentKey predeterminada que utiliza la directiva de streaming actual
properties.envelopeEncryption	EnvelopeEncryption	Configuración de EnvelopeEncryption
properties.noEncryption	NoEncryption	Configuraciones de NoEncryption
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

StreamingPolicyContentKey

Clase para especificar las propiedades de la clave de contenido

Nombre	Tipo	Description
label	string	La etiqueta se puede usar para especificar la clave de contenido al crear un localizador de streaming
policyName	string	Directiva usada por la clave de contenido
tracks	TrackSelection[]	Pistas que usan esta clave de contenido

StreamingPolicyContentKeys

Clase para especificar propiedades de todas las claves de contenido en la directiva de streaming

Nombre	Tipo	Description
defaultKey	DefaultKey	Clave de contenido predeterminada para un esquema de cifrado
keyToTrackMappings	StreamingPolicyContentKey[]	La representación de pistas necesita una clave de contenido independiente

StreamingPolicyFairPlayConfiguration

Clase para especificar configuraciones de FairPlay en la directiva de streaming

Nombre	Tipo	Description
allowPersistentLicense	boolean	Toda la licencia para que sea persistente o no
customLicenseAcquisitionUrlTemplate	string	Plantilla para la dirección URL del servicio personalizado que entrega licencias a los jugadores de usuario final. No se requiere cuando se usa Azure Media Services para emitir las licencias. La plantilla admite tokens reemplazables que el servicio actualizará en tiempo de ejecución con el valor específico de la solicitud. Los valores de token que se admiten actualmente son {AlternativeMediaId}, que se reemplaza por el valor de StreamingLocatorId.AlternativeMediaId, y {ContentKeyId}, que se reemplaza por el valor de identificador de la clave solicitada.

StreamingPolicyPlayReadyConfiguration

Clase para especificar configuraciones de PlayReady en la directiva de streaming

Nombre	Tipo	Description
customLicenseAcquisitionUrlTemplate	string	Plantilla para la dirección URL del servicio personalizado que entrega licencias a los jugadores del usuario final. No se requiere cuando se usa Azure Media Services para emitir las licencias. La plantilla admite tokens reemplazables que el servicio actualizará en tiempo de ejecución con el valor específico de la solicitud. Los valores de token que se admiten actualmente son {AlternativeMediaId}, que se reemplaza por el valor de StreamingLocatorId.AlternativeMediaId, y {ContentKeyId}, que se reemplaza por el valor de identificador de la clave solicitada.
playReadyCustomAttributes	string	Atributos personalizados para PlayReady

StreamingPolicyWidevineConfiguration

Clase para especificar configuraciones de Widevine en la directiva de streaming

Nombre	Tipo	Description
customLicenseAcquisitionUrlTemplate	string	Plantilla para la dirección URL del servicio personalizado que entrega licencias a los jugadores del usuario final. No se requiere cuando se usa Azure Media Services para emitir las licencias. La plantilla admite tokens reemplazables que el servicio actualizará en tiempo de ejecución con el valor específico de la solicitud. Los valores de token que se admiten actualmente son {AlternativeMediaId}, que se reemplaza por el valor de StreamingLocatorId.AlternativeMediaId, y {ContentKeyId}, que se reemplaza por el valor de identificador de la clave solicitada.

systemData

Metadatos relacionados con la creación y la última modificación del recurso.

Nombre	Tipo	Description
createdAt	string	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

TrackPropertyCompareOperation

Realizar un seguimiento de la operación de condición de propiedad

Nombre	Tipo	Description
Equal	string	Operación igual
Unknown	string	Operación de comparación de propiedades de seguimiento desconocida

TrackPropertyCondition

Clase para especificar una condición de propiedad de seguimiento

Nombre	Tipo	Description
operation	TrackPropertyCompareOperation	Realizar un seguimiento de la operación de condición de propiedad
property	TrackPropertyType	Tipo de propiedad Track
value	string	Seguimiento del valor de la propiedad

TrackPropertyType

Tipo de propiedad Track

Nombre	Tipo	Description
FourCC	string	Seguimiento de FourCC
Unknown	string	Propiedad de pista desconocida

TrackSelection

Clase para seleccionar una pista

Nombre	Tipo	Description
trackSelections	TrackPropertyCondition[]	TrackSelections es una lista de condiciones de propiedad de seguimiento que puede especificar pistas.