SubscriptionsOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:subscriptions> attribute.
- Inheritance
-
builtins.objectSubscriptionsOperations
Constructor
SubscriptionsOperations(*args, **kwargs)Methods
| create_or_update |
Creates a topic subscription. |
| delete |
Deletes a subscription from the specified topic. |
| get |
Returns a subscription description for the specified topic. |
| list_all |
List all the subscriptions under a specified topic. |
create_or_update
Creates a topic subscription.
async create_or_update(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, parameters: _models.SubscriptionCreateOrUpdateParameters, *, content_type: str = 'application/json', **kwargs: Any) -> _models.SubscriptionResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
subscription_name
Required
|
The subscription name. Required. |
|
parameters
Required
|
Parameters supplied to create a subscription resource. Is either a SubscriptionCreateOrUpdateParameters type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
SubscriptionResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
delete
Deletes a subscription from the specified topic.
async delete(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, **kwargs: Any) -> NoneParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
subscription_name
Required
|
The subscription name. Required. |
Returns
| Type | Description |
|---|---|
|
None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Returns a subscription description for the specified topic.
async get(resource_group_name: str, namespace_name: str, topic_name: str, subscription_name: str, **kwargs: Any) -> SubscriptionResourceParameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
|
subscription_name
Required
|
The subscription name. Required. |
Returns
| Type | Description |
|---|---|
|
SubscriptionResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list_all
List all the subscriptions under a specified topic.
list_all(resource_group_name: str, namespace_name: str, topic_name: str, **kwargs: Any) -> AsyncIterable[SubscriptionResource]Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
Name of the Resource group within the Azure subscription. Required. |
|
namespace_name
Required
|
The namespace name. Required. |
|
topic_name
Required
|
The topic name. Required. |
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either SubscriptionResource or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.servicebus.v2015_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\servicebus\\v2015_08_01\\models\\__init__.py'>
Azure SDK for Python