Share via

ProfilesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:profiles> attribute.

Constructor

ProfilesOperations(*args, **kwargs)

Methods

begin_can_migrate

Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.
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_migrate

Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.
begin_migration_commit

Commit the migrated Azure Frontdoor(Standard/Premium) profile.
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_can_migrate

Checks if CDN profile can be migrated to Azure Frontdoor(Standard/Premium) profile.

begin_can_migrate(resource_group_name: str, can_migrate_parameters: _models.CanMigrateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.CanMigrateResult]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
can_migrate_parameters
Required
CanMigrateParameters or IO[bytes]

Properties needed to check if cdn profile or classic frontdoor can be migrated. Is either a CanMigrateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[CanMigrateResult]

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

Exceptions

Type Description
HttpResponseError

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: _models.Profile, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Profile]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
profile
Required
Profile or IO[bytes]

Profile properties needed to create a new profile. Is either a Profile type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Profile]

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

Exceptions

Type Description
HttpResponseError

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) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_migrate

Migrate the CDN profile to Azure Frontdoor(Standard/Premium) profile. The change need to be committed after this.

begin_migrate(resource_group_name: str, migration_parameters: _models.MigrationParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.MigrateResult]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
migration_parameters
Required
MigrationParameters or IO[bytes]

Properties needed to migrate the profile. Is either a MigrationParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[MigrateResult]

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

Exceptions

Type Description
HttpResponseError

begin_migration_commit

Commit the migrated Azure Frontdoor(Standard/Premium) profile.

begin_migration_commit(resource_group_name: str, profile_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

begin_update

Updates an existing 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: _models.ProfileUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.Profile]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

Name of the Azure Front Door Standard or Azure Front Door Premium or CDN profile which is unique within the resource group. Required.
profile_update_parameters
Required
ProfileUpdateParameters or IO[bytes]

Profile properties needed to update an existing profile. Is either a ProfileUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Profile]

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

Exceptions

Type Description
HttpResponseError

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) -> SsoUri

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Returns

Type Description
SsoUri

SsoUri or the result of cls(response)

Exceptions

Type Description
HttpResponseError

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) -> Profile

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Returns

Type Description
Profile

Profile or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

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

list(**kwargs: Any) -> Iterable[Profile]

Returns

Type Description
ItemPaged[Profile]

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

Exceptions

Type Description
HttpResponseError

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[Profile]

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.

Returns

Type Description
ItemPaged[Profile]

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

Exceptions

Type Description
HttpResponseError

list_resource_usage

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

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

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Returns

Type Description
ItemPaged[ResourceUsage]

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

Exceptions

Type Description
HttpResponseError

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) -> SupportedOptimizationTypesListResult

Parameters

Name Description
resource_group_name
Required
str

Name of the Resource group within the Azure subscription. Required.
profile_name
Required
str

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

Returns

Type Description
SupportedOptimizationTypesListResult

SupportedOptimizationTypesListResult or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.cdn.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv77\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>