SystemTopics interface
Interface representing a SystemTopics.
Methods
Method Details
beginCreateOrUpdate(string, string, SystemTopic, SystemTopicsCreateOrUpdateOptionalParams)
Asynchronously creates a new system topic with the specified parameters.
function beginCreateOrUpdate(resourceGroupName: string, systemTopicName: string, systemTopicInfo: SystemTopic, options?: SystemTopicsCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<SystemTopic>, SystemTopic>>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.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<SystemTopic>, SystemTopic>>
beginCreateOrUpdateAndWait(string, string, SystemTopic, SystemTopicsCreateOrUpdateOptionalParams)
Asynchronously creates a new system topic with the specified parameters.
function beginCreateOrUpdateAndWait(resourceGroupName: string, systemTopicName: string, systemTopicInfo: SystemTopic, options?: SystemTopicsCreateOrUpdateOptionalParams): Promise<SystemTopic>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.
The options parameters.
Returns
Promise<SystemTopic>
beginDelete(string, string, SystemTopicsDeleteOptionalParams)
Delete existing system topic.
function beginDelete(resourceGroupName: string, systemTopicName: string, options?: SystemTopicsDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- systemTopicName
-
string
Name of the system topic.
- options
- SystemTopicsDeleteOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, SystemTopicsDeleteOptionalParams)
Delete existing system topic.
function beginDeleteAndWait(resourceGroupName: string, systemTopicName: string, options?: SystemTopicsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- systemTopicName
-
string
Name of the system topic.
- options
- SystemTopicsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
beginUpdate(string, string, SystemTopicUpdateParameters, SystemTopicsUpdateOptionalParams)
Asynchronously updates a system topic with the specified parameters.
function beginUpdate(resourceGroupName: string, systemTopicName: string, systemTopicUpdateParameters: SystemTopicUpdateParameters, options?: SystemTopicsUpdateOptionalParams): Promise<PollerLike<PollOperationState<SystemTopic>, SystemTopic>>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.
- options
- SystemTopicsUpdateOptionalParams
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<SystemTopic>, SystemTopic>>
beginUpdateAndWait(string, string, SystemTopicUpdateParameters, SystemTopicsUpdateOptionalParams)
Asynchronously updates a system topic with the specified parameters.
function beginUpdateAndWait(resourceGroupName: string, systemTopicName: string, systemTopicUpdateParameters: SystemTopicUpdateParameters, options?: SystemTopicsUpdateOptionalParams): Promise<SystemTopic>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.
- options
- SystemTopicsUpdateOptionalParams
The options parameters.
Returns
Promise<SystemTopic>
get(string, string, SystemTopicsGetOptionalParams)
Get properties of a system topic.
function get(resourceGroupName: string, systemTopicName: string, options?: SystemTopicsGetOptionalParams): Promise<SystemTopic>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
- systemTopicName
-
string
Name of the system topic.
- options
- SystemTopicsGetOptionalParams
The options parameters.
Returns
Promise<SystemTopic>
listByResourceGroup(string, SystemTopicsListByResourceGroupOptionalParams)
List all the system topics under a resource group.
function listByResourceGroup(resourceGroupName: string, options?: SystemTopicsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<SystemTopic, SystemTopic[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group within the user's subscription.
The options parameters.
Returns
listBySubscription(SystemTopicsListBySubscriptionOptionalParams)
List all the system topics under an Azure subscription.
function listBySubscription(options?: SystemTopicsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<SystemTopic, SystemTopic[], PageSettings>Parameters
The options parameters.