azure.azcollection.azure_rm_networkflowlog 模块 – 管理网络流日志

注意

此模块是 azure.azcollection 集合（版本 3.1.0）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要满足其他要求才能使用此模块，请参阅 要求 了解详细信息。

要在 Playbook 中使用它，请指定：azure.azcollection.azure_rm_networkflowlog。

azure.azcollection 2.5.0 中的新增功能

概要

  • 创建、更新或删除网络流日志。

要求

执行此模块的主机需要满足以下要求。

  • python >= 2.7

  • 执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合

  • 必须通过 pip 在执行来自 azure.azcollection 的模块的主机上安装集合的 requirements.txt 中列出的所有 python 包

  • 完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 中找到

参数

参数

注释

ad_user

字符串

Active Directory 用户名。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

adfs_authority_url

字符串

在 azure.azcollection 0.0.1 中添加

Azure AD 授权 URL。当使用用户名/密码进行身份验证，并且有自己的 ADFS 授权时使用。

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

选择与 Azure 服务通信时使用的 API 配置文件。默认值 latest 适用于公有云；未来的值将允许与 Azure Stack 一起使用。

默认值： "latest"

append_tags

布尔值

用于控制 tags 字段是规范的还是只是附加到现有标签。

当为规范时，在 tags 参数中找不到的任何标签将从对象的元数据中删除。

选项

  • false

  • true ←（默认）

auth_source

字符串

在 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 时，主机必须是启用了 MSI 扩展的 Azure 资源。subscription_id 或环境变量 AZURE_SUBSCRIPTION_ID 可用于标识订阅 ID（如果资源被授予访问多个订阅的权限），否则将选择第一个订阅。

msi 已在 Ansible 2.6 中添加。

选项

  • "auto" ←（默认）

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

字符串

在 azure.azcollection 0.0.1 中添加

控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 ignore 来禁用此行为。也可以通过凭据文件配置文件或 AZURE_CERT_VALIDATION 环境变量设置。

选项

  • "ignore"

  • "validate"

client_id

字符串

Azure 客户端 ID。当使用服务主体或托管标识 (msi) 进行身份验证时使用。

也可以通过 AZURE_CLIENT_ID 环境变量设置。

cloud_environment

字符串

在 azure.azcollection 0.0.1 中添加

对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 AzureChinaCloud、AzureUSGovernment）或元数据发现端点 URL（Azure Stack 所需）。也可以通过凭据文件配置文件或 AZURE_CLOUD_ENVIRONMENT 环境变量设置。

默认值： "AzureCloud"

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点的情况，例如在私有云或 Azure Stack 中。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将其设置为 **True**，将禁用授权验证。因此，至关重要的是要确保配置的授权主机是有效且可信的。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量设置。

选项

  • false ← (默认)

  • true

已启用

布尔值

启用/禁用流日志记录的标志。

选项

  • false

  • true

flow_analytics_configuration

dictionary

定义流量分析配置的参数。

network_watcher_flow_analytics_configuration

dictionary

定义流量分析配置的参数。

已启用

布尔值

启用/禁用流量分析的标志。

选项

  • false

  • true

traffic_analytics_interval

integer

决定 TA 服务执行流量分析频率的间隔（分钟）。

选项

  • 10

  • 60

workspace_id

字符串

附加工作区的资源 GUID。

workspace_region

字符串

附加工作区的位置。

workspace_resource_id

字符串

附加工作区的资源 ID。

location

字符串

有效的 Azure 位置。默认为资源组的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

string / 必填

网络流日志的名称。

network_watcher_name

string / 必填

网络监视器的名称。

password

字符串

Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。

profile

字符串

在 ~/.azure/credentials 文件中找到的安全配置文件。

resource_group

string / 必填

资源组的名称。

retention_policy

dictionary

定义流日志保留策略的参数。

days

integer

保留流日志记录的天数。

已启用

布尔值

启用/禁用保留的标志。

选项

  • false

  • true

secret

字符串

Azure 客户端密钥。当使用服务主体进行身份验证时使用。

state

字符串

流日志的状态。使用 present 创建或更新，使用 absent 删除。

选项

  • "absent"

  • "present" ← (默认)

storage_id

字符串

用于存储流日志的存储帐户的 ID。

subscription_id

字符串

您的 Azure 订阅 ID。

tags

dictionary

要分配为对象元数据的 string:string 对的字典。

对象的元数据标记将使用任何提供的值进行更新。

要删除标记，请将 append_tags 选项设置为 false。

