TopicsOperations interface

Package:

@azure/arm-eventgrid

Interface representing a Topics operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRegenerateKey
beginRegenerateKeyAndWait
beginUpdate
beginUpdateAndWait
createOrUpdate	Asynchronously creates a new topic with the specified parameters.
delete
get	Get properties of a topic.
listByResourceGroup	List all the topics under a resource group.
listBySubscription	List all the topics under an Azure subscription.
listEventTypes	List event types for a topic.
listSharedAccessKeys	List the two keys used to publish to a topic.
regenerateKey	Regenerate a shared access key for a topic.
update	Asynchronously updates a topic with the specified parameters.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdate: (resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Topic>, Topic>>

Property Value

(resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Topic>, Topic>>

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

beginCreateOrUpdateAndWait: (resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams) => Promise<Topic>

Property Value

(resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams) => Promise<Topic>

beginDelete

Warning

This API is now deprecated.

use delete instead

beginDelete: (resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

Property Value

(resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams) => Promise<SimplePollerLike<OperationState<void>, void>>

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

beginDeleteAndWait: (resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams) => Promise<void>

Property Value

(resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams) => Promise<void>

beginRegenerateKey

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKey: (resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>>

Property Value

(resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams) => Promise<SimplePollerLike<OperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>>

beginRegenerateKeyAndWait

Warning

This API is now deprecated.

use regenerateKey instead

beginRegenerateKeyAndWait: (resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams) => Promise<TopicSharedAccessKeys>

Property Value

(resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams) => Promise<TopicSharedAccessKeys>

beginUpdate

Warning

This API is now deprecated.

use update instead

beginUpdate: (resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Topic>, Topic>>

Property Value

(resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams) => Promise<SimplePollerLike<OperationState<Topic>, Topic>>

beginUpdateAndWait

Warning

This API is now deprecated.

use update instead

beginUpdateAndWait: (resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams) => Promise<Topic>

Property Value

(resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams) => Promise<Topic>

createOrUpdate

Asynchronously creates a new topic with the specified parameters.

createOrUpdate: (resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Topic>, Topic>

Property Value

(resourceGroupName: string, topicName: string, topicInfo: Topic, options?: TopicsCreateOrUpdateOptionalParams) => PollerLike<OperationState<Topic>, Topic>

delete

delete: (resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, topicName: string, options?: TopicsDeleteOptionalParams) => PollerLike<OperationState<void>, void>

get

Get properties of a topic.

get: (resourceGroupName: string, topicName: string, options?: TopicsGetOptionalParams) => Promise<Topic>

Property Value

(resourceGroupName: string, topicName: string, options?: TopicsGetOptionalParams) => Promise<Topic>

listByResourceGroup

List all the topics under a resource group.

listByResourceGroup: (resourceGroupName: string, options?: TopicsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

Property Value

(resourceGroupName: string, options?: TopicsListByResourceGroupOptionalParams) => PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

listBySubscription

List all the topics under an Azure subscription.

listBySubscription: (options?: TopicsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

Property Value

(options?: TopicsListBySubscriptionOptionalParams) => PagedAsyncIterableIterator<Topic, Topic[], PageSettings>

listEventTypes

List event types for a topic.

listEventTypes: (resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: TopicsListEventTypesOptionalParams) => PagedAsyncIterableIterator<EventType, EventType[], PageSettings>

Property Value

(resourceGroupName: string, providerNamespace: string, resourceTypeName: string, resourceName: string, options?: TopicsListEventTypesOptionalParams) => PagedAsyncIterableIterator<EventType, EventType[], PageSettings>

listSharedAccessKeys

List the two keys used to publish to a topic.

listSharedAccessKeys: (resourceGroupName: string, topicName: string, options?: TopicsListSharedAccessKeysOptionalParams) => Promise<TopicSharedAccessKeys>

Property Value

(resourceGroupName: string, topicName: string, options?: TopicsListSharedAccessKeysOptionalParams) => Promise<TopicSharedAccessKeys>

regenerateKey

Regenerate a shared access key for a topic.

regenerateKey: (resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams) => PollerLike<OperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>

Property Value

(resourceGroupName: string, topicName: string, regenerateKeyRequest: TopicRegenerateKeyRequest, options?: TopicsRegenerateKeyOptionalParams) => PollerLike<OperationState<TopicSharedAccessKeys>, TopicSharedAccessKeys>

update

Asynchronously updates a topic with the specified parameters.

update: (resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams) => PollerLike<OperationState<Topic>, Topic>

Property Value

(resourceGroupName: string, topicName: string, topicUpdateParameters: TopicUpdateParameters, options?: TopicsUpdateOptionalParams) => PollerLike<OperationState<Topic>, Topic>