azure.azcollection.azure_rm_securitygroup 模块 – 管理 Azure 网络安全组
注意
此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，有关详细信息，请参阅 要求。
要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_securitygroup。
azure.azcollection 0.1.0 中的新增功能
概要
创建、更新或删除网络安全组。
安全组包含访问控制列表 (ACL) 规则，这些规则允许或拒绝进出子网或各个网络接口的网络流量。
创建安全组时会包含一组默认安全规则和一组空的自定义安全规则。
通过向空的自定义安全规则集中添加规则来塑造流量流。
要求
执行此模块的主机需要以下要求。
python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 Python 包
完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 中找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。当使用用户名/密码进行身份验证并且具有您自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时使用的 API 配置文件。默认值 默认值： |
|
用于控制 tags 字段是规范的还是仅附加到现有标签。 当为规范时，在 tags 参数中未找到的任何标签都将从对象的元数据中删除。 选项
|
|
控制用于身份验证的凭据来源。 也可以通过 设置为 设置为 设置为 设置为 设置为
选项
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云以外的云环境，使用环境名称（由 Azure Python SDK 定义，例如 默认值: |
|
在创建安全组时自动添加到安全组的默认规则集。 通常，默认规则不会被修改。修改规则以塑造进出子网或 NIC 的流量。 有关规则字典的组成，请参见下面的规则。 |
|
是否允许流量。 选项
|
|
规则用途的简短描述。 |
|
目标地址前缀。 CIDR 或目标 IP 范围。 星号 还可以使用诸如 它可以接受字符串类型或字符串类型列表。 星号 默认值: |
|
目标应用程序安全组的列表。 它可以是资源 ID 的列表。 它可以是同一资源组中名称的列表。 它可以是包含 resource_group 和 name 的字典列表。 它与 |
|
流量所指向的端口或端口范围。 它可以接受字符串类型或字符串类型列表。 默认值: |
|
指示流量的方向。 选项
|
|
规则的唯一名称。 |
|
应用规则的顺序。必须是 100 到 4096 之间（包括 100 和 4096）的唯一整数。 |
|
接受的流量协议。 选项
|
|
CIDR 或源 IP 范围。 星号 还可以使用诸如 如果这是入口规则，则指定网络流量的来源。 它可以接受字符串类型或字符串类型列表。 星号 默认值: |
|
源应用程序安全组的列表。 它可以是资源 ID 的列表。 它可以是同一资源组中名称的列表。 它可以是包含 resource_group 和 name 的字典列表。 它与 |
|
流量的起始端口或端口范围。 它可以接受字符串类型或字符串类型列表。 默认值: |
|
确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现过程需要从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 **True**，将禁用授权验证。因此，至关重要的是要确保配置的授权主机是有效且可信的。 通过凭据文件配置文件或 选项
|
|
有效的 Azure 位置。默认为资源组的位置。 |
|
父参数。 |
|
父参数。 |
|
要操作的安全组的名称。 |
|
Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
删除任何与 default_rules 参数中定义的规则不匹配的现有规则。 选项
|
|
删除任何与 rules 参数中定义的规则不匹配的现有规则。 选项
|
|
安全组所属的资源组的名称。 |
|
塑造进出子网或 NIC 流量的规则集。每个规则都是一个字典。 |
|
是否允许流量。 选项
|
|
规则用途的简短描述。 |
|
目标地址前缀。 CIDR 或目标 IP 范围。 星号 还可以使用诸如 它可以接受字符串类型或字符串类型列表。 星号 默认值: |
|
目标应用程序安全组的列表。 它可以是资源 ID 的列表。 它可以是同一资源组中名称的列表。 它可以是包含 resource_group 和 name 的字典列表。 它与 |
|
流量所指向的端口或端口范围。 它可以接受字符串类型或字符串类型列表。 默认值: |
|
指示流量的方向。 选项
|
|
规则的唯一名称。 |
|
应用规则的顺序。必须是 100 到 4096 之间（包括 100 和 4096）的唯一整数。 |
|
接受的流量协议。 选项
|
|
CIDR 或源 IP 范围。 星号 还可以使用诸如 如果这是入口规则，则指定网络流量的来源。 它可以接受字符串类型或字符串类型列表。 星号 默认值: |
|
源应用程序安全组的列表。 它可以是资源 ID 的列表。 它可以是同一资源组中名称的列表。 它可以是包含 resource_group 和 name 的字典列表。 它与 |
|
流量的起始端口或端口范围。 它可以接受字符串类型或字符串类型列表。 默认值: |
|
Azure 客户端密钥。当使用服务主体进行身份验证时使用。 |
|
断言安全组的状态。设置为 选项
|
|
您的 Azure 订阅 ID。 |
|
要作为元数据分配给对象的字符串:字符串对的字典。 对象上的元数据标记将使用任何提供的值进行更新。 要删除标记，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。 Azure Front Door 不支持使用 Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。 |
|
Azure 租户 ID。当使用服务主体进行身份验证时使用。 |
|
x509_certificate_path 中指定的私钥的指纹。 当使用服务主体进行身份验证时使用。 如果定义了 x509_certificate_path，则为必填项。 |
|
用于以 PEM 格式创建服务主体的 X509 证书的路径。 证书必须附加到私钥。 当使用服务主体进行身份验证时使用。 |
备注
注意
为了使用 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 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递配置文件或在环境中设置 AZURE_PROFILE 来指定配置文件。
另请参阅
另请参阅
- 使用 Azure CLI 登录
如何使用
az login命令进行身份验证。
示例
- name: Create a security group
azure_rm_securitygroup:
resource_group: myResourceGroup
name: mysecgroup
purge_rules: true
rules:
- name: DenySSH
protocol: Tcp
destination_port_range: 22
access: Deny
priority: 100
direction: Inbound
- name: 'AllowSSH'
protocol: Tcp
source_address_prefix:
- '174.109.158.0/24'
- '174.109.159.0/24'
destination_port_range: 22
access: Allow
priority: 101
direction: Inbound
- name: 'AllowMultiplePorts'
protocol: Tcp
source_address_prefix:
- '174.109.158.0/24'
- '174.109.159.0/24'
destination_port_range:
- 80
- 443
access: Allow
priority: 102
- name: Update rules on existing security group
azure_rm_securitygroup:
resource_group: myResourceGroup
name: mysecgroup
rules:
- name: DenySSH
protocol: Tcp
destination_port_range: 22-23
access: Deny
priority: 100
direction: Inbound
- name: AllowSSHFromHome
protocol: Tcp
source_address_prefix: '174.109.158.0/24'
destination_port_range: 22-23
access: Allow
priority: 102
direction: Inbound
tags:
testing: testing
delete: on-exit
- name: Create a securiy group with I(protocol=Icmp)
azure_rm_securitygroup:
name: mysecgroup
resource_group: myResourceGroup
rules:
- name: SSH
protocol: Tcp
destination_port_range: 22
access: Allow
priority: 105
direction: Inbound
- name: ICMP
protocol: Icmp
priority: 106
- name: Delete security group
azure_rm_securitygroup:
resource_group: myResourceGroup
name: mysecgroup
state: absent
返回值
常用返回值记录在 这里，以下是此模块特有的字段
Key |
描述 |
|---|---|
安全组的当前状态。 返回: 始终 |
|
网络安全组的默认安全规则。 返回: 始终 示例： |
|
资源 ID。 返回: 始终 示例： |
|
资源位置。 返回: 始终 示例： |
|
安全组的名称。 返回: 始终 示例： |
|
对网络接口的引用集合。 返回: 始终 示例： |
|
网络安全组的安全规则集合。 返回: 始终 示例： |
|
对子网的引用集合。 返回: 始终 示例： |
|
要分配给安全组的标签。 返回: 始终 示例： |
|
资源类型。 返回: 始终 示例： |