Skip to content

azure_public_ip.md

Latest commit

 

History

History
91 lines (68 loc) · 3.91 KB

azure_public_ip.md

File metadata and controls

91 lines (68 loc) · 3.91 KB
Raw
title About the azure_public_ip Resource
platform azure

azure_public_ip

Use the azure_public_ip InSpec audit resource to test properties of an Azure Public IP address.

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used . For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

An azure_public_ip resource block identifies a public IP address by name and resource_group.

describe azure_public_ip(resource_group: 'example', name: 'addressName') do
  it { should exist }
end

Parameters

Name Description
resource_group Azure resource group that the targeted resource resides in. resourceGroupName
name The unique name of the public IP address. publicIpAddressName
resource_id The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}

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

  • resource_id
  • resource_group and name

Properties

Property Description
properties.ipAddress The IP address associated with the public IP address resource.

For properties applicable to all resources, such as type, name, id, 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 IP Address of a Public IP Resource

describe azure_public_ip(resource_group: 'example', name: 'publicIpAddressName') do
  its('properties.ipAddress') { should cmp '51.224.11.75' }
end
describe azure_public_ip(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}') do
  its('properties.ipAddress') { should cmp '51.224.11.75' }
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 the resource to always exist
describe azure_public_ip(resource_group: 'example', name: 'publicIpAddressName') do
  it { should exist }
end

# If we expect the resource not to exist
describe azure_public_ip(resource_group: 'example', name: 'publicIpAddressName') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.