Модуль azure.azcollection.azure_rm_securitygroup — управление сетевыми группами безопасности Azure

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. Значение по умолчанию latest подходит для общедоступных облаков; будущие значения позволят использовать Azure Stack.

По умолчанию: "latest"

append_tags

boolean

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

Если поле является каноническим, все теги, отсутствующие в параметре tags, будут удалены из метаданных объекта.

Варианты:

• false
• true ← (по умолчанию)

auth_source

string

добавлено в 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.

Варианты:

• "auto" ← (по умолчанию)
• "cli"
• "credential_file"
• "env"
• "msi"

cert_validation_mode

string

добавлено в 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

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

Для облачных сред, отличных от общедоступного облака США, укажите имя среды (определенное в Azure Python SDK, например, AzureChinaCloud, AzureUSGovernment) или URL-адрес конечной точки обнаружения метаданных (обязательно для Azure Stack). Значение также можно задать в профиле файла учетных данных или с помощью переменной окружения AZURE_CLOUD_ENVIRONMENT.

По умолчанию: "AzureCloud"

default_rules

list / elements=dictionary

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

Как правило, правила по умолчанию не изменяются. Изменяйте правила, чтобы управлять потоком трафика в подсеть или сетевой адаптер либо из них.

Структуру словаря правила см. ниже в описании параметра rules.

access

string

Разрешить ли поток трафика.

Варианты:

• "Allow" ← (по умолчанию)
• "Deny"

description

string

Краткое описание назначения правила.

destination_address_prefix

any

Префикс адреса назначения.

Нотация CIDR или диапазон IP-адресов назначения.

Для сопоставления со всеми исходными IP-адресами также можно использовать звездочку *.

Также можно использовать теги по умолчанию, например VirtualNetwork, AzureLoadBalancer и Internet.

Можно указать строку или список строк.

Звездочку * и теги по умолчанию можно указать только в виде отдельной строки, а не списка строк.

По умолчанию: "*"

destination_application_security_groups

list / elements=any

Список групп безопасности приложений назначения.

Это может быть список идентификаторов ресурсов.

Это может быть список имен в одной группе ресурсов.

Это может быть список словарей, содержащих resource_group и name.

Несовместим с destination_address_prefix и destination_address_prefixes.

destination_port_range

any

Порт или диапазон портов, к которым направляется трафик.

Можно указать строку или список строк.

По умолчанию: "*"

direction

string

Указывает направление потока трафика.

Варианты:

• "Inbound" ← (по умолчанию)
• "Outbound"

name

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

Уникальное имя правила.

priority

integer / обязательный

Порядок применения правила. Должно быть указано уникальное целое число от 100 до 4096 включительно.

protocol

string

Разрешенный протокол трафика.

Варианты:

• "Udp"
• "UDP"
• "Tcp"
• "TCP"
• "Icmp"
• "ICMP"
• "*" ← (по умолчанию)

source_address_prefix

any

Нотация CIDR или диапазон исходных IP-адресов.

Для сопоставления со всеми исходными IP-адресами также можно использовать звездочку *.

Также можно использовать теги по умолчанию, например VirtualNetwork, AzureLoadBalancer и Internet.

Для правила входящего трафика указывает источник сетевого трафика.

Можно указать строку или список строк.

Звездочку * и теги по умолчанию можно указать только в виде отдельной строки, а не списка строк.

По умолчанию: "*"

source_application_security_groups

list / elements=any

Список исходных групп безопасности приложений.

Это может быть список идентификаторов ресурсов.

Это может быть список имен в одной группе ресурсов.

Это может быть список словарей, содержащих resource_group и name.

Несовместим с source_address_prefix и source_address_prefixes.

source_port_range

any

Порт или диапазон портов, с которых поступает трафик.

Можно указать строку или список строк.

По умолчанию: "*"

disable_instance_discovery

boolean

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

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

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

Варианты:

• false ← (по умолчанию)
• true

location

string

