RulesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ServiceBusManagementClient's

<xref:rules> attribute.

Inheritance

builtins.object

RulesOperations

Constructor

RulesOperations(*args, **kwargs)

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.

create_or_update(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, rule_name: str, parameters: _models.Rule, *, content_type: str = 'application/json', **kwargs: Any) -> _models.Rule

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.
rule_name Required	str The rule name. Required.
parameters Required	Rule or IO Parameters supplied to create a rule. Is either a Rule type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Rule	Rule or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

delete

Deletes an existing rule.

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

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.
rule_name Required	str The rule name. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Retrieves the description for the specified rule.

get(resource_group_name: str, namespace_name: str, topic_name: str, subscription_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.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.
rule_name Required	str The rule name. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
Rule	Rule or the result of cls(response)

Exceptions

Type	Description
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: int | None = None, top: int | None = None, **kwargs: Any) -> Iterable[Rule]

Parameters

Name	Description
resource_group_name Required	str Name of the Resource group within the Azure subscription. Required.
namespace_name Required	str The namespace name. Required.
topic_name Required	str The topic name. Required.
subscription_name Required	str The subscription name. Required.
skip Required	int 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. Default value is None.
top Required	int May be used to limit the number of results to the most recent N usageDetails. Default value is None.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

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.servicebus.v2021_01_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2021_01_01_preview\\models\\__init__.py'>