Microsoft.Media (stable:2021-06-01)

2025/05/26 • 82 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 ,
}
{
logSpecifications:
{
Description: List of log specifications. ,
Required: False ,
}
[
{
name:
{
Description: The diagnostic log category name. ,
Required: False ,
}
string ,
displayName:
{
Description: The diagnostic log category display name. ,
Required: False ,
}
string ,
blobDuration:
{
Description: The time range for requests in each blob. ,
Required: False ,
}
string ,
}
,
]
,
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 ,
lockAggregationType:
{
Description: The metric lock aggregation type ,
Enum:
{
Average: The average. ,
Count: The count of a number of items, usually requests. ,
Total: The sum. ,
}
,
Required: False ,
}
enum ,
supportedAggregationTypes:
{
Description: Supported aggregation types. ,
Required: False ,
}
[
string ,
]
,
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 ,
}
,
]
,
enableRegionalMdmAccount:
{
Description: Indicates whether regional MDM account is enabled. ,
Required: False ,
}
boolean ,
sourceMdmAccount:
{
Description: The source MDM account. ,
Required: False ,
}
string ,
sourceMdmNamespace:
{
Description: The source MDM namespace. ,
Required: False ,
}
string ,
supportedTimeGrainTypes:
{
Description: The supported time grain types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
isDataAction:
{
Description: Whether the operation applies to data-plane. ,
Required: False ,
}
boolean ,
actionType:
{
Description: Indicates the action type. ,
Enum:
{
Internal: An internal action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
{
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
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 ,
}
{
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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Mediaservices_ListEdgePolicies (removed)
Description :  List the media edge policies associated with the Media Services account.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/listEdgePolicies
{
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 ,
}
{
deviceId:
{
Description: Unique identifier of the edge device. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
usageDataCollectionPolicy:
{
Required: False ,
}
{
dataCollectionFrequency:
{
Description: Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H. ,
Required: False ,
}
string ,
dataReportingFrequency:
{
Description: Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H. ,
Required: False ,
}
string ,
maxAllowedUnreportedUsageDuration:
{
Description: Maximum time for which the functionality of the device will not be hampered for not reporting the usage data. ,
Required: False ,
}
string ,
eventHubDetails:
{
Description: Details of Event Hub where the usage will be reported. ,
Required: False ,
}
{
name:
{
Description: Name of the Event Hub where usage will be reported. ,
Required: False ,
}
string ,
namespace:
{
Description: Namespace of the Event Hub where usage will be reported. ,
Required: False ,
}
string ,
token:
{
Description: SAS token needed to interact with Event Hub. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_List (removed)
Description :  Get list of group IDs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateLinkResources
{
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: Array of private link resources ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateLinkResources_Get (removed)
Description :  Get group ID.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateLinkResources/{name}
{
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 ,
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: Resource properties. ,
Required: False ,
}
{
groupId:
{
Description: The private link resource group id. ,
Required: False ,
}
string ,
requiredMembers:
{
Description: The private link resource required member names. ,
Required: False ,
}
[
string ,
]
,
requiredZoneNames:
{
Description: The private link resource Private link DNS zone name. ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_List (removed)
Description :  Get all private endpoint connections.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections
{
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: Array of private endpoint connections ,
Required: False ,
}
[
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Get (removed)
Description :  Get private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections/{name}
{
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 ,
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: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_CreateOrUpdate (removed)
Description :  Update private endpoint connection.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections/{name}
{
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 ,
name:
{
Required: True ,
}
string ,
parameters:
{
Description: The request parameters ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
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: Resource properties. ,
Required: False ,
}
{
privateEndpoint:
{
Description: The resource of private end point. ,
Required: False ,
}
{
id:
{
Description: The ARM identifier for Private Endpoint ,
Required: False ,
}
string ,
}
,
privateLinkServiceConnectionState:
{
Description: A collection of information about the state of the connection between service consumer and provider. ,
Required: True ,
}
{
status:
{
Description: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service. ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: The reason for approval/rejection of the connection. ,
Required: False ,
}
string ,
actionsRequired:
{
Description: A message indicating if changes on the service provider require any updates on the consumer. ,
Required: False ,
}
string ,
}
,
provisioningState:
{
Description: The provisioning state of the private endpoint connection resource. ,
Enum:
{
Succeeded: No description available. ,
Creating: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_Delete (removed)
Description :  Delete private endpoint connection.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections/{name}
{
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 ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 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 ,
identity:
{
Description: The storage account identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the storage account mapping. ,
Required: False ,
}
string ,
}
,
]
,
storageAuthentication:
{
Enum:
{
System: System authentication. ,
ManagedIdentity: Managed Identity authentication. ,
}
,
Required: False ,
}
enum ,
encryption:
{
Description: The account encryption properties. ,
Required: False ,
}
{
type:
{
Description: The type of key used to encrypt the Account Key. ,
Enum:
{
SystemKey: The Account Key is encrypted with a System Key. ,
CustomerKey: The Account Key is encrypted with a Customer Key. ,
}
,
Required: True ,
}
enum ,
keyVaultProperties:
{
Description: The properties of the key used to encrypt the account. ,
Required: False ,
}
{
keyIdentifier:
{
Description: The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey). ,
Required: False ,
}
string ,
currentKeyIdentifier:
{
Description: The current key used to encrypt the Media Services account, including the key version. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: The Key Vault identity. ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: The user assigned managed identity's ARM ID to use when accessing a resource. ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: Indicates whether to use System Assigned Managed Identity. Mutual exclusive with User Assigned Managed Identity. ,
Required: True ,
}
boolean ,
}
,
status:
{
Description: The current status of the Key Vault mapping. ,
Required: False ,
}
string ,
}
,
keyDelivery:
{
Description: The Key Delivery properties for Media Services account. ,
Required: False ,
}
{
accessControl:
{
Description: The access control properties for Key Delivery. ,
Required: False ,
}
{
defaultAction:
{
Description: The behavior for IP access control in Key Delivery. ,
Enum:
{
Allow: All public IP addresses are allowed. ,
Deny: Public IP addresses are blocked. ,
}
,
Required: False ,
}
enum ,
ipAllowList:
{
Description: The IP allow list for access control in Key Delivery. If the default action is set to 'Allow', the IP allow list must be empty. ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
publicNetworkAccess:
{
Description: Whether or not public network access is allowed for resources under the Media Services account. ,
Enum:
{
Enabled: Public network access is enabled. ,
Disabled: Public network access is disabled. ,
}
,
Required: False ,
}
enum ,
}
,
identity:
{
Description: The Managed Identity for the Media Services account. ,
Required: False ,
}
{
type:
{
Description: The identity type. ,
Required: True ,
}
string ,
principalId:
{
Description: The Principal ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
tenantId:
{
Description: The Tenant ID of the identity. ,
Format: uuid ,
Required: False ,
}
string ,
userAssignedIdentities:
{
Description: The user assigned managed identities. ,
Required: False ,
}
object ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 key 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 customer has created the Job, 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 customer has last updated the Job, 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 ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
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 ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
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 ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 customer has created the Job, 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 customer has last updated the Job, 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 ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
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 ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
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 ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 customer has created the Job, 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 customer has last updated the Job, 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 ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
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 ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
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 ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 (201)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, 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 customer has last updated the Job, 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 ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
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 ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
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 ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 customer has created the Job, 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 customer has last updated the Job, 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 ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
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 ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
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 ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
properties:
{
Description: The resource properties. ,
Required: False ,
}
{
created:
{
Description: The UTC date and time when the customer has created the Job, 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 customer has last updated the Job, 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 ,
}
,
]
,
}
,
presetOverride:
{
Description: A preset used to override the preset in the corresponding transform output. ,
Required: False ,
}
{
@odata.type:
{
Description: The discriminator for derived types. ,
Required: True ,
}
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 ,
startTime:
{
Description: The UTC date and time at which this Job Output began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job Output finished processing. ,
Format: date-time ,
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 ,
startTime:
{
Description: The UTC date and time at which this Job began processing. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The UTC date and time at which this Job finished processing. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Format: int32 ,
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
]
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Format: int32 ,
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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)

{
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 ,
}
,
}
,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Format: int32 ,
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 ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 (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 ,
}
,
}
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
Format: int32 ,
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 ,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 ,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
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 (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 ,
]
,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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 object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_List (removed)
Description :  Lists all the live events in the account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents
{
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: The result of the List Live Event operation. ,
Required: False ,
}
[
{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.count:
{
Description: The number of result. ,
Format: int32 ,
Required: False ,
}
integer ,
@odata.nextLink:
{
Description: The link to the next set of results. Not empty if value contains incomplete list of live outputs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Get (removed)
Description :  Gets properties of a live event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
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 live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Create (removed)
Description :  Creates a new live event.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
autoStart:
{
Description: The flag indicates if the resource should be automatically started on creation. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Live event properties needed for creation. ,
Required: True ,
}
{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Update (removed)
Description :  Updates settings on an existing live event.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: Live event properties needed for patch. ,
Required: True ,
}
{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The live event properties. ,
Required: False ,
}
{
description:
{
Description: A description for the live event. ,
Required: False ,
}
string ,
input:
{
Description: Live event input settings. It defines how the live event receives input from a contribution encoder. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The input protocol for the live event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: Smooth Streaming input will be sent by the contribution encoder to the live event. ,
RTMP: RTMP input will be sent by the contribution encoder to the live event. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: Access control for live event input. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
keyFrameIntervalDuration:
{
Description: ISO 8601 time duration of the key frame interval duration of the input. This value sets the EXT-X-TARGETDURATION property in the HLS output. For example, use PT2S to indicate 2 seconds. Leave the value empty for encoding live events. ,
Required: False ,
}
string ,
accessToken:
{
Description: A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the live event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: Live event preview settings. Preview allows live event producers to preview the live streaming content without creating any live output. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. Do not share the preview URL with the live event audience. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for live event preview. ,
Required: False ,
}
{
ip:
{
Description: The IP access control properties. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
previewLocator:
{
Description: The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created. ,
Required: False ,
}
string ,
streamingPolicyName:
{
Description: The name of streaming policy used for the live event preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An alternative media identifier associated with the streaming locator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field. ,
Required: False ,
}
string ,
}
,
encoding:
{
Description: Encoding settings for the live event. It configures whether a live encoder is used for the live event and settings for the live encoder if it is used. ,
Required: False ,
}
{
encodingType:
{
Description: Live event type. When encodingType is set to PassthroughBasic or PassthroughStandard, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bitrates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. This property cannot be modified after the live event is created. ,
Enum:
{
None: This is the same as PassthroughStandard, please see description below. This enumeration value is being deprecated. ,
Standard: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 720p in resolution. ,
Premium1080p: A contribution live encoder sends a single bitrate stream to the live event and Media Services creates multiple bitrate streams. The output cannot exceed 1080p in resolution. ,
PassthroughBasic: The ingested stream passes through the live event from the contribution encoder without any further processing. In the PassthroughBasic mode, ingestion is limited to up to 5Mbps and only 1 concurrent live output is allowed. Live transcription is not available. ,
PassthroughStandard: The ingested stream passes through the live event from the contribution encoder without any further processing. Live transcription is available. Ingestion bitrate limits are much higher and up to 3 concurrent live outputs are allowed. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’. ,
Required: False ,
}
string ,
stretchMode:
{
Description: Specifies how the input video will be resized to fit the desired output resolution(s). Default is None ,
Enum:
{
None: Strictly respects the output resolution specified in the encoding preset without considering the pixel aspect ratio or display aspect ratio of the input video. ,
AutoSize: Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9. ,
AutoFit: Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right. ,
}
,
Required: False ,
}
enum ,
keyFrameInterval:
{
Description: Use an ISO 8601 time value between 0.5 to 20 seconds to specify the output fragment length for the video and audio tracks of an encoding live event. For example, use PT2S to indicate 2 seconds. For the video track it also defines the key frame interval, or the length of a GoP (group of pictures). If this value is not set for an encoding live event, the fragment duration defaults to 2 seconds. The value cannot be set for pass-through live events. ,
Format: duration ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: Live transcription settings for the live event. See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) to be used for speech-to-text transcription – it should match the spoken language in the audio track. The value should be in BCP-47 format (e.g: 'en-US'). See https://go.microsoft.com/fwlink/?linkid=2133742 for more information about the live transcription feature and the list of supported languages. ,
Required: False ,
}
string ,
inputTrackSelection:
{
Description: Provides a mechanism to select the audio track in the input live feed, to which speech-to-text transcription is applied. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a live event, generated using speech-to-text transcription. This property is reserved for future use, any value set on this property will be ignored. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. This property is reserved for future use, any value set on this property will be ignored. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the live event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live event. See https://go.microsoft.com/fwlink/?linkid=2139012 for more information. ,
Enum:
{
Stopped: This is the initial state of the live event after creation (unless autostart was set to true.) No billing occurs in this state. In this state, the live event properties can be updated but streaming is not allowed. ,
Allocating: Allocate action was called on the live event and resources are being provisioned for this live event. Once allocation completes successfully, the live event will transition to StandBy state. ,
StandBy: Live event resources have been provisioned and is ready to start. Billing occurs in this state. Most properties can still be updated, however ingest or streaming is not allowed during this state. ,
Starting: The live event is being started and resources are being allocated. No billing occurs in this state. Updates or streaming are not allowed during this state. If an error occurs, the live event returns to the Stopped state. ,
Running: The live event resources have been allocated, ingest and preview URLs have been generated, and it is capable of receiving live streams. At this point, billing is active. You must explicitly call Stop on the live event resource to halt further billing. ,
Stopping: The live event is being stopped and resources are being de-provisioned. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
Deleting: The live event is being deleted. No billing occurs in this transient state. Updates or streaming are not allowed during this state. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: Live event cross site access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
useStaticHostname:
{
Description: Specifies whether a static hostname would be assigned to the live event preview and ingest endpoints. This value can only be updated if the live event is in Standby state ,
Required: False ,
}
boolean ,
hostnamePrefix:
{
Description: When useStaticHostname is set to true, the hostnamePrefix specifies the first part of the hostname assigned to the live event preview and ingest endpoints. The final hostname would be a combination of this prefix, the media service account name and a short code for the Azure Media Services data center. ,
Required: False ,
}
string ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The creation time for the live event ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The last modified time of the live event. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Delete (removed)
Description :  Deletes a live event.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Allocate (removed)
Description :  A live event is in StandBy state after allocation completes, and is ready to start.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/allocate
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Start (removed)
Description :  A live event in Stopped or StandBy state will be in Running state after the start operation completes.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/start
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Stop (removed)
Description :  Stops a running live event.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: LiveEvent stop parameters ,
Required: True ,
}
{
removeOutputsOnStop:
{
Description: The flag indicates whether live outputs are automatically deleted when live event is being stopped. Deleting live outputs do not delete the underlying assets. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveEvents_Reset (removed)
Description :  Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/reset
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveOutputs_List (removed)
Description :  Lists the live outputs of a live event.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
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: The result of the List LiveOutput operation. ,
Required: False ,
}
[
{
properties:
{
Description: Live output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the live output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset that the live output will write to. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: HTTP Live Streaming (HLS) packing setting for the live output. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The initial timestamp that the live output will start at, any content before this value will not be archived. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The creation time the live output. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The time the live output was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the live output. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live output. ,
Enum:
{
Creating: Live output is being created. No content is archived in the asset until the live output is in running state. ,
Running: Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder. ,
Deleting: Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.count:
{
Description: The number of result. ,
Format: int32 ,
Required: False ,
}
integer ,
@odata.nextLink:
{
Description: The link to the next set of results. Not empty if value contains incomplete list of live outputs. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveOutputs_Get (removed)
Description :  Gets a live output.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
liveOutputName:
{
Description: The name of the live output. ,
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: Live output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the live output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset that the live output will write to. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: HTTP Live Streaming (HLS) packing setting for the live output. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The initial timestamp that the live output will start at, any content before this value will not be archived. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The creation time the live output. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The time the live output was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the live output. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live output. ,
Enum:
{
Creating: Live output is being created. No content is archived in the asset until the live output is in running state. ,
Running: Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder. ,
Deleting: Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveOutputs_Create (removed)
Description :  Creates a new live output.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
liveOutputName:
{
Description: The name of the live output. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: Live Output properties needed for creation. ,
Required: True ,
}
{
properties:
{
Description: Live output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the live output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset that the live output will write to. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: HTTP Live Streaming (HLS) packing setting for the live output. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The initial timestamp that the live output will start at, any content before this value will not be archived. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The creation time the live output. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The time the live output was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the live output. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live output. ,
Enum:
{
Creating: Live output is being created. No content is archived in the asset until the live output is in running state. ,
Running: Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder. ,
Deleting: Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Live output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the live output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset that the live output will write to. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: HTTP Live Streaming (HLS) packing setting for the live output. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The initial timestamp that the live output will start at, any content before this value will not be archived. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The creation time the live output. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The time the live output was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the live output. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live output. ,
Enum:
{
Creating: Live output is being created. No content is archived in the asset until the live output is in running state. ,
Running: Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder. ,
Deleting: Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Live output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the live output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset that the live output will write to. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 time between 1 minute to 25 hours to indicate the maximum content length that can be archived in the asset for this live output. This also sets the maximum content length for the rewind window. For example, use PT1H30M to indicate 1 hour and 30 minutes of archive window. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: HTTP Live Streaming (HLS) packing setting for the live output. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The number of fragments in an HTTP Live Streaming (HLS) TS segment in the output of the live event. This value does not affect the packing ratio for HLS CMAF output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The initial timestamp that the live output will start at, any content before this value will not be archived. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The creation time the live output. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The time the live output was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the live output. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the live output. ,
Enum:
{
Creating: Live output is being created. No content is archived in the asset until the live output is in running state. ,
Running: Live output is running and archiving live streaming content to the asset if there is valid input from a contribution encoder. ,
Deleting: Live output is being deleted. The live asset is being converted from live to on-demand asset. Any streaming URLs created on the live output asset continue to work. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
LiveOutputs_Delete (removed)
Description :  Deletes a live output. Deleting a live output does not delete the asset the live output is writing to.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}
{
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 ,
liveEventName:
{
Description: The name of the live event, maximum length is 32. ,
Required: True ,
}
string ,
liveOutputName:
{
Description: The name of the live output. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_List (removed)
Description :  Lists the streaming endpoints in the account.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints
{
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: The result of the List StreamingEndpoint operation. ,
Required: False ,
}
[
{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.count:
{
Description: The number of result. ,
Format: int32 ,
Required: False ,
}
integer ,
@odata.nextLink:
{
Description: The link to the next set of results. Not empty if value contains incomplete list of streaming endpoints. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Get (removed)
Description :  Gets a streaming endpoint.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
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 streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Create (removed)
Description :  Creates a streaming endpoint.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
autoStart:
{
Description: The flag indicates if the resource should be automatically started on creation. ,
Required: False ,
}
boolean ,
parameters:
{
Description: Streaming endpoint properties needed for creation. ,
Required: True ,
}
{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Update (removed)
Description :  Updates a existing streaming endpoint.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: Streaming endpoint properties needed for creation. ,
Required: True ,
}
{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The streaming endpoint properties. ,
Required: False ,
}
{
description:
{
Description: The streaming endpoint description. ,
Required: False ,
}
string ,
scaleUnits:
{
Description: The number of scale units. Use the Scale operation to adjust this value. ,
Format: int32 ,
Required: True ,
}
integer ,
availabilitySetName:
{
Description: This feature is deprecated, do not set a value for this property. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the streaming endpoint. ,
Required: False ,
}
{
akamai:
{
Description: The access control of Akamai ,
Required: False ,
}
{
akamaiSignatureHeaderAuthenticationKeyList:
{
Description: authentication key list ,
Required: False ,
}
[
{
identifier:
{
Description: identifier of the key ,
Required: False ,
}
string ,
base64Key:
{
Description: authentication key ,
Required: False ,
}
string ,
expiration:
{
Description: The expiration time of the authentication key. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
}
,
ip:
{
Description: The IP access control of the streaming endpoint. ,
Required: False ,
}
{
allow:
{
Description: The IP allow list. ,
Required: False ,
}
[
{
name:
{
Description: The friendly name for the IP address range. ,
Required: False ,
}
string ,
address:
{
Description: The IP address. ,
Required: False ,
}
string ,
subnetPrefixLength:
{
Description: The subnet mask prefix length (see CIDR notation). ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}
,
maxCacheAge:
{
Description: Max cache age ,
Format: int64 ,
Required: False ,
}
integer ,
customHostNames:
{
Description: The custom host names of the streaming endpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The streaming endpoint host name. ,
Required: False ,
}
string ,
cdnEnabled:
{
Description: The CDN enabled flag. ,
Required: False ,
}
boolean ,
cdnProvider:
{
Description: The CDN provider name. ,
Required: False ,
}
string ,
cdnProfile:
{
Description: The CDN profile name. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state of the streaming endpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the streaming endpoint. ,
Enum:
{
Stopped: The initial state of a streaming endpoint after creation. Content is not ready to be streamed from this endpoint. ,
Starting: The streaming endpoint is transitioning to the running state. ,
Running: The streaming endpoint is running. It is able to stream content to clients ,
Stopping: The streaming endpoint is transitioning to the stopped state. ,
Deleting: The streaming endpoint is being deleted. ,
Scaling: The streaming endpoint is increasing or decreasing scale units. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The streaming endpoint access policies. ,
Required: False ,
}
{
clientAccessPolicy:
{
Description: The content of clientaccesspolicy.xml used by Silverlight. ,
Required: False ,
}
string ,
crossDomainPolicy:
{
Description: The content of crossdomain.xml used by Silverlight. ,
Required: False ,
}
string ,
}
,
freeTrialEndTime:
{
Description: The free trial expiration time. ,
Format: date-time ,
Required: False ,
}
string ,
created:
{
Description: The exact time the streaming endpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the streaming endpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: The system metadata relating to this resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Delete (removed)
Description :  Deletes a streaming endpoint.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Start (removed)
Description :  Starts an existing streaming endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/start
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Stop (removed)
Description :  Stops an existing streaming endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/stop
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
StreamingEndpoints_Scale (removed)
Description :  Scales an existing streaming endpoint.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/scale
{
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 ,
streamingEndpointName:
{
Description: The name of the streaming endpoint, maximum length is 24. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: Streaming endpoint scale parameters ,
Required: True ,
}
{
scaleUnit:
{
Description: The scale unit number of the streaming endpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}