azure_rm_keyvault – Управление экземпляром хранилища ключей

Новая версия с 2.5.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата
Статус

Обзор

Создание, обновление и удаление экземпляра хранилища ключей.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

python >= 2.7
azure >= 2.0.0

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
access_policies -			Массив из 0 до 16 идентификаторов, имеющих доступ к хранилищу ключей. Все идентификаторы в массиве должны использовать тот же идентификатор клиента, что и хранилище ключей.
	application_id -		Идентификатор приложения клиента, выполняющего запрос от имени принципала
	certificates -	Варианты: get list delete create import update managecontacts getissuers listissuers setissuers deleteissuers manageissuers recover purge	Список разрешений на сертификаты
	keys -	Варианты: encrypt decrypt wrapkey unwrapkey sign verify get list create update import delete backup restore recover purge	Список разрешений на ключи
	object_id - / обязательно		Идентификатор объекта пользователя, принципала службы или группы безопасности в клиенте Azure Active Directory для хранилища. Идентификатор объекта должен быть уникальным для списка политик доступа. Обратите внимание, что это не идентификатор приложения. Идентификатор объекта можно получить, выполнив команду "az ad sp show --id <идентификатор приложения>".
	secrets -	Варианты: get list set delete backup restore recover purge	Список разрешений на секреты
	storage -		Список разрешений на учетные записи хранения
	tenant_id -		Идентификатор клиента Azure Active Directory, который должен использоваться для проверки подлинности запросов к хранилищу ключей. Текущее значение хранилища ключей `tenant_id` будет использовано, если не указано иначе.
ad_user строка			Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
adfs_authority_url строка добавлен в 2.6			URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлен в 2.5		По умолчанию: "latest"	Выбирает профиль API для использования при общении с услугами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack.
append_tags булево		Варианты: no да ←	Используйте для управления тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлен в 2.5		Варианты: auto cli credential_file env msi	Управляет источником учетных данных для аутентификации. Если не указано, будет использована переменная среды ANSIBLE_AZURE_AUTH_SOURCE и по умолчанию `auto` если переменная не определена. `auto` будет следовать по умолчанию порядку приоритетов: параметры модуля -> переменные среды -> профиль по умолчанию в файле учетных данных `~/.azure/credentials`. При значении `cli`, учетные данные будут взяты из профиля Azure CLI по умолчанию. Также может быть задан через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `msi`, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, в противном случае выбирается первая подписка. `msi` был добавлен в Ansible 2.6.
cert_validation_mode строка добавлен в 2.5		Варианты: ignore validate	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, но при использовании прокси HTTPS или подключении к Azure Stack, может потребоваться отключить это поведение, передав `ignore`. Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы.
cloud_environment строка добавлен в 2.4		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (необходимо для Azure Stack). Также может быть задан через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
enable_soft_delete булево		Варианты: no yes	Свойство, определяющее, включена ли функция мягкого удаления для этого хранилища ключей.
enabled_for_deployment булево		Варианты: no yes	Свойство, определяющее, разрешено ли виртуальным машинам Azure получать сертификаты, хранящиеся как секреты в хранилище ключей.
enabled_for_disk_encryption булево		Варианты: no yes	Свойство, определяющее, разрешено ли Azure Disk Encryption получать секреты из хранилища и расшифровывать ключи.
enabled_for_template_deployment булево		Варианты: no yes	Свойство, определяющее, разрешено ли Azure Resource Manager получать секреты из хранилища ключей.
location -			Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
password -			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы.
profile строка			Профиль безопасности, найденный в файле ~/.azure/credentials.
recover_mode булево		Варианты: no yes	Создать хранилище в режиме восстановления.
resource_group - / обязательно			Имя группы ресурсов, к которой относится сервер.
secret строка			Секрет клиента Azure. Используйте при аутентификации с принципалом службы.
sku -			Подробности SKU
	family -		Название семейства SKU
	name - / обязательно	Варианты: standard premium	Имя SKU для указания, является ли хранилище ключей стандартным или премиум-класса.

состояние -	Варианты: отсутствует присутствует ←	Утвердите состояние хранилища ключей. Используйте `present` для создания или обновления хранилища ключей и `absent` для его удаления.
subscription_id строка		Ваш идентификатор подписки Azure.
теги словарь		Словарь пар «строка:строка» для назначения метаданных объекту. Метаданные-теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите параметр append_tags в значение false.
арендатор строка		Идентификатор арендатора Azure. Используйте при аутентификации с помощью принципала службы.
имя_хранилища - / обязательно		Имя хранилища
арендатор_хранилища -		Идентификатор арендатора Azure Active Directory, который должен использоваться для аутентификации запросов к хранилищу ключей.

Примечания

Примечание

Для аутентификации с Azure вы можете передавать параметры, устанавливать переменные среды, использовать профиль, сохраненный в ~/.azure/credentials, или войти в систему перед запуском задач или сценария с помощью az login.
Аутентификация также возможна с помощью принципала службы или пользователя Active Directory.
Для аутентификации через принципала службы передайте subscription_id, client_id, secret и tenant или установите переменные среды AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET и AZURE_TENANT.
Для аутентификации через пользователя Active Directory передайте ad_user и password или установите AZURE_AD_USER и AZURE_PASSWORD в среде.
В качестве альтернативы учетные данные могут быть сохранены в ~/.azure/credentials. Это ini-файл, содержащий раздел [default] и следующие ключи: subscription_id, client_id, secret и tenant или subscription_id, ad_user и password. Также возможно добавление дополнительных профилей. Укажите профиль, передав profile или установив AZURE_PROFILE в среде.

См. также

Войти с помощью Azure CLI: Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Create instance of Key Vault
  azure_rm_keyvault:
    resource_group: myResourceGroup
    vault_name: samplekeyvault
    enabled_for_deployment: yes
    vault_tenant: 72f98888-8666-4144-9199-2d7cd0111111
    sku:
      name: standard
    access_policies:
      - tenant_id: 72f98888-8666-4144-9199-2d7cd0111111
        object_id: 99998888-8666-4144-9199-2d7cd0111111
        keys:
          - get
          - list

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Возвращаемое	Описание
id строка	всегда	Идентификатор ресурса Azure Resource Manager для хранилища ключей. Пример: id

Состояние

Данному модулю не гарантируется обратная совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Zim Kalinowski (@zikalino)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/azure_rm_keyvault_module.html