Streaming Locators - List

Service:

Media Services

API Version:

2022-08-01

Enumerar localizadores de streaming
Listas los localizadores de streaming de la cuenta

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

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators?api-version=2022-08-01&$filter={$filter}&$top={$top}&$orderby={$orderby}

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.
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.
$filter	query		string	Restringe el conjunto de elementos devueltos.
$orderby	query		string	Especifica la clave por la que se debe ordenar la colección de resultados.
$top	query		integer int32	Especifica un entero no negativo n que limita el número de elementos devueltos de una colección. El servicio devuelve el número de elementos disponibles hasta pero no mayor que el valor especificado n.

Respuestas

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

Ejemplos

Lists Streaming Locators

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators?api-version=2022-08-01

Java

/** Samples for StreamingLocators List. */
public final class Main {
    /*
     * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list.json
     */
    /**
     * Sample code: Lists Streaming Locators.
     *
     * @param manager Entry point to MediaServicesManager.
     */
    public static void listsStreamingLocators(com.azure.resourcemanager.mediaservices.MediaServicesManager manager) {
        manager
            .streamingLocators()
            .list("contosorg", "contosomedia", null, null, null, 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 streaminglocatorslist.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_locators.list(
        resource_group_name="contoso",
        account_name="contosomedia",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list.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-locators-list.json
func ExampleStreamingLocatorsClient_NewListPager() {
	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)
	}
	pager := clientFactory.NewStreamingLocatorsClient().NewListPager("contoso", "contosomedia", &armmediaservices.StreamingLocatorsClientListOptions{Filter: nil,
		Top:     nil,
		Orderby: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.StreamingLocatorCollection = armmediaservices.StreamingLocatorCollection{
		// 	Value: []*armmediaservices.StreamingLocator{
		// 		{
		// 			Name: to.Ptr("clearStreamingLocator"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/streamingLocators"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator"),
		// 			Properties: &armmediaservices.StreamingLocatorProperties{
		// 				AssetName: to.Ptr("ClimbingMountRainier"),
		// 				ContentKeys: []*armmediaservices.StreamingLocatorContentKey{
		// 				},
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-08T18:29:31.934Z"); return t}()),
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "9999-12-31T23:59:59.999Z"); return t}()),
		// 				StreamingLocatorID: to.Ptr("6a116ec6-0c85-441f-9c31-89a5bc3adf0a"),
		// 				StreamingPolicyName: to.Ptr("clearStreamingPolicy"),
		// 			},
		// 		},
		// 		{
		// 			Name: to.Ptr("secureStreamingLocator"),
		// 			Type: to.Ptr("Microsoft.Media/mediaservices/streamingLocators"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/secureStreamingLocator"),
		// 			Properties: &armmediaservices.StreamingLocatorProperties{
		// 				AssetName: to.Ptr("ClimbingMountRainier"),
		// 				ContentKeys: []*armmediaservices.StreamingLocatorContentKey{
		// 				},
		// 				Created: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-08-08T18:29:31.954Z"); return t}()),
		// 				EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "9999-12-31T23:59:59.999Z"); return t}()),
		// 				StreamingLocatorID: to.Ptr("7338ef90-ffc8-42de-8bff-de8f99973300"),
		// 				StreamingPolicyName: to.Ptr("secureStreamingPolicy"),
		// 			},
		// 	}},
		// }
	}
}

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 Lists the Streaming Locators in the account
 *
 * @summary Lists the Streaming Locators in the account
 * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-list.json
 */
async function listsStreamingLocators() {
  const subscriptionId =
    process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso";
  const accountName = "contosomedia";
  const credential = new DefaultAzureCredential();
  const client = new AzureMediaServices(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.streamingLocators.list(resourceGroupName, accountName)) {
    resArray.push(item);
  }
  console.log(resArray);
}

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-locators-list.json
// this example is just showing the usage of "StreamingLocators_List" 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 StreamingLocatorResource
StreamingLocatorCollection collection = mediaServicesAccount.GetStreamingLocators();

// invoke the operation and iterate over the result
await foreach (StreamingLocatorResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    StreamingLocatorData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

{
  "value": [
    {
      "name": "clearStreamingLocator",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator",
      "type": "Microsoft.Media/mediaservices/streamingLocators",
      "properties": {
        "assetName": "ClimbingMountRainier",
        "created": "2018-08-08T18:29:31.9341192Z",
        "endTime": "9999-12-31T23:59:59.9999999Z",
        "streamingLocatorId": "6a116ec6-0c85-441f-9c31-89a5bc3adf0a",
        "streamingPolicyName": "clearStreamingPolicy",
        "contentKeys": []
      }
    },
    {
      "name": "secureStreamingLocator",
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/secureStreamingLocator",
      "type": "Microsoft.Media/mediaservices/streamingLocators",
      "properties": {
        "assetName": "ClimbingMountRainier",
        "created": "2018-08-08T18:29:31.9544387Z",
        "endTime": "9999-12-31T23:59:59.9999999Z",
        "streamingLocatorId": "7338ef90-ffc8-42de-8bff-de8f99973300",
        "streamingPolicyName": "secureStreamingPolicy",
        "contentKeys": []
      }
    }
  ]
}

Definiciones

Nombre	Description
createdByType	Tipo de identidad que creó el recurso.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
StreamingLocator	Un recurso de localizador de streaming
StreamingLocatorCollection	Colección de elementos streamingLocator.
StreamingLocatorContentKey	Clase para la clave de contenido en el localizador de streaming
StreamingLocatorContentKeyType	Tipo de cifrado de clave de contenido
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

createdByType

Tipo de identidad que creó el recurso.

Nombre	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

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.

StreamingLocator

Un recurso de localizador 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.alternativeMediaId	string	Id. de medio alternativo de este localizador de streaming
properties.assetName	string	Nombre de recurso
properties.contentKeys	StreamingLocatorContentKey[]	Claves de contenido que usa este localizador de streaming.
properties.created	string	Hora de creación del localizador de streaming.
properties.defaultContentKeyPolicyName	string	Nombre del elemento ContentKeyPolicy predeterminado que usa este localizador de streaming.
properties.endTime	string	Hora de finalización del localizador de streaming.
properties.filters	string[]	Lista de filtros de recursos o cuentas que se aplican a este localizador de streaming
properties.startTime	string	Hora de inicio del localizador de streaming.
properties.streamingLocatorId	string	Elemento StreamingLocatorId del localizador de streaming.
properties.streamingPolicyName	string	Nombre de la directiva de streaming que usa este localizador de streaming. Especifique el nombre de la directiva de streaming que creó o use una de las directivas de streaming predefinidas. Las directivas de streaming predefinidas que están disponibles son: "Predefined_DownloadOnly", "Predefined_ClearStreamingOnly", "Predefined_DownloadAndClearStreaming", "Predefined_ClearKey", "Predefined_MultiDrmCencStreaming" y "Predefined_ MultiDrmStreaming".
systemData	systemData	Metadatos del sistema relacionados con este recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

StreamingLocatorCollection

Colección de elementos streamingLocator.

Nombre	Tipo	Description
@odata.nextLink	string	Vínculo a la página siguiente de la colección (cuando la colección contiene demasiados resultados para devolver en una respuesta).
value	StreamingLocator[]	Colección de elementos streamingLocator.

StreamingLocatorContentKey

Clase para la clave de contenido en el localizador de streaming

Nombre	Tipo	Description
id	string	Identificador de la clave de contenido
labelReferenceInStreamingPolicy	string	Etiqueta de clave de contenido como se especifica en la directiva de streaming
policyName	string	ContentKeyPolicy usado por la clave de contenido
tracks	TrackSelection[]	Pistas que usan esta clave de contenido
type	StreamingLocatorContentKeyType	Tipo de cifrado de clave de contenido
value	string	Valor de clave de contenido

StreamingLocatorContentKeyType

Tipo de cifrado de clave de contenido

Nombre	Tipo	Description
CommonEncryptionCbcs	string	Cifrado común mediante CBCS
CommonEncryptionCenc	string	Cifrado común mediante CENC
EnvelopeEncryption	string	Cifrado de sobre

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 seguimiento 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.