Streaming Policies - Get

Dienst:

Media Services

API-Version:

2022-08-01

Abrufen einer Streamingrichtlinie
Abrufen der Details einer Streamingrichtlinie im Media Services-Konto

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
accountName	path	True	string	Der Name des Media Services-Kontos.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe innerhalb des Azure-Abonnements.
streamingPolicyName	path	True	string	Der Name der Streamingrichtlinie.
subscriptionId	path	True	string	Der eindeutige Bezeichner für ein Microsoft Azure-Abonnement.
api-version	query	True	string	Die Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	StreamingPolicy	OK
Other Status Codes	ErrorResponse	Ausführliche Fehlerinformationen.

Beispiele

Get a Streaming Policy by name

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
CbcsDrmConfiguration	Klasse zum Angeben von DRM-Konfigurationen des CommonEncryptionCbcs-Schemas in der Streamingrichtlinie
CencDrmConfiguration	Klasse zum Angeben von DRM-Konfigurationen des CommonEncryptionCenc-Schemas in der Streamingrichtlinie
ClearKeyEncryptionConfiguration	Klasse zum Angeben der ClearKey-Konfiguration allgemeiner Verschlüsselungsschemas in der Streamingrichtlinie
CommonEncryptionCbcs	Klasse für commonEncryptionCbcs-Verschlüsselungsschema
CommonEncryptionCenc	Klasse für das Umschlagverschlüsselungsschema
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DefaultKey	Klasse zum Angeben der Eigenschaften des Standardinhaltsschlüssels für jedes Verschlüsselungsschema
EnabledProtocols	Klasse zum Angeben der aktivierten Protokolle
EnvelopeEncryption	Klasse für EnvelopeEncryption-Verschlüsselungsschema
ErrorAdditionalInfo	Zusätzliche Informationen zum Ressourcenverwaltungsfehler.
ErrorDetail	Die Fehlerdetails.
ErrorResponse	Fehlerantwort
NoEncryption	Klasse für NoEncryption-Schema
StreamingPolicy	Eine Streamingrichtlinienressource
StreamingPolicyContentKey	Klasse zum Angeben von Eigenschaften des Inhaltsschlüssels
StreamingPolicyContentKeys	Klasse zum Angeben der Eigenschaften aller Inhaltsschlüssel in streaming policy
StreamingPolicyFairPlayConfiguration	Klasse zum Angeben von FairPlay-Konfigurationen in der Streamingrichtlinie
StreamingPolicyPlayReadyConfiguration	Klasse zum Angeben von Konfigurationen von PlayReady in der Streamingrichtlinie
StreamingPolicyWidevineConfiguration	Klasse zum Angeben von Konfigurationen von Widevine in streaming policy
systemData	Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.
TrackPropertyCompareOperation	Nachverfolgen des Bedingungsvorgangs der Eigenschaft
TrackPropertyCondition	Klasse zum Angeben einer Spureigenschaftsbedingung
TrackPropertyType	Track-Eigenschaftstyp
TrackSelection	Klasse zum Auswählen einer Spur

CbcsDrmConfiguration

Klasse zum Angeben von DRM-Konfigurationen des CommonEncryptionCbcs-Schemas in der Streamingrichtlinie

Name	Typ	Beschreibung
fairPlay	StreamingPolicyFairPlayConfiguration	FairPlay-Konfigurationen
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady-Konfigurationen
widevine	StreamingPolicyWidevineConfiguration	Widevine-Konfigurationen

CencDrmConfiguration

Klasse zum Angeben von DRM-Konfigurationen des CommonEncryptionCenc-Schemas in der Streamingrichtlinie

Name	Typ	Beschreibung
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady-Konfigurationen
widevine	StreamingPolicyWidevineConfiguration	Widevine-Konfigurationen

ClearKeyEncryptionConfiguration

Klasse zum Angeben der ClearKey-Konfiguration allgemeiner Verschlüsselungsschemas in der Streamingrichtlinie

Name	Typ	Beschreibung
customKeysAcquisitionUrlTemplate	string	Vorlage für die URL des benutzerdefinierten Diensts, der Inhaltsschlüssel für Endbenutzerplayer bereitstellt. Diese ist nicht erforderlich, wenn Sie Azure Media Services für das Ausstellen von Lizenzen verwenden. Die Vorlage unterstützt ersetzbare Token, die der Dienst zur Laufzeit mit dem Wert für die Anforderung aktualisiert. Der derzeit unterstützte Tokenwert ist {AlternativeMediaId}, der durch den Wert streamingLocatorId.AlternativeMediaId ersetzt wird.

CommonEncryptionCbcs

Klasse für commonEncryptionCbcs-Verschlüsselungsschema

