Spec-Zone.ru › Ansible

Модуль azure.azcollection.azure_rm_subnet_info – Получение фактов о подсети Azure

Примечание

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

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

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

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

Новая в azure.azcollection 0.1.2

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

Описание

  • Получение фактов о подсети Azure.

Требования

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

  • 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 могут использоваться для идентификации ID подписки, если присутствует более одной, в противном случае используется подписка az cli по умолчанию.

При установке в msi, хост-машина должна быть ресурсом Azure с включенным расширением MSI. subscription_id или переменная среды AZURE_SUBSCRIPTION_ID могут использоваться для идентификации 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

Имя подсети.

password

string

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

profile

string

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

resource_group

string / required

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

secret

string

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

subscription_id

string

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

tenant

string

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

thumbprint

строка

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

Отпечаток пальца закрытого ключа, указанного в x509_certificate_path.

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

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

virtual_network_name

строка / обязательно

Имя виртуальной сети.

x509_certificate_path

путь

добавлено в 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 facts of specific subnet
  azure_rm_subnet_info:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet

- name: List facts for all subnets in virtual network
  azure_rm_subnet_info:
    resource_group: myResourceGroup
    virtual_network_name: myVirtualNetwork
    name: mySubnet

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

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

Ключ

Описание

subnets

сложный

Список словарей, содержащих данные о подсети.

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

address_prefix_cidr

строка

CIDR, определяющий адресное пространство IPv4 подсети.

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

Пример: "10.1.0.0/16"

address_prefixes_cidr

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

CIDR, определяющий адресное пространство IPv4 и IPv6 подсети.

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

Пример: ["10.2.0.0/24", "fdda:e69b:1587:495e::/64"]

delegations

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

Связанные делегирования подсетей

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

actions

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

Список действий, связанных с сервисом делегирования

Возвращается: при наличии делегирования

Пример: ["Microsoft.Network/virtualNetworks/subnets/action"]

name

строка

Имя делегирования

Возвращается: при наличии делегирования

Пример: "delegationname"

provisioning_state

строка

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

Возвращается: при наличии делегирования

Пример: "Succeeded"

serviceName

строка

Сервис, связанный с делегированием

Возвращается: при наличии делегирования

Пример: "Microsoft.ContainerInstance/containerGroups"

id

строка

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my VirtualNetwork/subnets/mySubnet"

name

строка

Имя подсети.

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

Пример: "mySubnet"

nat_gateway

строка

Идентификатор связанного шлюза NAT.

Возвращается: при наличии

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/natGateways/myGw"

private_endpoint_network_policies

строка

Enabled или Disabled применяются сетевые политики к частным конечным точкам в подсети.

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

Пример: "Enabled"

private_link_service_network_policies

строка

Enabled или Disabled применяются сетевые политики к службам частной связи в подсети.

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

Пример: "Disabled"

provisioning_state

строка

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

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

Пример: "Succeeded"

resource_group

строка

Название группы ресурсов.

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

Пример: "myResourceGroup"

route_table

строка

Идентификатор связанной таблицы маршрутизации.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/routeTables/myRouteTable"

security_group

строка

Идентификатор связанной группы безопасности.

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGr oups/myNsg"

service_endpoints

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

Список конечных точек служб.

Возвращается: при наличии

locations

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

Список имён расположений.

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

Пример: ["eastus", "westus"]

provisioning_state

строка

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

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

Пример: "Succeeded"

service

строка

Тип службы конечной точки.

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

Пример: "Microsoft.Sql"

virtual_network_name

строка

Имя содержащей виртуальной сети.

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

Пример: "myVirtualNetwork"

Авторы

  • Zim Kalinowski (@zikalino)

Ссылки на сборки

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

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

Spec-Zone.ru

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