Microsoft.Media (stable:2022-11-01)

2025/05/26 • 31 deleted methods

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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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 ,
}
,
]
,
}
,
}
LiveEvents_ListGetStatus (removed)
Description :  Gets status telemetry of a live event.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getStatus
{
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 get live event status. ,
Required: False ,
}
[
{
state:
{
Description: Current 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. ,
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. ,
}
,
Required: False ,
}
enum ,
healthStatus:
{
Description: Health status of last 20 seconds. ,
Enum:
{
Excellent: Incoming bitrate >= 75% of target bitrate AND no Ingest warning and error AND ABS(IngestDrift) is equal to 0. ,
Good: Incoming bitrate >= 20% AND no Ingest Error or warning exception discontinuities which gap < 10 seconds. ,
Poor: Otherwise. ,
}
,
Required: False ,
}
enum ,
healthDescriptions:
{
Description: List of strings justifying the health status. ,
Required: False ,
}
[
string ,
]
,
lastUpdatedTime:
{
Description: Last updated UTC time of this status. ,
Format: date-time ,
Required: False ,
}
string ,
ingestion:
{
Description: Live event ingestion entry. ,
Required: False ,
}
{
streamName:
{
Description: Ingestion stream name. ,
Required: False ,
}
string ,
begin:
{
Description: Ingestion begin time in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: Ingestion end time in UTC. Empty if it's not stopped yet. ,
Format: date-time ,
Required: False ,
}
string ,
endReason:
{
Description: Reason why ingestion stops. Empty if it's not stopped yet. E.g) Service Stopped. No Ingestion. ,
Required: False ,
}
string ,
ingestInterruptions:
{
Description: IngestInterruption entry list. ,
Required: False ,
}
[
{
begin:
{
Description: UTC time of interruption start, encoder disconnected. ,
Format: date-time ,
Required: False ,
}
string ,
end:
{
Description: UTC time of interruption end, encoder re-connected. ,
Format: date-time ,
Required: False ,
}
string ,
duration:
{
Description: Duration of interruption in ISO 8601 time. For example, use PT1H30M to indicate 1 hour and 30 minutes. ,
Format: duration ,
Required: False ,
}
string ,
reason:
{
Description: Interruption reason. ,
Required: False ,
}
string ,
}
,
]
,
}
,
trackStatus:
{
Description: Track entry list. ,
Required: False ,
}
[
{
trackId:
{
Description: Track Id. ,
Required: False ,
}
string ,
expectedBitrate:
{
Description: Expected bitrate for this track. ,
Format: int64 ,
Required: False ,
}
integer ,
incomingBitrate:
{
Description: Average incoming bitrate for last 20 seconds when live event is running. ,
Format: int64 ,
Required: False ,
}
integer ,
ingestDrift:
{
Description: Current ingest drift value in seconds for last 1 minute. ,
Required: False ,
}
string ,
requestReceived:
{
Description: Total number of timed metadata request received. ,
Format: int64 ,
Required: False ,
}
integer ,
requestSucceeded:
{
Description: Total number of successful timed metadata request received. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (304)

{}

⚐ 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_ListGetStreamEvents (removed)
Description :  Get stream events telemetry of a live event.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getStreamEvents
{
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 get live event stream events. ,
Required: False ,
}
[
{
eventType:
{
Description: The type of the stream event. Format: StreamEvent/{eventType} ,
Enum:
{
StreamEvent/BeginIngest: Ingest session begins. ,
StreamEvent/EndIngest: Ingest session ends. ,
StreamEvent/FirstChunkReceived: First fragment received on ingest media track. ,
StreamEvent/ChunkDropped: Fragment dropped. ,
StreamEvent/UnalignedKeyFrames: Unaligned video keyframes detected. ,
StreamEvent/UnalignedPresentation: Unaligned presentation detected, meaning two fragments across two quality levels are not time aligned. ,
StreamEvent/Discontinuity: Timestamp discontinuity detected. ,
StreamEvent/InvalidConnection: Ingest session denied. ,
}
,
Required: False ,
}
enum ,
eventTime:
{
Description: The time event raised. ,
Format: date-time ,
Required: False ,
}
string ,
eventLevel:
{
Description: Event level. ,
Enum:
{
Critical: No description available. ,
Error: No description available. ,
Warning: No description available. ,
Information: No description available. ,
}
,
Required: False ,
}
enum ,
data:
{
Description: Event data based on event type. ,
Required: False ,
}
{
trackName:
{
Description: Name of the track. ,
Required: False ,
}
string ,
streamId:
{
Description: Stream ID in the format "trackName_bitrate" ,
Required: False ,
}
string ,
trackId:
{
Description: Track index. ,
Format: int32 ,
Required: False ,
}
integer ,
mediaType:
{
Description: Type of the track. ,
Enum:
{
audio: No description available. ,
video: No description available. ,
}
,
Required: False ,
}
enum ,
bitrate:
{
Description: Bitrate of the track. ,
Format: int64 ,
Required: False ,
}
integer ,
mediaTimestamp:
{
Description: Fragment timestamp in timescale. ,
Required: False ,
}
string ,
timescale:
{
Description: Timescale in which timestamps are expressed. ,
Required: False ,
}
string ,
previousFragmentTimestamp:
{
Description: Previous fragment timestamp in timescale. ,
Required: False ,
}
string ,
previousFragmentDuration:
{
Description: Previous fragment duration in timescale. ,
Required: False ,
}
string ,
currentFragmentTimestamp:
{
Description: Current fragment timestamp in timescale. ,
Required: False ,
}
string ,
fragmentOneTimestamp:
{
Description: Timestamp of first fragment used to make a comparison, in timescale. ,
Required: False ,
}
string ,
fragmentOneDuration:
{
Description: Duration of first fragment used to make a comparison, in timescale. ,
Required: False ,
}
string ,
fragmentTwoTimestamp:
{
Description: Timestamp of second fragment used to make a comparison, in timescale. ,
Required: False ,
}
string ,
fragmentTwoDuration:
{
Description: Duration of second fragment used to make a comparison, in timescale. ,
Required: False ,
}
string ,
fragmentDropReason:
{
Description: Reason the fragment was dropped. ,
Required: False ,
}
string ,
discontinuityGap:
{
Description: Length of the discontinuity gap in timescale. ,
Format: int64 ,
Required: False ,
}
integer ,
streamName:
{
Description: Identifier of the stream or connection. Encoder or customer is responsible to add this ID in the ingest URL. ,
Required: False ,
}
string ,
resultCode:
{
Description: Result code. ,
Required: False ,
}
string ,
resultMessage:
{
Description: Result message. ,
Required: False ,
}
string ,
duration:
{
Description: Fragment duration. ,
Required: False ,
}
string ,
resolution:
{
Description: Width x Height for video, null otherwise. ,
Required: False ,
}
string ,
minTime:
{
Description: The smaller timestamp of the two fragments compared. ,
Required: False ,
}
string ,
minTimeMediaType:
{
Description: The media type of the smaller timestamp of two fragments compared. ,
Enum:
{
Audio: No description available. ,
Video: No description available. ,
}
,
Required: False ,
}
enum ,
maxTime:
{
Description: The larger timestamp of the two fragments compared. ,
Required: False ,
}
string ,
maxTimeMediaType:
{
Description: The media type of the larger timestamp of two fragments compared. ,
Enum:
{
Audio: No description available. ,
Video: No description available. ,
}
,
Required: False ,
}
enum ,
timescaleOfMinTime:
{
Description: Timescale of the fragment with the smaller timestamp. ,
Required: False ,
}
string ,
timescaleOfMaxTime:
{
Description: Timescale of the fragment with the larger timestamp. ,
Required: False ,
}
string ,
remoteIp:
{
Description: Truncated IP of the encoder. ,
Required: False ,
}
string ,
remotePort:
{
Description: Port of the encoder. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (304)

{}

⚐ 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_ListGetTrackIngestHeartbeats (removed)
Description :  Get track ingest heartbeat events telemetry of a live event.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/getTrackIngestHeartbeats
{
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 get live event track events. ,
Required: False ,
}
[
{
eventType:
{
Description: The type of the track event. ,
Enum:
{
TrackEvent/IngestHeartbeat: Track heartbeat received. ,
}
,
Required: False ,
}
enum ,
eventTime:
{
Description: The time event raised. ,
Format: date-time ,
Required: False ,
}
string ,
data:
{
Description: Event data. ,
Required: False ,
}
{
trackName:
{
Description: Name of the track. ,
Required: False ,
}
string ,
trackType:
{
Description: Type of the track. ,
Enum:
{
audio: No description available. ,
video: No description available. ,
}
,
Required: False ,
}
enum ,
bitrate:
{
Description: Bitrate of the track. ,
Format: int64 ,
Required: False ,
}
integer ,
incomingBitrate:
{
Description: Calculated bitrate based on data chunks coming from encoder. ,
Format: int64 ,
Required: False ,
}
integer ,
lastTimestamp:
{
Description: Latest timestamp received for a track in last 20 seconds. ,
Required: False ,
}
string ,
timescale:
{
Description: Timescale in which timestamps are expressed. ,
Required: False ,
}
string ,
overlapCount:
{
Description: Number of data chunks that had overlapped timestamps in last 20 seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
discontinuityCount:
{
Description: Number of discontinuities detected in the last 20 seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
nonincreasingCount:
{
Description: Number of data chunks with timestamps in the past that were received in last 20 seconds. ,
Format: int64 ,
Required: False ,
}
integer ,
unexpectedBitrate:
{
Description: If expected and actual bitrates differ by more than allowed limit in last 20 seconds. ,
Required: False ,
}
boolean ,
state:
{
Description: State of the live event. ,
Required: False ,
}
string ,
healthy:
{
Description: Indicates whether ingest is healthy. ,
Required: False ,
}
boolean ,
lastFragmentArrivalTime:
{
Description: The last timestamp in UTC that a fragment arrived at the ingest endpoint. ,
Format: date-time ,
Required: False ,
}
string ,
ingestDriftValue:
{
Description: Indicates the speed of delay, in seconds-per-minute, of the incoming audio or video data during the last minute. The value is greater than zero if data is arriving to the live event slower than expected in the last minute; zero if data arrived with no delay; and "n/a" if no audio or video data was received. For example, if you have a contribution encoder sending in live content, and it is slowing down due to processing issues, or network latency, it may be only able to deliver a total of 58 seconds of audio or video in a one-minute period. This would be reported as two seconds-per-minute of drift. If the encoder is able to catch up and send all 60 seconds or more of data every minute, you will see this value reported as 0. If there was a disconnection or discontinuity from the encoder, this value may still display as 0, as it does not account for breaks in the data - only data that is delayed in timestamps. ,
Required: False ,
}
string ,
transcriptionState:
{
Description: This value is "On" for audio track heartbeats if live transcription is turned on, otherwise you will see an empty string. This state is only applicable to track type of "audio" for Live transcription. All other tracks will have an empty value. ,
Required: False ,
}
string ,
transcriptionLanguage:
{
Description: The language code (in BCP-47 format) of the transcription language. For example, "de-de" indicates German (Germany). The value is empty for the video track heartbeats, or when live transcription is turned off. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (202)

{
location:
{
Description: The URI to poll for completion status. ,
}
string ,
azure-asyncoperation:
{
Description: The URI to poll for completion status. ,
}
string ,
}

⚐ Response (304)

{}

⚐ 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_AsyncOperation (removed)
Description :  Get a live event operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEventOperations/{operationId}
{
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 ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
]
,
}
,
name:
{
Description: Operation Id of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status of the async operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: 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 ,
}
,
]
,
}
,
}
LiveEvents_OperationLocation (removed)
Description :  Get a live event operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/operationLocations/{operationId}
{
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 ,
operationId:
{
Description: The ID of an ongoing async operation. ,
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 ,
}
,
]
,
timedMetadataEndpoints:
{
Description: The metadata endpoints for the live event. ,
Required: False ,
}
[
{
url:
{
Description: The metadata 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)

{}

⚐ 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 ,
rewindWindowLength:
{
Description: ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL. ,
Format: duration ,
Required: False ,
}
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 ,
rewindWindowLength:
{
Description: ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL. ,
Format: duration ,
Required: False ,
}
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 ,
rewindWindowLength:
{
Description: ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL. ,
Format: duration ,
Required: False ,
}
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 ,
rewindWindowLength:
{
Description: ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL. ,
Format: duration ,
Required: False ,
}
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 ,
rewindWindowLength:
{
Description: ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL. ,
Format: duration ,
Required: False ,
}
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 ,
}
,
]
,
}
,
}
LiveOutputs_AsyncOperation (removed)
Description :  Get a Live Output operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveOutputOperations/{operationId}
{
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 ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
]
,
}
,
name:
{
Description: Operation Id of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status of the async operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: 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 ,
}
,
]
,
}
,
}
LiveOutputs_OperationLocation (removed)
Description :  Get a Live Output operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}/operationLocations/{operationId}
{
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 ,
operationId:
{
Description: The ID of an ongoing async operation. ,
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 ,
rewindWindowLength:
{
Description: ISO 8601 time between 1 minute to the duration of archiveWindowLength to control seek-able window length during Live. The service won't use this property once LiveOutput stops. The archived VOD will have full content with original ArchiveWindowLength. For example, use PT1H30M to indicate 1 hour and 30 minutes of rewind window length. Service will use implicit default value 30m only if Live Event enables LL. ,
Format: duration ,
Required: False ,
}
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 (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_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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
]
,
@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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ 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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ 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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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_Skus (removed)
Description :  List streaming endpoint supported skus.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/skus
{
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)

{
value:
{
Description: The result of the List StreamingEndpoint skus. ,
Required: False ,
}
[
{
resourceType:
{
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Required: False ,
}
{
scaleType:
{
Required: False ,
}
string ,
default:
{
Description: The streaming endpoint default capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
minimum:
{
Description: The streaming endpoint minimum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
maximum:
{
Description: The streaming endpoint maximum capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku 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 ,
}
,
]
,
}
,
}
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 ,
}
,
]
,
}
,
}
StreamingEndpoints_AsyncOperation (removed)
Description :  Get a streaming endpoint operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpointOperations/{operationId}
{
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 ,
operationId:
{
Description: The ID of an ongoing async operation. ,
Required: True ,
}
string ,
api-version:
{
Description: The version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
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 ,
}
,
]
,
}
,
name:
{
Description: Operation Id of the async operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status of the async operation. ,
Enum:
{
Succeeded: No description available. ,
Failed: No description available. ,
InProgress: 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 ,
}
,
]
,
}
,
}
StreamingEndpoints_OperationLocation (removed)
Description :  Get a streaming endpoint operation status.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/operationLocations/{operationId}
{
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 ,
operationId:
{
Description: The ID of an ongoing async operation. ,
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 ,
}
,
sku:
{
Description: The streaming endpoint sku. ,
Required: False ,
}
{
name:
{
Description: The streaming endpoint sku name. ,
Required: False ,
}
string ,
capacity:
{
Description: The streaming endpoint sku capacity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}