In this article:
URI Parameters
Request Body
Responses
Examples
Definitions
Create a Streaming Locator in the Media Services account
PUT https://{{api-endpoint}}/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}?api-version={{api-version}}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
accountName |
path | True | string | The Media Services account name. |
resourceGroupName |
path | True | string | The name of the resource group within the Azure subscription. |
subscriptionId |
path | True | string | The unique identifier for a Microsoft Azure subscription. |
streamingLocatorName |
path | True | string | The Streaming Locator name. |
api-version |
query | True | string | The version of the API to be used with the client request. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
properties.assetName | True | string | Asset Name |
properties.streaming PolicyName |
True | string | Name of the Streaming Policy used by this Streaming Locator. Either specify the name of a Streaming Policy you created or use one of the predefined Streaming Policies:
|
properties.alternative MediaId |
string | Alternative Media ID of this Streaming Locator. | |
properties.contentKeys | The ContentKeys used by this Streaming Locator. | ||
properties.default ContentKeyPolicyName |
string | Name of the default ContentKeyPolicy used by this Streaming Locator. | |
properties.endTime | string | The end time of the Streaming Locator. | |
properties.filters | string | A list of asset or account filters which apply to this Streaming Locator. | |
properties.startTime | string | The start time of the Streaming Locator. | |
properties.streaming LocatorId |
string | The StreamingLocatorId of the Streaming Locator. |
Responses
Name | Type | Description |
---|---|---|
201 Created | StreamingLocator | Created |
Other Status Codes | ErrorResponse | Detailed error information. |
Examples
Creates a Streaming Locator with clear streaming
Technology | Sample request |
---|---|
HTTP |
PUT https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/UserCreatedClearStreamingLocator?api-version={{api-version}} { "properties": { "streamingPolicyName": "clearStreamingPolicy", "assetName": "ClimbingMountRainier" } } |
Java |
/** * Samples for StreamingLocators Create. */ public final class Main { /* * x-ms-original-file: * specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming- * locators-create-clear.json */ /** * Sample code: Creates a Streaming Locator with clear streaming. * * @param manager Entry point to MediaServicesManager. */ public static void createsAStreamingLocatorWithClearStreaming( com.azure.resourcemanager.mediaservices.MediaServicesManager manager) { manager.streamingLocators().define("UserCreatedClearStreamingLocator") .withExistingMediaService("contosorg", "contosomedia").withAssetName("ClimbingMountRainier") .withStreamingPolicyName("clearStreamingPolicy").create(); } } 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 streaminglocatorscreateclear.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.create( resource_group_name="contoso", account_name="contosomedia", streaming_locator_name="UserCreatedClearStreamingLocator", parameters={"properties": {"assetName": "ClimbingMountRainier", "streamingPolicyName": "clearStreamingPolicy"}}, ) print(response) # x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-create-clear.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/azcore/to" "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-create-clear.json func ExampleStreamingLocatorsClient_Create_createsAStreamingLocatorWithClearStreaming() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armmediaservices.NewClientFactory("", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } _, err = clientFactory.NewStreamingLocatorsClient().Create(ctx, "contoso", "contosomedia", "UserCreatedClearStreamingLocator", armmediaservices.StreamingLocator{ Properties: &armmediaservices.StreamingLocatorProperties{ AssetName: to.Ptr("ClimbingMountRainier"), StreamingPolicyName: to.Ptr("clearStreamingPolicy"), }, }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } } 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 Create a Streaming Locator in the Media Services account * * @summary Create a Streaming Locator in the Media Services account * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-create-clear.json */ async function createsAStreamingLocatorWithClearStreaming() { const subscriptionId = process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000"; const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso"; const accountName = "contosomedia"; const streamingLocatorName = "UserCreatedClearStreamingLocator"; const parameters = { assetName: "ClimbingMountRainier", streamingPolicyName: "clearStreamingPolicy", }; const credential = new DefaultAzureCredential(); const client = new AzureMediaServices(credential, subscriptionId); const result = await client.streamingLocators.create( resourceGroupName, accountName, streamingLocatorName, parameters ); 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. |
.NET |
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-create-clear.json // this example is just showing the usage of "StreamingLocators_Create" 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 StreamingLocatorResource created on azure // for more information of creating StreamingLocatorResource, please refer to the document of StreamingLocatorResource string subscriptionId = "00000000-0000-0000-0000-000000000000"; string resourceGroupName = "contoso"; string accountName = "contosomedia"; string streamingLocatorName = "UserCreatedClearStreamingLocator"; ResourceIdentifier streamingLocatorResourceId = StreamingLocatorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, streamingLocatorName); StreamingLocatorResource streamingLocator = client.GetStreamingLocatorResource(streamingLocatorResourceId); // invoke the operation StreamingLocatorData data = new StreamingLocatorData() { AssetName = "ClimbingMountRainier", StreamingPolicyName = "clearStreamingPolicy", }; ArmOperation lro = await streamingLocator.UpdateAsync(WaitUntil.Completed, data); StreamingLocatorResource result = lro.Value; // the variable result 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 = result.Data; // for demo we just print out the id Console.WriteLine($"Succeeded on id: {resourceData.Id}"); 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: 201
{ "name": "UserCreatedClearStreamingLocator", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedClearStreamingLocator", "type": "Microsoft.Media/mediaservices/streamingLocators", "properties": { "assetName": "ClimbingMountRainier", "created": "2018-08-08T18:29:32.4323237Z", "endTime": "9999-12-31T23:59:59.9999999Z", "streamingLocatorId": "e34b0fc4-3be0-4a3c-9793-1f6b7be5b013", "streamingPolicyName": "clearStreamingPolicy", "contentKeys": [] } }
Creates a Streaming Locator with secure streaming
Technology | Sample request |
---|---|
HTTP |
PUT https://{{api-endpoint}}subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocator?api-version={{api-version}} { "properties": { "streamingPolicyName": "UserCreatedSecureStreamingPolicy", "assetName": "ClimbingMountRainier", "startTime": "2018-03-01T00:00:00Z", "endTime": "2028-12-31T23:59:59.9999999Z" } } |
Java |
import java.time.OffsetDateTime; /** * Samples for StreamingLocators Create. */ public final class Main { /* * x-ms-original-file: * specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming- * locators-create-secure.json */ /** * Sample code: Creates a Streaming Locator with secure streaming. * * @param manager Entry point to MediaServicesManager. */ public static void createsAStreamingLocatorWithSecureStreaming( com.azure.resourcemanager.mediaservices.MediaServicesManager manager) { manager.streamingLocators().define("UserCreatedSecureStreamingLocator") .withExistingMediaService("contosorg", "contosomedia").withAssetName("ClimbingMountRainier") .withStartTime(OffsetDateTime.parse("2018-03-01T00:00:00Z")) .withEndTime(OffsetDateTime.parse("2028-12-31T23:59:59.9999999Z")) .withStreamingPolicyName("UserCreatedSecureStreamingPolicy").create(); } } 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 streaminglocatorscreatesecure.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.create( resource_group_name="contoso", account_name="contosomedia", streaming_locator_name="UserCreatedSecureStreamingLocator", parameters={ "properties": { "assetName": "ClimbingMountRainier", "endTime": "2028-12-31T23:59:59.9999999Z", "startTime": "2018-03-01T00:00:00Z", "streamingPolicyName": "secureStreamingPolicy", } }, ) print(response) # x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-create-secure.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" "time" "github.com/Azure/azure-sdk-for-go/sdk/azcore/to" "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-create-secure.json func ExampleStreamingLocatorsClient_Create_createsAStreamingLocatorWithSecureStreaming() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armmediaservices.NewClientFactory("", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } _, err = clientFactory.NewStreamingLocatorsClient().Create(ctx, "contoso", "contosomedia", "UserCreatedSecureStreamingLocator", armmediaservices.StreamingLocator{ Properties: &armmediaservices.StreamingLocatorProperties{ AssetName: to.Ptr("ClimbingMountRainier"), EndTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2028-12-31T23:59:59.999Z"); return t }()), StartTime: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-03-01T00:00:00.000Z"); return t }()), StreamingPolicyName: to.Ptr("secureStreamingPolicy"), }, }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } } 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 Create a Streaming Locator in the Media Services account * * @summary Create a Streaming Locator in the Media Services account * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-create-secure.json */ async function createsAStreamingLocatorWithSecureStreaming() { const subscriptionId = process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000"; const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso"; const accountName = "contosomedia"; const streamingLocatorName = "UserCreatedSecureStreamingLocator"; const parameters = { assetName: "ClimbingMountRainier", endTime: new Date("2028-12-31T23:59:59.9999999Z"), startTime: new Date("2018-03-01T00:00:00Z"), streamingPolicyName: "secureStreamingPolicy", }; const credential = new DefaultAzureCredential(); const client = new AzureMediaServices(credential, subscriptionId); const result = await client.streamingLocators.create( resourceGroupName, accountName, streamingLocatorName, parameters ); 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. |
.NET |
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-create-secure.json // this example is just showing the usage of "StreamingLocators_Create" 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 StreamingLocatorResource created on azure // for more information of creating StreamingLocatorResource, please refer to the document of StreamingLocatorResource string subscriptionId = "00000000-0000-0000-0000-000000000000"; string resourceGroupName = "contoso"; string accountName = "contosomedia"; string streamingLocatorName = "UserCreatedSecureStreamingLocator"; ResourceIdentifier streamingLocatorResourceId = StreamingLocatorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, streamingLocatorName); StreamingLocatorResource streamingLocator = client.GetStreamingLocatorResource(streamingLocatorResourceId); // invoke the operation StreamingLocatorData data = new StreamingLocatorData() { AssetName = "ClimbingMountRainier", StartOn = DateTimeOffset.Parse("2018-03-01T00:00:00Z"), EndOn = DateTimeOffset.Parse("2028-12-31T23:59:59.9999999Z"), StreamingPolicyName = "secureStreamingPolicy", }; ArmOperation lro = await streamingLocator.UpdateAsync(WaitUntil.Completed, data); StreamingLocatorResource result = lro.Value; // the variable result 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 = result.Data; // for demo we just print out the id Console.WriteLine($"Succeeded on id: {resourceData.Id}"); 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: 201
{ "name": "UserCreatedSecureStreamingLocator", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocator", "type": "Microsoft.Media/mediaservices/streamingLocators", "properties": { "assetName": "ClimbingMountRainier", "created": "2018-08-08T18:29:32.6243295Z", "startTime": "2018-03-01T00:00:00Z", "endTime": "2028-12-31T23:59:59.9999999Z", "streamingLocatorId": "962775be-41fb-452a-b0dc-72ca2543a945", "streamingPolicyName": "UserCreatedSecureStreamingPolicy", "contentKeys": [ { "id": "1b2d5581-4518-4a51-ad8a-f55d3bf993d4", "type": "CommonEncryptionCbcs", "labelReferenceInStreamingPolicy": "cbcsDefaultKey", "tracks": [] }, { "id": "1a9858b1-3566-4bf1-9fee-60f2fb98e7e4", "type": "CommonEncryptionCenc", "labelReferenceInStreamingPolicy": "cencDefaultKey", "tracks": [] }, { "id": "5faac86a-3aca-4d6b-99c0-6bb8cc3497a1", "type": "EnvelopeEncryption", "labelReferenceInStreamingPolicy": "aesDefaultKey", "tracks": [] } ] } }
Creates a Streaming Locator with user defined content keys
Technology | Sample request |
---|---|
HTTP |
PUT https://{{api-endpoint}}/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaServices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys?api-version={{api-version}} { "properties": { "assetName": "ClimbingMountRainier", "streamingPolicyName": "secureStreamingPolicy", "streamingLocatorId": "90000000-0000-0000-0000-00000000000A", "contentKeys": [ { "labelReferenceInStreamingPolicy": "aesDefaultKey", "id": "60000000-0000-0000-0000-000000000001", "value": "1UqLohAfWsEGkULYxHjYZg==" }, { "labelReferenceInStreamingPolicy": "cencDefaultKey", "id": "60000000-0000-0000-0000-000000000004", "value": "4UqLohAfWsEGkULYxHjYZg==" }, { "labelReferenceInStreamingPolicy": "cbcsDefaultKey", "id": "60000000-0000-0000-0000-000000000007", "value": "7UqLohAfWsEGkULYxHjYZg==" } ] } } |
Java |
import com.azure.resourcemanager.mediaservices.models.StreamingLocatorContentKey; import java.util.Arrays; import java.util.UUID; /** * Samples for StreamingLocators Create. */ public final class Main { /* * x-ms-original-file: * specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming- * locators-create-secure-userDefinedContentKeys.json */ /** * Sample code: Creates a Streaming Locator with user defined content keys. * * @param manager Entry point to MediaServicesManager. */ public static void createsAStreamingLocatorWithUserDefinedContentKeys( com.azure.resourcemanager.mediaservices.MediaServicesManager manager) { manager.streamingLocators().define("UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys") .withExistingMediaService("contosorg", "contosomedia").withAssetName("ClimbingMountRainier") .withStreamingLocatorId(UUID.fromString("90000000-0000-0000-0000-00000000000A")) .withStreamingPolicyName("secureStreamingPolicy") .withContentKeys(Arrays.asList( new StreamingLocatorContentKey().withId(UUID.fromString("60000000-0000-0000-0000-000000000001")) .withLabelReferenceInStreamingPolicy("aesDefaultKey").withValue("1UqLohAfWsEGkULYxHjYZg=="), new StreamingLocatorContentKey().withId(UUID.fromString("60000000-0000-0000-0000-000000000004")) .withLabelReferenceInStreamingPolicy("cencDefaultKey").withValue("4UqLohAfWsEGkULYxHjYZg=="), new StreamingLocatorContentKey().withId(UUID.fromString("60000000-0000-0000-0000-000000000007")) .withLabelReferenceInStreamingPolicy("cbcsDefaultKey").withValue("7UqLohAfWsEGkULYxHjYZg=="))) .create(); } } 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 streaminglocatorscreatesecureuser_defined_content_keys.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.create( resource_group_name="contoso", account_name="contosomedia", streaming_locator_name="UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", parameters={ "properties": { "assetName": "ClimbingMountRainier", "contentKeys": [ { "id": "60000000-0000-0000-0000-000000000001", "labelReferenceInStreamingPolicy": "aesDefaultKey", "value": "1UqLohAfWsEGkULYxHjYZg==", }, { "id": "60000000-0000-0000-0000-000000000004", "labelReferenceInStreamingPolicy": "cencDefaultKey", "value": "4UqLohAfWsEGkULYxHjYZg==", }, { "id": "60000000-0000-0000-0000-000000000007", "labelReferenceInStreamingPolicy": "cbcsDefaultKey", "value": "7UqLohAfWsEGkULYxHjYZg==", }, ], "streamingLocatorId": "90000000-0000-0000-0000-00000000000A", "streamingPolicyName": "secureStreamingPolicy", } }, ) print(response) # x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-create-secure-userDefinedContentKeys.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/azcore/to" "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-create-secure-userDefinedContentKeys.json func ExampleStreamingLocatorsClient_Create_createsAStreamingLocatorWithUserDefinedContentKeys() { cred, err := azidentity.NewDefaultAzureCredential(nil) if err != nil { log.Fatalf("failed to obtain a credential: %v", err) } ctx := context.Background() clientFactory, err := armmediaservices.NewClientFactory("", cred, nil) if err != nil { log.Fatalf("failed to create client: %v", err) } _, err = clientFactory.NewStreamingLocatorsClient().Create(ctx, "contoso", "contosomedia", "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", armmediaservices.StreamingLocator{ Properties: &armmediaservices.StreamingLocatorProperties{ AssetName: to.Ptr("ClimbingMountRainier"), ContentKeys: []*armmediaservices.StreamingLocatorContentKey{ { ID: to.Ptr("60000000-0000-0000-0000-000000000001"), LabelReferenceInStreamingPolicy: to.Ptr("aesDefaultKey"), Value: to.Ptr("1UqLohAfWsEGkULYxHjYZg=="), }, { ID: to.Ptr("60000000-0000-0000-0000-000000000004"), LabelReferenceInStreamingPolicy: to.Ptr("cencDefaultKey"), Value: to.Ptr("4UqLohAfWsEGkULYxHjYZg=="), }, { ID: to.Ptr("60000000-0000-0000-0000-000000000007"), LabelReferenceInStreamingPolicy: to.Ptr("cbcsDefaultKey"), Value: to.Ptr("7UqLohAfWsEGkULYxHjYZg=="), }}, StreamingLocatorID: to.Ptr("90000000-0000-0000-0000-00000000000A"), StreamingPolicyName: to.Ptr("secureStreamingPolicy"), }, }, nil) if err != nil { log.Fatalf("failed to finish the request: %v", err) } } 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 Create a Streaming Locator in the Media Services account * * @summary Create a Streaming Locator in the Media Services account * x-ms-original-file: specification/mediaservices/resource-manager/Microsoft.Media/Metadata/stable/2022-08-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json */ async function createsAStreamingLocatorWithUserDefinedContentKeys() { const subscriptionId = process.env["MEDIASERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000"; const resourceGroupName = process.env["MEDIASERVICES_RESOURCE_GROUP"] || "contoso"; const accountName = "contosomedia"; const streamingLocatorName = "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys"; const parameters = { assetName: "ClimbingMountRainier", contentKeys: [ { id: "60000000-0000-0000-0000-000000000001", labelReferenceInStreamingPolicy: "aesDefaultKey", value: "1UqLohAfWsEGkULYxHjYZg==", }, { id: "60000000-0000-0000-0000-000000000004", labelReferenceInStreamingPolicy: "cencDefaultKey", value: "4UqLohAfWsEGkULYxHjYZg==", }, { id: "60000000-0000-0000-0000-000000000007", labelReferenceInStreamingPolicy: "cbcsDefaultKey", value: "7UqLohAfWsEGkULYxHjYZg==", }, ], streamingLocatorId: "90000000-0000-0000-0000-00000000000A", streamingPolicyName: "secureStreamingPolicy", }; const credential = new DefaultAzureCredential(); const client = new AzureMediaServices(credential, subscriptionId); const result = await client.streamingLocators.create( resourceGroupName, accountName, streamingLocatorName, parameters ); 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. |
.NET |
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-create-secure-userDefinedContentKeys.json // this example is just showing the usage of "StreamingLocators_Create" 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 StreamingLocatorResource created on azure // for more information of creating StreamingLocatorResource, please refer to the document of StreamingLocatorResource string subscriptionId = "00000000-0000-0000-0000-000000000000"; string resourceGroupName = "contoso"; string accountName = "contosomedia"; string streamingLocatorName = "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys"; ResourceIdentifier streamingLocatorResourceId = StreamingLocatorResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, streamingLocatorName); StreamingLocatorResource streamingLocator = client.GetStreamingLocatorResource(streamingLocatorResourceId); // invoke the operation StreamingLocatorData data = new StreamingLocatorData() { AssetName = "ClimbingMountRainier", StreamingLocatorId = Guid.Parse("90000000-0000-0000-0000-00000000000A"), StreamingPolicyName = "secureStreamingPolicy", ContentKeys = { new StreamingLocatorContentKey(Guid.Parse("60000000-0000-0000-0000-000000000001")) { LabelReferenceInStreamingPolicy = "aesDefaultKey", Value = "1UqLohAfWsEGkULYxHjYZg==", },new StreamingLocatorContentKey(Guid.Parse("60000000-0000-0000-0000-000000000004")) { LabelReferenceInStreamingPolicy = "cencDefaultKey", Value = "4UqLohAfWsEGkULYxHjYZg==", },new StreamingLocatorContentKey(Guid.Parse("60000000-0000-0000-0000-000000000007")) { LabelReferenceInStreamingPolicy = "cbcsDefaultKey", Value = "7UqLohAfWsEGkULYxHjYZg==", } }, }; ArmOperation lro = await streamingLocator.UpdateAsync(WaitUntil.Completed, data); StreamingLocatorResource result = lro.Value; // the variable result 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 = result.Data; // for demo we just print out the id Console.WriteLine($"Succeeded on id: {resourceData.Id}"); 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: 201
{ "name": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosorg/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", "type": "Microsoft.Media/mediaservices/streamingLocators", "properties": { "assetName": "ClimbingMountRainier", "created": "2018-08-08T18:29:32.7859424Z", "endTime": "9999-12-31T23:59:59.9999999Z", "streamingLocatorId": "90000000-0000-0000-0000-00000000000a", "streamingPolicyName": "secureStreamingPolicy", "contentKeys": [ { "id": "60000000-0000-0000-0000-000000000007", "type": "CommonEncryptionCbcs", "labelReferenceInStreamingPolicy": "cbcsDefaultKey", "tracks": [] }, { "id": "60000000-0000-0000-0000-000000000004", "type": "CommonEncryptionCenc", "labelReferenceInStreamingPolicy": "cencDefaultKey", "tracks": [] }, { "id": "60000000-0000-0000-0000-000000000001", "type": "EnvelopeEncryption", "labelReferenceInStreamingPolicy": "aesDefaultKey", "tracks": [] } ] } }
Definitions
Name | Description |
---|---|
createdByType | The type of identity that created the resource. |
ErrorAdditionalInfo | The resource management error additional info. |
ErrorDetail | The error detail. |
ErrorResponse | Error response. |
StreamingLocator | A Streaming Locator resource. |
StreamingLocatorContentKey | Class for content key in Streaming Locator. |
StreamingLocatorContentKeyType | Encryption type of Content Key. |
systemData | Metadata pertaining to creation and last modification of the resource. |
TrackPropertyCompareOperation | Track property condition operation. |
TrackPropertyCondition | Class to specify one track property condition. |
TrackPropertyType | Track property type. |
TrackSelection | Class to select a track |
createdByType
The type of identity that created the resource.
Name | Type |
---|---|
Application | string |
Key | string |
ManagedIdentity | string |
User | string |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info | object | The additional info. |
type | string | The additional info type. |
ErrorDetail
Name | Type | Description |
---|---|---|
additionalInfo | ErrorAdditionalInfo | The error additional info. |
code | string | The error code. |
details | ErrorDetail | The error details. |
message | string | The error message. |
target | string | The error target. |
ErrorResponse
Name | Type | Description |
---|---|---|
error | ErrorDetail | The error object. |
StreamingLocator
A Streaming Locator resource
Name | Type | Description |
---|---|---|
id | string | Fully qualified resource ID for the resource. E.g.
/subscriptions/{subscriptionId}/resource |
name | string | The name of the resource. |
properties.alternativeMediaId | string | Alternative Media ID of this Streaming Locator. |
properties.assetName | string | Asset Name. |
properties.contentKeys | The ContentKeys used by this Streaming Locator. | |
properties.created | string | The creation time of the Streaming Locator. |
properties.default ContentKeyPolicyName |
string | Name of the default ContentKeyPolicy used by this Streaming Locator. |
properties.endTime | string | The end time of the Streaming Locator. |
properties.filters | string | A list of asset or account filters which apply to this Streaming Locator. |
properties.startTime | string | The start time of the Streaming Locator. |
properties.streamingLocatorId | string | The StreamingLocatorId of the Streaming Locator. |
properties.streaming PolicyName |
string | Name of the Streaming Policy used by this Streaming Locator. Specify the name of your Streaming Policy or use one of the predefined policies, such as:
|
systemData | systemData | The system metadata relating to this resource. |
type | string | The type of the resource. E.g., "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". |
StreamingLocatorContentKey
Class for content key in Streaming Locator
Name | Type | Description |
---|---|---|
id | string | ID of the content key |
labelReferenceInStreamingPolicy | string | Label of the content key as specified in the streaming policy |
policyName | string | The ContentKeyPolicy used by the content key |
tracks | TrackSelection | Tracks that use this content key |
type | StreamingLocatorContentKeyType | Encryption type of the content key |
value | string | Value of the content key |
StreamingLocatorContentKeyType
Encryption type of Content Key
Name | Type | Description |
---|---|---|
CommonEncryptionCbcs | string | Common encryption using CBCS |
CommonEncryptionCenc | string | Common encryption using CENC |
EnvelopeEncryption | string | Envelope encryption |
systemData
Metadata pertaining to creation and last modification of the resource.
Name | Type | Description |
---|---|---|
createdAt | string | The timestamp of resource creation (UTC). |
createdBy | string | The identity that created the resource. |
createdByType | createdByType | The type of identity that created the resource. |
lastModifiedAt | string | The timestamp of resource last modification (UTC). |
lastModifiedBy | string | The identity that last modified the resource. |
lastModifiedByType | createdByType | The type of identity that last modified the resource. |
TrackPropertyCompareOperation
Track property condition operation
Name | Type | Description |
---|---|---|
Equal | string | Equal operation |
Unknown | string | Unknown track property compare operation |
TrackPropertyCondition
Class to specify one track property condition
Name | Type | Description |
---|---|---|
operation | TrackPropertyCompareOperation | Track property condition operation |
property | TrackPropertyType | Track property type |
value | string | Track property value |
TrackPropertyType
Track property type
Name | Type | Description |
---|---|---|
FourCC | string | Track FourCC |
Unknown | string | Unknown track property |
TrackSelection
Class to select a track
Name | Type | Description |
---|---|---|
trackSelections | TrackPropertyCondition | Track selections is a list of track property conditions that can specify track(s). |