azure.azcollection.azure_rm_containerinstance_info 模块 – 获取 Azure 容器实例信息

注意

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

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

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

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

azure.azcollection 0.1.2 中的新增功能

概要 

获取容器实例信息。

要求 

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

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"`
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 字符串	活动目录用户密码。在使用活动目录用户而不是服务主体进行身份验证时使用。
profile 字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
resource_group 字符串 / 必需	资源组的名称。
secret 字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
subscription_id 字符串	您的 Azure 订阅 ID。
tags 列表 / 元素=字符串	通过提供标签来限制结果。标签格式为“键:值”。
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: Get specific Container Instance facts
  azure_rm_containerinstance_info:
    resource_group: myResourceGroup
    name: myContainer

- name: List Container Instances in a specified resource group name
  azure_rm_containerinstance_info:
    resource_group: myResourceGroup
    tags:
      - key
      - key:value

返回值 

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

键	描述
container_groups 复杂类型	容器实例字典列表。返回值：始终返回
containers 复杂类型	容器组中的容器。返回值：始终返回示例：`"containers"`
commands 列表 / 元素=字符串	在容器实例中以 exec 形式执行的命令列表。返回值：始终返回示例：`["pip install abc"]`
cpu 整数	容器所需的 CPU 核心数。返回值：始终返回示例：`1`
environment_variables 复杂类型	容器环境变量列表。返回值：成功
name 字符串	环境变量名称。返回值：成功
value 字符串	环境变量值。返回值：成功
image 字符串	容器镜像名称。返回值：始终返回示例：`"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance /containerGroups/myContainer"`
memory 浮点数	容器所需的内存（以 GB 为单位）。返回值：始终返回示例：`1.5`
name 字符串	容器实例的名称。返回值：始终返回示例：`"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance /containerGroups/myContainer"`
ports 列表 / 元素=字符串	容器组中公开的端口列表。返回值：始终返回示例：`[80, 81]`
volume_mounts 列表 / 元素=字符串	在容器实例中挂载的卷列表返回值：如果在容器实例中挂载了卷示例：`[{"mount_path": "/mnt/repo", "name": "myvolume1"}]`
dns_name_label 字符串	IP 的 DNS 名称标签。返回值：始终返回示例：`"mydomain"`
id 字符串	资源 ID。返回值：始终返回示例：`"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/contain erGroups/myContainer"`
identity 复杂类型	服务器的身份。返回值：如果可用
type 字符串	托管身份的类型返回值：始终返回示例：`"UserAssigned"`
user_assigned_identities 复杂类型	用户分配的托管标识及其选项返回值：始终返回
id 字典	与资源关联的用户分配的标识 ID 字典返回值：始终返回
ip_address 字符串	容器实例的 IP 地址。返回值：始终返回示例：`"173.15.18.1"`
location 字符串	资源位置。返回值：始终返回示例：`"westus"`
name 字符串	资源名称。返回值：始终返回示例：`"mycontainers"`
os_type 字符串	容器的操作系统类型。返回值：始终返回示例：`"linux"`
ports 列表 / 元素=字符串	容器实例公开的端口列表。返回值：始终返回示例：`[80, 81]`
resource_group 字符串	容器所在的资源组。返回值：始终返回示例：`"testrg"`
subnet_ids 列表 / 元素=字符串	容器组的子网资源 ID。返回值：始终返回示例：`[{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnetrpfx/subnets/subrpfx"}]`
tags 字典	分配给资源的标签。字符串:字符串对的字典。返回值：成功示例：`{"tag1": "abc"}`
volumes 列表 / 元素=字符串	容器实例可以挂载的卷列表返回值：如果容器组有卷示例：`[{"git_repo": {"repository": "https://github.com/Azure-Samples/aci-helloworld.git"}, "name": "myvolume1"}]`

作者

Zim Kalinowski (@zikalino)