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
| 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) -> AsyncOperationResultParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
operation_id
Required
|
The ID of an ongoing async operation. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
AsyncOperationResult or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
|
parameters
Required
|
Live event properties needed for creation. Is either a model type or a IO type. Required. |
|
auto_start
Required
|
The flag indicates if the resource should be automatically started on creation. Default value is None. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either LiveEvent or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
|
parameters
Required
|
LiveEvent stop parameters. Is either a model type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
|
parameters
Required
|
Live event properties needed for patch. Is either a model type or a IO type. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
content_type
|
Body Parameter content-type. Known values are: 'application/json'. Default value is None. |
|
cls
|
A custom type or function that will be passed the direct response |
|
continuation_token
|
A continuation token to restart a poller from a saved state. |
|
polling
|
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
|
Default waiting time between two polls for LRO operations if no Retry-After header is present. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either LiveEvent or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get Live Event.
Gets properties of a live event.
get(resource_group_name: str, account_name: str, live_event_name: str, **kwargs: Any) -> LiveEventParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
LiveEvent or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either LiveEvent or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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 | NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group within the Azure subscription. Required. |
|
account_name
Required
|
The Media Services account name. Required. |
|
live_event_name
Required
|
The name of the live event, maximum length is 32. Required. |
|
operation_id
Required
|
The ID of an ongoing async operation. Required. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
cls
|
A custom type or function that will be passed the direct response |
Returns
| Type | Description |
|---|---|
|
LiveEvent or None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
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'>
Azure SDK for Python
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for