RulesOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

CdnManagementClient's

<xref:rules> attribute.

Inheritance
builtins.object
RulesOperations

Constructor

RulesOperations(*args, **kwargs)

Methods

begin_create

Creates a new delivery rule within the specified rule set.
begin_delete

Deletes an existing delivery rule within a rule set.
begin_update

Updates an existing delivery rule within a rule set.
get

Gets an existing delivery rule within a rule set.
list_by_rule_set

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

begin_create

Creates a new delivery rule within the specified rule set.

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]

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. Required.
rule_name
Required
str

Name of the delivery rule which is unique within the endpoint. Required.
rule
Required
Rule or IO[bytes]

The delivery rule properties. Is either a Rule type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Rule]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes an existing delivery rule within a rule set.

begin_delete(resource_group_name: str, profile_name: str, rule_set_name: str, rule_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 profile which is unique within the resource group. Required.
rule_set_name
Required
str

Name of the rule set under the profile. Required.
rule_name
Required
str

Name of the delivery rule which is unique within the endpoint. 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 delivery rule within a rule set.

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]

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. Required.
rule_name
Required
str

Name of the delivery rule which is unique within the endpoint. Required.
rule_update_properties
Required
RuleUpdateParameters or IO[bytes]

Delivery rule properties. Is either a RuleUpdateParameters type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[Rule]

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

Exceptions

Type Description
HttpResponseError

get

Gets an existing delivery rule within a rule set.

get(resource_group_name: str, profile_name: str, rule_set_name: str, rule_name: str, **kwargs: Any) -> Rule

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. Required.
rule_name
Required
str

Name of the delivery rule which is unique within the endpoint. Required.

Returns

Type Description
Rule

Rule or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list_by_rule_set

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

list_by_rule_set(resource_group_name: str, profile_name: str, rule_set_name: str, **kwargs: Any) -> Iterable[Rule]

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. Required.

Returns

Type Description
ItemPaged[Rule]

An iterator like instance of either Rule 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.9\\x64\\Lib\\site-packages\\azure\\mgmt\\cdn\\models\\__init__.py'>