Streaming Policies - Get

Service:

Media Services

API-versie:

2022-08-01

Een streamingbeleid ophalen
De details van een streamingbeleid ophalen in het Media Services-account

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

URI-parameters

Name	In	Vereist	Type	Description
accountName	path	True	string	De naam van het Media Services-account.
resourceGroupName	path	True	string	De naam van de resourcegroep binnen het Azure-abonnement.
streamingPolicyName	path	True	string	De naam van het streamingbeleid.
subscriptionId	path	True	string	De unieke id voor een Microsoft Azure-abonnement.
api-version	query	True	string	De versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name	Type	Description
200 OK	StreamingPolicy	OK
Other Status Codes	ErrorResponse	Gedetailleerde foutinformatie.

Voorbeelden

Get a Streaming Policy by name

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
CbcsDrmConfiguration	Klasse voor het opgeven van DRM-configuraties van het CommonEncryptionCbcs-schema in streamingbeleid
CencDrmConfiguration	Klasse voor het opgeven van DRM-configuraties van het CommonEncryptionCenc-schema in streamingbeleid
ClearKeyEncryptionConfiguration	Klasse voor het opgeven van clearkey-configuratie van algemene versleutelingsschema's in streamingbeleid
CommonEncryptionCbcs	Klasse voor CommonEncryptionCbcs-versleutelingsschema
CommonEncryptionCenc	Klasse voor envelopversleutelingsschema
createdByType	Het type identiteit waarmee de resource is gemaakt.
DefaultKey	Klasse voor het opgeven van eigenschappen van de standaardinhoudssleutel voor elk versleutelingsschema
EnabledProtocols	Klasse om op te geven welke protocollen zijn ingeschakeld
EnvelopeEncryption	Klasse voor EnvelopVersleutelingsschema
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
NoEncryption	Klasse voor NoEncryption-schema
StreamingPolicy	Een streamingbeleidsresource
StreamingPolicyContentKey	Klasse om eigenschappen van inhoudssleutel op te geven
StreamingPolicyContentKeys	Klasse voor het opgeven van eigenschappen van alle inhoudssleutels in streamingbeleid
StreamingPolicyFairPlayConfiguration	Klasse om configuraties van FairPlay op te geven in streamingbeleid
StreamingPolicyPlayReadyConfiguration	Klasse om configuraties van PlayReady op te geven in streamingbeleid
StreamingPolicyWidevineConfiguration	Klasse om configuraties van Widevine op te geven in streamingbeleid
systemData	Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.
TrackPropertyCompareOperation	Bewerking eigenschapsvoorwaarde bijhouden
TrackPropertyCondition	Klasse voor het opgeven van één voorwaarde voor de eigenschap track
TrackPropertyType	Type eigenschap bijhouden
TrackSelection	Klas om een nummer te selecteren

CbcsDrmConfiguration

Klasse voor het opgeven van DRM-configuraties van het CommonEncryptionCbcs-schema in streamingbeleid

Name	Type	Description
fairPlay	StreamingPolicyFairPlayConfiguration	FairPlay-configuraties
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady-configuraties
widevine	StreamingPolicyWidevineConfiguration	Widevine-configuraties

CencDrmConfiguration

Klasse voor het opgeven van DRM-configuraties van het CommonEncryptionCenc-schema in streamingbeleid

Name	Type	Description
playReady	StreamingPolicyPlayReadyConfiguration	PlayReady-configuraties
widevine	StreamingPolicyWidevineConfiguration	Widevine-configuraties

ClearKeyEncryptionConfiguration

Klasse voor het opgeven van clearkey-configuratie van algemene versleutelingsschema's in streamingbeleid

Name	Type	Description
customKeysAcquisitionUrlTemplate	string	Sjabloon voor de URL van de aangepaste service die inhoudssleutels levert aan eindgebruikers. Niet vereist bij het gebruik van Azure Media Services voor het verlenen van licenties. De sjabloon ondersteunt vervangbare tokens die de service tijdens runtime bijwerkt met de waarde die specifiek is voor de aanvraag. De momenteel ondersteunde tokenwaarde is {AlternativeMediaId}, die wordt vervangen door de waarde van StreamingLocatorId.AlternativeMediaId.

CommonEncryptionCbcs

Klasse voor CommonEncryptionCbcs-versleutelingsschema

