LiveEvents interface
Interface representing a LiveEvents.
Methods
Method Details
asyncOperation(string, string, string, LiveEventsAsyncOperationOptionalParams)
Get a live event operation status.
function asyncOperation(resourceGroupName: string, accountName: string, operationId: string, options?: LiveEventsAsyncOperationOptionalParams): Promise<AsyncOperationResult>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- operationId
-
string
The ID of an ongoing async operation.
The options parameters.
Returns
Promise<AsyncOperationResult>
beginAllocate(string, string, string, LiveEventsAllocateOptionalParams)
A live event is in StandBy state after allocation completes, and is ready to start.
function beginAllocate(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsAllocateOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsAllocateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginAllocateAndWait(string, string, string, LiveEventsAllocateOptionalParams)
A live event is in StandBy state after allocation completes, and is ready to start.
function beginAllocateAndWait(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsAllocateOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsAllocateOptionalParams
The options parameters.
Returns
Promise<void>
beginCreate(string, string, string, LiveEvent, LiveEventsCreateOptionalParams)
Creates a new live event.
function beginCreate(resourceGroupName: string, accountName: string, liveEventName: string, parameters: LiveEvent, options?: LiveEventsCreateOptionalParams): Promise<PollerLike<PollOperationState<LiveEvent>, LiveEvent>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- parameters
- LiveEvent
Live event properties needed for creation.
- options
- LiveEventsCreateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<LiveEvent>, LiveEvent>>
beginCreateAndWait(string, string, string, LiveEvent, LiveEventsCreateOptionalParams)
Creates a new live event.
function beginCreateAndWait(resourceGroupName: string, accountName: string, liveEventName: string, parameters: LiveEvent, options?: LiveEventsCreateOptionalParams): Promise<LiveEvent>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- parameters
- LiveEvent
Live event properties needed for creation.
- options
- LiveEventsCreateOptionalParams
The options parameters.
Returns
Promise<LiveEvent>
beginDelete(string, string, string, LiveEventsDeleteOptionalParams)
Deletes a live event.
function beginDelete(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, string, LiveEventsDeleteOptionalParams)
Deletes a live event.
function beginDeleteAndWait(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginReset(string, string, string, LiveEventsResetOptionalParams)
Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.
function beginReset(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsResetOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsResetOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginResetAndWait(string, string, string, LiveEventsResetOptionalParams)
Resets an existing live event. All live outputs for the live event are deleted and the live event is stopped and will be started again. All assets used by the live outputs and streaming locators created on these assets are unaffected.
function beginResetAndWait(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsResetOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsResetOptionalParams
The options parameters.
Returns
Promise<void>
beginStart(string, string, string, LiveEventsStartOptionalParams)
A live event in Stopped or StandBy state will be in Running state after the start operation completes.
function beginStart(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsStartOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsStartOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStartAndWait(string, string, string, LiveEventsStartOptionalParams)
A live event in Stopped or StandBy state will be in Running state after the start operation completes.
function beginStartAndWait(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsStartOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsStartOptionalParams
The options parameters.
Returns
Promise<void>
beginStop(string, string, string, LiveEventActionInput, LiveEventsStopOptionalParams)
Stops a running live event.
function beginStop(resourceGroupName: string, accountName: string, liveEventName: string, parameters: LiveEventActionInput, options?: LiveEventsStopOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- parameters
- LiveEventActionInput
LiveEvent stop parameters
- options
- LiveEventsStopOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginStopAndWait(string, string, string, LiveEventActionInput, LiveEventsStopOptionalParams)
Stops a running live event.
function beginStopAndWait(resourceGroupName: string, accountName: string, liveEventName: string, parameters: LiveEventActionInput, options?: LiveEventsStopOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- parameters
- LiveEventActionInput
LiveEvent stop parameters
- options
- LiveEventsStopOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, string, LiveEvent, LiveEventsUpdateOptionalParams)
Updates settings on an existing live event.
function beginUpdate(resourceGroupName: string, accountName: string, liveEventName: string, parameters: LiveEvent, options?: LiveEventsUpdateOptionalParams): Promise<PollerLike<PollOperationState<LiveEvent>, LiveEvent>>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- parameters
- LiveEvent
Live event properties needed for patch.
- options
- LiveEventsUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<LiveEvent>, LiveEvent>>
beginUpdateAndWait(string, string, string, LiveEvent, LiveEventsUpdateOptionalParams)
Updates settings on an existing live event.
function beginUpdateAndWait(resourceGroupName: string, accountName: string, liveEventName: string, parameters: LiveEvent, options?: LiveEventsUpdateOptionalParams): Promise<LiveEvent>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- parameters
- LiveEvent
Live event properties needed for patch.
- options
- LiveEventsUpdateOptionalParams
The options parameters.
Returns
Promise<LiveEvent>
get(string, string, string, LiveEventsGetOptionalParams)
Gets properties of a live event.
function get(resourceGroupName: string, accountName: string, liveEventName: string, options?: LiveEventsGetOptionalParams): Promise<LiveEvent>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- options
- LiveEventsGetOptionalParams
The options parameters.
Returns
Promise<LiveEvent>
list(string, string, LiveEventsListOptionalParams)
Lists all the live events in the account.
function list(resourceGroupName: string, accountName: string, options?: LiveEventsListOptionalParams): PagedAsyncIterableIterator<LiveEvent, LiveEvent[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- options
- LiveEventsListOptionalParams
The options parameters.
Returns
operationLocation(string, string, string, string, LiveEventsOperationLocationOptionalParams)
Get a live event operation status.
function operationLocation(resourceGroupName: string, accountName: string, liveEventName: string, operationId: string, options?: LiveEventsOperationLocationOptionalParams): Promise<LiveEvent>Parameters
- resourceGroupName
-
string
The name of the resource group within the Azure subscription.
- accountName
-
string
The Media Services account name.
- liveEventName
-
string
The name of the live event, maximum length is 32.
- operationId
-
string
The ID of an ongoing async operation.
The options parameters.
Returns
Promise<LiveEvent>