azurerm_sql_server ресурс

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

Используйте azurerm_sql_server ресурс InSpec для проверки свойств и конфигурации Azure SQL Server в рамках группы ресурсов.

Версия Azure REST API

Этот ресурс взаимодействует с версией 2018-06-01-preview API управления Azure. Дополнительную информацию см. в официальной документации Azure.

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

Доступность

Установка

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

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

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

Версия

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

Синтаксис

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

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

Примеры

Если SQL Server ссылается с допустимым Resource Group и Server Name.

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

Если SQL Server ссылается с недопустимым 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.
• server_name - Уникальное имя SQL Server.

Атрибуты

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

id

ID ресурса Azure.

name

Имя SQL Server, например my-sql-server.

kind

Тип SQL Server. Эта метаданные используются для удобства работы в Azure Portal.

location

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

properties

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

tags

Теги ресурса, примененные к SQL Server.

type

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

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

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

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

Матчеры

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

exists

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

Разрешения Azure

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