azure.azcollection.azure_rm_appserviceplan 模块 – 管理应用服务计划

注意

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

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

要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要进一步的要求才能使用此模块，请参阅 要求 了解详情。

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

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"

append_tags

布尔值

用于控制 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"

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

is_linux

布尔值

描述是否在 Linux 工作进程上托管 Web 应用程序。

选项

  • false ← (默认)

  • true

location

字符串

资源位置。如果未设置，则将使用资源组中的位置作为默认值。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必需

要创建或更新的应用服务计划的唯一名称。

number_of_workers

字符串

描述要分配的工作进程数量。

password

字符串

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

profile

字符串

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

resource_group

字符串 / 必需

资源所属的资源组的名称。

secret

字符串

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

sku

字符串

定价层，例如 F1、D1、B1、B2、B3、S1、P1、P1V2 等。

有关更多详细信息，请参阅 https://azure.microsoft.com/en-us/pricing/details/app-service/plans/。

对于 Linux 应用服务计划，请参阅 https://azure.microsoft.com/en-us/pricing/details/app-service/linux/ 了解更多详细信息。

state

字符串

断言应用服务计划的状态。

使用 present 创建或更新应用服务计划，使用 absent 删除它。

选项

  • "absent"

  • "present" ← (默认)

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create a windows app service plan
  azure_rm_appserviceplan:
    resource_group: myResourceGroup
    name: myAppPlan
    location: eastus
    sku: S1

- name: Create a linux app service plan
  azure_rm_appserviceplan:
    resource_group: myResourceGroup
    name: myAppPlan
    location: eastus
    sku: S1
    is_linux: true
    number_of_workers: 1

- name: update sku of existing windows app service plan
  azure_rm_appserviceplan:
    resource_group: myResourceGroup
    name: myAppPlan
    location: eastus
    sku: S2

返回值

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

键

描述

azure_appserviceplan

字典

有关应用服务计划当前状态的事实。

已返回: 始终

示例: {"id": "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.Web/serverfarms/myAppPlan"}

作者

  • Yunge Zhu (@yungezz)