Допустимое расположение Azure. По умолчанию используется расположение группы ресурсов.

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.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN.

oidc_token_file_path

path

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

Путь к файлу, содержащему токен OpenID Connect (OIDC) (JWT), используемый для аутентификации с удостоверением рабочей нагрузки.

Файл должен содержать только необработанный токен.

Этот метод обычно используется на платформах, которые сохраняют токены OIDC в виде файлов.

Также можно задать с помощью переменной окружения AZURE_FEDERATED_TOKEN_FILE.

password

string

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

profile

string

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

purge_default_rules

boolean

Удаляет все существующие правила, не соответствующие правилам, заданным в параметре default_rules.

Варианты:

• false ← (по умолчанию)
• true

purge_rules

boolean

Удаляет все существующие правила, не соответствующие правилам, заданным в параметрах rules.

Варианты:

• false ← (по умолчанию)
• true

resource_group

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

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

rules

list / elements=dictionary

Набор правил, управляющих потоком трафика в подсеть или сетевой адаптер либо из них. Каждое правило представляет собой словарь.

access

string

Разрешить ли поток трафика.

Варианты:

• "Allow" ← (по умолчанию)
• "Deny"

description

string

Краткое описание назначения правила.

destination_address_prefix

any

Префикс адреса назначения.

Нотация CIDR или диапазон IP-адресов назначения.

Для сопоставления со всеми исходными IP-адресами также можно использовать звездочку *.

Также можно использовать теги по умолчанию, например VirtualNetwork, AzureLoadBalancer и Internet.

Можно указать строку или список строк.

Звездочку * и теги по умолчанию можно указать только в виде отдельной строки, а не списка строк.

По умолчанию: "*"

destination_application_security_groups

list / elements=any

Список групп безопасности приложений назначения.

Это может быть список идентификаторов ресурсов.

Это может быть список имен в одной группе ресурсов.

Это может быть список словарей, содержащих resource_group и name.

Несовместим с destination_address_prefix и destination_address_prefixes.

destination_port_range

any

Порт или диапазон портов, к которым направляется трафик.

Можно указать строку или список строк.

По умолчанию: "*"

direction

string

Указывает направление потока трафика.

Варианты:

• "Inbound" ← (по умолчанию)
• "Outbound"

name

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

Уникальное имя правила.

priority

integer / обязательный

Порядок применения правила. Должно быть указано уникальное целое число от 100 до 4096 включительно.

protocol

string

Разрешенный протокол трафика.

Варианты:

• "Udp"
• "UDP"
• "Tcp"
• "TCP"
• "Icmp"
• "ICMP"
• "*" ← (по умолчанию)

source_address_prefix

any

Нотация CIDR или диапазон исходных IP-адресов.

Для сопоставления со всеми исходными IP-адресами также можно использовать звездочку *.

Также можно использовать теги по умолчанию, например VirtualNetwork, AzureLoadBalancer и Internet.

Для правила входящего трафика указывает источник сетевого трафика.

Можно указать строку или список строк.

Звездочку * и теги по умолчанию можно указать только в виде отдельной строки, а не списка строк.

По умолчанию: "*"

source_application_security_groups

list / elements=any

Список исходных групп безопасности приложений.

Это может быть список идентификаторов ресурсов.

Это может быть список имён в одной группе ресурсов.

Это может быть список словарей, содержащих resource_group и name.

Несовместимо с source_address_prefix и source_address_prefixes.

source_port_range

any

Порт или диапазон портов, откуда поступает трафик.

Принимает строку или список строк.

По умолчанию: "*"

secret

string

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

state

string

Задаёт требуемое состояние группы безопасности. Укажите present, чтобы создать или обновить группу безопасности. Укажите absent, чтобы удалить группу безопасности.

Варианты:

• "absent"
• "present" ← (по умолчанию)

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, используемому для создания субъекта-службы.

Сертификат необходимо добавить после закрытого ключа.

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

state

complex

