Skip to content

Latest commit

 

History

History
237 lines (184 loc) · 8.4 KB

azure-monitor-alerts-v0.md

File metadata and controls

237 lines (184 loc) · 8.4 KB
title description ms.date monikerRange
AzureMonitorAlerts@0 - Azure Monitor alerts (Deprecated) v0 task
Configure alerts on available metrics for an Azure resource (Deprecated).
05/14/2024
<=azure-pipelines

AzureMonitorAlerts@0 - Azure Monitor alerts (Deprecated) v0 task

:::moniker range=">=azure-pipelines-2020"

Configure alerts on available metrics for an Azure resource (Deprecated).

[!INCLUDE workload-identity]

:::moniker-end

:::moniker range="<=azure-pipelines-2019.1"

Configure alerts on available metrics for an Azure resource.

:::moniker-end

Syntax

:::moniker range=">=azure-pipelines-2020"

# Azure Monitor alerts (Deprecated) v0
# Configure alerts on available metrics for an Azure resource (Deprecated).
- task: AzureMonitorAlerts@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure Subscription. 
    ResourceGroupName: # string. Required. Resource Group. 
    ResourceType: 'Microsoft.Insights/components' # 'Microsoft.Insights/components' | 'Microsoft.Web/sites' | 'Microsoft.Storage/storageAccounts' | 'Microsoft.Compute/virtualMachines'. Required. Resource Type. Default: Microsoft.Insights/components.
    ResourceName: # string. Required. Resource name. 
    AlertRules: # string. Required. Alert rules. 
  # Notify via email
    #NotifyServiceOwners: # boolean. Subscription owners, contributors and readers. 
    #NotifyEmails: # string. Additional administrator emails.

:::moniker-end

:::moniker range="=azure-pipelines-2019.1"

# Azure Monitor alerts v0
# Configure alerts on available metrics for an Azure resource.
- task: AzureMonitorAlerts@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure Subscription. 
    ResourceGroupName: # string. Required. Resource Group. 
    ResourceType: 'Microsoft.Insights/components' # 'Microsoft.Insights/components' | 'Microsoft.Web/sites' | 'Microsoft.Storage/storageAccounts' | 'Microsoft.Compute/virtualMachines'. Required. Resource Type. Default: Microsoft.Insights/components.
    ResourceName: # string. Required. Resource name. 
    AlertRules: # string. Required. Alert rules. 
  # Notify via email
    #NotifyServiceOwners: # boolean. Subscription owners, contributors and readers. 
    #NotifyEmails: # string. Additional administrator emails.

:::moniker-end

:::moniker range="=azure-pipelines-2019"

# Azure Monitor Alerts v0
# Configure alerts on available metrics for an Azure resource.
- task: AzureMonitorAlerts@0
  inputs:
    azureSubscription: # string. Alias: ConnectedServiceName. Required. Azure Subscription. 
    ResourceGroupName: # string. Required. Resource Group. 
    ResourceType: 'Microsoft.Insights/components' # 'Microsoft.Insights/components' | 'Microsoft.Web/sites' | 'Microsoft.Storage/storageAccounts' | 'Microsoft.Compute/virtualMachines'. Required. Resource Type. Default: Microsoft.Insights/components.
    ResourceName: # string. Required. Resource name. 
    AlertRules: # string. Required. Alert rules. 
  # Notify via email
    #NotifyServiceOwners: # boolean. Subscription owners, contributors and readers. 
    #NotifyEmails: # string. Additional administrator emails.

:::moniker-end

Inputs

:::moniker range="<=azure-pipelines"

azureSubscription - Azure Subscription
Input alias: ConnectedServiceName. string. Required.

Selects the Azure Resource Manager subscription.

Note: To configure new service connection, select the Azure subscription from the list and click Authorize.

If your subscription is not listed or if you want to use an existing service principal, you can setup an Azure service connection using the Add or Manage button.


:::moniker-end

:::moniker range="<=azure-pipelines"

ResourceGroupName - Resource Group
string. Required.

Selects the Azure Resource Group that contains the Azure resource where you want to configure an alert.


:::moniker-end

:::moniker range="<=azure-pipelines"

ResourceType - Resource Type
string. Required. Allowed values: Microsoft.Insights/components (Application Insights), Microsoft.Web/sites (App Services), Microsoft.Storage/storageAccounts (Storage Account), Microsoft.Compute/virtualMachines (Virtual Machines). Default value: Microsoft.Insights/components.

Selects the Azure resource type.


:::moniker-end

:::moniker range="<=azure-pipelines"

ResourceName - Resource name
string. Required.

Selects the name of the Azure resource where you want to configure an alert.


:::moniker-end

:::moniker range="<=azure-pipelines"

AlertRules - Alert rules
string. Required.

The list of Azure monitor alerts that are configured on the selected Azure resource.

To add or modify alerts, click the … button.


:::moniker-end

:::moniker range="<=azure-pipelines"

NotifyServiceOwners - Subscription owners, contributors and readers
boolean.

Optional. Sends an email notification to everyone who has access to the specified resource group.


:::moniker-end

:::moniker range="<=azure-pipelines"

NotifyEmails - Additional administrator emails
string.

Optional. Add email addresses separated by semicolons (;) if you want to include additional email notification recipients. This feature can be incorporated whether or not the "subscription owners..." box is checked.


:::moniker-end

Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

:::moniker range="<=azure-pipelines"

None.

:::moniker-end

Remarks

Use this task to configure alerts on available metrics for an Azure resource.

Requirements

:::moniker range="<=azure-pipelines"

Requirement Description
Pipeline types YAML, Classic build, Classic release
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 2.111.0 or greater
Task category Deploy

:::moniker-end