AFDOriginGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:afd_origin_groups> attribute.

Inheritance

builtins.object

AFDOriginGroupsOperations

Constructor

AFDOriginGroupsOperations(*args, **kwargs)

Methods

begin_create	Creates a new origin group within the specified profile.
begin_delete	Deletes an existing origin group within a profile.
begin_update	Updates an existing origin group within a profile.
get	Gets an existing origin group within a profile.
list_by_profile	Lists all of the existing origin groups within a profile.
list_resource_usage	Checks the quota and actual usage of endpoints under the given Azure Front Door profile..

begin_create

Creates a new origin group within the specified profile.

begin_create(resource_group_name: str, profile_name: str, origin_group_name: str, origin_group: _models.AFDOriginGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AFDOriginGroup]

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
origin_group_name Required	str Name of the origin group which is unique within the endpoint. Required.
origin_group Required	AFDOriginGroup or IO[bytes] Origin group properties. Is either a AFDOriginGroup type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AFDOriginGroup]	An instance of LROPoller that returns either AFDOriginGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes an existing origin group within a profile.

begin_delete(resource_group_name: str, profile_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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
origin_group_name Required	str Name of the origin group which is unique within the profile. 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 a profile.

begin_update(resource_group_name: str, profile_name: str, origin_group_name: str, origin_group_update_properties: _models.AFDOriginGroupUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AFDOriginGroup]

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
origin_group_name Required	str Name of the origin group which is unique within the profile. Required.
origin_group_update_properties Required	AFDOriginGroupUpdateParameters or IO[bytes] Origin group properties. Is either a AFDOriginGroupUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[AFDOriginGroup]	An instance of LROPoller that returns either AFDOriginGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets an existing origin group within a profile.

get(resource_group_name: str, profile_name: str, origin_group_name: str, **kwargs: Any) -> AFDOriginGroup

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
origin_group_name Required	str Name of the origin group which is unique within the endpoint. Required.

Returns

Type	Description
AFDOriginGroup	AFDOriginGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_profile

Lists all of the existing origin groups within a profile.

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) -> Iterable[AFDOriginGroup]

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Returns

Type	Description
ItemPaged[AFDOriginGroup]	An iterator like instance of either AFDOriginGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_resource_usage

Checks the quota and actual usage of endpoints under the given Azure Front Door profile..

list_resource_usage(resource_group_name: str, profile_name: str, origin_group_name: str, **kwargs: Any) -> Iterable[Usage]

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 Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.
origin_group_name Required	str Name of the origin group which is unique within the endpoint. Required.

Returns

Type	Description
ItemPaged[Usage]	An iterator like instance of either Usage 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'>