Microsoft.Media (preview:2018-07-01)

2025/05/26 • 55 deleted methods

Operations_List (removed)
Description :  Lists all the Media Services operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.Media/operations
{
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Operation items. ,
Required: False ,
}
[
{
name:
{
Description: The operation name. ,
Required: True ,
}
string ,
display:
{
Description: The operation display name. ,
Required: False ,
}
{
provider:
{
Description: The service provider. ,
Required: False ,
}
string ,
resource:
{
Description: Resource on which the operation is performed. ,
Required: False ,
}
string ,
operation:
{
Description: The operation type. ,
Required: False ,
}
string ,
description:
{
Description: The operation description. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: Origin of the operation. ,
Required: False ,
}
string ,
properties:
{
Description: Operation properties format. ,
Required: False ,
}
{
serviceSpecification:
{
Description: The service specifications. ,
Required: False ,
}
{
metricSpecifications:
{
Description: List of metric specifications. ,
Required: False ,
}
[
{
name:
{
Description: The metric name. ,
Required: False ,
}
string ,
displayName:
{
Description: The metric display name. ,
Required: False ,
}
string ,
displayDescription:
{
Description: The metric display description. ,
Required: False ,
}
string ,
unit:
{
Description: The metric unit ,
Enum:
{
Bytes: The number of bytes. ,
Count: The count. ,
Milliseconds: The number of milliseconds. ,
}
,
Required: False ,
}
enum ,
aggregationType:
{
Description: The metric aggregation type ,
Enum:
{
Average: The average. ,
Count: The count of a number of items, usually requests. ,
Total: The sum. ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The metric dimensions. ,
Required: False ,
}
[
{
name:
{
Description: The metric dimension name. ,
Required: False ,
}
string ,
displayName:
{
Description: The display name for the dimension. ,
Required: False ,
}
string ,
toBeExportedForShoebox:
{
Description: Whether to export metric to shoebox. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
]
,
}
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_List (removed)
Description :  List Media Services accounts in the resource group
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of MediaService items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_Get (removed)
Description :  Get the details of a Media Services account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_CreateOrUpdate (removed)
Description :  Creates or updates a Media Services account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_Delete (removed)
Description :  Deletes a Media Services account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_Update (removed)
Description :  Updates an existing Media Services account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_SyncStorageKeys (removed)
Description :  Synchronizes storage account keys for a storage account associated with the Media Service account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/syncStorageKeys
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
id:
{
Description: The ID of the storage account resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Locations_CheckNameAvailability (removed)
Description :  Checks whether the Media Service resource name is available.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
locationName:
{
Description: The name of the location ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
name:
{
Description: The account name. ,
Required: False ,
}
string ,
type:
{
Description: The account type. For a Media Services account, this should be 'MediaServices'. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: Specifies if the name is available. ,
Required: True ,
}
boolean ,
reason:
{
Description: Specifies the reason if the name is not available. ,
Required: False ,
}
string ,
message:
{
Description: Specifies the detailed reason if the name is not available. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_ListBySubscription (removed)
Description :  List Media Services accounts in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of SubscriptionMediaService items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Mediaservices_GetBySubscription (removed)
Description :  Get the details of a Media Services account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices/{accountName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
mediaServiceId:
{
Description: The Media Services account ID. ,
Format: uuid ,
Required: False ,
}
string ,
storageAccounts:
{
Description: The storage accounts for this resource. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts. ,
Required: False ,
}
string ,
type:
{
Description: The type of the storage account. ,
Enum:
{
Primary: The primary storage account for the Media Services account. ,
Secondary: A secondary storage account for the Media Services account. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Transforms_List (removed)
Description :  Lists the Transforms in the account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Transform items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Transforms_Get (removed)
Description :  Gets a Transform.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Transforms_CreateOrUpdate (removed)
Description :  Creates or updates a new Transform.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Transforms_Delete (removed)
Description :  Deletes a Transform.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Transforms_Update (removed)
Description :  Updates a Transform.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: An optional verbose description of the Transform. ,
Required: False ,
}
string ,
lastModified:
{
Description: The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: An array of one or more TransformOutputs that the Transform should generate. ,
Required: True ,
}
[
{
onError:
{
Description: A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'. ,
Enum:
{
StopProcessingJob: Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped. ,
ContinueJob: Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue. ,
}
,
Required: False ,
}
enum ,
relativePriority:
{
Description: Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
preset:
{
Description: Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_List (removed)
Description :  Lists all of the Jobs for the Transform.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$orderby:
{
Description: Specifies the by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Job items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_Get (removed)
Description :  Gets a Job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_Create (removed)
Description :  Creates a Job.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_Delete (removed)
Description :  Deletes a Job.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_Update (removed)
Description :  Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
state:
{
Description: The current state of the job. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Optional customer supplied description of the Job. ,
Required: False ,
}
string ,
input:
{
Description: The inputs for the Job. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
lastModified:
{
Description: The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format. ,
Format: date-time ,
Required: False ,
}
string ,
outputs:
{
Description: The outputs for the Job. ,
Required: True ,
}
[
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
error:
{
Description: If the JobOutput is in the Error state, it contains the details of the error. ,
Required: False ,
}
{
code:
{
Description: Error code describing the error. ,
Enum:
{
ServiceError: Fatal service error, please contact support. ,
ServiceTransientError: Transient error, please retry, if retry is unsuccessful, please contact support. ,
DownloadNotAccessible: While trying to download the input files, the files were not accessible, please check the availability of the source. ,
DownloadTransientError: While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source. ,
UploadNotAccessible: While trying to upload the output files, the destination was not reachable, please check the availability of the destination. ,
UploadTransientError: While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination. ,
ConfigurationUnsupported: There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration. ,
ContentMalformed: There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files. ,
ContentUnsupported: There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files. ,
}
,
Required: False ,
}
enum ,
message:
{
Description: A human-readable language-dependent representation of the error. ,
Required: False ,
}
string ,
category:
{
Description: Helps with categorization of errors. ,
Enum:
{
Service: The error is service related. ,
Download: The error is download related. ,
Upload: The error is upload related. ,
Configuration: The error is configuration related. ,
Content: The error is related to data in the input files. ,
}
,
Required: False ,
}
enum ,
retry:
{
Description: Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal. ,
Enum:
{
DoNotRetry: Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected. ,
MayRetry: Issue may be resolved after waiting for a period of time and resubmitting the same Job. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
{
code:
{
Description: Code describing the error detail. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: False ,
}
string ,
}
,
]
,
}
,
state:
{
Description: Describes the state of the JobOutput. ,
Enum:
{
Canceled: The job was canceled. This is a final state for the job. ,
Canceling: The job is in the process of being canceled. This is a transient state for the job. ,
Error: The job has encountered an error. This is a final state for the job. ,
Finished: The job is finished. This is a final state for the job. ,
Processing: The job is processing. This is a transient state for the job. ,
Queued: The job is in a queued state, waiting for resources to become available. This is a transient state. ,
Scheduled: The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states. ,
}
,
Required: False ,
}
enum ,
progress:
{
Description: If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property. ,
Format: int32 ,
Required: False ,
}
integer ,
label:
{
Description: A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform. ,
Required: False ,
}
string ,
}
,
]
,
priority:
{
Description: Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal. ,
Enum:
{
Low: Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs. ,
Normal: Used for TransformOutputs that can be generated at Normal priority. ,
High: Used for TransformOutputs that should take precedence over others. ,
}
,
Required: False ,
}
enum ,
correlationData:
{
Description: Customer provided key, value pairs that will be returned in Job and JobOutput state events. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Jobs_CancelJob (removed)
Description :  Cancel a Job.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
transformName:
{
Description: The Transform name. ,
Required: True ,
}
string ,
jobName:
{
Description: The Job name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AccountFilters_List (removed)
Description :  List Account Filters in the Media Services account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of AccountFilter items. ,
Required: False ,
}
[
{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AccountFilters_Get (removed)
Description :  Get the details of an Account Filter in the Media Services account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Account Filter name ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AccountFilters_CreateOrUpdate (removed)
Description :  Creates or updates an Account Filter in the Media Services account.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Account Filter name ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AccountFilters_Delete (removed)
Description :  Deletes an Account Filter in the Media Services account.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Account Filter name ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AccountFilters_Update (removed)
Description :  Updates an existing Account Filter in the Media Services account.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Account Filter name ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_List (removed)
Description :  List Assets in the Media Services account with optional filtering and ordering
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Required: False ,
}
integer ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of Asset items. ,
Required: False ,
}
[
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_Get (removed)
Description :  Get the details of an Asset in the Media Services account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_CreateOrUpdate (removed)
Description :  Creates or updates an Asset in the Media Services account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_Delete (removed)
Description :  Deletes an Asset in the Media Services account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_Update (removed)
Description :  Updates an existing Asset in the Media Services account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
assetId:
{
Description: The Asset ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Asset. ,
Format: date-time ,
Required: False ,
}
string ,
alternateId:
{
Description: The alternate ID of the Asset. ,
Required: False ,
}
string ,
description:
{
Description: The Asset description. ,
Required: False ,
}
string ,
container:
{
Description: The name of the asset blob container. ,
Required: False ,
}
string ,
storageAccountName:
{
Description: The name of the storage account. ,
Required: False ,
}
string ,
storageEncryptionFormat:
{
Description: The Asset encryption format. One of None or MediaStorageEncryption. ,
Enum:
{
None: The Asset does not use client-side storage encryption (this is the only allowed value for new Assets). ,
MediaStorageClientEncryption: The Asset is encrypted with Media Services client-side encryption. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_ListContainerSas (removed)
Description :  Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listContainerSas
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
permissions:
{
Description: The permissions to set on the SAS URL. ,
Enum:
{
Read: The SAS URL will allow read access to the container. ,
ReadWrite: The SAS URL will allow read and write access to the container. ,
ReadWriteDelete: The SAS URL will allow read, write and delete access to the container. ,
}
,
Required: False ,
}
enum ,
expiryTime:
{
Description: The SAS URL expiration time. This must be less than 24 hours from the current time. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
assetContainerSasUrls:
{
Description: The list of Asset container SAS URLs. ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_GetEncryptionKey (removed)
Description :  Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/getEncryptionKey
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
key:
{
Description: The Asset File storage encryption key. ,
Format: byte ,
Required: False ,
}
string ,
assetFileEncryptionMetadata:
{
Description: Asset File encryption metadata. ,
Required: False ,
}
[
{
initializationVector:
{
Description: The Asset File initialization vector. ,
Required: False ,
}
string ,
assetFileName:
{
Description: The Asset File name. ,
Required: False ,
}
string ,
assetFileId:
{
Description: The Asset File Id. ,
Format: uuid ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
Assets_ListStreamingLocators (removed)
Description :  Lists Streaming Locators which are associated with this asset.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listStreamingLocators
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
streamingLocators:
{
Description: The list of Streaming Locators. ,
Required: False ,
}
[
{
name:
{
Description: Streaming Locator name. ,
Required: False ,
}
string ,
assetName:
{
Description: Asset Name. ,
Required: False ,
}
string ,
created:
{
Description: The creation time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
streamingLocatorId:
{
Description: StreamingLocatorId of the Streaming Locator. ,
Format: uuid ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: Name of the Streaming Policy used by this Streaming Locator. ,
Required: False ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Name of the default ContentKeyPolicy used by this Streaming Locator. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AssetFilters_List (removed)
Description :  List Asset Filters associated with the specified Asset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of AssetFilter items. ,
Required: False ,
}
[
{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AssetFilters_Get (removed)
Description :  Get the details of an Asset Filter associated with the specified Asset.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Asset Filter name ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AssetFilters_CreateOrUpdate (removed)
Description :  Creates or updates an Asset Filter associated with the specified Asset.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Asset Filter name ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AssetFilters_Delete (removed)
Description :  Deletes an Asset Filter associated with the specified Asset.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Asset Filter name ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
AssetFilters_Update (removed)
Description :  Updates an existing Asset Filter associated with the specified Asset.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters/{filterName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
assetName:
{
Description: The Asset name. ,
Required: True ,
}
string ,
filterName:
{
Description: The Asset Filter name ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The Media Filter properties. ,
Required: False ,
}
{
presentationTimeRange:
{
Description: The presentation time range. ,
Required: False ,
}
{
startTimestamp:
{
Description: The absolute start time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
endTimestamp:
{
Description: The absolute end time boundary. ,
Format: int64 ,
Required: False ,
}
integer ,
presentationWindowDuration:
{
Description: The relative to end sliding window. ,
Format: int64 ,
Required: False ,
}
integer ,
liveBackoffDuration:
{
Description: The relative to end right edge. ,
Format: int64 ,
Required: False ,
}
integer ,
timescale:
{
Description: The time scale of time stamps. ,
Format: int64 ,
Required: False ,
}
integer ,
forceEndTimestamp:
{
Description: The indicator of forcing existing of end time stamp. ,
Required: False ,
}
boolean ,
}
,
firstQuality:
{
Description: The first quality. ,
Required: False ,
}
{
bitrate:
{
Description: The first quality bitrate. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
tracks:
{
Description: The tracks selection conditions. ,
Required: False ,
}
[
{
trackSelections:
{
Description: The track selections. ,
Required: True ,
}
[
{
property:
{
Description: The track property type. ,
Enum:
{
Unknown: The unknown track property type. ,
Type: The type. ,
Name: The name. ,
Language: The language. ,
FourCC: The fourCC. ,
Bitrate: The bitrate. ,
}
,
Required: True ,
}
enum ,
value:
{
Description: The track property value. ,
Required: True ,
}
string ,
operation:
{
Description: The track property condition operation. ,
Enum:
{
Equal: The equal operation. ,
NotEqual: The not equal operation. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContentKeyPolicies_List (removed)
Description :  Lists the Content Key Policies in the account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Required: False ,
}
integer ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of ContentKeyPolicy items. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContentKeyPolicies_Get (removed)
Description :  Get the details of a Content Key Policy in the Media Services account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
contentKeyPolicyName:
{
Description: The Content Key Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContentKeyPolicies_CreateOrUpdate (removed)
Description :  Create or update a Content Key Policy in the Media Services account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
contentKeyPolicyName:
{
Description: The Content Key Policy name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContentKeyPolicies_Delete (removed)
Description :  Deletes a Content Key Policy in the Media Services account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
contentKeyPolicyName:
{
Description: The Content Key Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContentKeyPolicies_Update (removed)
Description :  Updates an existing Content Key Policy in the Media Services account
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
contentKeyPolicyName:
{
Description: The Content Key Policy name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the Content Key Policy. ,
Required: False ,
}
{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
ContentKeyPolicies_GetPolicyPropertiesWithSecrets (removed)
Description :  Get a Content Key Policy including secret values
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}/getPolicyPropertiesWithSecrets
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
contentKeyPolicyName:
{
Description: The Content Key Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
policyId:
{
Description: The legacy Policy ID. ,
Format: uuid ,
Required: False ,
}
string ,
created:
{
Description: The creation date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified date of the Policy ,
Format: date-time ,
Required: False ,
}
string ,
description:
{
Description: A description for the Policy. ,
Required: False ,
}
string ,
options:
{
Description: The Key Policy options. ,
Required: True ,
}
[
{
policyOptionId:
{
Description: The legacy Policy Option ID. ,
Format: uuid ,
Required: False ,
}
string ,
name:
{
Description: The Policy Option description. ,
Required: False ,
}
string ,
configuration:
{
Description: The key delivery configuration. ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
restriction:
{
Description: The requirements that must be met to deliver keys with this configuration ,
Required: True ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingPolicies_List (removed)
Description :  Lists the Streaming Policies in the account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Required: False ,
}
integer ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of StreamingPolicy items. ,
Required: False ,
}
[
{
properties:
{
Description: Class to specify properties of Streaming Policy ,
Required: False ,
}
{
created:
{
Description: Creation time of Streaming Policy ,
Format: date-time ,
Required: False ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Default ContentKey used by current Streaming Policy ,
Required: False ,
}
string ,
envelopeEncryption:
{
Description: Configuration of EnvelopeEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
customKeyAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
commonEncryptionCenc:
{
Description: Configuration of CommonEncryptionCenc ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for CommonEncryptionCenc encryption scheme ,
Required: False ,
}
{
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
commonEncryptionCbcs:
{
Description: Configuration of CommonEncryptionCbcs ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for current encryption scheme ,
Required: False ,
}
{
fairPlay:
{
Description: FairPlay configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
allowPersistentLicense:
{
Description: All license to be persistent or not ,
Required: True ,
}
boolean ,
}
,
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
noEncryption:
{
Description: Configurations of NoEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingPolicies_Get (removed)
Description :  Get the details of a Streaming Policy in the Media Services account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingPolicyName:
{
Description: The Streaming Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Class to specify properties of Streaming Policy ,
Required: False ,
}
{
created:
{
Description: Creation time of Streaming Policy ,
Format: date-time ,
Required: False ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Default ContentKey used by current Streaming Policy ,
Required: False ,
}
string ,
envelopeEncryption:
{
Description: Configuration of EnvelopeEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
customKeyAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
commonEncryptionCenc:
{
Description: Configuration of CommonEncryptionCenc ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for CommonEncryptionCenc encryption scheme ,
Required: False ,
}
{
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
commonEncryptionCbcs:
{
Description: Configuration of CommonEncryptionCbcs ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for current encryption scheme ,
Required: False ,
}
{
fairPlay:
{
Description: FairPlay configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
allowPersistentLicense:
{
Description: All license to be persistent or not ,
Required: True ,
}
boolean ,
}
,
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
noEncryption:
{
Description: Configurations of NoEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingPolicies_Create (removed)
Description :  Create a Streaming Policy in the Media Services account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingPolicyName:
{
Description: The Streaming Policy name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: Class to specify properties of Streaming Policy ,
Required: False ,
}
{
created:
{
Description: Creation time of Streaming Policy ,
Format: date-time ,
Required: False ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Default ContentKey used by current Streaming Policy ,
Required: False ,
}
string ,
envelopeEncryption:
{
Description: Configuration of EnvelopeEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
customKeyAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
commonEncryptionCenc:
{
Description: Configuration of CommonEncryptionCenc ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for CommonEncryptionCenc encryption scheme ,
Required: False ,
}
{
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
commonEncryptionCbcs:
{
Description: Configuration of CommonEncryptionCbcs ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for current encryption scheme ,
Required: False ,
}
{
fairPlay:
{
Description: FairPlay configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
allowPersistentLicense:
{
Description: All license to be persistent or not ,
Required: True ,
}
boolean ,
}
,
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
noEncryption:
{
Description: Configurations of NoEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Class to specify properties of Streaming Policy ,
Required: False ,
}
{
created:
{
Description: Creation time of Streaming Policy ,
Format: date-time ,
Required: False ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Default ContentKey used by current Streaming Policy ,
Required: False ,
}
string ,
envelopeEncryption:
{
Description: Configuration of EnvelopeEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
customKeyAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
commonEncryptionCenc:
{
Description: Configuration of CommonEncryptionCenc ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for CommonEncryptionCenc encryption scheme ,
Required: False ,
}
{
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
commonEncryptionCbcs:
{
Description: Configuration of CommonEncryptionCbcs ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
clearTracks:
{
Description: Representing which tracks should not be encrypted ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
contentKeys:
{
Description: Representing default content key for each encryption scheme and separate content keys for specific tracks ,
Required: False ,
}
{
defaultKey:
{
Description: Default content key for an encryption scheme ,
Required: False ,
}
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Default Key ,
Required: False ,
}
string ,
}
,
keyToTrackMappings:
{
Description: Representing tracks needs separate content key ,
Required: False ,
}
[
{
label:
{
Description: Label can be used to specify Content Key when creating a Streaming Locator ,
Required: False ,
}
string ,
policyName:
{
Description: Policy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this content key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}
,
drm:
{
Description: Configuration of DRMs for current encryption scheme ,
Required: False ,
}
{
fairPlay:
{
Description: FairPlay configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
allowPersistentLicense:
{
Description: All license to be persistent or not ,
Required: True ,
}
boolean ,
}
,
playReady:
{
Description: PlayReady configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
playReadyCustomAttributes:
{
Description: Custom attributes for PlayReady ,
Required: False ,
}
string ,
}
,
widevine:
{
Description: Widevine configurations ,
Required: False ,
}
{
customLicenseAcquisitionUrlTemplate:
{
Description: Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested. ,
Required: False ,
}
string ,
}
,
}
,
}
,
noEncryption:
{
Description: Configurations of NoEncryption ,
Required: False ,
}
{
enabledProtocols:
{
Description: Representing supported protocols ,
Required: False ,
}
{
download:
{
Description: Enable Download protocol or not ,
Required: True ,
}
boolean ,
dash:
{
Description: Enable DASH protocol or not ,
Required: True ,
}
boolean ,
hls:
{
Description: Enable HLS protocol or not ,
Required: True ,
}
boolean ,
smoothStreaming:
{
Description: Enable SmoothStreaming protocol or not ,
Required: True ,
}
boolean ,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingPolicies_Delete (removed)
Description :  Deletes a Streaming Policy in the Media Services account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingPolicyName:
{
Description: The Streaming Policy name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingLocators_List (removed)
Description :  Lists the Streaming Locators in the account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
$filter:
{
Description: Restricts the set of items returned. ,
Required: False ,
}
string ,
$top:
{
Description: 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. ,
Required: False ,
}
integer ,
$orderby:
{
Description: Specifies the key by which the result collection should be ordered. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: A collection of StreamingLocator items. ,
Required: False ,
}
[
{
properties:
{
Description: Properties of the Streaming Locator. ,
Required: False ,
}
{
assetName:
{
Description: Asset Name ,
Required: True ,
}
string ,
created:
{
Description: The creation time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
streamingLocatorId:
{
Description: The StreamingLocatorId of the Streaming Locator. ,
Format: uuid ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: 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' ,
Required: True ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Name of the default ContentKeyPolicy used by this Streaming Locator. ,
Required: False ,
}
string ,
contentKeys:
{
Description: The ContentKeys used by this Streaming Locator. ,
Required: False ,
}
[
{
id:
{
Description: ID of Content Key ,
Format: uuid ,
Required: True ,
}
string ,
type:
{
Description: Encryption type of Content Key ,
Enum:
{
CommonEncryptionCenc: Common Encryption using CENC ,
CommonEncryptionCbcs: Common Encryption using CBCS ,
EnvelopeEncryption: Envelope Encryption ,
}
,
Required: False ,
}
enum ,
labelReferenceInStreamingPolicy:
{
Description: Label of Content Key as specified in the Streaming Policy ,
Required: False ,
}
string ,
value:
{
Description: Value of Content Key ,
Required: False ,
}
string ,
policyName:
{
Description: ContentKeyPolicy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this Content Key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
alternativeMediaId:
{
Description: Alternative Media ID of this Streaming Locator ,
Required: False ,
}
string ,
filters:
{
Description: A list of asset or account filters which apply to this streaming locator ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
@odata.nextLink:
{
Description: A link to the next page of the collection (when the collection contains too many results to return in one response). ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingLocators_Get (removed)
Description :  Get the details of a Streaming Locator in the Media Services account
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingLocatorName:
{
Description: The Streaming Locator name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the Streaming Locator. ,
Required: False ,
}
{
assetName:
{
Description: Asset Name ,
Required: True ,
}
string ,
created:
{
Description: The creation time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
streamingLocatorId:
{
Description: The StreamingLocatorId of the Streaming Locator. ,
Format: uuid ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: 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' ,
Required: True ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Name of the default ContentKeyPolicy used by this Streaming Locator. ,
Required: False ,
}
string ,
contentKeys:
{
Description: The ContentKeys used by this Streaming Locator. ,
Required: False ,
}
[
{
id:
{
Description: ID of Content Key ,
Format: uuid ,
Required: True ,
}
string ,
type:
{
Description: Encryption type of Content Key ,
Enum:
{
CommonEncryptionCenc: Common Encryption using CENC ,
CommonEncryptionCbcs: Common Encryption using CBCS ,
EnvelopeEncryption: Envelope Encryption ,
}
,
Required: False ,
}
enum ,
labelReferenceInStreamingPolicy:
{
Description: Label of Content Key as specified in the Streaming Policy ,
Required: False ,
}
string ,
value:
{
Description: Value of Content Key ,
Required: False ,
}
string ,
policyName:
{
Description: ContentKeyPolicy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this Content Key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
alternativeMediaId:
{
Description: Alternative Media ID of this Streaming Locator ,
Required: False ,
}
string ,
filters:
{
Description: A list of asset or account filters which apply to this streaming locator ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingLocators_Create (removed)
Description :  Create a Streaming Locator in the Media Services account
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingLocatorName:
{
Description: The Streaming Locator name. ,
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: Properties of the Streaming Locator. ,
Required: False ,
}
{
assetName:
{
Description: Asset Name ,
Required: True ,
}
string ,
created:
{
Description: The creation time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
streamingLocatorId:
{
Description: The StreamingLocatorId of the Streaming Locator. ,
Format: uuid ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: 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' ,
Required: True ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Name of the default ContentKeyPolicy used by this Streaming Locator. ,
Required: False ,
}
string ,
contentKeys:
{
Description: The ContentKeys used by this Streaming Locator. ,
Required: False ,
}
[
{
id:
{
Description: ID of Content Key ,
Format: uuid ,
Required: True ,
}
string ,
type:
{
Description: Encryption type of Content Key ,
Enum:
{
CommonEncryptionCenc: Common Encryption using CENC ,
CommonEncryptionCbcs: Common Encryption using CBCS ,
EnvelopeEncryption: Envelope Encryption ,
}
,
Required: False ,
}
enum ,
labelReferenceInStreamingPolicy:
{
Description: Label of Content Key as specified in the Streaming Policy ,
Required: False ,
}
string ,
value:
{
Description: Value of Content Key ,
Required: False ,
}
string ,
policyName:
{
Description: ContentKeyPolicy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this Content Key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
alternativeMediaId:
{
Description: Alternative Media ID of this Streaming Locator ,
Required: False ,
}
string ,
filters:
{
Description: A list of asset or account filters which apply to this streaming locator ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the Streaming Locator. ,
Required: False ,
}
{
assetName:
{
Description: Asset Name ,
Required: True ,
}
string ,
created:
{
Description: The creation time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of the Streaming Locator. ,
Format: date-time ,
Required: False ,
}
string ,
streamingLocatorId:
{
Description: The StreamingLocatorId of the Streaming Locator. ,
Format: uuid ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: 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' ,
Required: True ,
}
string ,
defaultContentKeyPolicyName:
{
Description: Name of the default ContentKeyPolicy used by this Streaming Locator. ,
Required: False ,
}
string ,
contentKeys:
{
Description: The ContentKeys used by this Streaming Locator. ,
Required: False ,
}
[
{
id:
{
Description: ID of Content Key ,
Format: uuid ,
Required: True ,
}
string ,
type:
{
Description: Encryption type of Content Key ,
Enum:
{
CommonEncryptionCenc: Common Encryption using CENC ,
CommonEncryptionCbcs: Common Encryption using CBCS ,
EnvelopeEncryption: Envelope Encryption ,
}
,
Required: False ,
}
enum ,
labelReferenceInStreamingPolicy:
{
Description: Label of Content Key as specified in the Streaming Policy ,
Required: False ,
}
string ,
value:
{
Description: Value of Content Key ,
Required: False ,
}
string ,
policyName:
{
Description: ContentKeyPolicy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this Content Key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
alternativeMediaId:
{
Description: Alternative Media ID of this Streaming Locator ,
Required: False ,
}
string ,
filters:
{
Description: A list of asset or account filters which apply to this streaming locator ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingLocators_Delete (removed)
Description :  Deletes a Streaming Locator in the Media Services account
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingLocatorName:
{
Description: The Streaming Locator name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingLocators_ListContentKeys (removed)
Description :  List Content Keys used by this Streaming Locator
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingLocatorName:
{
Description: The Streaming Locator name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
contentKeys:
{
Description: ContentKeys used by current Streaming Locator ,
Required: False ,
}
[
{
id:
{
Description: ID of Content Key ,
Format: uuid ,
Required: True ,
}
string ,
type:
{
Description: Encryption type of Content Key ,
Enum:
{
CommonEncryptionCenc: Common Encryption using CENC ,
CommonEncryptionCbcs: Common Encryption using CBCS ,
EnvelopeEncryption: Envelope Encryption ,
}
,
Required: False ,
}
enum ,
labelReferenceInStreamingPolicy:
{
Description: Label of Content Key as specified in the Streaming Policy ,
Required: False ,
}
string ,
value:
{
Description: Value of Content Key ,
Required: False ,
}
string ,
policyName:
{
Description: ContentKeyPolicy used by Content Key ,
Required: False ,
}
string ,
tracks:
{
Description: Tracks which use this Content Key ,
Required: False ,
}
[
{
trackSelections:
{
Description: TrackSelections is a track property condition list which can specify track(s) ,
Required: False ,
}
[
{
property:
{
Description: Track property type ,
Enum:
{
Unknown: Unknown track property ,
FourCC: Track FourCC ,
}
,
Required: True ,
}
enum ,
operation:
{
Description: Track property condition operation ,
Enum:
{
Unknown: Unknown track property compare operation ,
Equal: Equal operation ,
}
,
Required: True ,
}
enum ,
value:
{
Description: Track property value ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingLocators_ListPaths (removed)
Description :  List Paths supported by this Streaming Locator
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths
{
subscriptionId:
{
Description: The unique identifier for a Microsoft Azure subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group within the Azure subscription. ,
Required: True ,
}
string ,
accountName:
{
Description: The Media Services account name. ,
Required: True ,
}
string ,
streamingLocatorName:
{
Description: The Streaming Locator name. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
streamingPaths:
{
Description: Streaming Paths supported by current Streaming Locator ,
Required: False ,
}
[
{
streamingProtocol:
{
Description: Streaming protocol ,
Enum:
{
Hls: HLS protocol ,
Dash: DASH protocol ,
SmoothStreaming: SmoothStreaming protocol ,
Download: Download protocol ,
}
,
Required: True ,
}
enum ,
encryptionScheme:
{
Description: Encryption scheme ,
Enum:
{
NoEncryption: NoEncryption scheme ,
EnvelopeEncryption: EnvelopeEncryption scheme ,
CommonEncryptionCenc: CommonEncryptionCenc scheme ,
CommonEncryptionCbcs: CommonEncryptionCbcs scheme ,
}
,
Required: True ,
}
enum ,
paths:
{
Description: Streaming paths for each protocol and encryptionScheme pair ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
downloadPaths:
{
Description: Download Paths supported by current Streaming Locator ,
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}