目前，Azure DNS 区域和流量管理器服务也不允许在标记中使用空格。

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。

target_resource_id

字符串

将应用流日志的网络安全组的 ID。

tenant

字符串

Azure 租户 ID。当使用服务主体进行身份验证时使用。

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

当使用服务主体进行身份验证时使用。

如果定义了 x509_certificate_path，则为必填项。

x509_certificate_path

path

在 azure.azcollection 1.14.0 中添加

用于以 PEM 格式创建服务主体的 X509 证书的路径。

证书必须附加到私钥。

当使用服务主体进行身份验证时使用。

注释

注意

  • 要使用 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: Create network flow log
  azure_rm_networkflowlog:
    resource_group: NetworkWatcherRG
    network_watcher_name: NetworkWatcher_eastus
    name: xz3mlwvnet-xz3mlwaiserv-flowlog02
    enabled: false
    flow_analytics_configuration:
      network_watcher_flow_analytics_configuration:
        enabled: false
        traffic_analytics_interval: 60
        workspace_id: 7c16a8dd-b983-4f75-b78b-a804c169306c
        workspace_region: eastus
        workspace_resource_id: "/subscriptions/xxx-xxx/resourceGroups/DefaultRG-EUS/providers/Microsoft.OperationalInsights/workspaces/DeWorkspace-0-EUS"
    retention_policy:
      days: 2
      enabled: true
    storage_id: "/subscriptions/xxx-xxx/resourceGroups/AutoTagFunctionAppRG/providers/Microsoft.Storage/storageAccounts/autotagfunctionappr9a08"
    target_resource_id: "/subscriptions/xxx-xxx/resourceGroups/xz3mlwaiserv/providers/Microsoft.Network/virtualNetworks/xz3mlwvnet"
    tags:
      key2: value2
      key5: value5

- name: Delete a Flow Logs
  azure_rm_networkflowlog:
    resource_group: myResourceGroup
    network_watcher_name: testwatcher
    name: myNetflowlog
    state: absent

返回值

常见返回值记录在此处，以下是此模块独有的字段

Key

描述

state

complex

网络流日志的事实。

返回：始终

enanbled

字符串

启用/禁用流日志记录的标志。

返回：始终

示例： "True"

flow_analytics_configuration

complex

定义流量分析配置的参数。

返回：始终

network_watcher_flow_analytics_configuration

complex

定义流量分析配置的参数。

返回：始终

已启用

布尔值

启用/禁用流量分析的标志。

返回：始终

示例： true

traffic_analytics_interval

字符串

决定 TA 服务执行流量分析频率的间隔（分钟）。

返回：始终

示例： "60"

workspace_id

字符串

附加工作区的资源 GUID。

返回：始终

示例： "7c16a8dd-b983-4f75-b78b-a804c169306c"

workspace_region

字符串

附加工作区的位置。

返回：始终

示例： "eastus"

workspace_resource_id

字符串

附加工作区的资源 ID。

返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/DefaulUS/providers/Microsoft.OperationalInsights/workspaces/DefaultWorkspace-0-EUS\""

id

字符串

资源 ID。

返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/NetWatcherRG/providers/Microsoft.Network/networkWatchers/NetWatcher_eastus/flowLogs/xz-flowlog\""

location

字符串

资源位置。

返回：始终

示例： "eastus"

name

字符串

资源名称。

返回：始终

示例： "xz-flowlog"

network_watcher_name

字符串

网络监视器的名称。

返回：始终

示例： "NetWatcher_eastus"

provisioning_state

字符串

网络流日志资源的预配状态。

返回：始终

示例： "Succeeded"

resource_group

字符串

资源组。

返回：始终

示例： "NetworkWatcherRG"

retention_policy

complex

定义流日志保留策略的参数。

返回：始终

day

integer

保留流日志记录的天数。

返回：始终

示例： 0

已启用

布尔值

启用/禁用保留的标志。

返回：始终

示例： false

storage_id

字符串

用于存储流日志的存储帐户的 ID。

返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/AutoTagFunctionAppRG/providers/Microsoft.Storage/storageAccounts/autotagfunc01"

tags

dictionary

资源标记。

返回：始终

示例： {"key1": "value1"}

target_resource_id

字符串

将应用流日志的网络安全组的 ID。

返回：始终

示例： "/subscriptions/xxx-xxx/resourceGroups/xz3mlwaiserv/providers/Microsoft.Network/virtualNetworks/xz3mlwvnet\""

type

字符串

资源类型。

返回：始终

示例： "Microsoft.Network/networkWatchers/flowLogs"

作者

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)