azurerm_cosmosdb_database_account ресурс

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

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

Версия Azure REST API

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

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

Доступность

Установка

Этот ресурс доступен в 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 не всегда возвращает ключи, у которых нет связанных данных. Может быть, что глубоко вложенное свойство не содержит нужного атрибута по вашей цепочке вызова. Если вы обнаруживаете, что пишете тесты на свойства, которые могут быть null, вильните этот пакет ресурсов и добавьте к нему метод доступа. В этом методе доступа вы сможете защититься от нулевых ключей. Запросы на добавление всегда приветствуются.

Матчеры

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

exists

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

Разрешения Azure

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