azure.azcollection.azure_rm_networkflowlog_info 模块 – 获取或列出网络流量日志

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：azure.azcollection.azure_rm_networkflowlog_info。

azure.azcollection 2.5.0 中的新增功能

概要

• 获取或列出网络流量日志事实。

要求

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

• python >= 2.7

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

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

• 完整的安装说明可以在 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"
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
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串	网络流量日志的名称。
network_watcher_name 字符串 / 必需	网络监视器的名称。
password 字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签列表来限制结果。将标签格式化为“键”或“键：值”。
租户 字符串	Azure 租户 ID。使用服务主体进行身份验证时使用。
指纹 字符串 在 azure.azcollection 1.14.0 中添加	在x509_certificate_path中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了x509_certificate_path，则为必需。
x509_certificate_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 中。这是一个包含 [default] 部分和以下键的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅

另请参阅

使用 Azure CLI 登录

如何使用az login命令进行身份验证。

示例

- name: Get the network watcher facts
  azure_rm_networkflowlog_info:
    resource_group: myResourceGroup
    network_watcher_name: mywatcher01
    name: flowlogname

- name: list the network flow logs and filter by tags
  azure_rm_networkflowlog_info:
    resource_group: myResourceGroup
    network_watcher_name: mywatcher01
    tags:
      - key1

返回值

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

键	描述
flow_logs 复杂类型	网络流量日志的事实。 返回值：始终
enanbled 字符串	启用/禁用流量日志记录的标志。 返回值：始终 示例："True"
flow_analytics_configuration 复杂类型	定义流量分析配置的参数。 返回值：始终
network_watcher_flow_analytics_configuration 复杂类型	定义流量分析配置的参数。 返回值：始终
enabled 布尔值	启用/禁用流量分析的标志。 返回值：始终 示例：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 复杂类型	定义流量日志保留策略的参数。 返回值：始终
day 整数	保留流量日志记录的天数。 返回值：始终 示例：0
enabled 布尔值	启用/禁用保留的标志。 返回值：始终 示例：false
storage_id 字符串	用于存储流量日志的存储帐户的 ID。 返回值：始终 示例："/subscriptions/xxx-xxx/resourceGroups/AutoTagFunctionAppRG/providers/Microsoft.Storage/storageAccounts/autotagfunc01"
tags 字典	资源标签。 返回值：始终 示例：{"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)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)