Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AlertRules

Package version

Class representing a AlertRules.

Hierarchy

  • AlertRules

Index

Constructors

Methods

Constructors

constructor

Methods

createOrUpdate

  • createOrUpdate(resourceGroupName: string, ruleName: string, parameters: AlertRuleResource, options?: msRest.RequestOptionsBase): Promise<Models.AlertRulesCreateOrUpdateResponse>
  • createOrUpdate(resourceGroupName: string, ruleName: string, parameters: AlertRuleResource, callback: msRest.ServiceCallback<AlertRuleResource>): void
  • createOrUpdate(resourceGroupName: string, ruleName: string, parameters: AlertRuleResource, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertRuleResource>): void

  • Creates or updates an alert rule.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • parameters: AlertRuleResource

      The parameters of the rule to create or update.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AlertRulesCreateOrUpdateResponse>

    Promise<Models.AlertRulesCreateOrUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • parameters: AlertRuleResource

      The parameters of the rule to create or update.

    • callback: msRest.ServiceCallback<AlertRuleResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • parameters: AlertRuleResource

      The parameters of the rule to create or update.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AlertRuleResource>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, ruleName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>
  • deleteMethod(resourceGroupName: string, ruleName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, ruleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Deletes an alert rule

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<msRest.RestResponse>

    Promise<msRest.RestResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, ruleName: string, options?: msRest.RequestOptionsBase): Promise<Models.AlertRulesGetResponse>
  • get(resourceGroupName: string, ruleName: string, callback: msRest.ServiceCallback<AlertRuleResource>): void
  • get(resourceGroupName: string, ruleName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertRuleResource>): void

  • Gets an alert rule

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AlertRulesGetResponse>

    Promise<Models.AlertRulesGetResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • callback: msRest.ServiceCallback<AlertRuleResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AlertRuleResource>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.AlertRulesListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<AlertRuleResourceCollection>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertRuleResourceCollection>): void

  • List the alert rules within a resource group.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AlertRulesListByResourceGroupResponse>

    Promise<Models.AlertRulesListByResourceGroupResponse>

  • Parameters

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AlertRuleResourceCollection>

      The callback

    Returns void

listBySubscription

  • listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.AlertRulesListBySubscriptionResponse>
  • listBySubscription(callback: msRest.ServiceCallback<AlertRuleResourceCollection>): void
  • listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertRuleResourceCollection>): void

update

  • update(resourceGroupName: string, ruleName: string, alertRulesResource: AlertRuleResourcePatch, options?: msRest.RequestOptionsBase): Promise<Models.AlertRulesUpdateResponse>
  • update(resourceGroupName: string, ruleName: string, alertRulesResource: AlertRuleResourcePatch, callback: msRest.ServiceCallback<AlertRuleResource>): void
  • update(resourceGroupName: string, ruleName: string, alertRulesResource: AlertRuleResourcePatch, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<AlertRuleResource>): void

  • Updates an existing AlertRuleResource. To update other fields use the CreateOrUpdate method.

    Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • alertRulesResource: AlertRuleResourcePatch

      Parameters supplied to the operation.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.AlertRulesUpdateResponse>

    Promise<Models.AlertRulesUpdateResponse>

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • alertRulesResource: AlertRuleResourcePatch

      Parameters supplied to the operation.

    • callback: msRest.ServiceCallback<AlertRuleResource>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      The name of the resource group.

    • ruleName: string

      The name of the rule.

    • alertRulesResource: AlertRuleResourcePatch

      Parameters supplied to the operation.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<AlertRuleResource>

      The callback

    Returns void

Generated using TypeDoc