Streaming Locators - Get

Get a Streaming Locator
Get the details of a Streaming Locator in the Media Services account

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

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.

streamingLocatorName
path True

string

The Streaming Locator name.

subscriptionId
path True

string

The unique identifier for a Microsoft Azure subscription.

api-version
query True

string

The version of the API to be used with the client request.

Responses

Name Type Description
200 OK

StreamingLocator

OK

Other Status Codes

ErrorResponse

Detailed error information.

Examples

Get a Streaming Locator by name

Sample request

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

Sample response

{
  "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:32.1154071Z",
    "endTime": "9999-12-31T23:59:59.9999999Z",
    "streamingLocatorId": "7684043b-f6d1-44a7-8bed-8a4aa474c5a4",
    "streamingPolicyName": "clearStreamingPolicy",
    "contentKeys": []
  }
}

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

The error detail.

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

Error response

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. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

The name of the resource

properties.alternativeMediaId

string

Alternative Media ID of this Streaming Locator

properties.assetName

string

Asset Name

properties.contentKeys

StreamingLocatorContentKey[]

The ContentKeys used by this Streaming Locator.

properties.created

string

The creation time of the Streaming Locator.

properties.defaultContentKeyPolicyName

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

string

Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'

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 Content Key

labelReferenceInStreamingPolicy

string

Label of Content Key as specified in the Streaming Policy

policyName

string

ContentKeyPolicy used by Content Key

tracks

TrackSelection[]

Tracks which use this Content Key

type

StreamingLocatorContentKeyType

Encryption type of Content Key

value

string

Value of 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[]

TrackSelections is a track property condition list which can specify track(s)