Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_bastionhost_info — Получение информации об Azure Bastion Host

Примечание

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

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

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

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

Новая функция в azure.azcollection 1.13.0

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

Описание

  • Получение фактов для Azure bastion host.

Требования

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

  • 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

Имя узла Bastion.

password

string

Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта безопасности.

profile

string

Профиль безопасности, найденный в файле ~/.azure/credentials.

resource_group

string

Имя группы ресурсов.

secret

string

Секретный ключ клиента Azure. Используйте при аутентификации с помощью субъекта безопасности.

subscription_id

string

Ваш идентификатор подписки Azure.

метки

список / элементы=строка

Ограничить результаты, предоставив список меток. Форматировать метки как ‘ключ’ или ‘ключ:значение’.

арендатор

строка

Идентификатор Azure-арендатора. Используйте при аутентификации с помощью Служебного принципала.

отпечаток

строка

добавлено в azure.azcollection 1.14.0

Отпечаток цифровой подписи закрытого ключа, указанного в x509_certificate_path.

Используйте при аутентификации с помощью Служебного принципала.

Требуется, если определено x509_certificate_path.

путь_к_сертификату_x509

путь

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

См. также

См. также

Вход с помощью Azure CLI

Как выполнить аутентификацию с помощью команды az login.

Примеры

- name: Get bastion host info by name
  azure_rm_bastionhost_info:
    name: bastion-name
    resource_group: myResourceGroup

- name: Get all bastion host by resource group
  azure_rm_bastionhost_info:
    resource_group: myResourceGroup

- name: Get all bastion hoste by subscription filter by tags
  azure_rm_bastionhost_info:
    tags:
      - key1
      - abc

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

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

Ключ

Описание

bastion_host

сложный

Список информации об Azure Bastion Host.

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

disable_copy_paste

булево

Включить/выключить функцию Копировать/Вставить для ресурса Bastion Host.

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

Пример: false

dns_name

строка

FQDN для конечной точки, через которую доступен Bastion Host.

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

Пример: "bst-0ca1e1b6-9969-4167-be54-5972e1395c25.bastion.azure.com"

enable_file_copy

булево

Включить/выключить функцию Копирования файлов для ресурса Bastion Host.

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

Пример: false

enable_ip_connect

булево

Включить/выключить функцию подключения по IP для ресурса Bastion Host.

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

Пример: false

enable_shareable_link

булево

Включить/выключить общую ссылку для ресурса Bastion Host.

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

Пример: false

enable_tunneling

булево

Включить/выключить функцию туннелирования для ресурса Bastion Host.

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

Пример: false

etag

строка

Уникальная неизменяемая строка, которая меняется при каждом обновлении ресурса.

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

Пример: "fb0e3a90-6afa-4a01-9171-9c84d144a0f3"

id

строка

Идентификатор ресурса Azure Bastion Host.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/bastionHosts/testbastion"

ip_configurations

сложный

Массив конфигураций IP адресов Bastion Host.

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

name

строка

Имя ресурса, уникальное в группе ресурсов.

Это имя может быть использовано для доступа к ресурсу.

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

Пример: "IpConf"

private_ip_allocation_method

строка

Метод выделения частного IP адреса.

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

Пример: "Static"

public_ip_address

сложный

Ссылка на ресурс PublicIP.

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

id

строка

Идентификатор публичного IP адреса.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/publicIPAddresses/Myip"

subnet

сложный

Ссылка на ресурс подсети.

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

id

строка

Идентификатор подсети.

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

Пример: "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet"

location

строка

Расположение ресурса.

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

Пример: "eastus"

имя

строка

Имя Azure Bastion Host.

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

Пример: "linkservice"

состояние_подготовки

строка

Состояние подготовки ресурса Bastion Host.

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

Пример: "Succeeded"

единицы_масштабирования

целое_число

Единицы масштабирования для ресурса Bastion Host.

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

Пример: 2

sku

сложное

Sku этого Bastion Host.

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

имя

строка

Имя этого Bastion Host.

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

Пример: "Standard"

метки

список / элементы=строка

Метки ресурса.

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

Пример: {"key1": "value1"}

тип

строка

Тип ресурса.

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

Пример: "Microsoft.Network/bastionHosts"

Авторы

  • xuzhang3 (@xuzhang3)
  • Fred-sun (@Fred-sun)

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

  • Система отслеживания ошибок
  • Главная страница
  • Репозиторий (источники)

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

Spec-Zone.ru

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