OriginGroupsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:origin_groups> attribute.

Inheritance
builtins.object
OriginGroupsOperations

Constructor

OriginGroupsOperations(*args, **kwargs)

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: _models.OriginGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.OriginGroup]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Name of the endpoint under the profile which is unique globally. Required.
origin_group_name
Required
str

Name of the origin group which is unique within the endpoint. Required.
origin_group
Required
OriginGroup or IO[bytes]

Origin group properties. Is either a OriginGroup type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[OriginGroup]

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

Exceptions

Type Description
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) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Name of the endpoint under the profile which is unique globally. Required.
origin_group_name
Required
str

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

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 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: _models.OriginGroupUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.OriginGroup]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Name of the endpoint under the profile which is unique globally. Required.
origin_group_name
Required
str

Name of the origin group which is unique within the endpoint. Required.
origin_group_update_properties
Required
OriginGroupUpdateParameters or IO[bytes]

Origin group properties. Is either a OriginGroupUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[OriginGroup]

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

Exceptions

Type Description
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) -> OriginGroup

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Name of the endpoint under the profile which is unique globally. Required.
origin_group_name
Required
str

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

Returns

Type Description
OriginGroup

OriginGroup or the result of cls(response)

Exceptions

Type Description
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[OriginGroup]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

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

Returns

Type Description
ItemPaged[OriginGroup]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

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