Текущее состояние группы безопасности.

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

default_rules

list / elements=string

Правила безопасности по умолчанию для группы сетевой безопасности.

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

Пример: [{"access": "Allow", "description": "Allow inbound traffic from all VMs in VNET", "destination_address_prefix": "VirtualNetwork", "destination_port_range": "*", "direction": "Inbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowVnetInBound", "name": "AllowVnetInBound", "priority": 65000, "protocol": "*", "provisioning_state": "Succeeded", "source_address_prefix": "VirtualNetwork", "source_port_range": "*"}, {"access": "Allow", "description": "Allow inbound traffic from azure load balancer", "destination_address_prefix": "*", "destination_port_range": "*", "direction": "Inbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowAzureLoadBalancerInBound", "name": "AllowAzureLoadBalancerInBound", "priority": 65001, "protocol": "*", "provisioning_state": "Succeeded", "source_address_prefix": "AzureLoadBalancer", "source_port_range": "*"}, {"access": "Deny", "description": "Deny all inbound traffic", "destination_address_prefix": "*", "destination_port_range": "*", "direction": "Inbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/DenyAllInBound", "name": "DenyAllInBound", "priority": 65500, "protocol": "*", "provisioning_state": "Succeeded", "source_address_prefix": "*", "source_port_range": "*"}, {"access": "Allow", "description": "Allow outbound traffic from all VMs to all VMs in VNET", "destination_address_prefix": "VirtualNetwork", "destination_port_range": "*", "direction": "Outbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowVnetOutBound", "name": "AllowVnetOutBound", "priority": 65000, "protocol": "*", "provisioning_state": "Succeeded", "source_address_prefix": "VirtualNetwork", "source_port_range": "*"}, {"access": "Allow", "description": "Allow outbound traffic from all VMs to Internet", "destination_address_prefix": "Internet", "destination_port_range": "*", "direction": "Outbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/AllowInternetOutBound", "name": "AllowInternetOutBound", "priority": 65001, "protocol": "*", "provisioning_state": "Succeeded", "source_address_prefix": "*", "source_port_range": "*"}, {"access": "Deny", "description": "Deny all outbound traffic", "destination_address_prefix": "*", "destination_port_range": "*", "direction": "Outbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/defaultSecurityRules/DenyAllOutBound", "name": "DenyAllOutBound", "priority": 65500, "protocol": "*", "provisioning_state": "Succeeded", "source_address_prefix": "*", "source_port_range": "*"}]

id

string

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

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

Пример: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup"

location

string

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

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

Пример: "westus"

name

string

Имя группы безопасности.

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

Пример: "mysecgroup"

network_interfaces

list / elements=string

Коллекция ссылок на сетевые интерфейсы.

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

Пример: []

rules

list / elements=string

Коллекция правил безопасности группы сетевой безопасности.

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

Пример: [{"access": "Deny", "description": null, "destination_address_prefix": "*", "destination_port_range": "22", "direction": "Inbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/securityRules/DenySSH", "name": "DenySSH", "priority": 100, "protocol": "Tcp", "provisioning_state": "Succeeded", "source_address_prefix": "*", "source_port_range": "*"}, {"access": "Allow", "description": null, "destination_address_prefix": "*", "destination_port_range": "22", "direction": "Inbound", "etag": "W/\"edf48d56-b315-40ca-a85d-dbcb47f2da7d\"", "id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroup/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/mysecgroup/securityRules/AllowSSH", "name": "AllowSSH", "priority": 101, "protocol": "Tcp", "provisioning_state": "Succeeded", "source_address_prefix": "174.109.158.0/24", "source_port_range": "*"}]

subnets

list / elements=string

Коллекция ссылок на подсети.

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

Пример: []

tags

dictionary

Теги, назначенные группе безопасности.

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

Пример: {"delete": "on-exit", "foo": "bar", "testing": "testing"}

type

string

Тип ресурса.

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

Пример: "Microsoft.Network/networkSecurityGroups"