Skip to content

azure_cosmosdb_database_account.md

Latest commit

 

History

History
92 lines (70 loc) · 4.18 KB

azure_cosmosdb_database_account.md

File metadata and controls

92 lines (70 loc) · 4.18 KB
Raw
title About the azure_cosmosdb_database_account Resource
platform azure

azure_cosmosdb_database_account

Use the azure_cosmosdb_database_account InSpec audit resource to test properties and configuration of an Azure CosmosDb Database Account within a Resource Group.

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, the latest version will be used. For more information, refer to azure_generic_resource.

Unless defined, azure_cloud global endpoint, and default values for the http client will be used . For more information, refer to the resource pack README.

Availability

Installation

This resource is available in the InSpec Azure resource pack. For an example inspec.yml file and how to set up your Azure credentials, refer to resource pack README.

Syntax

The resource_group and name must be given as a parameter.

describe azure_cosmosdb_database_account(resource_group: 'inspec-resource-group-9', name: 'my-cosmos-db') do
  it { should exist }
end

Parameters

Name Description
resource_group Azure resource group that the targeted resource resides in. resource-group-name
name The unique name of the targeted resource. resource-name
cosmosdb_database_account Alias for the name parameter.
resource_id The unique resource ID. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}

Either one of the parameter sets can be provided for a valid query:

  • resource_id
  • resource_group and name
  • resource_group and cosmosdb_database_account

Properties

Property Description
location Resource location, e.g. eastus.
kind Indicates the type of database account, e.g. GlobalDocumentDB, MongoDB.

For properties applicable to all resources, such as type, name, id, properties, refer to azure_generic_resource.

Also, refer to Azure documentation for other properties available. Any attribute in the response may be accessed with the key names separated by dots (.).

Examples

Test If a GlobalDocumentDB is Accessible on Public Network

describe azure_cosmosdb_database_account(resource_group: 'my-rg', name: 'my-cosmos-db') do
  its('properties.publicNetworkAccess') { should cmp 'Enabled' }
end
describe azure_cosmosdb_database_account(resource_id: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}') do
  its('properties.publicNetworkAccess') { should cmp 'Enabled' }
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 we expect 'my-cosmos-db' to always exist
describe azure_cosmosdb_database_account(resource_group: 'example', name: 'appgw-1') do
  it { should exist }
end

# If we expect 'my-cosmos-db' to never exist
describe azure_cosmosdb_database_account(resource_group: 'example', name: 'my-cosmos-db') do
  it { should_not exist }
end

Azure Permissions

Your Service Principal must be setup with a contributor role on the subscription you wish to test.