azure.azcollection.azure_rm_openshiftmanagedcluster_info 模块 – 获取 Azure Red Hat OpenShift 托管集群的信息

注意

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

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

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

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

azure.azcollection 1.11.0 中的新增功能

概要

  • 创建、更新和删除 Azure Red Hat OpenShift 托管集群实例。

要求

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

  • python >= 2.7

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

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

  • 完整的安装说明可以在这里找到 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（如果该资源被授予对多个订阅的访问权限），否则将选择第一个订阅。

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

log_mode

字符串

父参数。

log_path

字符串

父参数。

name

字符串

资源名称。

password

字符串

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

profile

字符串

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

resource_group

字符串

资源组的名称。

secret

字符串

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

subscription_id

字符串

您的 Azure 订阅 ID。

tenant

字符串

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

thumbprint

字符串

在 azure.azcollection 1.14.0 中添加

x509_certificate_path 中指定的私钥的指纹。

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

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

x509_certificate_path

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: List all Azure Red Hat OpenShift Managed Clusters for a given subscription
  azure_rm_openshiftmanagedcluster_info:
- name: List all Azure Red Hat OpenShift Managed Clusters for a given resource group
  azure_rm_openshiftmanagedcluster_info:
    resource_group: myResourceGroup
- name: Get Azure Red Hat OpenShift Managed Clusters
  azure_rm_openshiftmanagedcluster_info:
    resource_group: myResourceGroup
    name: myAzureFirewall

返回值

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

键

描述

id

字符串

资源 ID。

返回: 总是

示例: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.RedHatOpenShift/openShiftClusters/mycluster"

location

字符串

资源位置。

返回: 总是

示例: "eatus"

name

字符串

资源名称。

返回: 总是

示例: "mycluster"

properties

复杂

OpenShift 托管集群的属性。

返回: 总是

apiserverProfile

复杂

API 服务器配置。

返回: 总是

visibility

字符串

API 服务器可见性。

返回: 总是

示例: "Public"

clusterProfile

复杂

Openshift 集群的配置。

返回: 总是

domain

字符串

集群的域。

返回: 总是

示例: "mycluster"

fipsValidatedModules

字符串

是否使用 FIPS 验证的加密模块

返回: 总是

示例: "Enabled"

resourceGroupId

字符串

集群资源组的 ID。

返回: 总是

示例: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus-cluster"

version

字符串

Openshift 版本。

返回: 总是

示例: "4.4.17"

ingressProfiles

list / elements=string

入口配置。

返回: 总是

示例: [{"name": "default", "visibility": "Public"}]

masterProfile

复杂

OpenShift 主虚拟机配置。

返回: 总是

disk_encryption_set_id

字符串

关联的 DiskEncryptionSet 的资源 ID（如果适用）。

返回: successd

encryptionAtHost

字符串

主虚拟机是否在主机上加密。

返回: 总是

示例: "Disabled"

subnetId

字符串

主子网的 Azure 资源 ID（不可变）。

返回: 总是

示例: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"

vmSize

字符串

代理虚拟机的大小（不可变）。

返回: 总是

示例: "Standard_D8s_v3"

networkProfile

复杂

OpenShift 网络配置。

返回: 总是

outboundType

字符串

用于出口流量的出站类型。

返回: 总是

示例: "Loadbalancer"

podCidr

字符串

OpenShift Pod 的 CIDR。

返回: 总是

示例: "10.128.0.0/14"

preconfiguredNSG

字符串

指定子网是否预先附加了 NSG

返回: 总是

示例: "Disabled"

serviceCidr

字符串

OpenShift 服务的 CIDR。

返回: 总是

示例: "172.30.0.0/16"

provisioningState

字符串

当前部署或预配状态，仅出现在响应中。

返回: 总是

示例: "Creating"

servicePrincipalProfile

复杂

服务主体。

返回: 总是

clientId

字符串

服务主体的客户端 ID。

返回: 总是

示例: "xxxxxxxx-xxxx-xxxx-xxxxxxxxxxxx"

workerProfiles

复杂

OpenShift 集群虚拟机配置。

返回: 总是

count

integer

用于托管 docker 容器的代理（虚拟机）数量。

返回: 总是

示例: 3

diskSizeGB

integer

磁盘大小（以 GB 为单位）。

返回: 总是

示例: 128

encryptionAtHost

字符串

工作虚拟机是否在主机上加密。

返回: 总是

示例: "Disabled"

name

字符串

订阅和资源组上下文中池配置文件的唯一名称。

返回: 总是

示例: "worker"

subnetId

字符串

工作池的子网 ID。

返回: 总是

示例: "/subscriptions/xx-xx-xx-xx/resourceGroups/mycluster-eastus/providers/Microsoft.Network/ virtualNetworks/mycluster-vnet/subnets/mycluster-worker"

vmSize

字符串

代理虚拟机的大小。

返回: 总是

示例: "Standard_D4s_v3"

type

字符串

资源类型。

返回: 总是

示例: "Microsoft.RedHatOpenShift/openShiftClusters"

作者

  • Paul Czarkowski (@paulczar)