модуль azure.azcollection.azure_rm_bastionhost – ресурс управляемого узла-бастиона
Примечание
Этот модуль входит в коллекцию azure.azcollection (версия 3.18.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install azure.azcollection. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: azure.azcollection.azure_rm_bastionhost.
Добавлено в azure.azcollection 1.13.0
Краткое описание
- Создание, обновление или удаление ресурса узла-бастиона.
Требования
На хосте, выполняющем этот модуль, должны быть установлены перечисленные ниже компоненты.
- 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 добавлено в azure.azcollection 0.0.1 | URL-адрес центра Azure AD. Используйте при аутентификации с помощью имени пользователя и пароля, если у вас есть собственный центр ADFS. |
api_profile string добавлено в azure.azcollection 0.0.1 | Выбирает профиль API для обмена данными со службами Azure. Значение по умолчанию По умолчанию: |
append_tags boolean | Определяет, является ли поле тегов каноническим или теги только добавляются к существующим. В каноническом режиме все теги, отсутствующие в параметре tags, удаляются из метаданных объекта. Варианты:
|
auth_source string добавлено в azure.azcollection 0.0.1 | Определяет источник учетных данных для аутентификации. Также можно задать с помощью переменной среды Если задано значение Если задано значение Если задано значение Если задано значение Если задано значение Параметр Варианты:
|
cert_validation_mode string добавлено в azure.azcollection 0.0.1 | Управляет проверкой сертификатов конечных точек Azure. По умолчанию все модули проверяют сертификат сервера, однако при использовании HTTPS-прокси или Azure Stack может потребоваться отключить эту проверку, передав Варианты:
|
client_id string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы или управляемого удостоверения (msi). Также можно задать с помощью переменной среды |
cloud_environment string добавлено в azure.azcollection 0.0.1 | Для облачных сред, отличных от общедоступного облака США, укажите имя среды (определенное в Azure Python SDK, например По умолчанию: |
disable_copy_paste boolean | Включает или отключает функцию копирования и вставки ресурса Bastion Host. Варианты:
|
disable_instance_discovery boolean добавлено в azure.azcollection 2.3.0 | Определяет, выполняется ли обнаружение экземпляра при попытке аутентификации. Если задать значение true, обнаружение экземпляра и проверка центра будут полностью отключены. Эта возможность предназначена для сценариев, в которых невозможно обратиться к конечной точке метаданных, например в частных облаках или Azure Stack. Обнаружение экземпляра включает получение метаданных центра с адреса https://login.microsoft.com/ для проверки центра. Если задать значение **True**, проверка центра отключается. Поэтому важно убедиться, что настроенный узел центра является действительным и надежным. Задается в профиле файла учетных данных или с помощью переменной среды Варианты:
|
enable_file_copy boolean | Включает или отключает функцию копирования файлов ресурса Bastion Host. Варианты:
|
enable_ip_connect boolean | Включает или отключает функцию подключения по IP-адресу ресурса Bastion Host. Варианты:
|
boolean | Включает или отключает функцию ссылки для общего доступа ресурса Bastion Host. Варианты:
|
enable_tunneling boolean | Включает или отключает функцию туннелирования ресурса Bastion Host. Варианты:
|
ip_configurations list / элементы=dictionary | Массив конфигураций IP-адресов узла-бастиона. |
|
name string |
Имя конфигурации IP-адреса узла-бастиона. |
|
private_ip_allocation_method string |
Метод выделения частного IP-адреса. Варианты:
|
|
public_ip_address dictionary |
Ссылка на ресурс PublicIP. |
|
id string |
Идентификатор общедоступного IP-адреса. |
|
subnet dictionary |
Ссылка на ресурс подсети. |
|
id string |
Идентификатор подсети. |
location string | Расположение ресурса. |
log_mode string | Родительский аргумент. |
log_path string | Родительский аргумент. |
name string / обязательный | Имя узла-бастиона. |
oidc_token string добавлено в azure.azcollection 3.17.0 | Токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Этот токен обменивается с Azure AD с использованием федеративного удостоверения OIDC. Полезен в системах CI (например, GitHub Actions, Azure DevOps), где платформа напрямую предоставляет токен OIDC. Также можно задать с помощью переменной среды |
oidc_token_file_path path добавлено в azure.azcollection 3.17.0 | Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с помощью удостоверения рабочей нагрузки. Файл должен содержать только необработанный токен. Этот метод часто используется на платформах, которые сохраняют токены OIDC в файлах. Также можно задать с помощью переменной среды |
password string | Пароль пользователя Active Directory. Используйте при аутентификации с помощью пользователя Active Directory, а не субъекта-службы. |
profile string | Профиль безопасности из файла ~/.azure/credentials. |
resource_group string / обязательный | Имя группы ресурсов. |
scale_units integer | Количество единиц масштабирования ресурса Bastion Host. |
secret string | Секрет клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
sku dictionary | Артикул этого ресурса Bastion Host. |
|
name string |
Название артикула. Варианты:
|
state string | Проверьте состояние службы приватного канала. Используйте state=present, чтобы создать или обновить службу канала, и state=absent, чтобы удалить ее. Варианты:
|
subscription_id string | Идентификатор вашей подписки Azure. |
tags dictionary | Словарь пар строка:строка, назначаемых объекту в качестве метаданных. Указанные значения обновят теги метаданных объекта. Чтобы удалить теги, задайте для параметра append_tags значение false. В настоящее время в зонах Azure DNS и службах Traffic Manager также нельзя использовать пробелы в тегах. Azure Front Door не поддерживает использование Azure Automation и Azure CDN поддерживают не более 15 тегов для ресурсов. |
tenant string | Идентификатор клиента Azure. Используйте при аутентификации с помощью субъекта-службы. |
thumbprint string добавлено в azure.azcollection 1.14.0 | Отпечаток закрытого ключа, указанного в x509_certificate_path. Используйте при аутентификации с помощью субъекта-службы. Обязателен, если задан x509_certificate_path. |
x509_certificate_path path добавлено в azure.azcollection 1.14.0 | Путь к сертификату X509 в формате PEM, используемому для создания субъекта-службы. Сертификат должен быть добавлен к закрытому ключу. Используйте при аутентификации с помощью субъекта-службы. |
Примечания
Примечание
- Для аутентификации в Azure можно передавать параметры, задавать переменные среды, использовать профиль из ~/.azure/credentials или выполнить вход перед запуском задач или плейбука с помощью
az login. - Также возможна аутентификация с помощью субъекта-службы или пользователя Active Directory.
- Для аутентификации через OIDC передайте client_id, tenant и oidc_token или oidc_token_file_path либо задайте переменные среды AZURE_CLIENT_ID, AZURE_TENANT и AZURE_FEDERATED_TOKEN или AZURE_FEDERATED_TOKEN_FILE.
- Для аутентификации через субъект-службу передайте 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: Create bastion host info
azure_rm_bastionhost:
name: bastion-name
resource_group: myResourceGroup
ip_configurations:
- name: testip_configuration
subnet:
id: "{{ subnet_output.state.id }}"
public_ip_address:
id: "{{ publicIP_output.publicipaddresses[0].id }}"
private_ip_allocation_method: Dynamic
sku:
name: Standard
enable_tunneling: false
enable_shareable_link: false
enable_ip_connect: false
enable_file_copy: false
scale_units: 6
disable_copy_paste: false
tags:
key1: value1
- name: Create bastion host info
azure_rm_bastionhost:
name: bastion-name
resource_group: myResourceGroup
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
bastion_host complex | Список сведений об узлах-бастионах Azure. Возвращается: всегда |
|
disable_copy_paste boolean |
Включение или отключение функции копирования и вставки для ресурса узла-бастиона. Возвращается: всегда Пример: |
|
dns_name string |
FQDN конечной точки, по которой доступен узел-бастион. Возвращается: всегда Пример: |
|
enable_file_copy boolean |
Включение или отключение функции копирования файлов для ресурса узла-бастиона. Возвращается: всегда Пример: |
|
enable_ip_connect boolean |
Включение или отключение функции подключения по IP для ресурса узла-бастиона. Возвращается: всегда Пример: |
|
boolean |
Включение или отключение функции ссылки общего доступа для ресурса узла-бастиона. Возвращается: всегда Пример: |
|
enable_tunneling boolean |
Включение или отключение функции туннелирования для ресурса узла-бастиона. Возвращается: всегда Пример: |
|
etag string |
Уникальная строка только для чтения, которая изменяется при каждом обновлении ресурса. Возвращается: всегда Пример: |
|
id string |
Идентификатор ресурса узла-бастиона Azure. Возвращается: всегда Пример: |
|
ip_configurations complex |
Массив конфигураций IP-адресов узла-бастиона. Возвращается: всегда |
|
name string |
Имя ресурса, уникальное в пределах группы ресурсов. Это имя можно использовать для доступа к ресурсу. Возвращается: всегда Пример: |
|
private_ip_allocation_method string |
Метод распределения частного IP-адреса. Возвращается: всегда Пример: |
|
public_ip_address complex |
Ссылка на ресурс PublicIP. Возвращается: всегда |
|
id string |
Идентификатор общедоступного IP-адреса. Возвращается: всегда Пример: |
|
subnet string |
Ссылка на ресурс подсети. Возвращается: всегда |
|
id string |
Идентификатор подсети.. Возвращается: всегда Пример: |
|
location string |
Расположение ресурса. Возвращается: всегда Пример: |
|
name string |
Имя узла-бастиона Azure. Возвращается: всегда Пример: |
|
provisioning_state string |
Состояние подготовки ресурса узла-бастиона. Возвращается: всегда Пример: |
|
scale_units integer |
Количество единиц масштабирования ресурса узла-бастиона. Возвращается: всегда Пример: |
|
sku complex |
SKU этого узла-бастиона. Возвращается: всегда |
|
name string |
Название этого узла-бастиона. Возвращается: всегда Пример: |
|
tags list / elements=string |
Теги ресурса. Возвращается: всегда Пример: |
|
type string |
Тип ресурса. Возвращается: всегда Пример: |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/azure/azcollection/azure_rm_bastionhost_module.html