azurerm_sql_server ресурс

[редактировать на GitHub]

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

Версия Azure REST API

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

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

Доступность

Установка

Этот ресурс доступен в 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 указан с валидным 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
• kind
• location
• properties
• tags
• type

id

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

name

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

kind

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

location

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

properties

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

метки

Метки ресурсов, применённые к серверу SQL.

type

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

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

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

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

Матчеры

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

exists

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

Разрешения Azure

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