OriginGroupsOperations Class

OriginGroupsOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

OriginGroupsOperations

Constructor

OriginGroupsOperations(client, config, serializer, deserializer)

Parameters

client

Required

Client for service requests.

config

Required

Configuration of service client.

serializer

Required

An object model serializer.

deserializer

Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create	Creates a new origin group within the specified endpoint.
begin_delete	Deletes an existing origin group within an endpoint.
begin_update	Updates an existing origin group within an endpoint.
get	Gets an existing origin group within an endpoint.
list_by_endpoint	Lists all of the existing origin groups within an endpoint.

begin_create

Creates a new origin group within the specified endpoint.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, origin_group_name: str, origin_group: azure.mgmt.cdn.models._models_py3.OriginGroup, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.OriginGroup]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

origin_group_name

str

Required

Name of the origin group which is unique within the endpoint.

origin_group

OriginGroup

Required

Origin group properties.

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

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

Return type

LROPoller[OriginGroup]

Exceptions

HttpResponseError

begin_delete

Deletes an existing origin group within an endpoint.

begin_delete(resource_group_name: str, profile_name: str, endpoint_name: str, origin_group_name: str, **kwargs: Any) -> azure.core.polling._poller.LROPoller[None]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

origin_group_name

str

Required

Name of the origin group which is unique within the endpoint.

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

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

Return type

LROPoller[None]

Exceptions

HttpResponseError

begin_update

Updates an existing origin group within an endpoint.

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, origin_group_name: str, origin_group_update_properties: azure.mgmt.cdn.models._models_py3.OriginGroupUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.OriginGroup]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

origin_group_name

str

Required

Name of the origin group which is unique within the endpoint.

origin_group_update_properties

OriginGroupUpdateParameters

Required

Origin group properties.

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

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

Return type

LROPoller[OriginGroup]

Exceptions

HttpResponseError

get

Gets an existing origin group within an endpoint.

get(resource_group_name: str, profile_name: str, endpoint_name: str, origin_group_name: str, **kwargs: Any) -> azure.mgmt.cdn.models._models_py3.OriginGroup

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

origin_group_name

str

Required

Name of the origin group which is unique within the endpoint.

cls

callable

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

Returns

OriginGroup, or the result of cls(response)

Return type

OriginGroup

Exceptions

HttpResponseError

list_by_endpoint

Lists all of the existing origin groups within an endpoint.

list_by_endpoint(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.OriginGroupListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

profile_name

str

Required

Name of the CDN profile which is unique within the resource group.

endpoint_name

str

Required

Name of the endpoint under the profile which is unique globally.

cls

callable

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

Returns

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

Return type

ItemPaged[OriginGroupListResult]

Exceptions

HttpResponseError

Attributes

models

models = <module 'azure.mgmt.cdn.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.9.13\\x64\\lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>