azurerm_mysql_server ресурс

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

Используйте ресурс проверки InSpec azurerm_mysql_server для тестирования свойств и конфигурации сервера Azure MySQL.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2017-12-01 API управления Azure. Более подробную информацию можно найти в официальной документации Azure.

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

Доступность

Установка

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

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

Также вам нужно настроить свои учетные данные Azure; см. в файле README пакета ресурсов.

Версия

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

Синтаксис

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

describe azurerm_mysql_server(resource_group: 'inspec-resource-group-9', server_name: 'example_server') do
  it { should exist }
end

Примеры

Если сервер SQL упомянут с допустимым Resource Group и Server Name

describe azurerm_sql_server(resource_group: 'my-rg', server_name: 'sql-server-1') do
  it { should exist }
end

Если сервер SQL упомянут с недопустимым Resource Group или Server Name

describe azurerm_sql_server(resource_group: 'invalid-rg', server_name: 'i-dont-exist') do
  it { should_not exist }
end

Параметры

• resource_group - Группа ресурсов, к которой принадлежит сервер SQL.
• server_name - Уникальное имя сервера SQL.

Атрибуты

• id
• name
• sku
• location
• properties
• tags
• type

id

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

name

Имя сервера MySQL, например my-sql-server.

sku

SKU сервера mysql. Это свойства, относящиеся к информации о выставлении счетов за сервер.

location

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

properties

Коллекция дополнительных свойств конфигурации, связанных с сервером MySQL, например administratorLogin.

tags

Теги ресурсов, примененные к серверу MySQL.

type

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

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

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

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

Матчеры

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

exists

describe azurerm_mysql_server(resource_group: 'my-rg', server_name: 'server-name-1') do
  it { should exist }
end

Разрешения Azure

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