Streaming Policies - Get

Service:

Media Services

Version d'API:

2022-08-01

Obtenir une stratégie de streaming
Obtenir les détails d’une stratégie de streaming dans le compte Media Services

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
accountName	path	True	string	Nom du compte Media Services.
resourceGroupName	path	True	string	Nom du groupe de ressources dans l’abonnement Azure.
streamingPolicyName	path	True	string	Nom de la stratégie de streaming.
subscriptionId	path	True	string	Identificateur unique d’un abonnement Microsoft Azure.
api-version	query	True	string	Version de l’API à utiliser avec la demande du client.

Réponses

Nom	Type	Description
200 OK	StreamingPolicy	Ok
Other Status Codes	ErrorResponse	Informations détaillées sur les erreurs.

Exemples

Get a Streaming Policy by name

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
CbcsDrmConfiguration	Classe pour spécifier les configurations DRM du schéma CommonEncryptionCbcs dans la stratégie de streaming
CencDrmConfiguration	Classe pour spécifier les configurations DRM du schéma CommonEncryptionCenc dans la stratégie de streaming
ClearKeyEncryptionConfiguration	Classe pour spécifier la configuration ClearKey des schémas de chiffrement courants dans la stratégie de streaming
CommonEncryptionCbcs	Classe pour le schéma de chiffrement CommonEncryptionCbcs
CommonEncryptionCenc	Classe pour le schéma de chiffrement d’enveloppe
createdByType	Type d’identité qui a créé la ressource.
DefaultKey	Classe pour spécifier les propriétés de la clé de contenu par défaut pour chaque schéma de chiffrement
EnabledProtocols	Classe pour spécifier les protocoles activés
EnvelopeEncryption	Classe pour le schéma de chiffrement EnvelopeEncryption
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
NoEncryption	Classe pour le schéma NoEncryption
StreamingPolicy	Une ressource de stratégie de streaming
StreamingPolicyContentKey	Classe pour spécifier les propriétés de la clé de contenu
StreamingPolicyContentKeys	Classe pour spécifier les propriétés de toutes les clés de contenu dans la stratégie de streaming
StreamingPolicyFairPlayConfiguration	Classe pour spécifier des configurations de FairPlay dans la stratégie de streaming
StreamingPolicyPlayReadyConfiguration	Classe pour spécifier les configurations de PlayReady dans la stratégie de streaming
StreamingPolicyWidevineConfiguration	Classe pour spécifier les configurations de Widevine dans la stratégie de streaming
systemData	Métadonnées relatives à la création et à la dernière modification de la ressource.
TrackPropertyCompareOperation	Suivi de l’opération de condition de propriété
TrackPropertyCondition	Classe pour spécifier une condition de propriété de suivi
TrackPropertyType	Type de propriété track
TrackSelection	Classe pour sélectionner une piste

CbcsDrmConfiguration

Classe pour spécifier les configurations DRM du schéma CommonEncryptionCbcs dans la stratégie de streaming

Nom	Type	Description
fairPlay	StreamingPolicyFairPlayConfiguration	Configurations FairPlay
playReady	StreamingPolicyPlayReadyConfiguration	Configurations PlayReady
widevine	StreamingPolicyWidevineConfiguration	Configurations Widevine

CencDrmConfiguration

Classe pour spécifier les configurations DRM du schéma CommonEncryptionCenc dans la stratégie de streaming

Nom	Type	Description
playReady	StreamingPolicyPlayReadyConfiguration	Configurations PlayReady
widevine	StreamingPolicyWidevineConfiguration	Configurations Widevine

ClearKeyEncryptionConfiguration

Classe pour spécifier la configuration ClearKey des schémas de chiffrement courants dans la stratégie de streaming

Nom	Type	Description
customKeysAcquisitionUrlTemplate	string	Modèle pour l’URL du service personnalisé qui fournit des clés de contenu aux joueurs des utilisateurs finaux. Il n’est pas nécessaire lorsque vous utilisez Azure Media Services pour émettre vos licences. Ce modèle prend en charge les jetons remplaçables que le service met à jour lors de l’exécution, en utilisant la valeur spécifique à la requête. La valeur du jeton actuellement prise en charge est {AlternativeMediaId}, qui est remplacée par la valeur de StreamingLocatorId.AlternativeMediaId.

CommonEncryptionCbcs

Classe pour le schéma de chiffrement CommonEncryptionCbcs

