azure.azcollection.azure_rm_keyvaultsecret_info – Получение данных о секрете Azure Key Vault

Примечание

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_keyvaultsecret_info.

Введено в версии 0.1.2: из azure.azcollection

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

Обзор

Получение данных о секрете Azure Key Vault.

Требования

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

python >= 2.7
azure >= 2.0.0

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
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.
auth_source строка добавлено в 0.0.1 azure.azcollection	Варианты: auto ← 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`.
name строка		Имя секрета. Если не задано, будут перечислены все секреты в vault_uri.
password строка		Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory, а не с принципом службы.
profile строка		Профиль безопасности, найденный в файле ~/.azure/credentials.
secret строка		Секрет клиента Azure. Используется при аутентификации с принципом службы.
show_deleted_secret булево	Варианты: no ← yes	Установите show_delete_secret=true, чтобы отобразить удалённые секреты. Установите show_deleted_secret=false, чтобы отобразить не удалённые секреты.
subscription_id строка		Идентификатор вашей Azure-подписки.
tags словарь		Ограничить результаты, указав список тегов. Формат тегов — 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор Azure-аренды. Используется при аутентификации с принципом службы.
vault_uri строка / обязательно		URL хранилища, где хранится секрет.
version строка	По умолчанию: "current"	Версия секрета. Установите `current`, чтобы отобразить последнюю версию секрета. Установите `all`, чтобы отобразить все версии секрета. Укажите конкретную версию, чтобы отобразить определённую версию секрета. Например, fd2682392a504455b79c90dd04a1bf46

Примечания

Примечание

Для аутентификации с 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: Get latest version of specific secret
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: mySecret

- name: List all versions of specific secret
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: mySecret
    version: all

- name: List specific version of specific secret
  azure_rm_keyvaultsecret_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: mySecret
    version: fd2682392a504455b79c90dd04a1bf46

- name: List all secrets in specific key vault
  azure_rm_keyvaultsecret_info:
      vault_uri: "https://myVault.vault.azure.net"

- name: List deleted secrets in specific key vault
  azure_rm_keyvaultsecret_info:
      vault_uri: "https://myVault.vault.azure.net"
      show_deleted_secret: True

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

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

Ключ			Возвращаемое значение	Описание
secrets complex			всегда	Список секретов в Azure Key Vault.
	attributes словарь		успех	Атрибуты секрета.
		created строка	всегда	Дата и время создания. Пример: 2019-04-25T07:26:49+00:00
		enabled строка	всегда	Указывает, включён ли секрет. Пример: True
		expires строка	успех	Дата и время истечения срока действия. Пример: 2019-04-25T07:26:49+00:00
		not_before строка	успех	Дата и время, до которого секрет недоступен. Пример: 2019-04-25T07:26:49+00:00
		recovery_level строка	всегда	Отражает уровень восстановления при удалении, действующий для секретов в данном хранилище. Если содержит 'Purgeable', секрет может быть удалён навсегда привилегированным пользователем, В противном случае только система может удалить секрет по окончании периода хранения. Пример: Recoverable+Purgeable
		updated строка	всегда	Дата и время обновления. Пример: 2019-04-25T07:26:49+00:00
	content_type строка		всегда	Тип контента (необязательно) Пример: mysecrettype
	secret строка		всегда	Значение секрета. Пример: mysecretvault
	sid строка		всегда	Идентификатор секрета. Пример: https://myVault.vault.azure.net/flexsecret/secret1/fd2682392a504455b79c90dd04a1bf46
	tags словарь		всегда	Теги секрета. Пример: {'delete': 'on-exit'}
	version строка		всегда	Версия секрета. Пример: fd2682392a504455b79c90dd04a1bf46

Авторы

Jose Angel Munoz (@imjoseangel)

© 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_keyvaultsecret_info_module.html