LiveEventsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:live_events> attribute.
- Inheritance
-
builtins.objectLiveEventsOperations
Constructor
LiveEventsOperations(*args, **kwargs)Methods
| 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. |
begin_allocate
Allocate resources for a live event.
A live event is in StandBy state after allocation completes, and is ready to start.
async begin_allocate(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_create
Create Live Event.
Creates a new live event.
async begin_create(resource_group_name: str, account_name: str, live_event_name: str, parameters: azure.mgmt.media.models._models_py3.LiveEvent, auto_start: Optional[bool] = None, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.media.models._models_py3.LiveEvent]Parameters
- auto_start
- bool
The flag indicates if the resource should be automatically started on creation. 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either LiveEvent or the result of cls(response)
Return type
Exceptions
begin_delete
Delete Live Event.
Deletes a live event.
async begin_delete(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
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.
async begin_reset(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_start
Start Live Event.
A live event in Stopped or StandBy state will be in Running state after the start operation completes.
async begin_start(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_stop
Stop Live Event.
Stops a running live event.
async begin_stop(resource_group_name: str, account_name: str, live_event_name: str, parameters: azure.mgmt.media.models._models_py3.LiveEventActionInput, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[None]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either None or the result of cls(response)
Return type
Exceptions
begin_update
Updates settings on an existing live event.
async begin_update(resource_group_name: str, account_name: str, live_event_name: str, parameters: azure.mgmt.media.models._models_py3.LiveEvent, **kwargs: Any) -> azure.core.polling._async_poller.AsyncLROPoller[azure.mgmt.media.models._models_py3.LiveEvent]Parameters
- 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 AsyncPollingMethod
By default, your polling method will be AsyncARMPolling. 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
An instance of AsyncLROPoller that returns either LiveEvent or the result of cls(response)
Return type
Exceptions
get
Get Live Event.
Gets properties of a live event.
async get(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> azure.mgmt.media.models._models_py3.LiveEventParameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
LiveEvent, or the result of cls(response)
Return type
Exceptions
list
List live events.
Lists all the live events in the account.
list(resource_group_name: str, account_name: str, **kwargs: Any) -> AsyncIterable[azure.mgmt.media.models._models_py3.LiveEventListResult]Parameters
- cls
- callable
A custom type or function that will be passed the direct response
Returns
An iterator like instance of either LiveEventListResult or the result of cls(response)
Return type
Exceptions
Attributes
models
models = <module 'azure.mgmt.media.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\media\\models\\__init__.py'>Feedback
Submit and view feedback for