OriginsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:origins> attribute.

Constructor

OriginsOperations(*args, **kwargs)

Methods

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

begin_create

Creates a new origin within the specified endpoint.

async begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, origin: _models.Origin, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Origin]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or 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_name Required	str Name of the origin which is unique within the endpoint. Required.
origin Required	Origin or Origin or IO[bytes] Origin properties. Is either a Origin type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[Origin]	An instance of AsyncLROPoller that returns Origin. The Origin is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes an existing origin within an endpoint.

async begin_delete(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, **kwargs: Any) -> AsyncLROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or 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_name Required	str Name of the origin which is unique within the endpoint. Required.

Returns

Type	Description
AsyncLROPoller[None]	An instance of AsyncLROPoller that returns None

Exceptions

Type	Description
HttpResponseError

begin_update

Updates an existing origin within an endpoint.

async begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, origin_update_properties: _models.OriginUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> AsyncLROPoller[_models.Origin]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or 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_name Required	str Name of the origin which is unique within the endpoint. Required.
origin_update_properties Required	OriginUpdateParameters or OriginUpdateParameters or IO[bytes] Origin properties. Is either a OriginUpdateParameters type or a IO[bytes] type. Required.

Returns

Type	Description
AsyncLROPoller[Origin]	An instance of AsyncLROPoller that returns Origin. The Origin is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Gets an existing origin within an endpoint.

async get(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, **kwargs: Any) -> Origin

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or 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_name Required	str Name of the origin which is unique within the endpoint. Required.

Returns

Type	Description
Origin	Origin. The Origin is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list_by_endpoint

Lists all of the existing origins within an endpoint.

list_by_endpoint(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) -> AsyncItemPaged[Origin]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
profile_name Required	str Name of the Azure Front Door Standard or Azure Front Door Premium or 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
AsyncItemPaged[Origin]	An iterator like instance of Origin

Exceptions

Type	Description
HttpResponseError

Feedback

Was this page helpful?