azure_ddos_protection_resources resource

Use the azure_ddos_protection_resources InSpec audit resource to test the properties of DDoS protection plans in a resource group.

Azure REST API version, endpoint, and HTTP client parameters

This resource interacts with API versions supported by the resource provider. You can specify the api_version as a resource parameter to use a specific version of the Azure REST API. If you don’t specify an API version, this resource uses the latest version available. For more information about API versioning, see the azure_generic_resource.

By default, this resource uses the azure_cloud global endpoint and default HTTP client settings. You can override these settings if you need to connect to a different Azure environment (such as Azure Government or Azure China). For more information about configuration options, see the resource pack README.

Syntax

An azure_ddos_protection_resources resource block returns all Azure bastion hosts, within a resource group (if provided).

describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do
   #....
end

Parameters

resource_group

Azure resource group where the targeted resource resides.

Properties

names

A list of the unique resource names.

Field: name

ids

A list of DDoS protection plan IDs.

Field: id

virtual_networks

The list of virtual networks associated with the DDoS protection plan resource.

Field: virtual_networks

provisioning_states

The provisioning states of the DDoS protection plans.

Field: provisioning_state

types

The types of all the DDoS protection plans.

Field: type

resource_guids

The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrates the resource across subscriptions or resource groups.

Field: resource_guid

Also, refer to the Azure documentation for all available properties. Access any attribute in the response by separating the key names with a period (.).

Examples

Test to ensure that the DDoS protection plan resource is in a successful state:

describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do
  its('provisioning_states') { should include('Succeeded') }
end

Test to ensure that a DDoS protection plan resource is from a location:

describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do
  its('location') { should include `RESOURCE_LOCATION` }
end

Test if any DDoS protection plan exists in the resource group:

describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') do
  it { should exist }
end

Matchers

This resource has the following special matchers.

exists

# Should not exist if no bastion hots are in the resource group.

describe azure_ddos_protection_resources(resource_group: 'RESOURCE_GROUP') 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.