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

+++ title = "azurerm_subnet resource" draft = false gh_repo = "inspec" platform = "azure" [menu] [menu.inspec] title = "azurerm_subnet" identifier = "inspec/resources/azure/azurermsubnet.md azurermsubnet resource" parent = "inspec/resources/azure" +++ {{< inspec/azurermdeprecated resource="azuresubnet" >}} Use the `azurerm_subnet` InSpec audit resource to test properties related to a subnet for a given virtual network. This resource interacts with version `2018-02-01` 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 . This resource first became available in 1.2.0 of the inspec-azure resource pack. The `resource_group`, virtual network `vnet`, and subnet 'name' must be given as parameters. Since subnet must be in the context of a virtual network, this parameter had to be included. describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do ... end describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do it { should exist } end describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do its('address_prefix') { should eq [192.168.0.0/24] } end describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do its('nsg') { should eq 'NetworkSecurityGroupName'} end `resource_group` `vnet` `name` Defines the resource group of the subnet that you wish to test resides in. describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do ... end Defines the virtual network that the subnet that you wish to test is a part of. describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do ... end Defines the name of the subnet that you wish to test. describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do ... end `id` `name` `type` `address_prefix` `nsg` The subnet's id. its('id') { should eq(id) } Id will be in format: '/subscriptions/<subscription-id>/resourceGroups/<resource-group-name>/providers/Microsoft.Network/virtualNetworks/Inspec-VNet/subnets/Inspec-Subnet' The subnets's name. its('name') { should eq('SubnetName') } The virtual network's resource type. its('type') { should eq 'Microsoft.Network/virtualNetworks/subnets' } The address prefix for the subnet. its('address_prefix') { should eq "x.x.x.x/x" } The network security group attached to the subnet. its('nsg') { should eq 'MyNetworkSecurityGroupName' } 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. describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'MySubnetName') do it { should exist } end describe azurermsubnet(resourcegroup: 'MyResourceGroup', vnet: 'MyVnetName', name: 'DoesNotExist') 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.