azure.azcollection.azure_rm_bastionhost_info 模块 – 获取 Azure 防御主机信息

注意

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

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

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

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

azure.azcollection 1.13.0 中的新增功能

概要

  • 获取 Azure 防御主机信息的详细信息。

要求

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

  • 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（如果资源被授予对多个订阅的访问权限），否则选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "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

字符串

防御主机的名称。

password

字符串

活动目录用户密码。在使用活动目录用户而不是服务主体进行身份验证时使用。

配置文件

字符串

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

资源组

字符串

资源组的名称。

密钥

字符串

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

订阅 ID

字符串

您的 Azure 订阅 ID。

标签

列表 / 元素=字符串

通过提供标签列表来限制结果。标签格式为“键”或“键:值”。

租户

字符串

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登录。

  • 也可以使用服务主体或活动目录用户进行身份验证。

  • 要通过服务主体进行身份验证，请传递 subscription_id、client_id、secret 和 tenant，或设置环境变量 AZURE_SUBSCRIPTION_ID、AZURE_CLIENT_ID、AZURE_SECRET 和 AZURE_TENANT。

  • 要通过活动目录用户进行身份验证，请传递 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 bastion host info by name
  azure_rm_bastionhost_info:
    name: bastion-name
    resource_group: myResourceGroup

- name: Get all bastion host by resource group
  azure_rm_bastionhost_info:
    resource_group: myResourceGroup

- name: Get all bastion hoste by subscription filter by tags
  azure_rm_bastionhost_info:
    tags:
      - key1
      - abc

返回值

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

键

描述

堡垒主机

复杂类型

Azure 堡垒主机信息的列表。

返回：始终

disable_copy_paste

布尔值

启用/禁用堡垒主机资源的复制/粘贴功能。

返回：始终

示例：false

dns_name

字符串

可访问堡垒主机的端点的完全限定域名。

返回：始终

示例："bst-0ca1e1b6-9969-4167-be54-5972e1395c25.bastion.azure.com"

enable_file_copy

布尔值

启用/禁用堡垒主机资源的文件复制功能。

返回：始终

示例：false

enable_ip_connect

布尔值

启用/禁用堡垒主机资源的 IP 连接功能。

返回：始终

示例：false

布尔值

启用/禁用堡垒主机资源的可共享链接。

返回：始终

示例：false

enable_tunneling

布尔值

启用/禁用堡垒主机资源的隧道功能。

返回：始终

示例：false

etag

字符串

每当资源更新时都会更改的唯一只读字符串。

返回：始终

示例："fb0e3a90-6afa-4a01-9171-9c84d144a0f3"

id

字符串

Azure 堡垒主机的资源 ID。

返回：始终

示例："/subscriptions/xxx-xxx/resourceGroups/myResourceGroup/providers/Microsoft.Network/bastionHosts/testbastion"

ip_configurations

复杂类型

堡垒主机 IP 配置的数组。

返回：始终

name

字符串

在资源组内唯一的资源名称。

此名称可用于访问资源。

返回：始终

示例："IpConf"

private_ip_allocation_method

字符串

私有 IP 分配方法。

返回：始终

示例："Static"

public_ip_address

复杂类型

公共 IP 资源的引用。

返回：始终

id

字符串

公共 IP 地址的 ID。

返回：始终

示例："/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/publicIPAddresses/Myip"

子网

复杂类型

对子网资源的引用。

返回：始终

id

字符串

子网的 ID。

返回：始终

示例："/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AzureBastionSubnet"

位置

字符串

资源位置。

返回：始终

示例："eastus"

name

字符串

Azure 堡垒主机的名称。

返回：始终

示例："linkservice"

provisioning_state

字符串

堡垒主机资源的预配状态。

返回：始终

示例："Succeeded"

scale_units

整数

堡垒主机资源的规模单位。

返回：始终

示例：2

sku

复杂类型

此堡垒主机的 SKU。

返回：始终

name

字符串

此堡垒主机的名称。

返回：始终

示例："Standard"

标签

列表 / 元素=字符串

资源标签。

返回：始终

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

类型

字符串

资源类型。

返回：始终

示例："Microsoft.Network/bastionHosts"

作者

  • xuzhang3 (@xuzhang3)

  • Fred-sun (@Fred-sun)