azure.azcollection.azure_rm_servicebustopicsubscription 模块 – 管理 Azure 服务总线订阅

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要

  • 创建、更新或删除 Azure 服务总线订阅。

要求

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

  • 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，否则将选择第一个订阅。

Ansible 2.6 中添加了 msi。

选项

  • "auto" ←（默认）

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

auto_delete_on_idle_in_seconds

整数

订阅自动删除的空闲间隔时间。

最短持续时间为 5 分钟。

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"

dead_lettering_on_filter_evaluation_exceptions

布尔值

指示订阅是否在筛选器评估异常时具有死信支持的值。

选项

  • false

  • true

dead_lettering_on_message_expiration

布尔值

指示当消息过期时订阅是否具有死信支持的值。

选项

  • false

  • true

default_message_time_to_live_seconds

整数

默认消息生存时间值。

这是消息过期的持续时间，从消息发送到服务总线时开始。

这是当消息本身未设置 TimeToLive 时使用的默认值。

disable_instance_discovery

布尔值

在 azure.azcollection 2.3.0 中添加

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

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

选项

  • false ← (默认)

  • true

duplicate_detection_time_in_seconds

整数

定义重复检测历史记录持续时间的 TimeSpan 结构。

enable_batched_operations

布尔值

指示是否启用服务器端批处理操作的值。

选项

  • false

  • true

forward_dead_lettered_messages_to

字符串

用于转发订阅的死信消息的队列或主题名称。

forward_to

字符串

用于转发订阅消息的队列或主题名称。

lock_duration_in_seconds

整数

窥视锁定的时间跨度持续时间。

消息被锁定以供其他接收者使用的时间量。

LockDuration 的最大值为 5 分钟。

log_mode

字符串

父参数。

log_path

字符串

父参数。

max_delivery_count

整数

最大传递计数。

消息在传递次数达到此数目后将自动进入死信队列。

name

字符串 / 必需

Servicebus 订阅的名称。

namespace

字符串 / 必需

Servicebus 命名空间名称。

命名空间是所有消息传递组件的作用域容器。

多个订阅和主题可以驻留在单个命名空间中，并且命名空间通常用作应用程序容器。

password

字符串

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

profile

字符串

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

requires_session

布尔值

一个值，指示订阅是否支持会话的概念。

选项

  • false

  • true

resource_group

字符串 / 必需

资源组的名称。

secret

字符串

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

state

字符串

断言 servicebus 订阅的状态。使用 present 创建或更新，使用 absent 删除。

选项

  • "absent"

  • "present" ← (默认)

status

字符串

实体的状态。

选项

  • "active"

  • "disabled"

  • "send_disabled"

  • "receive_disabled"

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

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

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

topic

字符串 / 必需

订阅所订阅的主题名称。

x509_certificate_path

路径

在 azure.azcollection 1.14.0 中添加

用于创建 PEM 格式的服务主体的 X509 证书的路径。

证书必须附加到私钥。

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

注释

注意

  • 对于使用 Azure 进行身份验证，您可以传递参数、设置环境变量、使用存储在 ~/.azure/credentials 中的配置文件，或者在使用 az login 运行任务或 playbook 之前登录。

  • 也可以使用服务主体或 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 subscription
  azure_rm_servicebustopicsubscription:
      name: sbsub
      resource_group: myResourceGroup
      namespace: bar
      topic: subtopic

返回值

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

键

描述

id

字符串

订阅的当前状态。

返回: 成功

示例: "/subscriptions/xxx...xxx/resourceGroups/myResourceGroup/providers/Microsoft.ServiceBus/ namespaces/nsb57dc95979/topics/topicb57dc95979/subscriptions/subsb57dc95979"

作者

  • Yuwei Zhou (@yuwzho)