azure.azcollection.azure_rm_cognitivesearch 模块 – 管理 Azure 认知搜索服务

注意

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

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

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

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

azure.azcollection 1.4.0 中的新增功能

摘要

  • 创建、更新或删除 Azure 认知搜索服务。

要求

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

  • python >= 2.7

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

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

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

参数

参数

注释

ad_user

字符串

活动目录用户名。在使用活动目录用户而不是服务主体进行身份验证时使用。

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 参数中找不到的任何标签都将从对象的元数据中删除。

选项

  • 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

hosting_mode

字符串

仅适用于 standard3 SKU。

您可以设置此属性以启用最多 3 个高密度分区，每个分区最多允许 1000 个索引。

对于 standard3 SKU，值为“default”或“highDensity”。

对于所有其他 SKU，此值必须为“default”。

选项

  • "default" ← (默认)

  • "highDensity"

identity

字符串

资源的标识。

选项

  • "None" ← (默认)

  • "SystemAssigned"

location

字符串

有效的 Azure 位置。默认为资源组的位置。

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串 / 必需

Azure 认知搜索服务的名称。

搜索服务名称只能包含小写字母、数字或短划线。

不能使用短划线作为前两个或最后一个字符。

不能包含连续的短划线。

长度必须在 2 到 60 个字符之间。

搜索服务名称必须在全球范围内唯一。

服务创建后无法更改服务名称。

network_rule_set

列表 / 元素=字符串

确定如何访问 Azure 认知搜索服务的网络特定规则。

partition_count

整数

搜索服务中的分区数。

可以是1、2、3、4、6 或 12。

大于 1 的值仅对标准 SKU 有效。

对于将 hostingMode 设置为“highDensity”的“standard3”服务，允许的值介于 1 和 3 之间。

默认值： 1

password

字符串

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

profile

字符串

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

public_network_access

字符串

可以将此值设置为enabled 以避免对现有客户资源和模板造成重大更改。

如果设置为enabled，则不允许通过公共接口进行流量，私有端点连接将成为独占的访问方法。

选项

  • "enabled" ← (默认)

  • "disabled"

replica_count

整数

搜索服务中的副本数。

对于sku=standard，它必须是 1 到 12（包含）之间的值。

对于sku=basic，它必须是 1 到 3（包含）之间的值。

默认值： 1

resource_group

字符串 / 必需

当前订阅中的资源组名称。

secret

字符串

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

sku

字符串

搜索服务的 SKU，它决定价格等级和容量限制。

创建新的搜索服务时，此属性是必需的。

选项

  • "free"

  • "basic" ← (默认)

  • "standard"

  • "standard2"

  • "standard3"

  • "storage_optimized_l1"

  • "storage_optimized_l2"

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

另请参阅

另请参阅

使用 Azure CLI 登录

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

示例

- name: Create Azure Cognitive Search
  azure_rm_cognitivesearch:
    resource_group: myResourceGroup
    name: myAzureSearch

返回值

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

Key

描述

state

字典

Azure 认知搜索的信息。

返回：始终

hosting_mode

字符串

所选托管模式的类型。

返回：始终

示例： "default"

id

字符串

与此 Azure 认知搜索关联的唯一标识符。

返回：始终

示例： "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

identity

字典

Azure 认知搜索服务的标识。

返回：始终

示例： {"principal_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "type": "SystemAssigned"}

principal_id

字符串

分配的标识符。

返回：成功

示例： "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

type

字符串

标识类型。

返回：始终

示例： "SystemAssigned"

location

字符串

Azure 认知搜索服务所在的地理位置。

返回：始终

示例： "西欧"

name

字符串

Azure 认知搜索服务的名称。

返回：始终

示例： "myazuresearch"

network_rule_set

列表 / 元素=字符串

确定如何访问 Azure 认知搜索服务的网络特定规则。

返回：始终

示例： ["1.1.1.1", "8.8.8.8/31"]

partition_count

整数

Azure 认知搜索服务中的分区数。

返回：始终

示例： 3

provisioning_state

字符串

Azure 认知搜索服务的预配状态。

返回：始终

示例： "succeeded"

public_network_access

字符串

是否允许通过公共接口进行流量。

返回：始终

示例： "enabled"

replica_count

整数

Azure 认知搜索服务中的副本数。

返回：始终

示例： 3

sku

字符串

Azure 认知搜索服务的 SKU。

返回：始终

示例： "standard"

status

字符串

Azure 认知搜索的状态。

返回：始终

示例： "正在运行"

tags

字典

资源标签。

返回：始终

示例： {"tag1": "abc"}

作者

  • David Duque Hernández (@next-davidduquehernandez)