azure_aks_clusters resource

Use the azure_aks_clusters InSpec audit resource to test the properties and configuration of multiple Azure AKS Clusters.

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_aks_clusters resource block returns all AKS Clusters, either within a Resource Group (if provided) or within an entire Subscription.

describe azure_aks_clusters do
  #...
end

Or

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

Parameters

resource_group (optional)

The name of the resource group.

Properties

ids

A list of the unique resource IDs.

Field: id

locations

A list of locations for all the resources being interrogated.

Field: location

names

A list of names of all the resources being interrogated.

Field: name

tags

A list of tag:value pairs defined on the resources being interrogated.

Field: tags

properties

A list of properties for all the resources being interrogated.

Field: properties

Examples

Test that an example Resource Group has the named AKS Cluster:

describe azure_aks_clusters(resource_group: 'RESOURCE_GROUP') do
  its('names') { should include('ClusterName') }
end

Matchers

This resource has the following special matchers.

exists

The control passes if the filter returns at least one result. Use should_not if you expect zero matches.

# If we expect 'EXAMPLEGROUP' Resource Group to have AKS Clusters.

describe azure_aks_clusters(resource_group: 'EXAMPLEGROUP') do
  it { should exist }
end

not_exists

# If we expect 'EMPTYEXAMPLEGROUP' Resource Group not to have AKS Clusters.

describe azure_aks_clusters(resource_group: 'EMPTYEXAMPLEGROUP') 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.