Share via

RuleProperties Class

Properties of a topic subscription rule.

Please use get_rule, create_rule, or list_rules on the ServiceBusAdministrationClient to get a RuleProperties instance instead of instantiating a RuleProperties object directly.

Constructor

RuleProperties(name: str, *, filter: CorrelationRuleFilter | SqlRuleFilter | None, action: SqlRuleAction | None, created_at_utc: datetime | None)

Parameters

Name Description
name
Required
str

Name of the rule.

Keyword-Only Parameters

Name Description
filter
CorrelationRuleFilter or SqlRuleFilter or None

The filter of the rule.
action
SqlRuleAction or None

The action of the rule.
created_at_utc
datetime or None

The exact time the rule was created.

Variables

Name Description
name
str

Name of the rule.
filter
CorrelationRuleFilter or SqlRuleFilter or None

The filter of the rule.
action
SqlRuleAction or None

The action of the rule.
created_at_utc
datetime or None

The exact time the rule was created.

Methods

get
has_key
items
keys
update
values

get 

get(key: str, default: Any | None = None) -> Any

Parameters

Name Description
key
Required
default
Default value: None

has_key 

has_key(k: str) -> bool

Parameters

Name Description
k
Required

items 

items() -> List[Tuple[str, Any]]

keys 

keys() -> List[str]

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> List[Any]