RulesOperations Class

RulesOperations 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

RulesOperations

Constructor

RulesOperations(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 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: azure.mgmt.cdn.models._models_py3.Rule, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Rule]

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 profile which is unique within the resource group.

rule_set_name

str

Required

Name of the rule set under the profile.

rule_name

str

Required

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

rule

Rule

Required

The delivery rule properties.

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]

Exceptions

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) -> 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 profile which is unique within the resource group.

rule_set_name

str

Required

Name of the rule set under the profile.

rule_name

str

Required

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

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]

Exceptions

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: azure.mgmt.cdn.models._models_py3.RuleUpdateParameters, **kwargs: Any) -> azure.core.polling._poller.LROPoller[azure.mgmt.cdn.models._models_py3.Rule]

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 profile which is unique within the resource group.

rule_set_name

str

Required

Name of the rule set under the profile.

rule_name

str

Required

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

rule_update_properties

RuleUpdateParameters

Required

Delivery rule properties.

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]

Exceptions

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) -> azure.mgmt.cdn.models._models_py3.Rule

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 profile which is unique within the resource group.

rule_set_name

str

Required

Name of the rule set under the profile.

rule_name

str

Required

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

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

Exceptions

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[azure.mgmt.cdn.models._models_py3.RuleListResult]

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 profile which is unique within the resource group.

rule_set_name

str

Required

Name of the rule set under the profile.

cls

callable

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

Returns

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

Return type

ItemPaged[RuleListResult]

Exceptions

HttpResponseError

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'>