Spec-Zone.ru › Ansible 2.10

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

Примечание

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

Для его установки используйте: 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 могут использоваться для определения идентификатора подписки, если их несколько; в противном случае используется стандартная подписка 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_secret
логическое значение
    Варианты:
  • нет ←
  • да
Установите 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

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

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

Ключи Возвращаемое значение Описание
keyvaults
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
secret
строка
всегда
Значение секрета.

Пример:
mysecretvault
sid
строка
всегда
Идентификатор секрета.

Пример:
https://myVault.vault.azure.net/flexsecret/secret1/fd2682392a504455b79c90dd04a1bf46
tags
словарь
всегда
Теги секрета.

Пример:
{'delete': 'on-exit'}
type
строка
всегда
Тип содержимого (необязательно)

Пример:
mysecrettype
version
строка
всегда
Версия секрета.

Пример:
fd2682392a504455b79c90dd04a1bf46


Авторы

  • Jose Angel Munoz (@imjoseangel)

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

Spec-Zone.ru

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