RuleSetsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:rule_sets> attribute.

Constructor

RuleSetsOperations(*args, **kwargs)

Methods

begin_delete

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

Creates a new rule set within the specified profile.
get

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

Lists existing AzureFrontDoor rule sets within a profile.
list_resource_usage

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

begin_delete

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

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

Parameters

Name Description
resource_group_name
Required
str

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

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

Name of the rule set under the profile which is unique globally. Required.

Keyword-Only Parameters

Name Description
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 AsyncPollingMethod

By default, your polling method will be AsyncARMPolling. 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

Type Description
AsyncLROPoller[None]

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

Exceptions

Type Description
HttpResponseError

create

Creates a new rule set within the specified profile.

async create(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) -> RuleSet

Parameters

Name Description
resource_group_name
Required
str

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

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

Name of the rule set under the profile which is unique globally. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
RuleSet

RuleSet or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

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

async get(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) -> RuleSet

Parameters

Name Description
resource_group_name
Required
str

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

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

Name of the rule set under the profile which is unique globally. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
RuleSet

RuleSet or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_profile

Lists existing AzureFrontDoor rule sets within a profile.

list_by_profile(resource_group_name: str, profile_name: str, **kwargs: Any) -> AsyncIterable[RuleSet]

Parameters

Name Description
resource_group_name
Required
str

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

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

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AsyncItemPaged[RuleSet]

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

Exceptions

Type Description
HttpResponseError

list_resource_usage

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

list_resource_usage(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) -> AsyncIterable[Usage]

Parameters

Name Description
resource_group_name
Required
str

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

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

Name of the rule set under the profile which is unique globally. Required.

Keyword-Only Parameters

Name Description
cls
callable

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

Returns

Type Description
AsyncItemPaged[Usage]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.cdn.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv99\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>