Nom	Type	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Configuration facultative prenant en charge ClearKey dans le schéma de chiffrement CommonEncryptionCbcs.
clearTracks	TrackSelection[]	Représentant les pistes qui ne doivent pas être chiffrées
contentKeys	StreamingPolicyContentKeys	Représentation de la clé de contenu par défaut pour chaque schéma de chiffrement et clés de contenu distinctes pour des pistes spécifiques
drm	CbcsDrmConfiguration	Configuration des DRMs pour le schéma de chiffrement actuel
enabledProtocols	EnabledProtocols	Représentation des protocoles pris en charge

CommonEncryptionCenc

Classe pour le schéma de chiffrement d’enveloppe

Nom	Type	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Configuration facultative prenant en charge ClearKey dans le schéma de chiffrement CommonEncryptionCenc.
clearTracks	TrackSelection[]	Représentant les pistes qui ne doivent pas être chiffrées
contentKeys	StreamingPolicyContentKeys	Représentation de la clé de contenu par défaut pour chaque schéma de chiffrement et clés de contenu distinctes pour des pistes spécifiques
drm	CencDrmConfiguration	Configuration des drms pour le schéma de chiffrement CommonEncryptionCenc
enabledProtocols	EnabledProtocols	Représentation des protocoles pris en charge

createdByType

Type d’identité qui a créé la ressource.

Nom	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

Classe pour spécifier les propriétés de la clé de contenu par défaut pour chaque schéma de chiffrement

Nom	Type	Description
label	string	L’étiquette peut être utilisée pour spécifier la clé de contenu lors de la création d’un localisateur de streaming
policyName	string	Stratégie utilisée par la clé par défaut

EnabledProtocols

Classe pour spécifier les protocoles activés

Nom	Type	Description
dash	boolean	Activer le protocole DASH ou non
download	boolean	Activer le protocole de téléchargement ou non
hls	boolean	Activer le protocole HLS ou non
smoothStreaming	boolean	Activer le protocole SmoothStreaming ou non

EnvelopeEncryption

Classe pour le schéma de chiffrement EnvelopeEncryption

Nom	Type	Description
clearTracks	TrackSelection[]	Représentant les pistes qui ne doivent pas être chiffrées
contentKeys	StreamingPolicyContentKeys	Représentation de la clé de contenu par défaut pour chaque schéma de chiffrement et clés de contenu distinctes pour des pistes spécifiques
customKeyAcquisitionUrlTemplate	string	Modèle pour l’URL du service personnalisé qui fournit des clés aux joueurs des utilisateurs finaux. Il n’est pas nécessaire lorsque vous utilisez Azure Media Services pour émettre vos clés. Ce modèle prend en charge les jetons remplaçables que le service met à jour lors de l’exécution, en utilisant la valeur spécifique à la requête. Les valeurs de jeton actuellement prises en charge sont {AlternativeMediaId}, qui est remplacée par la valeur de StreamingLocatorId.AlternativeMediaId et {ContentKeyId}, qui est remplacée par la valeur de l’identificateur de la clé demandée.
enabledProtocols	EnabledProtocols	Représentation des protocoles pris en charge

ErrorAdditionalInfo

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires
type	string	Type d’informations supplémentaires.

ErrorDetail

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d'erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

NoEncryption

Classe pour le schéma NoEncryption

Nom	Type	Description
enabledProtocols	EnabledProtocols	Représentation des protocoles pris en charge

StreamingPolicy

Une ressource de stratégie de streaming

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nom de la ressource.
properties.commonEncryptionCbcs	CommonEncryptionCbcs	Configuration de CommonEncryptionCbcs
properties.commonEncryptionCenc	CommonEncryptionCenc	Configuration de CommonEncryptionCenc
properties.created	string	Heure de création de la stratégie de streaming
properties.defaultContentKeyPolicyName	string	Clé de contenu (ContentKey) par défaut utilisée par la stratégie de streaming active
properties.envelopeEncryption	EnvelopeEncryption	Configuration de EnvelopeEncryption
properties.noEncryption	NoEncryption	Configurations de NoEncryption
systemData	systemData	Métadonnées système relatives à cette ressource.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

StreamingPolicyContentKey

Classe pour spécifier les propriétés de la clé de contenu

Nom	Type	Description
label	string	L’étiquette peut être utilisée pour spécifier la clé de contenu lors de la création d’un localisateur de streaming
policyName	string	Stratégie utilisée par la clé de contenu
tracks	TrackSelection[]	Suivis qui utilisent cette clé de contenu

