azure.mgmt.cdn.operations module

class azure.mgmt.cdn.operations.AFDCustomDomainsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s afd_custom_domains attribute.

begin_create(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain: _models.AFDDomain, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDDomain]

begin_create(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDDomain]

Creates a new domain within the specified profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• custom_domain_name (str) – Name of the domain under the profile which is unique globally. Required.

• custom_domain (AFDDomain or IO) – Domain properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDDomain or the result of cls(response)

Return type

LROPoller[AFDDomain]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• custom_domain_name (str) – Name of the domain under the profile which is unique globally. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_refresh_validation_token(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Updates the domain validation token.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• custom_domain_name (str) – Name of the domain under the profile which is unique globally. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain_update_properties: _models.AFDDomainUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDDomain]

begin_update(resource_group_name: str, profile_name: str, custom_domain_name: str, custom_domain_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDDomain]

Updates an existing domain within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• custom_domain_name (str) – Name of the domain under the profile which is unique globally. Required.

• custom_domain_update_properties (AFDDomainUpdateParameters or IO) – Domain properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDDomain or the result of cls(response)

Return type

LROPoller[AFDDomain]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, custom_domain_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.AFDDomain

Gets an existing AzureFrontDoor domain with the specified domain name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• custom_domain_name (str) – Name of the domain under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AFDDomain or the result of cls(response)

Return type

AFDDomain

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.AFDDomain]

Lists existing AzureFrontDoor domains.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile or CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AFDDomain]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.AFDEndpointsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s afd_endpoints attribute.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint: _models.AFDEndpoint, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDEndpoint]

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDEndpoint]

Creates a new AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• endpoint (AFDEndpoint or IO) – Endpoint properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDEndpoint or the result of cls(response)

Return type

LROPoller[AFDEndpoint]

Raises

HttpResponseError –

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

