azure.azcollection.azure_rm_automationrunbook_info 模块 – 获取 Azure 自动化 Runbook 信息

注意

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

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

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

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

azure.azcollection 1.12.0 中的新增功能

概要

  • 获取自动化 Runbook 的信息。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

string

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

adfs_authority_url

string

在 azure.azcollection 0.0.1 中添加

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

api_profile

string

在 azure.azcollection 0.0.1 中添加

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

默认值： "latest"

auth_source

string

在 azure.azcollection 0.0.1 中添加

控制用于身份验证的凭据的来源。

也可以通过 ANSIBLE_AZURE_AUTH_SOURCE 环境变量进行设置。

当设置为 auto（默认）时，优先级为模块参数 -> env -> credential_file -> cli。

当设置为 env 时，凭据将从环境变量中读取

当设置为 credential_file 时，它将从 ~/.azure/credentials 中读取配置文件。

当设置为 cli 时，凭据将来自 Azure CLI 配置文件。如果存在多个订阅 ID，则可以使用 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"

automation_account_name

string / required

自动化帐户的名称。

cert_validation_mode

string

在 azure.azcollection 0.0.1 中添加

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

选项

  • "ignore"

  • "validate"

client_id

string

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

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

cloud_environment

string

在 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

log_mode

string

父参数。

log_path

string

父参数。

name

string

自动化 Runbook 的名称。

password

string

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

profile

string

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

resource_group

string / required

资源组的名称。

secret

string

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

show_content

boolean

是否检索由 Runbook 名称标识的 Runbook 的内容。

选项

  • false

  • true

subscription_id

string

您的 Azure 订阅 ID。

tags

list / elements=string

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

tenant

string

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

thumbprint

string

在 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 中的配置文件，或者在运行您的任务或 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 中。这是一个 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_automationrunbook_info:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"

- name: List automation runbook in the account
  azure_rm_automationrunbook_info:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"

- name: Get details of an automation account
  azure_rm_automationrunbook_info:
    resource_group: "{{ resource_group }}"
    automation_account_name: "{{ account-name }}"
    name: "{{ runbook-name }}"
    show_content: true

返回值

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

键

描述

automation_runbook

complex

自动化 Runbook 字典列表。

返回： 始终

creation_time

string

资源创建日期时间。

返回： 始终

示例： "2022-03-24T06:30:54.116666+00:00"

id

string

资源 ID。

返回： 始终

示例： "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups /myResourceGroup/providers/Microsoft.Automation/automationAccounts/test/runbooks/runbook_name"

job_count

integer

Runbook 的作业计数。

返回： 始终

示例： 3

last_modified_by

string

资源的最后修改者。

返回： 始终

示例： "Fred-sun"

last_modified_time

string

最后更新资源的人员。

返回： 始终

示例： "2022-03-25T06:30:54.116666+00:00"

location

string

资源位置。

返回： 始终

示例： "eastus"

log_activity_trace

integer

记录 Runbook 活动跟踪的选项。

返回： 始终

示例： 3

log_progress

boolean

是否显示进度日志选项。

返回： 始终

示例： true

log_verbose

boolean

是否显示详细日志选项。

返回： 始终

示例： true

name

string

资源名称。

返回： 始终

示例： "Testing"

output_types

list / elements=string

Runbook 输出类型。

返回： 始终

示例： []

resource_group

string

资源组名称。

返回： 始终

示例： "myResourceGroup"

runbook_content_link

string

发布的 Runbook 内容链接。

返回： 始终

state

string

资源状态。

返回： 始终

示例： "Published"

tags

list / elements=string

资源标签。

返回： 始终

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

type

string

资源自动化 Runbook 类型。

返回： 始终

示例： "Microsoft.Automation/AutomationAccounts/Runbooks"

作者

  • Fred Sun (@Fred-sun)