Name	Typ	Beschreibung
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Optionale Konfiguration, die ClearKey im CommonEncryptionCbcs-Verschlüsselungsschema unterstützt.
clearTracks	TrackSelection[]	Darstellen, welche Spuren nicht verschlüsselt werden sollen
contentKeys	StreamingPolicyContentKeys	Darstellen des Standardinhaltsschlüssels für jedes Verschlüsselungsschema und separate Inhaltsschlüssel für bestimmte Spuren
drm	CbcsDrmConfiguration	Konfiguration von DRMs für das aktuelle Verschlüsselungsschema
enabledProtocols	EnabledProtocols	Darstellen unterstützter Protokolle

CommonEncryptionCenc

Klasse für das Umschlagverschlüsselungsschema

Name	Typ	Beschreibung
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Optionale Konfiguration, die ClearKey im CommonEncryptionCenc-Verschlüsselungsschema unterstützt.
clearTracks	TrackSelection[]	Darstellen, welche Spuren nicht verschlüsselt werden sollen
contentKeys	StreamingPolicyContentKeys	Darstellen des Standardinhaltsschlüssels für jedes Verschlüsselungsschema und separate Inhaltsschlüssel für bestimmte Spuren
drm	CencDrmConfiguration	Konfiguration von DRMs für das CommonEncryptionCenc-Verschlüsselungsschema
enabledProtocols	EnabledProtocols	Darstellen unterstützter Protokolle

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name	Typ	Beschreibung
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

Klasse zum Angeben der Eigenschaften des Standardinhaltsschlüssels für jedes Verschlüsselungsschema

Name	Typ	Beschreibung
label	string	Bezeichnung kann verwendet werden, um den Inhaltsschlüssel beim Erstellen eines Streaminglocators anzugeben.
policyName	string	Vom Standardschlüssel verwendete Richtlinie

EnabledProtocols

Klasse zum Angeben der aktivierten Protokolle

Name	Typ	Beschreibung
dash	boolean	Aktivieren des DASH-Protokolls oder nicht
download	boolean	Aktivieren des Downloadprotokolls oder nicht
hls	boolean	HLS-Protokoll aktivieren oder nicht
smoothStreaming	boolean	Aktivieren des SmoothStreaming-Protokolls oder nicht

EnvelopeEncryption

Klasse für EnvelopeEncryption-Verschlüsselungsschema

Name	Typ	Beschreibung
clearTracks	TrackSelection[]	Darstellen, welche Spuren nicht verschlüsselt werden sollen
contentKeys	StreamingPolicyContentKeys	Darstellen des Standardinhaltsschlüssels für jedes Verschlüsselungsschema und separate Inhaltsschlüssel für bestimmte Spuren
customKeyAcquisitionUrlTemplate	string	Vorlage für die URL des benutzerdefinierten Diensts, der Schlüssel für Endbenutzerplayer bereitstellt. Diese ist nicht erforderlich, wenn Sie Azure Media Services für das Ausstellen von Schlüsseln verwenden. Die Vorlage unterstützt ersetzbare Token, die der Dienst zur Laufzeit mit dem Wert für die Anforderung aktualisiert. Die derzeit unterstützten Werte für Token sind {AlternativeMediaId} (wird durch den Wert von StreamingLocatorId.AlternativeMediaId ersetzt) und {ContentKeyId} (wird durch den Wert des Bezeichners des angeforderten Schlüssels ersetzt).
enabledProtocols	EnabledProtocols	Darstellen unterstützter Protokolle

ErrorAdditionalInfo

Zusätzliche Informationen zum Ressourcenverwaltungsfehler.

Name	Typ	Beschreibung
info	object	Zusätzliche Informationen.
type	string	Typ der zusätzlichen Informationen.

ErrorDetail

Die Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Fehlerinformationen.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

NoEncryption

Klasse für NoEncryption-Schema

Name	Typ	Beschreibung
enabledProtocols	EnabledProtocols	Darstellen unterstützter Protokolle

StreamingPolicy

Eine Streamingrichtlinienressource

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.commonEncryptionCbcs	CommonEncryptionCbcs	Konfiguration von CommonEncryptionCbcs
properties.commonEncryptionCenc	CommonEncryptionCenc	Konfiguration von CommonEncryptionCenc
properties.created	string	Zeitpunkt der Erstellung der Streamingrichtlinie
properties.defaultContentKeyPolicyName	string	Standardmäßiger ContentKey, der von der aktuellen Streamingrichtlinie verwendet wird.
properties.envelopeEncryption	EnvelopeEncryption	Konfiguration von EnvelopeEncryption
properties.noEncryption	NoEncryption	Konfiguration von NoEncryption
systemData	systemData	Die Systemmetadaten, die sich auf diese Ressource beziehen.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

StreamingPolicyContentKey

Klasse zum Angeben von Eigenschaften des Inhaltsschlüssels

