RulesOperations Class

RulesOperations async 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

create_or_update	Creates a new rule and updates an existing rule.
delete	Deletes an existing rule.
get	Retrieves the description for the specified rule.
list_by_subscriptions	List all the rules within given topic-subscription.

create_or_update

Creates a new rule and updates an existing rule.

async create_or_update(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, rule_name: str, parameters: azure.mgmt.servicebus.v2017_04_01.models._models_py3.Rule, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.Rule

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

rule_name

str

Required

The rule name.

parameters

<xref:azure.mgmt.servicebus.models.Rule>

Required

Parameters supplied to create a rule.

cls

callable

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

Returns

Rule, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.Rule>

Exceptions

HttpResponseError

delete

Deletes an existing rule.

async delete(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, rule_name: str, **kwargs) -> None

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

rule_name

str

Required

The rule name.

cls

callable

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

Returns

None, or the result of cls(response)

Return type

None

Exceptions

HttpResponseError

get

Retrieves the description for the specified rule.

async get(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, rule_name: str, **kwargs) -> azure.mgmt.servicebus.v2017_04_01.models._models_py3.Rule

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

rule_name

str

Required

The rule name.

cls

callable

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

Returns

Rule, or the result of cls(response)

Return type

<xref:azure.mgmt.servicebus.models.Rule>

Exceptions

HttpResponseError

list_by_subscriptions

List all the rules within given topic-subscription.

list_by_subscriptions(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, skip: Optional[int] = None, top: Optional[int] = None, **kwargs) -> AsyncIterable[azure.mgmt.servicebus.v2017_04_01.models._models_py3.RuleListResult]

Parameters

resource_group_name

str

Required

Name of the Resource group within the Azure subscription.

namespace_name

str

Required

The namespace name.

topic_name

str

Required

The topic name.

subscription_name

str

Required

The subscription name.

skip

int

default value: None

Skip is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skip parameter that specifies a starting point to use for subsequent calls.

top

int

default value: None

May be used to limit the number of results to the most recent N usageDetails.

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

AsyncItemPaged[<xref:azure.mgmt.servicebus.models.RuleListResult>]

Exceptions

HttpResponseError

Attributes

models

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