azure.azcollection.azure_rm_subnet_info – Получение фактов о подсети Azure
Примечание
Этот плагин входит в состав коллекции azure.azcollection (версия 1.4.0).
Для его установки используйте: ansible-galaxy collection install azure.azcollection.
Для использования в книге задач укажите: azure.azcollection.azure_rm_subnet_info.
Новое в версии 0.1.2: коллекции azure.azcollection
Обзор
- Получение фактов о подсети Azure.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- 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 |
| Управляет источником учетных данных для аутентификации. Также может быть задан через переменную окружения ANSIBLE_AZURE_AUTH_SOURCE.При установке в auto (по умолчанию) приоритет имеет модульные параметры -> env -> credential_file -> cli.При установке в env, учетные данные будут считываться из переменных окружения.При установке в credential_file, будет считываться профиль из ~/.azure/credentials.При установке в cli, учетные данные будут получены из профиля Azure CLI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если их несколько; иначе используется подписка по умолчанию из Azure CLI.При установке в msi, хост-машина должна быть Azure-ресурсом с включённым расширением MSI. subscription_id или переменная окружения AZURE_SUBSCRIPTION_ID могут использоваться для определения идентификатора подписки, если ресурсу предоставлен доступ к нескольким подпискам; в противном случае выбирается первая подписка.msi было добавлено в Ansible 2.6. |
| cert_validation_mode строка добавлено в 0.0.1 коллекции azure.azcollection |
| Управляет поведением проверки сертификата для 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 строка | Имя подсети. | |
| password строка | Пароль пользователя Active Directory. Используйте при аутентификации с пользователем Active Directory, а не с принципалом службы. | |
| profile строка | Профиль безопасности, найденный в файле ~/.azure/credentials. | |
| resource_group строка / обязательно | Имя группы ресурсов. | |
| secret строка | Секрет клиента Azure. Используйте при аутентификации с принципалом службы. | |
| subscription_id строка | Идентификатор вашей подписки Azure. | |
| tenant строка | Идентификатор клиента Azure. Используйте при аутентификации с принципалом службы. | |
| virtual_network_name строка / обязательно | Имя виртуальной сети. |
Примечания
Примечание
- Для аутентификации с 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
Значения возврата
Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание | ||
|---|---|---|---|---|
| подсети сложный | всегда | Список словарей, содержащих данные о подсети. | ||
| 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 строка | при наличии делегации | Состояние подготовки делегации. Пример: Успешно | ||
| serviceName строка | при наличии делегации | Сервис, связанный с делегацией Пример: Microsoft.ContainerInstance/containerGroups | ||
| id строка | всегда | Идентификатор ресурса подсети. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/my VirtualNetwork/subnets/mySubnet | ||
| name строка | всегда | Имя подсети. Пример: mySubnet | ||
| private_endpoint_network_policies строка | всегда | Enabled или Disabled применяют сетевые политики к частным конечным точкам в подсети.Пример: Включено | ||
| private_link_service_network_policies строка | всегда | Enabled или Disabled применяют сетевые политики к службам частной связи в подсети.Пример: Отключено | ||
| provisioning_state строка | всегда | Состояние подготовки. Пример: Успешно | ||
| 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 строка | всегда | Состояние подготовки. Пример: Успешно | ||
| service строка | всегда | Тип службы конечной точки. Пример: Microsoft.Sql | ||
| virtual_network_name строка | всегда | Имя содержащей виртуальной сети. Пример: myVirtualNetwork | ||
Авторы
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_subnet_info_module.html