azure.azcollection.azure_rm_automationaccount_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_automationaccount_info。

azure.azcollection 0.1.2 中的新增功能

概要 

获取自动化帐户的信息。

要求 

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

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"`
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 boolean 在 azure.azcollection 2.3.0 中添加	确定在尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点（例如在私有云或 Azure Stack 中）的场景。实例发现的过程包括从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 True，将禁用授权的验证。因此，务必确保配置的授权主机是有效且可信的。通过凭据文件配置文件或 `AZURE_DISABLE_INSTANCE_DISCOVERY` 环境变量设置。选项 `false` ← (默认) `true`
list_keys boolean	列出自动化帐户的密钥。请注意，这将产生网络开销，建议仅在设置了 name 时使用。选项 `false` `true`
list_statistics boolean	列出自动化帐户的统计信息详细信息。请注意，这将产生网络开销，建议仅在设置了 name 时使用。选项 `false` `true`
list_usages boolean	列出自动化帐户的使用情况详细信息。请注意，这将产生网络开销，建议仅在设置了 name 时使用。选项 `false` `true`
log_mode 字符串	父参数。
log_path 字符串	父参数。
name 字符串	自动化帐户的名称。
password 字符串	Active Directory 用户密码。当使用 Active Directory 用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必选	资源组的名称。
secret 字符串	Azure 客户端密钥。当使用服务主体进行身份验证时使用。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签列表来限制结果。将标签格式化为“key”或“key:value”。
tenant 字符串	Azure 租户 ID。当使用服务主体进行身份验证时使用。
thumbprint 字符串在 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 中。这是一个 ini 文件，包含一个 [default] 部分和以下键：subscription_id、client_id、secret 和 tenant，或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。

另请参阅 

另请参阅

使用 Azure CLI 登录: 如何使用 az login 命令进行身份验证。

示例 

- name: Get details of an automation account
  azure_rm_automationaccount_info:
    name: Testing
    resource_group: myResourceGroup
    list_statistics: true
    list_usages: true
    list_keys: true
    tags:
      - key
      - key:value

- name: List automation account in a resource group
  azure_rm_automationaccount_info:
    resource_group: myResourceGroup

- name: List automation account in a resource group
  azure_rm_automationaccount_info:

返回值 

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

键	描述
automation_accounts 复杂	自动化帐户字典的列表。返回值：始终
creation_time 字符串	资源创建日期时间。返回值：始终示例： `"2019-04-26T02:55:16.500Z"`
id 字符串	资源 ID。返回值：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing"`
keys 复杂	资源密钥。返回值：始终
key_name 字符串	密钥的名称。返回值：始终示例： `"Primary"`
permissions 字符串	密钥的权限。返回值：始终示例： `"Full"`
value 字符串	密钥的值。返回值：始终示例： `"MbepKTO6IyGwml0GaKBkKN"`
last_modified_time 字符串	资源上次修改日期时间。返回值：始终示例： `"2019-04-26T02:55:16.500Z"`
location 字符串	资源位置。返回值：始终示例： `"eastus"`
name 字符串	资源名称。返回值：始终示例： `"Testing"`
resource_group 字符串	资源组名称。返回值：始终示例： `"myResourceGroup"`
state 字符串	资源状态。返回值：始终示例： `"ok"`
statistics 复杂	资源统计信息。返回值：始终
counter_property 字符串	统计信息的属性值。返回值：始终示例： `"New"`
counter_value 整数	统计信息的值。返回值：始终示例： `0`
end_time 字符串	统计信息的结束时间。返回值：始终示例： `"2019-04-26T06:29:43.587518Z"`
id 字符串	统计信息的 ID。返回值：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/Testing/statistics/New"`
start_time 字符串	统计信息的开始时间。返回值：始终示例： `"2019-04-26T06:29:43.587518Z"`
usages 复杂	资源使用情况。返回值：始终
current_value 浮点数	当前使用量。返回值：始终示例： `0.0`
limit 整数	最大限制，`-1` 表示无限制。返回值：始终示例： `-1`
name 复杂	使用情况计数器名称。返回值：始终
localized_value 字符串	本地化名称。返回值：始终示例： `"SubscriptionUsage"`
value 字符串	名称值。返回值：始终示例： `"SubscriptionUsage"`
throttle_status 字符串	使用情况限制状态。返回值：始终示例： `"NotThrottled"`
unit 字符串	使用情况单位名称。返回值：始终示例： `"Minute"`

作者

Yuwei Zhou (@yuwzho)