List Streaming Locators
Listing, Sorting and Filtering Streaming Locators
This endpoint returns the list of streaming locators in the specified project.
Sorting
The results from this endpoint can be ordered using the $orderby query parameter. Specify a list of field names, separated by commas
where each one can optionally specify asc or desc.
Sorting is valid on the following fields: created, createdBy, id, name, properties/created, properties/endTime, properties/startTime, updated, updatedBy
Filtering
The $filter query parameter allows for streaming locators to be filtered on the basis of fields in the schema using OData query syntax.
See this document for more details on the syntax used.
Filters are valid on the following fields: created, createdBy, createdByEmail, createdByName, id, name, properties/assetName, properties/created, properties/endTime, properties/startTime, updated, updatedBy, updatedByEmail, updatedByName
Examples:
?$top=10 - Returns only the first 10 streaming locators from the list.
?$orderby=name desc - Sorts streaming locators by name in descending order.
?$filter=name eq 'descriptive name' - Returns streaming locators that match the provided name.
?$orderby=created desc - Sorts streaming locators by creation date in descending order.
?$filter=created ge 2021-01-01T00:00:00Z - Returns streaming locators created after January 1, 2021.
Authentication
Authorization Bearer
Bearer authentication of the form Bearer <token>, where token is your
auth token.
Path parameters
project_name string Required
Query parameters
$orderby string Optional
Specifies the key by which the result collection should be ordered.
$filter string Optional
Restricts the set of items returned.
$top string Optional
Specifies a non-negative integer
n that limits the number of items returned from a collection.
The service returns the number of available items up to but not greater than the specified value n. $skiptoken string Optional
Specifies a start offset to support paginated results.
Use
@odata.nextLink in the result object to enumerate the collection -
it will be present only if there's more than one page of entities.Response
200 A list of storage accounts
@odata.nextLinkstringOptional
@odata.nextLink URL if the page length and number of items match.
Supplemental info
Show 5 propertiesHide 5 properties
countintegerRequired
Number of items returned
kindstringRequired
Type of items in the list
operationstringRequired
Operation type. Should always say 'list'
Pagination info
Show 4 propertiesHide 4 properties
endintegerRequired
Position of the last item in the list
recordsintegerRequired
Total number of items returned in the list
startintegerRequired
Position of the first item in the list
totalintegerRequired
Total number of items in the project
Project info
Show 2 propertiesHide 2 properties
idstringRequired
Project ID
namestringRequired
Project name
The list of streaming locators
Show 5 propertiesHide 5 properties
idstringOptional
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
namestringOptional1-260 characterspattern: ^[^\^\'<>%&:\\?/*+]+$
The name of the resource
Properties for streaming locator
Show 14 propertiesHide 14 properties
alternativeMediaIdstringOptional
The alternative media id of the asset used by this streaming locator
assetNamestringRequired
The name of the asset used by this streaming locator
contentIdstringOptional1-260 characters
Optional content ID. Only valid when an external key server is used.
The content keys used by this streaming locator
Show 6 propertiesHide 6 properties
idstringRequired
The id of the content key
labelReferenceInStreamingPolicystringOptional
The label reference in the streaming policy
policyNamestringOptional
The name of the policy
Not currently supported. The tracks which use this content key
Show 1 propertyHide 1 property
The track selections
Show 3 propertiesHide 3 properties
The track property comparison operation
Show 2 propertiesHide 2 properties
EqualstringRequired
The track property comparison operation
UnknownstringRequired
The track property comparison operation
propertystringRequired
The track property to compare against
valuestringRequired
The track property value.
typeenumOptional
The streaming locator content key type
Allowed values:CommonEncryptionCencCommonEncryptionCbcsEnvelopeEncryption
valuestringOptional
The value of the content key
defaultContentKeyPolicyNamestringOptional<=260 characters
The default content key policy name used by this streaming locator.
defaultManifestFilenamestringOptional1-260 characterspattern: ^[A-Za-z0-9 _.,()-]+$
Manifest filename used with streaming endpoints that have urlStyle set to 'Aquila' or 'Unified'. For example: manifest.ism (for MP4 assets), manifest.mpd (for TS assets), index.qfm (for live events)
endTimestringOptionalformat: date-time
The end time of the streaming locator
filterslist of stringsOptional
A list of asset or account filters to apply to the streaming locator.
provisioningStateenumOptional
The provisioning state of the streaming locator. Set by the system. One of InProgress, Succeeded, Failed.
Allowed values:InProgressSucceededFailed
resourceStateenumOptional
The runtime state of the streaming locator. Set by the system.
Allowed values:CreatingUpdatingDeletingCreatedDeletedError
startTimestringOptionalformat: date-time
The start time of the streaming locator
streamingLocatorIdstringOptional1-260 characterspattern: ^[^\/]+$
The streaming locator id
streamingPolicyNamestringRequired<=260 characters
The name of the streaming policy used by this streaming locator.
You may specify a custom policy by name, or used one of the predefined policies.
To get the list of valid policy options use the
You may specify a custom policy by name, or used one of the predefined policies.
To get the list of valid policy options use the
GET /api/v1/projects/{project_name}/media/streamingPolicies endpoint.suppressedbooleanOptionalDefaults to false
Optional configuration for output suppression.
A suppressed locator will return a 404 HTTP response to requests, in the same way it would if the startTime had not yet been reached.
The 404 code can be overridden with a different status code by setting preAvailabilityStatusCode in a custom catalog in a Streaming Policy.
Metadata pertaining to creation and last modification of the resource.
Show 7 propertiesHide 7 properties
createdAtstringRequiredformat: date-time
The timestamp of resource creation (UTC).
createdBystringRequired
The identity that created the resource.
createdByTypeenumRequired
The type of identity that created the resource.
Allowed values:UserApplicationManagedIdentityKey
internalIdstringRequiredformat: uuid
The internal ID of the resource.
lastModifiedAtstringRequiredformat: date-time
The timestamp of resource last modification (UTC).
lastModifiedBystringRequired
The identity that last modified the resource.
lastModifiedByTypeenumRequired
The type of identity that last modified the resource.
Allowed values:UserApplicationManagedIdentityKey
typestringOptional
The type of the resource. E.g. "Microsoft.Media/mediaservices/assets"
Errors
400 Bad Request
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
401 Unauthorized
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
403 Forbidden
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
404 Not Found
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
429 Too Many Requests
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code
500 Internal Server Error
Pertinent information about the error
Show 3 propertiesHide 3 properties
codestringRequired
The error code.
detailstringRequired
The error message.
extraDetailmap from strings to anyOptional
Extra information regarding this error.
Show value schemaHide value schema
[any key]any
refstringRequired
A reference to the request that caused the error.
statusintegerRequired
The HTTP status code