azure_ddos_protection_resource Resource

[edit on GitHub]

Use the azure_ddos_protection_resource InSpec audit resource to test properties of a DDoS protection plan resource.

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.

Installation

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

See the Chef InSpec documentation on cloud platforms for information on configuring your Azure environment for InSpec and creating an InSpec profile that uses the InSpec Azure resource pack.

Syntax

The resource_group and the DDoS protection plan resource name, or the resource_id are required parameters.

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

Parameters

The resource_group and the DDoS protection plan resource name, or the resource_id are required parameters.

Properties

name

Name of the Azure DDoS protection plan resource to test.

type

The resource type.

provisioning_state

The provisioning state of DDoS protection plan. Valid values: Deleting, Failed, Succeeded, Updating.

virtual_networks

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

resource_guid

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

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

Examples

Ensure that the DDoS protection plan resource has the correct type.

describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do
  its('type') { should eq 'Microsoft.Network/ddosProtectionPlans' }
end

Ensure that the DDoS protection plan resource is in successful state.

describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do
  its('provisioning_state') { should eq 'Succeeded' }
end

Ensure that the DDoS protection plan resource is from same location.

describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') do
  its('location') { should eq `RESOURCE_LOCATION` }
end

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 a DDoS protection plan resource is found it will exist

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

# DDoS protection plan resources that aren't found will not exist
describe azure_ddos_protection_resource(resource_group: 'RESOURCE_GROUP', name: 'DDOS_PROTECTION_PLAN_NAME') 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.