Project: Chef InSpec (Provisioning / Security & Compliance)
File: azurerm_monitor_activity_log_alert.md

+++ title = "azurermmonitoractivitylogalert resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurermmonitoractivitylogalert" identifier = "inspec/resources/azure/azurermmonitoractivitylogalert.md azurermmonitoractivitylogalert resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azuremonitoractivitylog_alert" >}} Use the `azurermmonitoractivitylogalert` InSpec audit resource to test properties of an Azure Monitor Activity Log Alert. This resource interacts with version `2017-04-01` of the Azure Management API. For more information see the . At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version. This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the following to your `inspec.yml` in your top-level profile: depends: name: inspec-azure git: https://github.com/inspec/inspec-azure.git You'll also need to setup your Azure credentials; see the resource pack . An `azurermmonitoractivitylogalert` resource block identifies an Activity Log Alert by name and resource group. describe azurermmonitoractivitylogalert(resource_group: 'example', name: 'AlertName') do ... end describe azurermmonitoractivitylogalert(resource_group: 'example', name: 'AlertName') do it { should exist } end describe azurermmonitoractivitylogalert(resource_group: 'example', name: 'AlertName') do its('operations') { should include 'Microsoft.Authorization/policyAssignments/write' } end `name` `resource_group` The resource group as well as the Activity Log Alert name. describe azurermmonitoractivitylogalert(resource_group: 'example', name: 'AlertName') do its('operations') { should include 'Microsoft.Authorization/policyAssignments/write' } end For more information on these attributes see . `id` `name` `operations` `properties` `conditions` The Activity Log Alert's id. its('id') { should eq(id) } The Activity Log Alert's name. its('name') { should eq(name) } The operations collection can be checked for the presence or absence of a given operation string. its('operations') { should include 'Microsoft.Authorization/policyAssignments/write' } A list of actions that are executed when the condition is met. Description of this alert. its('properties.description') { should eq 'Alert description' } Indicates if this alert is enabled or not (`true`|`false`). its('properties.enabled') { should be_true } List of resources this alert applies to. There must be at least one item in this list. its('properties.scopes') { should include 'subscriptions/SUBSCRIPTION_ID' } There are additional attributes that may be accessed that we have not documented. Please take a look at the . Any attribute in the response may be accessed with the key names separated by dots (`.`). The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you'll be able to guard against nil keys. Pull requests are always welcome. {{< readfile file="content/inspec/reusable/md/inspecmatcherslink.md" >}} This resource has the following special matchers. The control will pass if the resource returns a result. Use `should_not` if you expect zero matches. describe azurermmonitoractivitylogalert(resource_group: 'example', name: 'AlertName') do it { should exist } end describe azurermmonitoractivitylogalert(resource_group: 'example', name: 'OtherAlertName') do it { should_not exist } end Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test.