Share via


TopicEventSubscriptionCollection Class

Definition

A class representing a collection of TopicEventSubscriptionResource and their operations. Each TopicEventSubscriptionResource in the collection will belong to the same instance of EventGridTopicResource. To get a TopicEventSubscriptionCollection instance call the GetTopicEventSubscriptions method from an instance of EventGridTopicResource.

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

Constructors

TopicEventSubscriptionCollection()

Initializes a new instance of the TopicEventSubscriptionCollection 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, EventGridSubscriptionData, CancellationToken)

Asynchronously creates a new event subscription or updates an existing event subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_CreateOrUpdate
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
CreateOrUpdateAsync(WaitUntil, String, EventGridSubscriptionData, CancellationToken)

Asynchronously creates a new event subscription or updates an existing event subscription.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_CreateOrUpdate
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
Exists(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_Get
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
ExistsAsync(String, CancellationToken)

Checks to see if the resource exists in azure.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_Get
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
Get(String, CancellationToken)

Get properties of an event subscription of a topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_Get
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
GetAll(String, Nullable<Int32>, CancellationToken)

List all event subscriptions that have been created for a specific topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions
  • Operation Id: TopicEventSubscriptions_List
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
GetAllAsync(String, Nullable<Int32>, CancellationToken)

List all event subscriptions that have been created for a specific topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions
  • Operation Id: TopicEventSubscriptions_List
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
GetAsync(String, CancellationToken)

Get properties of an event subscription of a topic.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_Get
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
GetIfExists(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_Get
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
GetIfExistsAsync(String, CancellationToken)

Tries to get details for this resource from the service.

  • Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/eventSubscriptions/{eventSubscriptionName}
  • Operation Id: TopicEventSubscriptions_Get
  • Default Api Version: 2024-06-01-preview
  • Resource: TopicEventSubscriptionResource
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<TopicEventSubscriptionResource>.GetAsyncEnumerator(CancellationToken)

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<TopicEventSubscriptionResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to