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

Примечание

Этот плагин входит в коллекцию azure.azcollection (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install azure.azcollection.

Чтобы использовать его в книге задач, укажите: azure.azcollection.azure_rm_keyvault.

Новое в версии 0.1.2: из azure.azcollection

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

Описание

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

Требования

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

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 строка добавлено в 0.0.1 azure.azcollection			URL-адрес службы Azure AD. Используйте при аутентификации с именем пользователя/паролем и собственной службой ADFS.
api_profile строка добавлено в 0.0.1 azure.azcollection		По умолчанию: "latest"	Выбирает профиль API для использования при взаимодействии с Azure-сервисами. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.
append_tags булево		Варианты: нет да ←	Управление тем, является ли поле тегов каноническим или просто добавляется к существующим тегам. При каноническом значении любые теги, отсутствующие в параметре тегов, будут удалены из метаданных объекта.
auth_source строка добавлено в 0.0.1 azure.azcollection		Варианты: авто ← cli credential_file env msi	Управление источником учетных данных для аутентификации. Также можно задать через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При значении `auto` (по умолчанию) приоритет имеет: параметры модуля -> `env` -> `credential_file` -> `cli`. При значении `env`, учетные данные будут считываться из переменных среды. При значении `credential_file`, профиль будет считываться из `~/.azure/credentials`. При значении `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если их несколько, иначе используется по умолчанию. При значении `msi`, хост-машина должна быть Azure-ресурсом с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам, иначе выбирается первая подписка. `msi` добавлено в Ansible 2.6.
cert_validation_mode строка добавлено в 0.0.1 azure.azcollection		Варианты: ignore validate	Управление поведением проверки сертификатов для Azure-точек входа. По умолчанию все модули проверяют серверный сертификат, но при использовании прокси-сервера HTTPS или при работе с Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`.
client_id строка			Идентификатор клиента Azure. Используется при аутентификации с помощью службы.
cloud_environment строка добавлено в 0.0.1 azure.azcollection		По умолчанию: "AzureCloud"	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment` ) или URL-адрес точки входа для обнаружения метаданных (необходимо для Azure Stack). Также можно задать через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`.
enable_soft_delete булево		Варианты: нет да	Параметр для указания, включена ли функция мягкого удаления для данного хранилища ключей.
enabled_for_deployment булево		Варианты: нет да	Параметр для указания, разрешено ли виртуальным машинам Azure получать сертификаты, сохраненные как секреты в хранилище ключей.
enabled_for_disk_encryption булево		Варианты: нет да	Параметр для указания, разрешено ли Azure Disk Encryption получать секреты из хранилища и раскрывать ключи.
enabled_for_template_deployment булево		Варианты: нет да	Параметр для указания, разрешено ли Azure Resource Manager получать секреты из хранилища ключей.
location строка			Расположение ресурса. Если не задано, используется расположение из группы ресурсов по умолчанию.
password строка			Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory вместо службы.
profile строка			Профиль безопасности в файле ~/.azure/credentials.
recover_mode булево		Варианты: нет да	Создать хранилище в режиме восстановления.
resource_group строка / обязательно			Имя группы ресурсов, к которой относится сервер.
secret строка			Секрет клиента Azure. Используется при аутентификации с помощью службы.
sku строка			Детали SKU.
	family строка		Имя семейства SKU.
	name строка / обязательно	Варианты: стандартный премиум	Имя SKU для указания, является ли хранилище ключей стандартным или премиум-хранилищем.
state строка		Варианты: отсутствует наличие ←	Установить состояние хранилища ключей. Используйте `present` для создания или обновления хранилища ключей и `absent` для его удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для назначения метаданных объекту. Метаданные теги объекта будут обновлены любыми предоставленными значениями. Для удаления тегов установите опцию append_tags в значение false.
tenant строка			Идентификатор клиента Azure. Используется при аутентификации с помощью службы.
vault_name строка / обязательно			Имя хранилища.
vault_tenant строка			Идентификатор клиента 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

Авторы

Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_keyvault_module.html