community.azure.azure_rm_securitygroup_facts – Получение фактов о группе безопасности

Примечание

Этот плагин входит в состав коллекции community.azure (версия 1.0.0).

Для его установки используйте: ansible-galaxy collection install community.azure.

Чтобы использовать его в книге задач, укажите: community.azure.azure_rm_securitygroup_facts.

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Получение фактов о конкретной группе безопасности или всех группах безопасности в группе ресурсов.

Требования

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

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	Варианты: auto ← cli credential_file env msi	Управляет источником учетных данных для аутентификации. Также может быть задан через переменную среды `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	Варианты: ignore validate	Управляет поведением проверки сертификата для 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.
tags строка		Ограничить результаты, предоставив список тегов. Формат тегов: 'ключ' или 'ключ:значение'.
tenant строка		Идентификатор клиента Azure. Используется при аутентификации с принципалом службы.

Примечания

Примечание

Для аутентификации в 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 for one security group
  community.azure.azure_rm_securitygroup_info:
    resource_group: myResourceGroup
    name: secgroup001

- name: Get facts for all security groups
  community.azure.azure_rm_securitygroup_info:
    resource_group: myResourceGroup

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

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

END_OF_DOCUMENT_MARKER

Ключ		Возвращаемое значение	Описание
securitygroups сложный тип		всегда	Список словарей, содержащих информацию о группах безопасности.
	etag строка	всегда	Уникальная неизменяемая строка, которая меняется при каждом обновлении ресурса. Пример: W/"d036f4d7-d977-429a-a8c6-879bc2523399"
	id строка	всегда	Идентификатор ресурса. Пример: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001
	location строка	всегда	Расположение ресурса. Пример: eastus2
	name строка	всегда	Имя ресурса. Пример: secgroup001
	properties словарь	всегда	Список свойств группы безопасности. Пример: {'defaultSecurityRules': [{'etag': 'W/"d036f4d7-d977-429a-a8c6-879bc2523399"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001/defaultSecurityRules/AllowVnetInBound', 'name': 'AllowVnetInBound', 'properties': {'access': 'Allow', 'description': 'Разрешить входящий трафик со всех ВМ в VNET', 'destinationAddressPrefix': 'VirtualNetwork', 'destinationPortRange': '', 'direction': 'Inbound', 'priority': 65000, 'protocol': '', 'provisioningState': 'Succeeded', 'sourceAddressPrefix': 'VirtualNetwork', 'sourcePortRange': ''}}, {'etag': 'W/"d036f4d7-d977-429a-a8c6-879bc2523399"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001/defaultSecurityRules/AllowAzureLoadBalancerInBound', 'name': 'AllowAzureLoadBalancerInBound', 'properties': {'access': 'Allow', 'description': 'Разрешить входящий трафик от azure load balancer', 'destinationAddressPrefix': '', 'destinationPortRange': '', 'direction': 'Inbound', 'priority': 65001, 'protocol': '', 'provisioningState': 'Succeeded', 'sourceAddressPrefix': 'AzureLoadBalancer', 'sourcePortRange': ''}}, {'etag': 'W/"d036f4d7-d977-429a-a8c6-879bc2523399"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001/defaultSecurityRules/DenyAllInBound', 'name': 'DenyAllInBound', 'properties': {'access': 'Deny', 'description': 'Заблокировать весь входящий трафик', 'destinationAddressPrefix': '', 'destinationPortRange': '', 'direction': 'Inbound', 'priority': 65500, 'protocol': '', 'provisioningState': 'Succeeded', 'sourceAddressPrefix': '', 'sourcePortRange': ''}}, {'etag': 'W/"d036f4d7-d977-429a-a8c6-879bc2523399"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001/defaultSecurityRules/AllowVnetOutBound', 'name': 'AllowVnetOutBound', 'properties': {'access': 'Allow', 'description': 'Разрешить исходящий трафик со всех ВМ во все ВМ в VNET', 'destinationAddressPrefix': 'VirtualNetwork', 'destinationPortRange': '', 'direction': 'Outbound', 'priority': 65000, 'protocol': '', 'provisioningState': 'Succeeded', 'sourceAddressPrefix': 'VirtualNetwork', 'sourcePortRange': ''}}, {'etag': 'W/"d036f4d7-d977-429a-a8c6-879bc2523399"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001/defaultSecurityRules/AllowInternetOutBound', 'name': 'AllowInternetOutBound', 'properties': {'access': 'Allow', 'description': 'Разрешить исходящий трафик со всех ВМ в интернет', 'destinationAddressPrefix': 'Internet', 'destinationPortRange': '', 'direction': 'Outbound', 'priority': 65001, 'protocol': '', 'provisioningState': 'Succeeded', 'sourceAddressPrefix': '', 'sourcePortRange': ''}}, {'etag': 'W/"d036f4d7-d977-429a-a8c6-879bc2523399"', 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/secgroup001/defaultSecurityRules/DenyAllOutBound', 'name': 'DenyAllOutBound', 'properties': {'access': 'Deny', 'description': 'Заблокировать весь исходящий трафик', 'destinationAddressPrefix': '', 'destinationPortRange': '', 'direction': 'Outbound', 'priority': 65500, 'protocol': '', 'provisioningState': 'Succeeded', 'sourceAddressPrefix': '', 'sourcePortRange': ''}}], 'networkInterfaces': [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nic004'}], 'provisioningState': 'Succeeded', 'resourceGuid': 'ebd00afa-5dc8-446f-810a-50dd6f671588', 'securityRules': []}
	tags словарь	всегда	Теги, которые необходимо назначить группе безопасности. Пример: {'tag': 'значение'}
	type строка	всегда	Тип ресурса. Пример: Microsoft.Network/networkSecurityGroups

Авторы

Крис Хаускнект (@chouseknecht)
Мэтт Дэвис (@nitzmahone)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/azure/azure_rm_securitygroup_facts_module.html