Name	Type	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Optionele configuratie die ClearKey ondersteunt in commonEncryptionCbcs-versleutelingsschema.
clearTracks	TrackSelection[]	Vertegenwoordigen welke sporen niet mogen worden versleuteld
contentKeys	StreamingPolicyContentKeys	Vertegenwoordigt de standaardinhoudssleutel voor elk versleutelingsschema en afzonderlijke inhoudssleutels voor specifieke nummers
drm	CbcsDrmConfiguration	Configuratie van DRM's voor het huidige versleutelingsschema
enabledProtocols	EnabledProtocols	Ondersteunde protocollen vertegenwoordigen

CommonEncryptionCenc

Klasse voor envelopversleutelingsschema

Name	Type	Description
clearKeyEncryptionConfiguration	ClearKeyEncryptionConfiguration	Optionele configuratie die ClearKey ondersteunt in het versleutelingsschema CommonEncryptionCenc.
clearTracks	TrackSelection[]	Vertegenwoordigen welke sporen niet mogen worden versleuteld
contentKeys	StreamingPolicyContentKeys	Vertegenwoordigt de standaardinhoudssleutel voor elk versleutelingsschema en afzonderlijke inhoudssleutels voor specifieke nummers
drm	CencDrmConfiguration	Configuratie van DRM's voor CommonEncryptionCenc-versleutelingsschema
enabledProtocols	EnabledProtocols	Ondersteunde protocollen vertegenwoordigen

createdByType

Het type identiteit waarmee de resource is gemaakt.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DefaultKey

Klasse voor het opgeven van eigenschappen van de standaardinhoudssleutel voor elk versleutelingsschema

Name	Type	Description
label	string	Label kan worden gebruikt om inhoudssleutel op te geven bij het maken van een streaming-locator
policyName	string	Beleid dat wordt gebruikt door de standaardsleutel

EnabledProtocols

Klasse om op te geven welke protocollen zijn ingeschakeld

Name	Type	Description
dash	boolean	DASH-protocol inschakelen of niet
download	boolean	Downloadprotocol inschakelen of niet
hls	boolean	HLS-protocol inschakelen of niet
smoothStreaming	boolean	SmoothStreaming-protocol inschakelen of niet

EnvelopeEncryption

Klasse voor EnvelopVersleutelingsschema

Name	Type	Description
clearTracks	TrackSelection[]	Vertegenwoordigen welke sporen niet mogen worden versleuteld
contentKeys	StreamingPolicyContentKeys	Vertegenwoordigt de standaardinhoudssleutel voor elk versleutelingsschema en afzonderlijke inhoudssleutels voor specifieke nummers
customKeyAcquisitionUrlTemplate	string	Sjabloon voor de URL van de aangepaste service die sleutels levert aan eindgebruikers. Niet vereist bij het gebruik van Azure Media Services voor het uitgeven van sleutels. De sjabloon ondersteunt vervangbare tokens die de service tijdens runtime bijwerkt met de waarde die specifiek is voor de aanvraag. De momenteel ondersteunde tokenwaarden zijn {AlternativeMediaId}, die wordt vervangen door de waarde van StreamingLocatorId.AlternativeMediaId en {ContentKeyId}, die wordt vervangen door de waarde van de id van de sleutel die wordt aangevraagd.
enabledProtocols	EnabledProtocols	Ondersteunde protocollen vertegenwoordigen

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het type aanvullende informatie.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

NoEncryption

Klasse voor NoEncryption-schema

Name	Type	Description
enabledProtocols	EnabledProtocols	Ondersteunde protocollen vertegenwoordigen

StreamingPolicy

Een streamingbeleidsresource

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.commonEncryptionCbcs	CommonEncryptionCbcs	Configuratie van CommonEncryptionCbcs
properties.commonEncryptionCenc	CommonEncryptionCenc	Configuratie van CommonEncryptionCenc
properties.created	string	Aanmaaktijd van streamingbeleid
properties.defaultContentKeyPolicyName	string	Standaard ContentKey die wordt gebruikt door het huidige streamingbeleid
properties.envelopeEncryption	EnvelopeEncryption	Configuratie van EnvelopeEncryption
properties.noEncryption	NoEncryption	Configuraties van NoEncryption
systemData	systemData	De systeemmetagegevens met betrekking tot deze resource.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

StreamingPolicyContentKey

Klasse om eigenschappen van inhoudssleutel op te geven

