ServiceBusSubscriptionCollection Class

Definition

A class representing a collection of ServiceBusSubscriptionResource and their operations. Each ServiceBusSubscriptionResource in the collection will belong to the same instance of ServiceBusTopicResource. To get a ServiceBusSubscriptionCollection instance call the GetServiceBusSubscriptions method from an instance of ServiceBusTopicResource.

public class ServiceBusSubscriptionCollection : Azure.ResourceManager.ArmCollection, System.Collections.Generic.IAsyncEnumerable<Azure.ResourceManager.ServiceBus.ServiceBusSubscriptionResource>, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ServiceBus.ServiceBusSubscriptionResource>
type ServiceBusSubscriptionCollection = class
    inherit ArmCollection
    interface seq<ServiceBusSubscriptionResource>
    interface IEnumerable
    interface IAsyncEnumerable<ServiceBusSubscriptionResource>
Public Class ServiceBusSubscriptionCollection
Inherits ArmCollection
Implements IAsyncEnumerable(Of ServiceBusSubscriptionResource), IEnumerable(Of ServiceBusSubscriptionResource)
Inheritance
ServiceBusSubscriptionCollection
Implements

Constructors

ServiceBusSubscriptionCollection()

Initializes a new instance of the ServiceBusSubscriptionCollection class for mocking.

Properties

Client

Gets the ArmClient this resource client was created from.

(Inherited from ArmCollection)
Diagnostics

Gets the diagnostic options for this resource client.

(Inherited from ArmCollection)
Endpoint

Gets the base uri for this resource client.

(Inherited from ArmCollection)
Id

Gets the resource identifier.

(Inherited from ArmCollection)
Pipeline

Gets the pipeline for this resource client.

(Inherited from ArmCollection)

Methods

CreateOrUpdate(WaitUntil, String, ServiceBusSubscriptionData, CancellationToken)

Creates a topic subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_CreateOrUpdate
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
CreateOrUpdateAsync(WaitUntil, String, ServiceBusSubscriptionData, CancellationToken)

Creates a topic subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_CreateOrUpdate
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_Get
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_Get
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
Get(String, CancellationToken)

Returns a subscription description for the specified topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_Get
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
GetAll(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List all the subscriptions under a specified topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions
  • Operation Id: Subscriptions_ListByTopic
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
GetAllAsync(Nullable<Int32>, Nullable<Int32>, CancellationToken)

List all the subscriptions under a specified topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions
  • Operation Id: Subscriptions_ListByTopic
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
GetAsync(String, CancellationToken)

Returns a subscription description for the specified topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_Get
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_Get
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ServiceBus/namespaces/{namespaceName}/topics/{topicName}/subscriptions/{subscriptionName}
  • Operation Id: Subscriptions_Get
  • Default Api Version: 2024-01-01
  • Resource: ServiceBusSubscriptionResource
TryGetApiVersion(ResourceType, String)

Gets the api version override if it has been set for the current client options.

(Inherited from ArmCollection)

Explicit Interface Implementations

IAsyncEnumerable<ServiceBusSubscriptionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<ServiceBusSubscriptionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to