azurerm_cosmosdb_database_account ресурс

[править на GitHub]

Используйте ресурс аудита InSpec azurerm_cosmosdb_database_account для проверки свойств и конфигурации учётной записи базы данных Azure CosmosDb в группе ресурсов.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2015-04-08 API управления Azure. Дополнительную информацию можно найти в официальной документации Azure.

В настоящее время, кажется, нет способа выбрать версию документации API Azure. Если вы заметите упоминание новой версии в официальной документации, пожалуйста, откройте вопрос или отправьте запрос на добавление с обновлённой версией.

Доступность

Установка

Этот ресурс доступен в inspec-azure пакете ресурсов. Чтобы использовать его, добавьте следующее в свой inspec.yml в вашем профиле верхнего уровня:

depends:
  inspec-azure:
    git: https://github.com/inspec/inspec-azure.git

Вам также потребуется настроить свои учетные данные Azure; см. README пакета ресурсов.

Версия

Этот ресурс впервые стал доступен в версии 1.11.0 пакета ресурсов inspec-azure.

Синтаксис

resource_group и cosmosdb_database_account должны быть заданы в качестве параметра.

describe azurerm_cosmosdb_database_account(resource_group: 'my-rg', cosmosdb_database_account 'my-cosmos-db') do
  it { should exist }
end

Примеры

Если учётная запись базы данных CosmosDb ссылается с корректным Resource Group и CosmosDb Database Account

describe azurerm_cosmosdb_database_account(resource_group: 'my-rg', cosmosdb_database_account 'my-cosmos-db') do
  it { should exist }
end

Если учётная запись базы данных CosmosDb ссылается с некорректным Resource Group и CosmosDb Database Account

describe azurerm_cosmosdb_database_account(resource_group: 'my-rg', cosmosdb_database_account 'fake-cosmos-db') do
  it { should not exist }
end

Параметры

• resource_group - Группа ресурсов, к которой принадлежит учётная запись базы данных CosmosDb.
• cosmosdb_database_account - Уникальное имя учётной записи базы данных CosmosDb.

Атрибуты

• id
• name
• location
• type
• kind
• tags
• properties

id

Идентификатор ресурса Azure.

name

Имя учётной записи базы данных CosmosDb, например, my-cosmosdb-account.

location

Расположение ресурса, например, eastus.

type

Тип ресурса, обычно Microsoft.DocumentDB/databaseAccounts.

kind

Указывает тип учётной записи базы данных, например, GlobalDocumentDB, MongoDB

теги

Теги ресурсов, применённые к учётной записи ComsosDb.

свойства

Коллекция дополнительных свойств конфигурации, связанных с учётной записью базы данных CosmosDb, например, Capability, ConsistencyPolicy, DatabaseAccountKind.

Полный список свойств можно найти в документации Azure.

Другие атрибуты

Есть дополнительные атрибуты, к которым можно получить доступ, которые мы не задокументировали. Пожалуйста, обратитесь к документации Azure. Любой атрибут в ответе можно получить, используя имена ключей, разделённые точками (.).

API не всегда возвращает ключи, у которых нет связанных данных. Возможны случаи, когда глубоко вложенное свойство может не иметь нужного атрибута в цепочке вызовов. Если вам нужно писать тесты на свойства, которые могут быть nil, создайте форк этого пакета ресурсов и добавьте метод доступа к ресурсу. В этом методе доступа вы сможете защититься от ключей nil. Запросы на добавление всегда приветствуются.

Матчеры

Этот ресурс аудита InSpec имеет следующие специальные матчеры. Полный список доступных матчеров можно найти на нашей странице Универсальные матчеры.

exists

describe azurerm_cosmosdb_database_account(resource_group: ‘my-rg’, cosmosdb_database_account ‘my-cosmos-db’) do it { should exist } end

Разрешения Azure

Ваша служба-принципал должна быть настроена с ролью contributor на подписке, которую вы хотите протестировать.