StreamingPolicyContentKeys

Classe pour spécifier les propriétés de toutes les clés de contenu dans la stratégie de streaming

Nom	Type	Description
defaultKey	DefaultKey	Clé de contenu par défaut pour un schéma de chiffrement
keyToTrackMappings	StreamingPolicyContentKey[]	La représentation des pistes nécessite une clé de contenu distincte

StreamingPolicyFairPlayConfiguration

Classe pour spécifier des configurations de FairPlay dans la stratégie de streaming

Nom	Type	Description
allowPersistentLicense	boolean	Toutes les licences doivent être persistantes ou non
customLicenseAcquisitionUrlTemplate	string	Modèle pour l’URL du service personnalisé qui fournit des licences aux utilisateurs finaux. Il n’est pas nécessaire lorsque vous utilisez Azure Media Services pour émettre vos licences. Ce modèle prend en charge les jetons remplaçables que le service met à jour lors de l’exécution, en utilisant la valeur spécifique à la requête. Les valeurs de jeton actuellement prises en charge sont {AlternativeMediaId}, qui est remplacée par la valeur de StreamingLocatorId.AlternativeMediaId et {ContentKeyId}, qui est remplacée par la valeur de l’identificateur de la clé demandée.

StreamingPolicyPlayReadyConfiguration

Classe pour spécifier les configurations de PlayReady dans la stratégie de streaming

Nom	Type	Description
customLicenseAcquisitionUrlTemplate	string	Modèle pour l’URL du service personnalisé qui fournit des licences aux joueurs des utilisateurs finaux. Il n’est pas nécessaire lorsque vous utilisez Azure Media Services pour émettre vos licences. Ce modèle prend en charge les jetons remplaçables que le service met à jour lors de l’exécution, en utilisant la valeur spécifique à la requête. Les valeurs de jeton actuellement prises en charge sont {AlternativeMediaId}, qui est remplacée par la valeur de StreamingLocatorId.AlternativeMediaId et {ContentKeyId}, qui est remplacée par la valeur de l’identificateur de la clé demandée.
playReadyCustomAttributes	string	Attributs personnalisés pour PlayReady

StreamingPolicyWidevineConfiguration

Classe pour spécifier les configurations de Widevine dans la stratégie de streaming

Nom	Type	Description
customLicenseAcquisitionUrlTemplate	string	Modèle pour l’URL du service personnalisé qui fournit des licences aux joueurs des utilisateurs finaux. Il n’est pas nécessaire lorsque vous utilisez Azure Media Services pour émettre vos licences. Ce modèle prend en charge les jetons remplaçables que le service met à jour lors de l’exécution, en utilisant la valeur spécifique à la requête. Les valeurs de jeton actuellement prises en charge sont {AlternativeMediaId}, qui est remplacée par la valeur de StreamingLocatorId.AlternativeMediaId et {ContentKeyId}, qui est remplacée par la valeur de l’identificateur de la clé demandée.

systemData

Métadonnées relatives à la création et à la dernière modification de la ressource.

Nom	Type	Description
createdAt	string	Horodatage de la création de ressources (UTC).
createdBy	string	Identité qui a créé la ressource.
createdByType	createdByType	Type d’identité qui a créé la ressource.
lastModifiedAt	string	Horodatage de la dernière modification de la ressource (UTC)
lastModifiedBy	string	Identité qui a modifié la dernière ressource.
lastModifiedByType	createdByType	Type d’identité qui a modifié la dernière ressource.

TrackPropertyCompareOperation

Suivi de l’opération de condition de propriété

Nom	Type	Description
Equal	string	Opération d’égalité
Unknown	string	Opération de comparaison de propriétés de suivi inconnue

TrackPropertyCondition

Classe pour spécifier une condition de propriété de suivi

Nom	Type	Description
operation	TrackPropertyCompareOperation	Suivi de l’opération de condition de propriété
property	TrackPropertyType	Type de propriété track
value	string	Suivre la valeur de la propriété

TrackPropertyType

Type de propriété track

Nom	Type	Description
FourCC	string	Suivre fourCC
Unknown	string	Propriété de piste inconnue

TrackSelection

Classe pour sélectionner une piste

Nom	Type	Description
trackSelections	TrackPropertyCondition[]	TrackSelections est une liste de conditions de propriétés de suivi qui peut spécifier la ou les pistes