Name	Type	Description
label	string	Label kan worden gebruikt om inhoudssleutel op te geven bij het maken van een streaming-locator
policyName	string	Beleid dat wordt gebruikt door inhoudssleutel
tracks	TrackSelection[]	Houdt bij welke inhoudssleutel wordt gebruikt

StreamingPolicyContentKeys

Klasse voor het opgeven van eigenschappen van alle inhoudssleutels in streamingbeleid

Name	Type	Description
defaultKey	DefaultKey	Standaardinhoudssleutel voor een versleutelingsschema
keyToTrackMappings	StreamingPolicyContentKey[]	Voor het weergeven van sporen is een afzonderlijke inhoudssleutel vereist

StreamingPolicyFairPlayConfiguration

Klasse om configuraties van FairPlay op te geven in streamingbeleid

Name	Type	Description
allowPersistentLicense	boolean	Alle licenties die permanent moeten zijn of niet
customLicenseAcquisitionUrlTemplate	string	Sjabloon voor de URL van de aangepaste service die licenties levert aan eindgebruikers. Niet vereist bij het gebruik van Azure Media Services voor het verlenen van licenties. De sjabloon ondersteunt vervangbare tokens die de service tijdens runtime bijwerkt met de waarde die specifiek is voor de aanvraag. De momenteel ondersteunde tokenwaarden zijn {AlternativeMediaId}, die wordt vervangen door de waarde van StreamingLocatorId.AlternativeMediaId en {ContentKeyId}, die wordt vervangen door de waarde van de id van de sleutel die wordt aangevraagd.

StreamingPolicyPlayReadyConfiguration

Klasse om configuraties van PlayReady op te geven in streamingbeleid

Name	Type	Description
customLicenseAcquisitionUrlTemplate	string	Sjabloon voor de URL van de aangepaste service die licenties levert aan eindgebruikers. Niet vereist bij het gebruik van Azure Media Services voor het verlenen van licenties. De sjabloon ondersteunt vervangbare tokens die de service tijdens runtime bijwerkt met de waarde die specifiek is voor de aanvraag. De momenteel ondersteunde tokenwaarden zijn {AlternativeMediaId}, die wordt vervangen door de waarde van StreamingLocatorId.AlternativeMediaId en {ContentKeyId}, die wordt vervangen door de waarde van de id van de sleutel die wordt aangevraagd.
playReadyCustomAttributes	string	Aangepaste kenmerken voor PlayReady

StreamingPolicyWidevineConfiguration

Klasse om configuraties van Widevine op te geven in streamingbeleid

Name	Type	Description
customLicenseAcquisitionUrlTemplate	string	Sjabloon voor de URL van de aangepaste service die licenties levert aan eindgebruikers. Niet vereist bij het gebruik van Azure Media Services voor het verlenen van licenties. De sjabloon ondersteunt vervangbare tokens die de service tijdens runtime bijwerkt met de waarde die specifiek is voor de aanvraag. De momenteel ondersteunde tokenwaarden zijn {AlternativeMediaId}, die wordt vervangen door de waarde van StreamingLocatorId.AlternativeMediaId en {ContentKeyId}, die wordt vervangen door de waarde van de id van de sleutel die wordt aangevraagd.

systemData

Metagegevens met betrekking tot het maken en laatste wijzigen van de resource.

Name	Type	Description
createdAt	string	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit die de resource heeft gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string	Het tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource het laatst heeft gewijzigd.

TrackPropertyCompareOperation

Bewerking eigenschapsvoorwaarde bijhouden

Name	Type	Description
Equal	string	Gelijke bewerking
Unknown	string	Onbekende vergelijkingsbewerking voor bijhouden van eigenschap

TrackPropertyCondition

Klasse voor het opgeven van één voorwaarde voor de eigenschap track

Name	Type	Description
operation	TrackPropertyCompareOperation	Bewerking eigenschapsvoorwaarde bijhouden
property	TrackPropertyType	Type eigenschap bijhouden
value	string	Waarde van eigenschap bijhouden

TrackPropertyType

Type eigenschap bijhouden

Name	Type	Description
FourCC	string	FourCC bijhouden
Unknown	string	Onbekende track-eigenschap

TrackSelection

Klas om een nummer te selecteren

Name	Type	Description
trackSelections	TrackPropertyCondition[]	TrackSelections is een lijst met voorwaarden voor trackeigenschappen waarmee u track(s) kunt opgeven