Модуль azure.azcollection.azure_rm_keyvaultkey_info – Получение фактов о ключе Azure Key Vault

Примечание

Этот модуль является частью коллекции azure.azcollection (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Для использования в playbook укажите: azure.azcollection.azure_rm_keyvaultkey_info.

Добавлена в azure.azcollection 0.1.2

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

Описание

Получение фактов о ключе Azure Key Vault.

Требования

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

python >= 2.7
На хосте, выполняющем этот модуль, должна быть установлена коллекция azure.azcollection через galaxy
Все пакеты Python, перечисленные в файле requirements.txt коллекции, должны быть установлены через pip на хосте, на котором выполняются модули из azure.azcollection
Полные инструкции по установке можно найти по адресу https://galaxy.ansible.com/azure/azcollection

Параметры

Параметр	Комментарии
ad_user string	Имя пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
adfs_authority_url string added in azure.azcollection 0.0.1	URL-адрес узла Azure AD. Используйте при аутентификации с помощью имени пользователя/пароля и имеете собственный узел ADFS.
api_profile string added in azure.azcollection 0.0.1	Выбирает профиль API для использования при взаимодействии с службами Azure. Значение по умолчанию `latest` подходит для общедоступных облаков; будущие значения позволят использовать с Azure Stack. Default: `"latest"`
auth_source string added in azure.azcollection 0.0.1	Управляет источником учетных данных для аутентификации. Также может быть установлен через переменную среды `ANSIBLE_AZURE_AUTH_SOURCE`. При установке в `auto` (по умолчанию) приоритет имеет параметры модуля -> `env` -> `credential_file` -> `cli`. При установке в `env`, учетные данные будут считываться из переменных среды При установке в `credential_file`, он будет считывать профиль из `~/.azure/credentials`. При установке в `cli`, учетные данные будут получены из профиля Azure CLI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если присутствует более одного, в противном случае используется подписка az cli по умолчанию. При установке в `msi`, хост-машина должна быть ресурсом Azure с включенным расширением MSI. `subscription_id` или переменная среды `AZURE_SUBSCRIPTION_ID` могут использоваться для идентификации идентификатора подписки, если ресурсу предоставлен доступ к более чем одной подписке, в противном случае выбирается первая подписка. Параметр `msi` был добавлен в Ansible 2.6. Варианты: `"auto"` ← (по умолчанию) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси-сервера HTTPS или в Azure Stack может потребоваться отключить это поведение, передав `ignore`. Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CERT_VALIDATION`. Варианты: `"ignore"` `"validate"`
client_id string	Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта безопасности или управляемой идентификации (msi). Также может быть установлен через переменную среды `AZURE_CLIENT_ID`.
cloud_environment string added in azure.azcollection 0.0.1	Для облачных сред, отличных от общедоступного облака США, имя среды (как определено в Azure Python SDK, например, `AzureChinaCloud`, `AzureUSGovernment`), или URL-адрес конечной точки обнаружения метаданных (требуется для Azure Stack). Также может быть установлен через профиль файла учетных данных или переменную среды `AZURE_CLOUD_ENVIRONMENT`. Default: `"AzureCloud"`
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Определяет, будет ли выполняться обнаружение экземпляров при попытке аутентификации. Установка этого значения в true полностью отключит как обнаружение экземпляров, так и проверку полномочий. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает извлечение метаданных полномочий из https://login.microsoft.com/ для проверки полномочий. Установив это значение в True, проверка полномочий отключается. В результате крайне важно убедиться, что настроенный узел полномочий является действительным и заслуживающим доверия. Устанавливается через профиль файла учетных данных или переменную среды `AZURE_DISABLE_INSTANCE_DISCOVERY`. Варианты: `false` ← (по умолчанию) `true`
log_mode string	Родительский аргумент.
log_path string	Родительский аргумент.
name string	Имя ключа. Если не указано, будут перечислены все ключи в vault_uri.
password string	Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с субъектом безопасности.
profile string	Профиль безопасности, найденный в файле ~/.azure/credentials.
secret string	Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.
show_deleted_key boolean	Установите в `true` для отображения удаленных ключей. Установите в `false` для отображения не удаленных ключей. Варианты: `false` ← (по умолчанию) `true`
subscription_id string	Ваш идентификатор подписки Azure.

тэги список / элементы=строка	Ограничить результаты, предоставив список тэгов. Формат тэгов: ‘ключ’ или ‘ключ:значение’.
арендатор строка	Идентификатор Azure-арендатора. Используется при аутентификации с помощью Служебного принципа.
отпечаток строка добавлен в azure.azcollection 1.14.0	Отпечаток частного ключа, указанного в x509_certificate_path. Используется при аутентификации с помощью Служебного принципа. Требуется, если определён x509_certificate_path.
vault_uri строка / обязательно	URI хранилища ключей, в котором хранится ключ.
версия строка	Версия ключа. Установите в `current`, чтобы отобразить последнюю версию ключа. Установите в `all`, чтобы отобразить все версии ключа. Установите конкретную версию, чтобы отобразить конкретную версию ключа. Например, fd2682392a504455b79c90dd04a1bf46. По умолчанию: `"current"`
x509_certificate_path путь добавлен в azure.azcollection 1.14.0	Путь к X509 сертификату, используемому для создания служебного принципа в формате PEM. Сертификат должен быть присоединен к закрытому ключу. Используется при аутентификации с помощью Служебного принципа.

Примечания

Примечание

Для аутентификации с 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. Также можно добавить дополнительные профили. Укажите профиль, передав профиль или установив AZURE_PROFILE в среде.

См. также

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

Примеры

- name: Get latest version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey

- name: List all versions of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: all

- name: List specific version of specific key
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    name: myKey
    version: fd2682392a504455b79c90dd04a1bf46

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

- name: List deleted keys in specific key vault
  azure_rm_keyvaultkey_info:
    vault_uri: "https://myVault.vault.azure.net"
    show_deleted_key: true

Значения возврата

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

Ключ	Описание
keyvaults complex	Список ключей в Azure Key Vault. Возвращается: всегда
attributes dictionary	Атрибуты ключа. Возвращается: успешно
created string	Дата и время создания. Возвращается: всегда Пример: `"2019-04-25T07:26:49+00:00"`
enabled string	Указывает, включен ли ключ. Возвращается: всегда Пример: `"True"`
expires string	Дата и время истечения срока действия. Возвращается: успешно Пример: `"2019-04-25T07:26:49+00:00"`
not_before string	Дата и время "не ранее чем". Возвращается: успешно Пример: `"2019-04-25T07:26:49+00:00"`
recovery_level string	Отражает уровень восстановления после удаления, который в настоящее время действует для ключей в текущем хранилище. Если он содержит `Purgeable`, ключ может быть окончательно удален привилегированным пользователем. В противном случае только система может очистить ключ по истечении интервала хранения. Возвращается: всегда Пример: `"Purgable"`
updated string	Дата и время обновления. Возвращается: всегда Пример: `"2019-04-25T07:26:49+00:00"`
key dictionary	Открытая часть ключа. Возвращается: успешно
crv string	Название эллиптической кривой. Возвращается: успешно
e string	Открытый показатель RSA. Возвращается: успешно
n string	Модули RSA. Возвращается: успешно
x string	X-компонент открытого ключа EC. Возвращается: успешно
y string	Y-компонент открытого ключа EC. Возвращается: успешно
kid string	Идентификатор ключа. Возвращается: всегда Пример: `"https://myVault.vault.azure.net/keys/key1/fd2682392a504455b79c90dd04a1bf46"`
managed boolean	`True` если срок действия ключа управляется хранилищем ключей. Возвращается: успешно Пример: `true`
permitted_operations list / elements=string	Допустимые операции с ключом. Возвращается: всегда Пример: `["encrypt"]`
tags list / elements=string	Теги ключа. Возвращается: всегда Пример: `["foo"]`
type string	Тип ключа. Возвращается: всегда Пример: `"RSA"`

версия

строка

Версия ключа.

Возвращается: всегда

Пример: "fd2682392a504455b79c90dd04a1bf46"

Авторы

Yunge Zhu (@yungezz)

Ссылки на коллекцию

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