Rules interface
Interface representing a Rules.
Methods
| create |
Creates a new rule and updates an existing rule |
| delete(string, string, string, string, string, Rules |
Deletes an existing rule. |
| get(string, string, string, string, string, Rules |
Retrieves the description for the specified rule. |
| list |
List all the rules within given topic-subscription |
Method Details
createOrUpdate(string, string, string, string, string, Rule, RulesCreateOrUpdateOptionalParams)
Creates a new rule and updates an existing rule
function createOrUpdate(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, ruleName: string, parameters: Rule, options?: RulesCreateOrUpdateOptionalParams): Promise<Rule>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- topicName
-
string
The topic name.
- subscriptionName
-
string
The subscription name.
- ruleName
-
string
The rule name.
- parameters
- Rule
Parameters supplied to create a rule.
The options parameters.
Returns
Promise<Rule>
delete(string, string, string, string, string, RulesDeleteOptionalParams)
Deletes an existing rule.
function delete(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, ruleName: string, options?: RulesDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- topicName
-
string
The topic name.
- subscriptionName
-
string
The subscription name.
- ruleName
-
string
The rule name.
- options
- RulesDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, RulesGetOptionalParams)
Retrieves the description for the specified rule.
function get(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, ruleName: string, options?: RulesGetOptionalParams): Promise<Rule>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- topicName
-
string
The topic name.
- subscriptionName
-
string
The subscription name.
- ruleName
-
string
The rule name.
- options
- RulesGetOptionalParams
The options parameters.
Returns
Promise<Rule>
listBySubscriptions(string, string, string, string, RulesListBySubscriptionsOptionalParams)
List all the rules within given topic-subscription
function listBySubscriptions(resourceGroupName: string, namespaceName: string, topicName: string, subscriptionName: string, options?: RulesListBySubscriptionsOptionalParams): PagedAsyncIterableIterator<Rule, Rule[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the Resource group within the Azure subscription.
- namespaceName
-
string
The namespace name
- topicName
-
string
The topic name.
- subscriptionName
-
string
The subscription name.
The options parameters.