Share via

LiveEventsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

AzureMediaServices's

<xref:live_events> attribute.

Inheritance
builtins.object
LiveEventsOperations

Constructor

LiveEventsOperations(*args, **kwargs)

Methods

async_operation

Get operation status.

Get a live event operation status.
begin_allocate

Allocate resources for a live event.

A live event is in StandBy state after allocation completes, and is ready to start.
begin_create

Create Live Event.

Creates a new live event.
begin_delete

Delete Live Event.

Deletes a live event.
begin_reset

Reset Live Event.

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.
begin_start

Start Live Event.

A live event in Stopped or StandBy state will be in Running state after the start operation completes.
begin_stop

Stop Live Event.

Stops a running live event.
begin_update

Updates settings on an existing live event.
get

Get Live Event.

Gets properties of a live event.
list

List live events.

Lists all the live events in the account.
operation_location

Get operation status.

Get a live event operation status.

async_operation

Get operation status.

Get a live event operation status.

async_operation(resource_group_name: str, account_name: str, operation_id: str, **kwargs: Any) -> AsyncOperationResult

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
operation_id
Required
str

The ID of an ongoing async operation. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
AsyncOperationResult

AsyncOperationResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_allocate

Allocate resources for a live event.

A live event is in StandBy state after allocation completes, and is ready to start.

begin_allocate(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_create

Create Live Event.

Creates a new live event.

begin_create(resource_group_name: str, account_name: str, live_event_name: str, parameters: _models.LiveEvent, auto_start: bool | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.LiveEvent]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.
parameters
Required
LiveEvent or IO

Live event properties needed for creation. Is either a model type or a IO type. Required.
auto_start
Required
bool

The flag indicates if the resource should be automatically started on creation. Default value is None.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[LiveEvent]

An instance of LROPoller that returns either LiveEvent or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Delete Live Event.

Deletes a live event.

begin_delete(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_reset

Reset Live Event.

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.

begin_reset(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_start

Start Live Event.

A live event in Stopped or StandBy state will be in Running state after the start operation completes.

begin_start(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_stop

Stop Live Event.

Stops a running live event.

begin_stop(resource_group_name: str, account_name: str, live_event_name: str, parameters: _models.LiveEventActionInput, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.
parameters
Required
LiveEventActionInput or IO

LiveEvent stop parameters. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[None]

An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_update

Updates settings on an existing live event.

begin_update(resource_group_name: str, account_name: str, live_event_name: str, parameters: _models.LiveEvent, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.LiveEvent]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.
parameters
Required
LiveEvent or IO

Live event properties needed for patch. Is either a model type or a IO type. Required.

Keyword-Only Parameters

Name Description
content_type
str

Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls
callable

A custom type or function that will be passed the direct response
continuation_token
str

A continuation token to restart a poller from a saved state.
polling
bool or PollingMethod

By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval
int

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type Description
LROPoller[LiveEvent]

An instance of LROPoller that returns either LiveEvent or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get Live Event.

Gets properties of a live event.

get(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> LiveEvent

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
LiveEvent

LiveEvent or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List live events.

Lists all the live events in the account.

list(resource_group_name: str, account_name: str, **kwargs: Any) -> Iterable[LiveEvent]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
ItemPaged[LiveEvent]

An iterator like instance of either LiveEvent or the result of cls(response)

Exceptions

Type Description
HttpResponseError

operation_location

Get operation status.

Get a live event operation status.

operation_location(resource_group_name: str, account_name: str, live_event_name: str, operation_id: str, **kwargs: Any) -> LiveEvent | None

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group within the Azure subscription. Required.
account_name
Required
str

The Media Services account name. Required.
live_event_name
Required
str

The name of the live event, maximum length is 32. Required.
operation_id
Required
str

The ID of an ongoing async operation. Required.

Keyword-Only Parameters

Name Description
cls
callable

A custom type or function that will be passed the direct response

Returns

Type Description
LiveEvent,
None

LiveEvent or None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.media.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\media\\models\\__init__.py'>