Spec-Zone.ru › Ansible 2.11

azure.azcollection.azure_rm_keyvaultkey_info – Получение фактов о ключе хранилища Azure Key Vault

Примечание

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

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

Для использования в книге задач, укажите: azure.azcollection.azure_rm_keyvaultkey_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 может использоваться для идентификации идентификатора подписки, если их несколько, в противном случае используется стандартная подписка az 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_key
логический тип
    Варианты:
  • нет ←
  • да
Установите в true для отображения удалённых ключей. Установите в 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 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
string
успех
Атрибуты ключа.
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
string
успех
Публичная часть ключа.
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
всегда
Разрешенные операции с ключом.

Пример:
шифрование
tags
list / elements=string
всегда
Теги ключа.

Пример:
['foo']
type
string
всегда
Тип ключа.

Пример:
RSA
version
string
всегда
Версия ключа.

Пример:
fd2682392a504455b79c90dd04a1bf46


Авторы

  • Yunge Zhu (@yungezz)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API