azure.azcollection.azure_rm_apimanagement_info 模块 – 获取 API 实例信息

注意

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

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

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

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

azure.azcollection 1.6.0 中的新增功能

概要

  • 获取 API 实例信息。

要求

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

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

字符串

API 版本标识符。它必须在当前 API 管理服务实例中唯一。

api_profile

字符串

azure.azcollection 0.0.1 中新增

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

默认值： "latest"

append_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

expand_api_version_set

布尔值

在响应中包含完整的ApiVersionSet资源。

选项

  • false

  • true

include_not_tagged_apis

布尔值

在响应中包含未标记的API。

选项

  • false

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必需

资源组的名称。

secret

字符串

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

service_name

字符串 / 必需

API管理服务的名称。

subscription_id

字符串

您的Azure订阅ID。

tags

字典

字符串：字符串对的字典，作为元数据分配给对象。

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

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

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

Azure前端门户不支持使用

Azure自动化和Azure CDN仅支持资源上的15个标签。

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中。这是一个包含[default]部分和以下键的ini文件：subscription_id、client_id、secret和tenant或subscription_id、ad_user和password。也可以添加其他配置文件。通过传递profile或在环境中设置AZURE_PROFILE来指定配置文件。

另请参阅

另请参阅

使用Azure CLI登录

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

示例

- name: Get the information of api
  azure_rm_apimanagement_info:
    resource_group: myResourceGroup
    service_name: myService
- name: Get the information of api
  azure_rm_apimanagement_info:
    resource_group: myResourceGroup
    service_name: myService
    api_id: testApi

返回值

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

键

描述

api

复杂

字典结果列表，其中键是Api的名称，值是该Api的事实。

返回：始终

api_name

复杂

用户提供的api名称。

返回：成功

id

字符串

资源ID。

返回：始终

name

字符串

资源名称。

返回：始终

properties

字典

Api实体契约属性。

返回：始终

type

字符串

API管理资源的资源类型。

返回：始终

作者

  • Sakar Mehra (@sakar97)

  • Nikhil Patne (@nikhilpatne)