ProfilesOperations Class

ProfilesOperations operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
ProfilesOperations

Constructor

ProfilesOperations(client, config, serializer, deserializer)

Parameters

client
Required

Client for service requests.

config
Required

Configuration of service client.

serializer
Required

An object model serializer.

deserializer
Required

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create

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.

begin_delete

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.

begin_update

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.

generate_sso_uri

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.

get

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.

list

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

list_by_resource_group

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

list_resource_usage

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

list_supported_optimization_types

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

begin_create

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.

begin_create(resource_group_name: str, profile_name: str, profile: azure.mgmt.cdn.models._models_py3.Profile, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Profile]

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

profile
Profile
Required

Profile properties needed to create a new profile.

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

Exceptions

begin_delete

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.

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

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

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

Exceptions

begin_update

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.

begin_update(resource_group_name: str, profile_name: str, profile_update_parameters: azure.mgmt.cdn.models._models_py3.ProfileUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Profile]

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

profile_update_parameters
ProfileUpdateParameters
Required

Profile properties needed to update an existing profile.

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

Exceptions

generate_sso_uri

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.

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

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

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

cls
callable

A custom type or function that will be passed the direct response

Returns

SsoUri, or the result of cls(response)

Return type

Exceptions

get

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.

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

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

Profile, or the result of cls(response)

Return type

Exceptions

list

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

list(**kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.ProfileListResult]

Parameters

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

list_by_resource_group

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

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[azure.mgmt.cdn.models._models_py3.ProfileListResult]

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

list_resource_usage

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

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

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

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

Return type

Exceptions

list_supported_optimization_types

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

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

Parameters

resource_group_name
str
Required

Name of the Resource group within the Azure subscription.

profile_name
str
Required

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group.

cls
callable

A custom type or function that will be passed the direct response

Returns

SupportedOptimizationTypesListResult, or the result of cls(response)

Return type

Exceptions

Attributes

models

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