Deletes an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, contents: _models.AfdPurgeParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, contents: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Removes a content from AzureFrontDoor.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• contents (AfdPurgeParameters or IO) – The list of paths to the content and the list of linked domains to be purged. Path can be a full URL, e.g. ‘/pictures/city.png’ which removes a single file, or a directory with a wildcard, e.g. ‘/pictures/*’ which removes all folders and files in the directory. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint_update_properties: _models.AFDEndpointUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDEndpoint]

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.AFDEndpoint]

Updates an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update domains, use the Update Custom Domain operation.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• endpoint_update_properties (AFDEndpointUpdateParameters or IO) – Endpoint update properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDEndpoint or the result of cls(response)

Return type

LROPoller[AFDEndpoint]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.AFDEndpoint

Gets an existing AzureFrontDoor endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AFDEndpoint or the result of cls(response)

Return type

AFDEndpoint

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.AFDEndpoint]

Lists existing AzureFrontDoor endpoints.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AFDEndpoint]

Raises

HttpResponseError –

list_resource_usage(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Usage]

Checks the quota and actual usage of the given AzureFrontDoor endpoint under the given CDN profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: _models.ValidateCustomDomainInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateCustomDomainOutput

validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateCustomDomainOutput

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.This api isn’t work for apex domain.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_properties (ValidateCustomDomainInput or IO) – Custom domain to be validated. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

ValidateCustomDomainOutput or the result of cls(response)

Return type

ValidateCustomDomainOutput

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.AFDOriginGroupsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s afd_origin_groups attribute.

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]

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

Creates a new origin group within the specified profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the endpoint. Required.

• origin_group (AFDOriginGroup or IO) – Origin group properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDOriginGroup or the result of cls(response)

Return type

LROPoller[AFDOriginGroup]

Raises

HttpResponseError –

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

Deletes an existing origin group within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

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]

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

Updates an existing origin group within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

• origin_group_update_properties (AFDOriginGroupUpdateParameters or IO) – Origin group properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDOriginGroup or the result of cls(response)

Return type

LROPoller[AFDOriginGroup]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, origin_group_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.AFDOriginGroup

Gets an existing origin group within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the endpoint. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AFDOriginGroup or the result of cls(response)

Return type

AFDOriginGroup

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.AFDOriginGroup]

Lists all of the existing origin groups within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AFDOriginGroup]

Raises

HttpResponseError –

list_resource_usage(resource_group_name: str, profile_name: str, origin_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Usage]

Checks the quota and actual usage of the given AzureFrontDoor origin group under the given CDN profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the endpoint. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.AFDOriginsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s afd_origins attribute.

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]

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

Creates a new origin within the specified origin group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

• origin_name (str) – Name of the origin that is unique within the profile. Required.

• origin (AFDOrigin or IO) – Origin properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDOrigin or the result of cls(response)

Return type

LROPoller[AFDOrigin]

Raises

HttpResponseError –

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

Deletes an existing origin within an origin group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

• origin_name (str) – Name of the origin which is unique within the profile. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

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]

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

Updates an existing origin within an origin group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

• origin_name (str) – Name of the origin which is unique within the profile. Required.

• origin_update_properties (AFDOriginUpdateParameters or IO) – Origin properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 AFDOrigin or the result of cls(response)

Return type

LROPoller[AFDOrigin]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, origin_group_name: str, origin_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.AFDOrigin

Gets an existing origin within an origin group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

• origin_name (str) – Name of the origin which is unique within the profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

AFDOrigin or the result of cls(response)

Return type

AFDOrigin

Raises

HttpResponseError –

list_by_origin_group(resource_group_name: str, profile_name: str, origin_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.AFDOrigin]

Lists all of the existing origins within an origin group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (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 (str) – Name of the origin group which is unique within the profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[AFDOrigin]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.AFDProfilesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s afd_profiles attribute.

check_host_name_availability(resource_group_name: str, profile_name: str, check_host_name_availability_input: _models.CheckHostNameAvailabilityInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

check_host_name_availability(resource_group_name: str, profile_name: str, check_host_name_availability_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

Check the name availability of a host name.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

• check_host_name_availability_input (CheckHostNameAvailabilityInput or IO) – Custom domain to be validated. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Raises

HttpResponseError –

list_resource_usage(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Usage]

Checks the quota and actual usage of AzureFrontDoor endpoints under the given CDN profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.CdnManagementClientOperationsMixin

Bases: azure.mgmt.cdn._vendor.MixinABC

check_endpoint_name_availability(resource_group_name: str, check_endpoint_name_availability_input: _models.CheckEndpointNameAvailabilityInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckEndpointNameAvailabilityOutput

check_endpoint_name_availability(resource_group_name: str, check_endpoint_name_availability_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckEndpointNameAvailabilityOutput

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a afdx endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• check_endpoint_name_availability_input (CheckEndpointNameAvailabilityInput or IO) – Input to check. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckEndpointNameAvailabilityOutput or the result of cls(response)

Return type

CheckEndpointNameAvailabilityOutput

Raises

HttpResponseError –

check_name_availability(check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

check_name_availability(check_name_availability_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

Parameters

check_name_availability_input (CheckNameAvailabilityInput or IO) – Input to check. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Raises

HttpResponseError –

check_name_availability_with_subscription(check_name_availability_input: _models.CheckNameAvailabilityInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

check_name_availability_with_subscription(check_name_availability_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.CheckNameAvailabilityOutput

Check the availability of a resource name. This is needed for resources where name is globally unique, such as a CDN endpoint.

Parameters

check_name_availability_input (CheckNameAvailabilityInput or IO) – Input to check. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

CheckNameAvailabilityOutput or the result of cls(response)

Return type

CheckNameAvailabilityOutput

Raises

HttpResponseError –

validate_probe(validate_probe_input: _models.ValidateProbeInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateProbeOutput

validate_probe(validate_probe_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateProbeOutput

Check if the probe path is a valid path and the file can be accessed. Probe path is the path to a file hosted on the origin server to help accelerate the delivery of dynamic content via the CDN endpoint. This path is relative to the origin path specified in the endpoint configuration.

Parameters

validate_probe_input (ValidateProbeInput or IO) – Input to check. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

ValidateProbeOutput or the result of cls(response)

Return type

ValidateProbeOutput

Raises

HttpResponseError –

class azure.mgmt.cdn.operations.CustomDomainsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s custom_domains attribute.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, custom_domain_properties: _models.CustomDomainParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CustomDomain]

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, custom_domain_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CustomDomain]

Creates a new custom domain within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_name (str) – Name of the custom domain within an endpoint. Required.

• custom_domain_properties (CustomDomainParameters or IO) – Properties required to create a new custom domain. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 CustomDomain or the result of cls(response)

Return type

LROPoller[CustomDomain]

Raises

HttpResponseError –

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

Deletes an existing custom domain within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_name (str) – Name of the custom domain within an endpoint. Required.

Keyword Arguments

• 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 CustomDomain or the result of cls(response)

Return type

LROPoller[CustomDomain]

Raises

HttpResponseError –

begin_disable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.CustomDomain]

Disable https delivery of the custom domain.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_name (str) – Name of the custom domain within an endpoint. Required.

Keyword Arguments

• 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 CustomDomain or the result of cls(response)

Return type

LROPoller[CustomDomain]

Raises

HttpResponseError –

begin_enable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, custom_domain_https_parameters: Optional[_models.CustomDomainHttpsParameters] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CustomDomain]

begin_enable_custom_https(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, custom_domain_https_parameters: Optional[IO] = None, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CustomDomain]

Enable https delivery of the custom domain.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_name (str) – Name of the custom domain within an endpoint. Required.

• custom_domain_https_parameters (CustomDomainHttpsParameters or IO) – The configuration specifying how to enable HTTPS for the custom domain - using CDN managed certificate or user’s own certificate. If not specified, enabling ssl uses CDN managed certificate by default. Is either a model type or a IO type. Default value is None.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 CustomDomain or the result of cls(response)

Return type

LROPoller[CustomDomain]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.CustomDomain

Gets an existing custom domain within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_name (str) – Name of the custom domain within an endpoint. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CustomDomain or the result of cls(response)

Return type

CustomDomain

Raises

HttpResponseError –

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

Lists all of the existing custom domains within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[CustomDomain]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.EdgeNodesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s edge_nodes attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.EdgeNode]

Edgenodes are the global Point of Presence (POP) locations used to deliver CDN content to end users.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[EdgeNode]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.EndpointsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s endpoints attribute.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint: _models.Endpoint, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Endpoint]

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Endpoint]

Creates a new CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• endpoint (Endpoint or IO) – Endpoint properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Endpoint or the result of cls(response)

Return type

LROPoller[Endpoint]

Raises

HttpResponseError –

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

Deletes an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_load_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: _models.LoadParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_load_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Pre-loads a content to CDN. Available for Verizon Profiles.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• content_file_paths (LoadParameters or IO) – The path to the content to be loaded. Path should be a full URL, e.g. ‘/pictures/city.png’ which loads a single file. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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]

Raises

HttpResponseError –

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: _models.PurgeParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

begin_purge_content(resource_group_name: str, profile_name: str, endpoint_name: str, content_file_paths: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[None]

Removes a content from CDN.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• content_file_paths (PurgeParameters or IO) – The path to the content to be purged. Path can be a full URL, e.g. ‘/pictures/city.png’ which removes a single file, or a directory with a wildcard, e.g. ‘/pictures/*’ which removes all folders and files in the directory. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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]

Raises

HttpResponseError –

begin_start(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Endpoint]

Starts an existing CDN endpoint that is on a stopped state.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

• 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 Endpoint or the result of cls(response)

Return type

LROPoller[Endpoint]

Raises

HttpResponseError –

begin_stop(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Endpoint]

Stops an existing running CDN endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

• 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 Endpoint or the result of cls(response)

Return type

LROPoller[Endpoint]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint_update_properties: _models.EndpointUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Endpoint]

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, endpoint_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Endpoint]

Updates an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile. Only tags can be updated after creating an endpoint. To update origins, use the Update Origin operation. To update origin groups, use the Update Origin group operation. To update custom domains, use the Update Custom Domain operation.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• endpoint_update_properties (EndpointUpdateParameters or IO) – Endpoint update properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Endpoint or the result of cls(response)

Return type

LROPoller[Endpoint]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.Endpoint

Gets an existing CDN endpoint with the specified endpoint name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Endpoint or the result of cls(response)

Return type

Endpoint

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Endpoint]

Lists existing CDN endpoints.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Endpoint]

Raises

HttpResponseError –

list_resource_usage(resource_group_name: str, profile_name: str, endpoint_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.ResourceUsage]

Checks the quota and usage of geo filters and custom domains under the given endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ResourceUsage]

Raises

HttpResponseError –

validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: _models.ValidateCustomDomainInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateCustomDomainOutput

validate_custom_domain(resource_group_name: str, profile_name: str, endpoint_name: str, custom_domain_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateCustomDomainOutput

Validates the custom domain mapping to ensure it maps to the correct CDN endpoint in DNS.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• custom_domain_properties (ValidateCustomDomainInput or IO) – Custom domain to be validated. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

ValidateCustomDomainOutput or the result of cls(response)

Return type

ValidateCustomDomainOutput

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.LogAnalyticsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s log_analytics attribute.

get_log_analytics_locations(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.ContinentsResponse

Get all available location names for AFD log analytics report.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContinentsResponse or the result of cls(response)

Return type

ContinentsResponse

Raises

HttpResponseError –

get_log_analytics_metrics(resource_group_name: str, profile_name: str, metrics: List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.LogMetric]], date_time_begin: datetime.datetime, date_time_end: datetime.datetime, granularity: Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.LogMetricsGranularity], custom_domains: List[str], protocols: List[str], group_by: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.LogMetricsGroupBy]]] = None, continents: Optional[List[str]] = None, country_or_regions: Optional[List[str]] = None, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.MetricsResponse

Get log report for AFD profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group. Required.

• metrics (list[str or LogMetric]) – Required.

• date_time_begin (datetime) – Required.

• date_time_end (datetime) – Required.

• granularity (str or LogMetricsGranularity) – Known values are: “PT5M”, “PT1H”, and “P1D”. Required.

• custom_domains (list[str]) – Required.

• protocols (list[str]) – Required.

• group_by (list[str or LogMetricsGroupBy]) – Default value is None.

• continents (list[str]) – Default value is None.

• country_or_regions (list[str]) – Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

MetricsResponse or the result of cls(response)

Return type

MetricsResponse

Raises

HttpResponseError –

get_log_analytics_rankings(resource_group_name: str, profile_name: str, rankings: List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.LogRanking]], metrics: List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.LogRankingMetric]], max_ranking: int, date_time_begin: datetime.datetime, date_time_end: datetime.datetime, custom_domains: Optional[List[str]] = None, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.RankingsResponse

Get log analytics ranking report for AFD profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group. Required.

• rankings (list[str or LogRanking]) – Required.

• metrics (list[str or LogRankingMetric]) – Required.

• max_ranking (int) – Required.

• date_time_begin (datetime) – Required.

• date_time_end (datetime) – Required.

• custom_domains (list[str]) – Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RankingsResponse or the result of cls(response)

Return type

RankingsResponse

Raises

HttpResponseError –

get_log_analytics_resources(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.ResourcesResponse

Get all endpoints and custom domains available for AFD log report.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ResourcesResponse or the result of cls(response)

Return type

ResourcesResponse

Raises

HttpResponseError –

get_waf_log_analytics_metrics(resource_group_name: str, profile_name: str, metrics: List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafMetric]], date_time_begin: datetime.datetime, date_time_end: datetime.datetime, granularity: Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafGranularity], actions: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafAction]]] = None, group_by: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafRankingGroupBy]]] = None, rule_types: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafRuleType]]] = None, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.WafMetricsResponse

Get Waf related log analytics report for AFD profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group. Required.

• metrics (list[str or WafMetric]) – Required.

• date_time_begin (datetime) – Required.

• date_time_end (datetime) – Required.

• granularity (str or WafGranularity) – Known values are: “PT5M”, “PT1H”, and “P1D”. Required.

• actions (list[str or WafAction]) – Default value is None.

• group_by (list[str or WafRankingGroupBy]) – Default value is None.

• rule_types (list[str or WafRuleType]) – Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WafMetricsResponse or the result of cls(response)

Return type

WafMetricsResponse

Raises

HttpResponseError –

get_waf_log_analytics_rankings(resource_group_name: str, profile_name: str, metrics: List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafMetric]], date_time_begin: datetime.datetime, date_time_end: datetime.datetime, max_ranking: int, rankings: List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafRankingType]], actions: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafAction]]] = None, rule_types: Optional[List[Union[str, azure.mgmt.cdn.models._cdn_management_client_enums.WafRuleType]]] = None, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.WafRankingsResponse

Get WAF log analytics charts for AFD profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. which is unique within the resource group. Required.

• metrics (list[str or WafMetric]) – Required.

• date_time_begin (datetime) – Required.

• date_time_end (datetime) – Required.

• max_ranking (int) – Required.

• rankings (list[str or WafRankingType]) – Required.

• actions (list[str or WafAction]) – Default value is None.

• rule_types (list[str or WafRuleType]) – Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

WafRankingsResponse or the result of cls(response)

Return type

WafRankingsResponse

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.ManagedRuleSetsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s managed_rule_sets attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.ManagedRuleSetDefinition]

Lists all available managed rule sets.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ManagedRuleSetDefinition]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.Operations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Operation]

Lists all of the available CDN REST API operations.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Operation]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.OriginGroupsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s origin_groups attribute.

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]

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, origin_group_name: str, origin_group: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OriginGroup]

Creates a new origin group within the specified endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_group_name (str) – Name of the origin group which is unique within the endpoint. Required.

• origin_group (OriginGroup or IO) – Origin group properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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]

Raises

HttpResponseError –

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

Deletes an existing origin group within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_group_name (str) – Name of the origin group which is unique within the endpoint. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

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]

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, origin_group_name: str, origin_group_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.OriginGroup]

Updates an existing origin group within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_group_name (str) – Name of the origin group which is unique within the endpoint. Required.

• origin_group_update_properties (OriginGroupUpdateParameters or IO) – Origin group properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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]

Raises

HttpResponseError –

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

Gets an existing origin group within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_group_name (str) – Name of the origin group which is unique within the endpoint. Required.

Keyword Arguments

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

Raises

HttpResponseError –

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

Lists all of the existing origin groups within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[OriginGroup]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.OriginsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s origins attribute.

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) → LROPoller[_models.Origin]

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, origin: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Origin]

Creates a new origin within the specified endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_name (str) – Name of the origin that is unique within the endpoint. Required.

• origin (Origin or IO) – Origin properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Origin or the result of cls(response)

Return type

LROPoller[Origin]

Raises

HttpResponseError –

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

Deletes an existing origin within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_name (str) – Name of the origin which is unique within the endpoint. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

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) → LROPoller[_models.Origin]

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, origin_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Origin]

Updates an existing origin within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_name (str) – Name of the origin which is unique within the endpoint. Required.

• origin_update_properties (OriginUpdateParameters or IO) – Origin properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Origin or the result of cls(response)

Return type

LROPoller[Origin]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, endpoint_name: str, origin_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.Origin

Gets an existing origin within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• origin_name (str) – Name of the origin which is unique within the endpoint. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Origin or the result of cls(response)

Return type

Origin

Raises

HttpResponseError –

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

Lists all of the existing origins within an endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Origin]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.PoliciesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s policies attribute.

begin_create_or_update(resource_group_name: str, policy_name: str, cdn_web_application_firewall_policy: _models.CdnWebApplicationFirewallPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CdnWebApplicationFirewallPolicy]

begin_create_or_update(resource_group_name: str, policy_name: str, cdn_web_application_firewall_policy: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CdnWebApplicationFirewallPolicy]

Create or update policy with specified rule set name within a resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• policy_name (str) – The name of the CdnWebApplicationFirewallPolicy. Required.

• cdn_web_application_firewall_policy (CdnWebApplicationFirewallPolicy or IO) – Policy to be created. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 CdnWebApplicationFirewallPolicy or the result of cls(response)

Return type

LROPoller[CdnWebApplicationFirewallPolicy]

Raises

HttpResponseError –

begin_update(resource_group_name: str, policy_name: str, cdn_web_application_firewall_policy_patch_parameters: _models.CdnWebApplicationFirewallPolicyPatchParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CdnWebApplicationFirewallPolicy]

begin_update(resource_group_name: str, policy_name: str, cdn_web_application_firewall_policy_patch_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.CdnWebApplicationFirewallPolicy]

Update an existing CdnWebApplicationFirewallPolicy with the specified policy name under the specified subscription and resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• policy_name (str) – The name of the CdnWebApplicationFirewallPolicy. Required.

• cdn_web_application_firewall_policy_patch_parameters (CdnWebApplicationFirewallPolicyPatchParameters or IO) – CdnWebApplicationFirewallPolicy parameters to be patched. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 CdnWebApplicationFirewallPolicy or the result of cls(response)

Return type

LROPoller[CdnWebApplicationFirewallPolicy]

Raises

HttpResponseError –

delete(resource_group_name: str, policy_name: str, **kwargs: Any) → None

Deletes Policy.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• policy_name (str) – The name of the CdnWebApplicationFirewallPolicy. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

get(resource_group_name: str, policy_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.CdnWebApplicationFirewallPolicy

Retrieve protection policy with specified name within a resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• policy_name (str) – The name of the CdnWebApplicationFirewallPolicy. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

CdnWebApplicationFirewallPolicy or the result of cls(response)

Return type

CdnWebApplicationFirewallPolicy

Raises

HttpResponseError –

list(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.CdnWebApplicationFirewallPolicy]

Lists all of the protection policies within a resource group.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[CdnWebApplicationFirewallPolicy]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.ProfilesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s profiles attribute.

begin_create(resource_group_name: str, profile_name: str, profile: _models.Profile, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile]

begin_create(resource_group_name: str, profile_name: str, profile: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile]

Creates a new Azure Front Door Standard or Azure Front Door Premium or CDN profile with a profile name under the specified subscription and resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

• profile (Profile or IO) – Profile properties needed to create a new profile. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Profile or the result of cls(response)

Return type

LROPoller[Profile]

Raises

HttpResponseError –

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

Deletes an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified parameters. Deleting a profile will result in the deletion of all of the sub-resources including endpoints, origins and custom domains.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, profile_update_parameters: _models.ProfileUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile]

begin_update(resource_group_name: str, profile_name: str, profile_update_parameters: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Profile]

Updates an existing Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

• profile_update_parameters (ProfileUpdateParameters or IO) – Profile properties needed to update an existing profile. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Profile or the result of cls(response)

Return type

LROPoller[Profile]

Raises

HttpResponseError –

generate_sso_uri(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.SsoUri

Generates a dynamic SSO URI used to sign in to the CDN supplemental portal. Supplemental portal is used to configure advanced feature capabilities that are not yet available in the Azure portal, such as core reports in a standard profile; rules engine, advanced HTTP reports, and real-time stats and alerts in a premium profile. The SSO URI changes approximately every 10 minutes.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SsoUri or the result of cls(response)

Return type

SsoUri

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.Profile

Gets an Azure Front Door Standard or Azure Front Door Premium or CDN profile with the specified profile name under the specified subscription and resource group.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Profile or the result of cls(response)

Return type

Profile

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Profile]

Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within an Azure subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Profile]

Raises

HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Profile]

Lists all of the Azure Front Door Standard, Azure Front Door Premium, and CDN profiles within a resource group.

Parameters

resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Profile]

Raises

HttpResponseError –

list_resource_usage(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.ResourceUsage]

Checks the quota and actual usage of endpoints under the given Azure Front Door Standard or Azure Front Door Premium or CDN profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ResourceUsage]

Raises

HttpResponseError –

list_supported_optimization_types(resource_group_name: str, profile_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.SupportedOptimizationTypesListResult

Gets the supported optimization types for the current profile. A user can create an endpoint with an optimization type from the listed values.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SupportedOptimizationTypesListResult or the result of cls(response)

Return type

SupportedOptimizationTypesListResult

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.ResourceUsageOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s resource_usage attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.ResourceUsage]

Check the quota and actual usage of the CDN profiles under the given subscription.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[ResourceUsage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.RoutesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s routes attribute.

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, route: _models.Route, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Route]

begin_create(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, route: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Route]

Creates a new route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• route_name (str) – Name of the routing rule. Required.

• route (Route or IO) – Route properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Route or the result of cls(response)

Return type

LROPoller[Route]

Raises

HttpResponseError –

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

Deletes an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• route_name (str) – Name of the routing rule. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, route_update_properties: _models.RouteUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Route]

begin_update(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, route_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Route]

Updates an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• route_name (str) – Name of the routing rule. Required.

• route_update_properties (RouteUpdateParameters or IO) – Route update properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Route or the result of cls(response)

Return type

LROPoller[Route]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, endpoint_name: str, route_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.Route

Gets an existing route with the specified route name under the specified subscription, resource group, profile, and AzureFrontDoor endpoint.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

• route_name (str) – Name of the routing rule. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Route or the result of cls(response)

Return type

Route

Raises

HttpResponseError –

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

Lists all of the existing origins within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• endpoint_name (str) – Name of the endpoint under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Route]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.RuleSetsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s rule_sets attribute.

begin_delete(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile which is unique globally. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

create(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.RuleSet

Creates a new rule set within the specified profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RuleSet or the result of cls(response)

Return type

RuleSet

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.RuleSet

Gets an existing AzureFrontDoor rule set with the specified rule set name under the specified subscription, resource group and profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

RuleSet or the result of cls(response)

Return type

RuleSet

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.RuleSet]

Lists existing AzureFrontDoor rule sets within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[RuleSet]

Raises

HttpResponseError –

list_resource_usage(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Usage]

Checks the quota and actual usage of the given AzureFrontDoor rule set under the given CDN profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile which is unique globally. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Usage]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.RulesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s rules attribute.

begin_create(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, rule: _models.Rule, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Rule]

begin_create(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, rule: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Rule]

Creates a new delivery rule within the specified rule set.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile. Required.

• rule_name (str) – Name of the delivery rule which is unique within the endpoint. Required.

• rule (Rule or IO) – The delivery rule properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Rule or the result of cls(response)

Return type

LROPoller[Rule]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing delivery rule within a rule set.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile. Required.

• rule_name (str) – Name of the delivery rule which is unique within the endpoint. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_update(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, rule_update_properties: _models.RuleUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Rule]

begin_update(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, rule_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Rule]

Updates an existing delivery rule within a rule set.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile. Required.

• rule_name (str) – Name of the delivery rule which is unique within the endpoint. Required.

• rule_update_properties (RuleUpdateParameters or IO) – Delivery rule properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Rule or the result of cls(response)

Return type

LROPoller[Rule]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.Rule

Gets an existing delivery rule within a rule set.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile. Required.

• rule_name (str) – Name of the delivery rule which is unique within the endpoint. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Rule or the result of cls(response)

Return type

Rule

Raises

HttpResponseError –

list_by_rule_set(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Rule]

Lists all of the existing delivery rules within a rule set.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• rule_set_name (str) – Name of the rule set under the profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Rule]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.SecretsOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s secrets attribute.

begin_create(resource_group_name: str, profile_name: str, secret_name: str, secret: _models.Secret, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Secret]

begin_create(resource_group_name: str, profile_name: str, secret_name: str, secret: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.Secret]

Creates a new Secret within the specified profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• secret_name (str) – Name of the Secret under the profile. Required.

• secret (Secret or IO) – The Secret properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 Secret or the result of cls(response)

Return type

LROPoller[Secret]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, profile_name: str, secret_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing Secret within profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• secret_name (str) – Name of the Secret under the profile. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, secret_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.Secret

Gets an existing Secret within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• secret_name (str) – Name of the Secret under the profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Secret or the result of cls(response)

Return type

Secret

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.Secret]

Lists existing AzureFrontDoor secrets.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[Secret]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.SecurityPoliciesOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s security_policies attribute.

begin_create(resource_group_name: str, profile_name: str, security_policy_name: str, security_policy: _models.SecurityPolicy, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityPolicy]

begin_create(resource_group_name: str, profile_name: str, security_policy_name: str, security_policy: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityPolicy]

Creates a new security policy within the specified profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• security_policy_name (str) – Name of the security policy under the profile. Required.

• security_policy (SecurityPolicy or IO) – The security policy properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 SecurityPolicy or the result of cls(response)

Return type

LROPoller[SecurityPolicy]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, profile_name: str, security_policy_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None]

Deletes an existing security policy within profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• security_policy_name (str) – Name of the security policy under the profile. Required.

Keyword Arguments

• 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]

Raises

HttpResponseError –

begin_patch(resource_group_name: str, profile_name: str, security_policy_name: str, security_policy_update_properties: _models.SecurityPolicyUpdateParameters, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityPolicy]

begin_patch(resource_group_name: str, profile_name: str, security_policy_name: str, security_policy_update_properties: IO, *, content_type: str = "'application/json'", **kwargs: Any) → LROPoller[_models.SecurityPolicy]

Updates an existing security policy within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• security_policy_name (str) – Name of the security policy under the profile. Required.

• security_policy_update_properties (SecurityPolicyUpdateParameters or IO) – Security policy update properties. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• 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 SecurityPolicy or the result of cls(response)

Return type

LROPoller[SecurityPolicy]

Raises

HttpResponseError –

get(resource_group_name: str, profile_name: str, security_policy_name: str, **kwargs: Any) → azure.mgmt.cdn.models._models_py3.SecurityPolicy

Gets an existing security policy within a profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

• security_policy_name (str) – Name of the security policy under the profile. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

SecurityPolicy or the result of cls(response)

Return type

SecurityPolicy

Raises

HttpResponseError –

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) → Iterable[azure.mgmt.cdn.models._models_py3.SecurityPolicy]

Lists security policies associated with the profile.

Parameters

• resource_group_name (str) – Name of the Resource group within the Azure subscription. Required.

• profile_name (str) – Name of the Azure Front Door Standard or Azure Front Door Premium profile which is unique within the resource group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

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

Return type

ItemPaged[SecurityPolicy]

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>

class azure.mgmt.cdn.operations.ValidateOperations(*args, **kwargs)

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through CdnManagementClient’s validate attribute.

secret(validate_secret_input: _models.ValidateSecretInput, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateSecretOutput

secret(validate_secret_input: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ValidateSecretOutput

Validate a Secret in the profile.

Parameters

validate_secret_input (ValidateSecretInput or IO) – The Secret source. Is either a model type or a IO type. Required.

Keyword Arguments

• content_type (str) – Body Parameter content-type. Known values are: ‘application/json’. Default value is None.

• cls (callable) – A custom type or function that will be passed the direct response

Returns

ValidateSecretOutput or the result of cls(response)

Return type

ValidateSecretOutput

Raises

HttpResponseError –

models = <module 'azure.mgmt.cdn.models' from '/mnt/vss/_work/1/s/sdk/cdn/azure-mgmt-cdn/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/cdn/models/__init__.py'>