azure.azcollection.azure_rm_hdinsightcluster 模块 – 管理 Azure HDInsight 集群实例
注意
此模块是 azure.azcollection 集合 (版本 3.1.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install azure.azcollection。您需要其他要求才能使用此模块，请参阅 要求 了解详细信息。
要在剧本中使用它，请指定：azure.azcollection.azure_rm_hdinsightcluster。
azure.azcollection 0.1.2 中的新增功能
概要
创建、更新和删除 Azure HDInsight 集群实例。
要求
执行此模块的主机需要以下要求。
python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
集合的 requirements.txt 中列出的所有 python 包都必须通过 pip 安装在执行 azure.azcollection 集合中模块的主机上
完整的安装说明可在 https://galaxy.ansible.com/azure/azcollection 找到
参数
参数 |
注释 |
|---|---|
Active Directory 用户名。使用时使用 Active Directory 用户而不是服务主体进行身份验证。 |
|
Azure AD 授权 URL。当使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。 |
|
选择在与 Azure 服务通信时使用的 API 配置文件。对于公共云， 默认值： |
|
用于控制标签字段是规范的还是只是附加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项
|
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为
选项
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但是当使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。使用时使用服务主体或托管标识 (msi) 进行身份验证。 也可以通过 |
|
对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 默认值： |
|
集群定义。 |
|
网关 REST 密码。 |
|
网关 REST 用户名。 |
|
集群类型。 选项
|
|
集群版本。例如 |
|
集群中的角色列表。 |
|
Linux操作系统配置文件。 |
|
SSH密码。 |
|
SSH用户名。 |
|
集群的最小实例数。 |
|
角色名称。 选项
|
|
集群的实例数。 |
|
虚拟机的尺寸。 |
|
确定尝试身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能适用于无法访问元数据端点的情况，例如私有云或 Azure Stack。实例发现过程需要从https://login.microsoft.com/检索权限元数据以验证权限。将其设置为**True**，将禁用权限的验证。因此，必须确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 选项
|
|
HDInsight 集群的身份。 |
|
托管身份的类型 选项
|
|
用户分配的托管身份及其选项 默认值： |
|
如果需要将身份列表追加到当前身份 (true)，或者需要替换当前身份 (false) 选项
|
|
与 HDInsight 集群关联的用户分配身份 ID 列表 默认值： |
|
资源位置。如果未设置，则将使用资源组中的位置作为默认值。 |
|
父参数。 |
|
父参数。 |
|
集群的名称。 |
|
操作系统的类型。 选项
|
|
Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
资源组的名称。 |
|
Azure 客户端密钥。在使用服务主体进行身份验证时使用。 |
|
断言集群的状态。 使用 选项
|
|
集群中的存储帐户列表。 |
|
存储帐户中的容器。 |
|
存储帐户是否为默认存储帐户。 选项
|
|
存储帐户访问密钥。 |
|
Blob 存储端点。例如 storage_account_name.blob.core.windows.net。 |
|
您的 Azure 订阅 ID。 |
|
要作为元数据分配给对象的字符串：字符串对的字典。 对象上的元数据标签将使用任何提供的数值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。 |
|
Azure 租户 ID。在使用服务主体进行身份验证时使用。 |
|
在 *x509_certificate_path* 中指定的私钥的指纹。 在使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则为必需。 |
|
集群层。 选项
|
|
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 中。这是一个包含 [default] 部分和以下密钥的 ini 文件：subscription_id、client_id、secret 和 tenant 或 subscription_id、ad_user 和 password。也可以添加其他配置文件。通过传递 profile 或在环境中设置 AZURE_PROFILE 来指定配置文件。
另请参阅
另请参阅
- 使用 Azure CLI 登录
如何使用
az login命令进行身份验证。
示例
- name: Create instance of HDInsight Cluster
azure_rm_hdinsightcluster:
resource_group: myResourceGroup
name: myCluster
location: eastus2
cluster_version: 3.6
os_type: linux
tier: standard
cluster_definition:
kind: spark
gateway_rest_username: http-user
gateway_rest_password: "{{ password }}"
storage_accounts:
- name: myStorageAccount.blob.core.windows.net
is_default: true
container: myContainer
key: GExmaxH4lDNdHA9nwAsCt8t4AOQas2y9vXQP1kKALTram7Q3/5xLVIab3+nYG1x63Xyak9/VXxQyNBHA9pDWw==
compute_profile_roles:
- name: headnode
target_instance_count: 2
vm_size: Standard_D3
linux_profile:
username: sshuser
password: "{{ password }}"
- name: workernode
target_instance_count: 2
vm_size: Standard_D3
linux_profile:
username: sshuser
password: "{{ password }}"
返回值
常用的返回值已在此处记录，以下是此模块特有的字段
密钥 |
描述 |
|---|---|
集群的完全限定资源 ID。 返回：始终 示例： |