Share via


EventGridTopicCollection Class

Definition

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

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

Constructors

EventGridTopicCollection()

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

Asynchronously creates a new topic with the specified parameters.

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

Asynchronously creates a new topic with the specified parameters.

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

Checks to see if the resource exists in azure.

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

Checks to see if the resource exists in azure.

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

Get properties of a topic.

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

List all the topics under a resource group.

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

List all the topics under a resource group.

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

Get properties of a topic.

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

Tries to get details for this resource from the service.

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

Tries to get details for this resource from the service.

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

Returns an enumerator that iterates asynchronously through the collection.

IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

IEnumerable<EventGridTopicResource>.GetEnumerator()

Returns an enumerator that iterates through the collection.

Applies to