Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_bastionhost – Ресурс управляемого шлюза Bastion

Примечание

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

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

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

Для использования в книге задач укажите: azure.azcollection.azure_rm_bastionhost.

Новый в azure.azcollection 1.13.0

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

Описание

  • Создание, обновление или удаление ресурса шлюза Bastion.

Требования

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

  • 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"

append_tags

boolean

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

В каноническом режиме любые теги, не найденные в параметре тегов, будут удалены из метаданных объекта.

Choices:

  • false
  • true ← (default)

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.

Choices:

  • "auto" ← (default)
  • "cli"
  • "credential_file"
  • "env"
  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

Управляет поведением проверки сертификата для конечных точек Azure. По умолчанию все модули будут проверять серверный сертификат, но при использовании прокси HTTPS или для Azure Stack может потребоваться отключить это поведение, передав ignore. Также может быть установлено через профиль файла учетных данных или переменную среды AZURE_CERT_VALIDATION.

Choices:

  • "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_copy_paste

boolean

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

Choices:

  • false
  • true

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Определяет, выполняется ли обнаружение экземпляров при попытке аутентификации. Установка этого параметра в true полностью отключит как обнаружение экземпляров, так и проверку подлинности. Эта функция предназначена для использования в сценариях, когда конечная точка метаданных недоступна, например, в частных облаках или Azure Stack. Процесс обнаружения экземпляров включает в себя получение метаданных авторизации из https://login.microsoft.com/ для проверки авторизации. Установив это значение в **True**, проверка авторизации отключается. В результате важно убедиться, что настроенный узел авторизации является действительным и заслуживающим доверия.

Устанавливается через профиль файла учетных данных или переменную среды AZURE_DISABLE_INSTANCE_DISCOVERY.

Choices:

  • false ← (default)
  • true

enable_file_copy

boolean

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

Choices:

  • false
  • true

enable_ip_connect

boolean

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

Choices:

  • false
  • true

enable_shareable_link

boolean

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

Choices:

  • false
  • true

enable_tunneling

boolean

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

Варианты:

  • false
  • true

ip_configurations

list / elements=dictionary

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

name

string

Имя конфигурации IP-адреса Bastion Host.

private_ip_allocation_method

string

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

Варианты:

  • "Static"
  • "Dynamic"

public_ip_address

dictionary

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

id

string

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

subnet

dictionary

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

id

string

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

location

string

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

log_mode

string

Родительский аргумент.

log_path

string

Родительский аргумент.

name

string / обязательно

Имя Bastion Host.

password

string

Пароль пользователя Active Directory. Используется при аутентификации с пользователем Active Directory вместо службы-принципала.

profile

string

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

resource_group

string / обязательно

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

scale_units

integer

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

secret

string

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

sku

dictionary

SKU этого Bastion Host.

name

string

Название SKU.

Варианты:

  • "Standard"
  • "Basic"

state

string

Устанавливает состояние службы частной связи.

Используйте state=present для создания или обновления службы связи и state=absent для удаления.

Варианты:

  • "present" ← (по умолчанию)
  • "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

Отпечаток цифрового сертификата (thumbprint) указанного в x509_certificate_path.

Используется при аутентификации с помощью службы-принципала.

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

x509_certificate_path

path

added in azure.azcollection 1.14.0

Путь к сертификату X509, используемому для создания служебного принципала в формате PEM.

Сертификат должен быть присоединён к закрытому ключу.

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

Примечания

Примечание

  • Для аутентификации в Azure можно передавать параметры, устанавливать переменные среды, использовать профиль, сохранённый в ~/.azure/credentials, или войти в систему перед выполнением задач или playbook с помощью 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: 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 Bastion Host.

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

disable_copy_paste

boolean

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

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

Пример: false

dns_name

string

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

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

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

enable_file_copy

boolean

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

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

Пример: false

enable_ip_connect

boolean

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

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

Пример: false

enable_shareable_link

boolean

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

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

Пример: false

enable_tunneling

boolean

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

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

Пример: false

etag

string

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

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

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

id

string

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

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

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

ip_configurations

complex

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

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

name

string

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

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

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

Пример: "IpConf"

private_ip_allocation_method

string

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

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

Пример: "Static"

public_ip_address

complex

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

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

id

string

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

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

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

subnet

string

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

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

id

string

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

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

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

location

string

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

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

Пример: "eastus"
END_OF_DOCUMENT_MARKER

Имя

строка

Имя Azure Bastion Host.

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

Пример: "linkservice"

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

строка

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

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

Пример: "Succeeded"

scale_units

целое число

Масштабируемые единицы для ресурса 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_module.html

Spec-Zone.ru

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