Project: Chef InSpec (Provisioning / Security & Compliance)
File: azurerm_aks_cluster.md

+++ title = "azurermakscluster resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurermakscluster" identifier = "inspec/resources/azure/azurermakscluster.md azurermakscluster resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azureaks_cluster" >}} Use the `azurermakscluster` InSpec audit resource to test properties of an Azure AKS Cluster. This resource interacts with version `2018-03-31` of the Azure Management API. For more information see the . At the moment, there doesn't appear to be a way to select the version of the Azure API docs. If you notice a newer version being referenced in the official documentation please open an issue or submit a pull request using the updated version. This resource is available in the `inspec-azure` [resource pack](/inspec/glossary/#resource-pack). To use it, add the following to your `inspec.yml` in your top-level profile: depends: name: inspec-azure git: https://github.com/inspec/inspec-azure.git You'll also need to setup your Azure credentials; see the resource pack . An `azurermakscluster` resource block identifies an AKS Cluster by name and Resource Group. describe azurermakscluster(resource_group: 'example', name: 'ClusterName') do ... end describe azurermakscluster(resource_group: 'example', name: 'ClusterName') do it { should exist } end describe azurermnetworksecuritygroup(resourcegroup: 'example', name: 'ClusterName') do its('properties.provisioningState') { should cmp 'Succeeded' } end describe azurermnetworksecuritygroup(resourcegroup: 'example', name: 'ClusterName') do its('properties.agentPoolProfiles.first.count') { should cmp 5 } end `name` `resource_group` The Resource Group as well as the AKS Cluster name. describe azurermakscluster(resource_group: 'example', name: 'ClusterName') do it { should exist } end All of the attributes are available via dot notation. This is an example of the currently available attributes. ```ruby control 'azurermakscluster' do describe azurermakscluster(resource_group: 'example', name: 'ClusterName') do it { should exist } its('properties.provisioningState') { should cmp 'Succeeded' } its('properties.kubernetesVersion') { should cmp '1.11.3' } its('properties.dnsPrefix') { should cmp 'ClusterName' } its('properties.fqdn') { should cmp 'ClusterName' } its('properties.agentPoolProfiles.first.name') { should cmp 'agentpool' } its('properties.agentPoolProfiles.first.count') { should cmp 3 } its('properties.agentPoolProfiles.first.vmSize') { should cmp 'StandardDS2V2' } its('properties.agentPoolProfiles.first.storageProfile') { should cmp 'ManagedDisks' } its('properties.agentPoolProfiles.first.maxPods') { should cmp 110 } its('properties.agentPoolProfiles.first.osType') { should cmp 'Linux' } end end ``` There are additional attributes that may be accessed that we have not documented. Please take a look at the . Any attribute in the response may be accessed with the key names separated by dots (`.`). The API may not always return keys that do not have any associated data. There may be cases where the deeply nested property may not have the desired attribute along your call chain. If you find yourself writing tests against properties that may be nil, fork this resource pack and add an accessor to the resource. Within that accessor you'll be able to guard against nil keys. Pull requests are always welcome. {{< readfile file="content/inspec/reusable/md/inspecmatcherslink.md" >}} This resource has the following special matchers. The control will pass if the resource returns a result. Use `should_not` if you expect zero matches. describe azurermakscluster(resource_group: 'example', name: 'ClusterName') do it { should exist } end describe azurermakscluster(resource_group: 'example', name: 'ClusterName') do it { should_not exist } end Your [Service Principal](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-create-service-principal-portal) must be setup with a `contributor` role on the subscription you wish to test.