azure.azcollection.azure_rm_apimanagement 模块 – 管理 Azure 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。

azure.azcollection 1.6.0 中的新增功能

概要

  • 创建 Azure API 实例。

  • 更新现有的 Azure API 实例。

  • 删除 Azure API 实例。

要求

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

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

字符串 / 必需

API 修订标识符。它在当前 API 管理服务实例中必须是唯一的。

api_profile

字符串

在 azure.azcollection 0.0.1 中添加

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

默认值: "latest"

api_revision

字符串

描述 API 的修订。

如果未提供值，则创建默认修订 1

api_revision_description

字符串

API 修订的描述。

api_type

字符串

要创建的 API 类型。

http 创建 SOAP 到 REST API。

soap 创建 SOAP 直通 API。

选项

  • "soap"

  • "http"

api_version

字符串

如果 API 已版本化，则指示 API 的版本标识符

api_version_description

字符串

API 版本的描述。

api_version_set

字典

版本集详细信息

description

字符串

API 版本集的描述。

id

字符串

现有 API 版本集的标识符

省略此值以创建新的版本集。

name

字符串

API 版本集的显示名称。

version_header_name

字符串

如果 versioningScheme 设置为 `header`，则指示 API 版本的 HTTP 标头参数的名称。

version_query_name

字符串

如果 versioningScheme 设置为 `query`，则指示 API 版本的查询参数的名称。

versioning_scheme

字符串

一个值，确定 API 版本标识符在 HTTP 请求中的位置。

选项

  • "Segment"

  • "Query"

  • "Header"

api_version_set_id

字符串

相关 ApiVersionSet 的资源标识符。

append_tags

布尔值

用于控制标签字段是规范的还是仅附加到现有标签。

当为规范时，在 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"

authentication_settings

字典

此 API 中包含的身份验证设置的集合。

o_auth2

字典

OAuth2 身份验证设置

authorization_server_id

字符串

OAuth 授权服务器标识符。

scope

字符串

操作范围。

openid

字典

OpenID Connect 身份验证设置

bearer_token_sending_methods

list / elements=string

如何将令牌发送到服务器。

选项

  • "authorizationHeader"

  • "query"

openid_provider_id

字符串

OAuth 授权服务器标识符。

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"

description

字符串

API 的描述。

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和授权验证。此功能旨在用于无法访问元数据端点（例如在私有云或 Azure Stack 中）的场景。实例发现过程需要从 https://login.microsoft.com/ 检索授权元数据以验证授权。通过将此设置为 **True**，将禁用授权验证。因此，至关重要的是要确保配置的授权主机有效且可信。

通过凭据文件配置文件或 AZURE_DISABLE_INSTANCE_DISCOVERY 环境变量进行设置。

选项

  • false ← (默认)

  • true

display_name

字符串

要显示的 API 名称。长度必须为 1 到 300 个字符。

format

字符串

API 导入的内容格式。

选项

  • "wadl-xml"

  • "wadl-link-json"

  • "swagger-json"

  • "swagger-link-json"

  • "wsdl"

  • "wsdl-link"

  • "openapi"

  • "openapi+json"

  • "openapi-link"

is_current

布尔值

指示 API 修订是否为当前 API 修订。

选项

  • false

  • true

log_mode

字符串

父参数。

log_path

字符串

父参数。

password

字符串

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

path

字符串

唯一标识此 API 的相对 URL。

profile

字符串

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

protocols

list / elements=string

描述可以调用此 API 中操作的协议。

选项

  • "http"

  • "https"

resource_group

字符串 / 必需

资源组的名称。

secret

字符串

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

service_name

字符串 / 必需

API 管理服务的名称。

service_url

字符串

实现此 API 的后端服务的绝对 URL

长度不能超过 2000 个字符。

source_api_id

字符串

源 API 的 API 标识符。

state

字符串

API 的状态。

使用 present 创建或更新 API，使用 absent 删除 API。

选项

  • "absent"

  • "present" ← (默认)

subscription_id

字符串

您的 Azure 订阅 ID。

subscription_key_parameter_names

字典

API 可用的协议。

header

字符串

订阅密钥标头名称。

query

字符串

订阅密钥查询字符串参数名称。

subscription_required

布尔值

指定访问 API 是否需要 API 或产品订阅。

选项

  • false

  • true

tags

字典

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

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

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

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

Azure Front Door 不支持使用

Azure Automation 和 Azure CDN 仅支持资源上的 15 个标记。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

当使用服务主体进行身份验证时使用。

如果定义了 x509_certificate_path，则为必需。

type

字符串

API 的类型

选项

  • "http"

  • "soap"

value

字符串

导入 API 时的内容值。

wsdl_selector

字典

用于限制将 WSDL 导入为文档子集的条件。

wsdl_endpoint_name

字符串

要从 WSDL 导入的端点（端口）的名称。

wsdl_service_name

字符串

要从 WSDL 导入的服务的名称。

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: Create a new API instance
  azure_rm_apimanagement:
    resource_group: 'myResourceGroup'
    service_name: myService
    api_id: testApi
    description: testDescription
    display_name: TestAPI
    service_url: 'http://testapi.example.net/api'
    path: myapiPath
    protocols:
      - https
- name: Update an existing API instance.
  azure_rm_apimanagement:
    resource_group: myResourceGroup
    service_name: myService
    api_id: testApi
    display_name: newTestAPI
    service_url: 'http://testapi.example.net/api'
    path: myapiPath
    protocols:
      - https
- name: ApiManagementDeleteApi
  azure_rm_apimanagement:
    resource_group: myResourceGroup
    service_name: myService
    api_id: testApi
    state: absent

返回值

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

Key

描述

id

字符串

资源 ID。

返回: 总是

作者

  • Sakar Mehra (@sakar97)

  • Nikhil Patne (@nikhilpatne)