Microsoft.Media (preview:2019-05-01)

2025/05/26 • 20 deleted methods

LiveEvents_List (removed)
Description :  Lists 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: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.count:
{
Description: The number of result. ,
Format: int32 ,
Required: False ,
}
integer ,
@odata.nextLink:
{
Description: Th 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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveEvents_Get (removed)
Description :  Gets 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. ,
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: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveEvents_Create (removed)
Description :  Creates a 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. ,
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: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Live Event properties. ,
Required: False ,
}
{
description:
{
Description: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The Live Event properties. ,
Required: False ,
}
{
description:
{
Description: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveEvents_Update (removed)
Description :  Updates a 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. ,
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 creation. ,
Required: True ,
}
{
properties:
{
Description: The Live Event properties. ,
Required: False ,
}
{
description:
{
Description: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Live Event properties. ,
Required: False ,
}
{
description:
{
Description: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The Live Event properties. ,
Required: False ,
}
{
description:
{
Description: The Live Event description. ,
Required: False ,
}
string ,
input:
{
Description: The Live Event input. ,
Required: True ,
}
{
streamingProtocol:
{
Description: The streaming protocol for the Live Event. This is specified at creation time and cannot be updated. ,
Enum:
{
FragmentedMP4: No description available. ,
RTMP: No description available. ,
}
,
Required: True ,
}
enum ,
accessControl:
{
Description: The access control for LiveEvent 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 timespan duration of the key frame interval duration. ,
Required: False ,
}
string ,
accessToken:
{
Description: A unique identifier for a stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value. ,
Required: False ,
}
string ,
endpoints:
{
Description: The input endpoints for the Live Event. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
}
,
preview:
{
Description: The Live Event preview. ,
Required: False ,
}
{
endpoints:
{
Description: The endpoints for preview. ,
Required: False ,
}
[
{
protocol:
{
Description: The endpoint protocol. ,
Required: False ,
}
string ,
url:
{
Description: The endpoint URL. ,
Required: False ,
}
string ,
}
,
]
,
accessControl:
{
Description: The access control for LiveEvent 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 LiveEvent preview. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
alternativeMediaId:
{
Description: An Alternative Media Identifier associated with the StreamingLocator 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: The Live Event encoding. ,
Required: False ,
}
{
encodingType:
{
Description: The encoding type for Live Event. This value is specified at creation time and cannot be updated. ,
Enum:
{
None: No description available. ,
Basic: No description available. ,
Standard: No description available. ,
Premium1080p: No description available. ,
}
,
Required: False ,
}
enum ,
presetName:
{
Description: The encoding preset name. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
string ,
}
,
transcriptions:
{
Description: The Live Event transcription. ,
Required: False ,
}
[
{
language:
{
Description: Specifies the language (locale) used for speech-to-text transcription - it should match the spoken language in the audio track. The value should be in BCP-47 format of 'language tag-region' (e.g: 'en-US'). The list of supported languages are 'en-US' and 'en-GB'. ,
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. ,
Required: False ,
}
[
{
property:
{
Description: Property name to select. ,
Required: False ,
}
string ,
operation:
{
Description: Comparing operation. ,
Required: False ,
}
string ,
value:
{
Description: Property value to select. ,
Required: False ,
}
string ,
}
,
]
,
outputTranscriptionTrack:
{
Description: Describes a transcription track in the output of a Live Event, generated using speech-to-text transcription. ,
Required: False ,
}
{
trackName:
{
Description: The output track name. ,
Required: True ,
}
string ,
}
,
}
,
]
,
provisioningState:
{
Description: The provisioning state of the Live Event. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the Live Event. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The Live Event 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 ,
}
,
vanityUrl:
{
Description: Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
boolean ,
streamOptions:
{
Description: The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. ,
Required: False ,
}
[
string ,
]
,
created:
{
Description: The exact time the Live Event was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the Live Event was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveEvents_Start (removed)
Description :  Starts an existing Live Event.
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. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveEvents_Stop (removed)
Description :  Stops an existing 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. ,
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 if remove LiveOutputs on Stop. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveEvents_Reset (removed)
Description :  Resets an existing Live Event.
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. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveOutputs_List (removed)
Description :  Lists the Live Outputs in the 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. ,
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 Output operation. ,
Required: False ,
}
[
{
properties:
{
Description: The Live Output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the Live Output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset name. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: The HLS configuration. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The amount of fragments per HTTP Live Streaming (HLS) segment. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The output snapshot time. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The exact time the Live Output was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact 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: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
@odata.count:
{
Description: The number of result. ,
Format: int32 ,
Required: False ,
}
integer ,
@odata.nextLink:
{
Description: Th 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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
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. ,
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: The Live Output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the Live Output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset name. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: The HLS configuration. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The amount of fragments per HTTP Live Streaming (HLS) segment. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The output snapshot time. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The exact time the Live Output was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact 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: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveOutputs_Create (removed)
Description :  Creates a 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. ,
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: The Live Output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the Live Output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset name. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: The HLS configuration. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The amount of fragments per HTTP Live Streaming (HLS) segment. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The output snapshot time. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The exact time the Live Output was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact 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: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The Live Output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the Live Output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset name. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: The HLS configuration. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The amount of fragments per HTTP Live Streaming (HLS) segment. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The output snapshot time. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The exact time the Live Output was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact 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: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The Live Output properties. ,
Required: False ,
}
{
description:
{
Description: The description of the Live Output. ,
Required: False ,
}
string ,
assetName:
{
Description: The asset name. ,
Required: True ,
}
string ,
archiveWindowLength:
{
Description: ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content. ,
Format: duration ,
Required: True ,
}
string ,
manifestName:
{
Description: The manifest file name. If not provided, the service will generate one automatically. ,
Required: False ,
}
string ,
hls:
{
Description: The HLS configuration. ,
Required: False ,
}
{
fragmentsPerTsSegment:
{
Description: The amount of fragments per HTTP Live Streaming (HLS) segment. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
outputSnapTime:
{
Description: The output snapshot time. ,
Format: int64 ,
Required: False ,
}
integer ,
created:
{
Description: The exact time the Live Output was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact 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: No description available. ,
Running: No description available. ,
Deleting: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
LiveOutputs_Delete (removed)
Description :  Deletes a Live Output.
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. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_List (removed)
Description :  Lists the StreamingEndpoints 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 StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
@odata.count:
{
Description: The number of result. ,
Format: int32 ,
Required: False ,
}
integer ,
@odata.nextLink:
{
Description: Th link to the next set of results. Not empty if value contains incomplete list of StreamingEndpoints. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Get (removed)
Description :  Gets a StreamingEndpoint.
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 StreamingEndpoint. ,
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 StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (404)

{}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Create (removed)
Description :  Creates a StreamingEndpoint.
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 StreamingEndpoint. ,
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: StreamingEndpoint properties needed for creation. ,
Required: True ,
}
{
properties:
{
Description: The StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Update (removed)
Description :  Updates a existing StreamingEndpoint.
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 StreamingEndpoint. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: StreamingEndpoint properties needed for creation. ,
Required: True ,
}
{
properties:
{
Description: The StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{
properties:
{
Description: The StreamingEndpoint properties. ,
Required: False ,
}
{
description:
{
Description: The StreamingEndpoint 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: The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time. ,
Required: False ,
}
string ,
accessControl:
{
Description: The access control definition of the StreamingEndpoint. ,
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 StreamingEndpoint. ,
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 StreamingEndpoint ,
Required: False ,
}
[
string ,
]
,
hostName:
{
Description: The StreamingEndpoint 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 StreamingEndpoint. ,
Required: False ,
}
string ,
resourceState:
{
Description: The resource state of the StreamingEndpoint. ,
Enum:
{
Stopped: No description available. ,
Starting: No description available. ,
Running: No description available. ,
Stopping: No description available. ,
Deleting: No description available. ,
Scaling: No description available. ,
}
,
Required: False ,
}
enum ,
crossSiteAccessPolicies:
{
Description: The StreamingEndpoint 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 StreamingEndpoint was created. ,
Format: date-time ,
Required: False ,
}
string ,
lastModified:
{
Description: The exact time the StreamingEndpoint was last modified. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Delete (removed)
Description :  Deletes a StreamingEndpoint.
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 StreamingEndpoint. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Start (removed)
Description :  Starts an existing StreamingEndpoint.
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 StreamingEndpoint. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Stop (removed)
Description :  Stops an existing StreamingEndpoint.
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 StreamingEndpoint. ,
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 properties. ,
Required: False ,
}
{
code:
{
Description: A language-independent error name. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The target of the error (for example, the name of the property in error). ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
}
,
}
StreamingEndpoints_Scale (removed)
Description :  Scales an existing StreamingEndpoint.
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 StreamingEndpoint. ,
Required: True ,
}
string ,
api-version:
{
Description: The Version of the API to be used with the client request. ,
Required: True ,
}
string ,
parameters:
{
Description: StreamingEndpoint scale parameters ,
Required: True ,
}
{
scaleUnit:
{
Description: The scale unit number of the StreamingEndpoint. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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