Name	Typ	Beschreibung
label	string	Bezeichnung kann verwendet werden, um den Inhaltsschlüssel beim Erstellen eines Streaminglocators anzugeben.
policyName	string	Vom Inhaltsschlüssel verwendete Richtlinie
tracks	TrackSelection[]	Nachverfolgen, die diesen Inhaltsschlüssel verwenden

StreamingPolicyContentKeys

Klasse zum Angeben der Eigenschaften aller Inhaltsschlüssel in streaming policy

Name	Typ	Beschreibung
defaultKey	DefaultKey	Standardinhaltsschlüssel für ein Verschlüsselungsschema
keyToTrackMappings	StreamingPolicyContentKey[]	Für die Darstellung von Spuren ist ein separater Inhaltsschlüssel erforderlich.

StreamingPolicyFairPlayConfiguration

Klasse zum Angeben von FairPlay-Konfigurationen in der Streamingrichtlinie

Name	Typ	Beschreibung
allowPersistentLicense	boolean	Alle Lizenzen sollen dauerhaft sein oder nicht
customLicenseAcquisitionUrlTemplate	string	Vorlage für die URL des benutzerdefinierten Diensts, der Lizenzen für Endbenutzer-Spieler bereitstellt. Diese ist nicht erforderlich, wenn Sie Azure Media Services für das Ausstellen von Lizenzen verwenden. Die Vorlage unterstützt ersetzbare Token, die der Dienst zur Laufzeit mit dem Wert für die Anforderung aktualisiert. Die derzeit unterstützten Werte für Token sind {AlternativeMediaId} (wird durch den Wert von StreamingLocatorId.AlternativeMediaId ersetzt) und {ContentKeyId} (wird durch den Wert des Bezeichners des angeforderten Schlüssels ersetzt).

StreamingPolicyPlayReadyConfiguration

Klasse zum Angeben von Konfigurationen von PlayReady in der Streamingrichtlinie

Name	Typ	Beschreibung
customLicenseAcquisitionUrlTemplate	string	Vorlage für die URL des benutzerdefinierten Diensts, der Lizenzen für Endbenutzerplayer bereitstellt. Diese ist nicht erforderlich, wenn Sie Azure Media Services für das Ausstellen von Lizenzen verwenden. Die Vorlage unterstützt ersetzbare Token, die der Dienst zur Laufzeit mit dem Wert für die Anforderung aktualisiert. Die derzeit unterstützten Werte für Token sind {AlternativeMediaId} (wird durch den Wert von StreamingLocatorId.AlternativeMediaId ersetzt) und {ContentKeyId} (wird durch den Wert des Bezeichners des angeforderten Schlüssels ersetzt).
playReadyCustomAttributes	string	Benutzerdefinierte Attribute für PlayReady

StreamingPolicyWidevineConfiguration

Klasse zum Angeben von Konfigurationen von Widevine in streaming policy

Name	Typ	Beschreibung
customLicenseAcquisitionUrlTemplate	string	Vorlage für die URL des benutzerdefinierten Diensts, der Lizenzen für Endbenutzerplayer bereitstellt. Diese ist nicht erforderlich, wenn Sie Azure Media Services für das Ausstellen von Lizenzen verwenden. Die Vorlage unterstützt ersetzbare Token, die der Dienst zur Laufzeit mit dem Wert für die Anforderung aktualisiert. Die derzeit unterstützten Werte für Token sind {AlternativeMediaId} (wird durch den Wert von StreamingLocatorId.AlternativeMediaId ersetzt) und {ContentKeyId} (wird durch den Wert des Bezeichners des angeforderten Schlüssels ersetzt).

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name	Typ	Beschreibung
createdAt	string	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

TrackPropertyCompareOperation

Nachverfolgen des Bedingungsvorgangs der Eigenschaft

Name	Typ	Beschreibung
Equal	string	Gleichheitsvorgang
Unknown	string	Unbekannter Nachverfolgungseigenschaftsvergleichsvorgang

TrackPropertyCondition

Klasse zum Angeben einer Spureigenschaftsbedingung

Name	Typ	Beschreibung
operation	TrackPropertyCompareOperation	Zustandsvorgang der Eigenschaft nachverfolgen
property	TrackPropertyType	Eigenschaftentyp nachverfolgen
value	string	Nachverfolgen des Eigenschaftswerts

TrackPropertyType

Track-Eigenschaftstyp

Name	Typ	Beschreibung
FourCC	string	Track FourCC
Unknown	string	Unbekannte Titeleigenschaft

TrackSelection

Klasse zum Auswählen einer Spur

Name	Typ	Beschreibung
trackSelections	TrackPropertyCondition[]	TrackSelections ist eine Liste der Track-Eigenschaftsbedingung, die Spur(en) angeben kann.