AFDOriginsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:afd_origins> attribute.

Inheritance
builtins.object
AFDOriginsOperations

Constructor

AFDOriginsOperations(*args, **kwargs)

Methods

begin_create

Creates a new origin within the specified origin group.
begin_delete

Deletes an existing origin within an origin group.
begin_update

Updates an existing origin within an origin group.
get

Gets an existing origin within an origin group.
list_by_origin_group

Lists all of the existing origins within an origin group.

begin_create

Creates a new origin within the specified origin group.

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

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_name
Required
str

Name of the origin that is unique within the profile. Required.
origin
Required
AFDOrigin or IO[bytes]

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

Returns

Type Description
LROPoller[AFDOrigin]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes an existing origin within an origin group.

begin_delete(resource_group_name: str, profile_name: str, origin_group_name: str, origin_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.
origin_name
Required
str

Name of the origin 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 within an origin group.

begin_update(resource_group_name: str, profile_name: str, origin_group_name: str, origin_name: str, origin_update_properties: _models.AFDOriginUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.AFDOrigin]

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_name
Required
str

Name of the origin which is unique within the profile. Required.
origin_update_properties
Required
AFDOriginUpdateParameters or IO[bytes]

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

Returns

Type Description
LROPoller[AFDOrigin]

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

Exceptions

Type Description
HttpResponseError

get

Gets an existing origin within an origin group.

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

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_name
Required
str

Name of the origin which is unique within the profile. Required.

Returns

Type Description
AFDOrigin

AFDOrigin or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_origin_group

Lists all of the existing origins within an origin group.

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

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
ItemPaged[AFDOrigin]

An iterator like instance of either AFDOrigin 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'>