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

Примечание

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

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

Для использования в playbook, укажите: 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 <application 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` могут использоваться для указания идентификатора подписки, если их несколько, в противном случае используется стандартная подписка Azure CLI. При значении `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 строка / обязательно	Варианты: standard premium	Имя SKU для указания, является ли хранилище ключей стандартным или премиум-класса.
state строка		Варианты: absent present ←	Утверждает состояние хранилища ключей. Используйте `present` для создания или обновления хранилища ключей и `absent` для его удаления.
subscription_id строка			Ваш идентификатор подписки Azure.
tags словарь			Словарь пар строка:строка для задания метаданных объекта. Метаданные теги объекта будут обновлены всеми предоставленными значениями. Для удаления тегов установите опцию append_tags в false.
tenant строка			Идентификатор клиента Azure. Используйте при аутентификации с помощью службы-принципала.
vault_name строка / обязательно			Имя хранилища.
vault_tenant строка			Идентификатор клиента Azure Active Directory, который должен использоваться для аутентификации запросов в хранилище ключей.

Примечания

Примечание

Для аутентификации с Azure можно передать параметры, установить переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти перед выполнением задач или playbook с помощью 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 string	всегда	Идентификатор ресурса Azure Resource Manager для хранилища ключей. Пример: id

Авторы

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.10/collections/azure/azcollection/azure_rm_keyvault_module.html