azure_application_gateway Resource

Use the azure_application_gateway InSpec audit resource to test the properties and configuration of an Azure Application Gateway.

Azure REST API Version, Endpoint, and HTTP Client Parameters

This resource interacts with API versions supported by the resource provider. The api_version can be defined as a resource parameter. If not provided, this resource uses the latest version. For more information, refer to the azure_generic_resource document.

Unless defined, this resource uses the azure_cloud global endpoint and default values for the HTTP client. For more information, refer to the resource pack README.

Install

This resource is available in the Chef InSpec Azure resource pack.

For information on configuring your Azure environment for Chef InSpec and creating an InSpec profile that uses the InSpec Azure resource pack, see the Chef InSpec documentation for the Azure cloud platform.

Syntax

resource_group and name, or the resource_id must be given as a parameter.

describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', name: 'NAME') do
  it { should exist }
end

describe azure_application_gateway(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/applicationGateways/{gatewayName}') do
  it { should exist }
end

Parameters

resource_group: Azure resource group where the targeted resource resides.
name: The unique name of the targeted resource.
application_gateway_name: Alias for the name parameter.
resource_id: The unique resource ID.

Either one of the parameter sets can be provided for a valid query:

resource_id
resource_group and name
resource_group and application_gateway_name

Properties

identity: The identity of the application gateway, if configured. It is a managed service identity object.
zones: A list of availability zones denoting from where the resource needs to come.

For properties applicable to all resources, such as type, name, id, and properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test the SSL policy name of an application gateway

describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', application_gateway_name: 'APPLICATION_GATEWAY_NAME') do
  its('properties.sslPolicy.policyName') { should eq 'AppGwSslPolicy20170401S' }
end

describe azure_application_gateway(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.Network/applicationGateways/{gatewayName}') do
  its('properties.sslPolicy.policyName') { should eq 'AppGwSslPolicy20170401S' }
end

See integration tests for more examples.

Matchers

This InSpec audit resource has the following special matchers. For a full list of available matchers, please visit our Universal Matchers page.

exists

# If we expect 'APPGW-1' always to exist.

describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', name: 'APPGW-1') do
  it { should exist }
end

not_exists

# If we expect 'APPGW-1' never to exist.

describe azure_application_gateway(resource_group: 'RESOURCE_GROUP', name: 'APPGW-1') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be set up with at least a contributor role on the subscription you wish to test.