SystemTopicsImpl | @azure/arm-eventgrid

Class containing SystemTopics operations.

Hierarchy

SystemTopicsImpl

Implements

SystemTopics

Index

Constructors

constructor

Methods

Constructors

constructor

new SystemTopicsImpl(client: EventGridManagementClient): SystemTopicsImpl

- Defined in operations/systemTopics.ts:40
Initialize a new instance of the class SystemTopics class.

Parameters
- client: EventGridManagementClient
  
  Reference to the service client
Returns SystemTopicsImpl

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, systemTopicName: string, systemTopicInfo: SystemTopic, options?: SystemTopicsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SystemTopicsCreateOrUpdateResponse>, SystemTopicsCreateOrUpdateResponse>>

Implementation of SystemTopics.beginCreateOrUpdate
- Defined in operations/systemTopics.ts:169
Asynchronously creates a new system topic with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- systemTopicInfo: SystemTopic
  
  System Topic information.
- Optional options: SystemTopicsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SystemTopicsCreateOrUpdateResponse>, SystemTopicsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName: string, systemTopicName: string, systemTopicInfo: SystemTopic, options?: SystemTopicsCreateOrUpdateOptionalParams): Promise<SystemTopicsCreateOrUpdateResponse>

Implementation of SystemTopics.beginCreateOrUpdateAndWait
- Defined in operations/systemTopics.ts:239
Asynchronously creates a new system topic with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- systemTopicInfo: SystemTopic
  
  System Topic information.
- Optional options: SystemTopicsCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicsCreateOrUpdateResponse>

beginDelete

beginDelete(resourceGroupName: string, systemTopicName: string, options?: SystemTopicsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>

Implementation of SystemTopics.beginDelete
- Defined in operations/systemTopics.ts:260
Delete existing system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- Optional options: SystemTopicsDeleteOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName: string, systemTopicName: string, options?: SystemTopicsDeleteOptionalParams): Promise<void>

Implementation of SystemTopics.beginDeleteAndWait
- Defined in operations/systemTopics.ts:323
Delete existing system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- Optional options: SystemTopicsDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

beginUpdate

beginUpdate(resourceGroupName: string, systemTopicName: string, systemTopicUpdateParameters: SystemTopicUpdateParameters, options?: SystemTopicsUpdateOptionalParams): Promise<PollerLike<PollOperationState<SystemTopicsUpdateResponse>, SystemTopicsUpdateResponse>>

Implementation of SystemTopics.beginUpdate
- Defined in operations/systemTopics.ts:343
Asynchronously updates a system topic with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- systemTopicUpdateParameters: SystemTopicUpdateParameters
  
  SystemTopic update information.
- Optional options: SystemTopicsUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<SystemTopicsUpdateResponse>, SystemTopicsUpdateResponse>>

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName: string, systemTopicName: string, systemTopicUpdateParameters: SystemTopicUpdateParameters, options?: SystemTopicsUpdateOptionalParams): Promise<SystemTopicsUpdateResponse>

Implementation of SystemTopics.beginUpdateAndWait
- Defined in operations/systemTopics.ts:418
Asynchronously updates a system topic with the specified parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- systemTopicUpdateParameters: SystemTopicUpdateParameters
  
  SystemTopic update information.
- Optional options: SystemTopicsUpdateOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicsUpdateResponse>

get

get(resourceGroupName: string, systemTopicName: string, options?: SystemTopicsGetOptionalParams): Promise<SystemTopicsGetResponse>

Implementation of SystemTopics.get
- Defined in operations/systemTopics.ts:151
Get properties of a system topic.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- systemTopicName: string
  
  Name of the system topic.
- Optional options: SystemTopicsGetOptionalParams
  
  The options parameters.
Returns Promise<SystemTopicsGetResponse>

listByResourceGroup

listByResourceGroup(resourceGroupName: string, options?: SystemTopicsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SystemTopic>

Implementation of SystemTopics.listByResourceGroup
- Defined in operations/systemTopics.ts:97
List all the system topics under a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group within the user's subscription.
- Optional options: SystemTopicsListByResourceGroupOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SystemTopic>

listBySubscription

listBySubscription(options?: SystemTopicsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SystemTopic>

Implementation of SystemTopics.listBySubscription
- Defined in operations/systemTopics.ts:54
List all the system topics under an Azure subscription.

Parameters
- Optional options: SystemTopicsListBySubscriptionOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<SystemTopic>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: EventGridManagementClient

Returns SystemTopicsImpl

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

systemTopicName: string

systemTopicInfo: SystemTopic

Optional options: SystemTopicsCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SystemTopicsCreateOrUpdateResponse>, SystemTopicsCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

systemTopicName: string

systemTopicInfo: SystemTopic

Optional options: SystemTopicsCreateOrUpdateOptionalParams

Returns Promise<SystemTopicsCreateOrUpdateResponse>

beginDelete

Parameters

resourceGroupName: string

systemTopicName: string

Optional options: SystemTopicsDeleteOptionalParams

Returns Promise<PollerLike<PollOperationState<void>, void>>

beginDeleteAndWait

Parameters

resourceGroupName: string

systemTopicName: string

Optional options: SystemTopicsDeleteOptionalParams

Returns Promise<void>

beginUpdate

Parameters

resourceGroupName: string

systemTopicName: string

systemTopicUpdateParameters: SystemTopicUpdateParameters

Optional options: SystemTopicsUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<SystemTopicsUpdateResponse>, SystemTopicsUpdateResponse>>

beginUpdateAndWait

Parameters

resourceGroupName: string

systemTopicName: string

systemTopicUpdateParameters: SystemTopicUpdateParameters

Optional options: SystemTopicsUpdateOptionalParams

Returns Promise<SystemTopicsUpdateResponse>

get

Parameters

resourceGroupName: string

systemTopicName: string

Optional options: SystemTopicsGetOptionalParams

Returns Promise<SystemTopicsGetResponse>

listByResourceGroup

Parameters

resourceGroupName: string

Optional options: SystemTopicsListByResourceGroupOptionalParams

Returns PagedAsyncIterableIterator<SystemTopic>

listBySubscription

Parameters

Optional options: SystemTopicsListBySubscriptionOptionalParams

Returns PagedAsyncIterableIterator<SystemTopic>