azure.azcollection.azure_rm_containerinstance 模块 – 管理 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。

azure.azcollection 0.1.2 中的新增功能

概要 

创建、更新和删除 Azure 容器实例。

要求 

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

python >= 2.7
执行此模块的主机必须通过 galaxy 安装 azure.azcollection 集合
集合的 requirements.txt 中列出的所有 python 包必须通过 pip 安装在执行 azure.azcollection 中模块的主机上
完整的安装说明可以在 https://galaxy.ansible.com/azure/azcollection 找到

参数 

参数	注释
acr_identity 字符串 azure.azcollection 2.5.0 中新增	用于访问注册表服务器的身份。
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"`
containers 列表 / 元素=字典	容器列表。创建时必需。
命令列表 / 元素=字符串	在容器实例内以 exec 形式执行的命令列表。更新现有容器时，所有现有命令将被新的命令替换。
cpu 浮点数	容器所需的 CPU 核心数。默认值： `1.0`
环境变量列表 / 元素=字典	容器环境变量列表。更新现有容器时，所有现有变量将被新的变量替换。
is_secure 布尔值	变量是否安全。选项 `false` `true`
名称字符串 / 必需	环境变量名称。
值字符串 / 必需	环境变量值。
镜像字符串 / 必需	容器镜像名称。
内存浮点数	容器所需的内存，单位为 GB。默认值： `1.5`
名称字符串 / 必需	容器实例的名称。
端口列表 / 元素=整数	在容器组中公开的端口列表。
卷挂载列表 / 元素=字典	容器实例的卷挂载。
挂载路径字符串 / 必需	应在容器内挂载卷的路径。
名称字符串 / 必需	卷挂载的名称。
只读布尔值	指示卷挂载是否为只读的标志。选项 `false` `true`
disable_instance_discovery 布尔值在 azure.azcollection 2.3.0 中添加	确定在尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能旨在用于无法访问元数据端点的场景，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 检索权限元数据以验证权限。通过将其设置为 True，将禁用权限的验证。因此，必须确保配置的权限主机有效且值得信赖。通过凭据文件配置文件或 `AZURE_DISABLE_INSTANCE_DISCOVERY` 环境变量设置。选项 `false` ← (默认) `true`
dns_name_label 字符串	IP 的 DNS 名称标签。
force_update 布尔值	强制更新现有容器实例。任何更新都将导致现有容器被删除并重新创建。选项 `false` ← (默认) `true`
身份字典 azure.azcollection 2.5.0 中新增	服务器的身份。
类型字符串	托管身份的类型选项 `"SystemAssigned"` `"SystemAssigned, UserAssigned"` `"UserAssigned"` 默认值： `"None"`
user_assigned_identities 字典	用户分配的托管标识及其选项默认值： `{}`
id 列表 / 元素=字符串	与 VM 关联的用户分配标识 ID 列表默认值： `[]`
ip_address 字符串	容器组的 IP 地址类型。默认为 `none`，并创建没有公共 IP 的实例。选项 `"public"` `"none"` ← (默认) `"private"`
位置字符串	有效的 Azure 位置。默认为资源组的位置。
log_mode 字符串	父参数。
log_path 字符串	父参数。
名称字符串 / 必需	容器组的名称。
os_type 字符串	容器的操作系统类型。选项 `"linux"` ← (默认) `"windows"`
密码字符串	Active Directory 用户密码。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。
端口列表 / 元素=整数	在容器组中公开的端口列表。此选项已弃用，请使用containers下的ports。默认值： `[]`
配置文件字符串	在 ~/.azure/credentials 文件中找到的安全配置文件。
registry_login_server 字符串	容器镜像注册表登录服务器。
registry_password 字符串	登录容器镜像注册表服务器的密码。
registry_username 字符串	登录容器镜像注册表服务器的用户名。
资源组字符串 / 必需	资源组的名称。
restart_policy 字符串	容器组中所有容器的重启策略。选项 `"always"` `"on_failure"` `"never"`
密钥字符串	Azure 客户端密钥。在使用服务主体进行身份验证时使用。
状态字符串	断言容器实例的状态。使用 `present` 创建或更新容器实例，使用 `absent` 删除它。选项 `"absent"` `"present"` ← (默认)
subnet_ids 列表 / 元素=字符串	容器组的子网资源 ID。目前不支持多个子网。只能使用一个子网。
subscription_id 字符串	您的 Azure 订阅 ID。
标签字典	字符串：字符串对的字典，作为元数据分配给对象。对象上的元数据标签将使用任何提供的数值进行更新。要删除标签，请将 append_tags 选项设置为 false。目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。
租户字符串	Azure 租户 ID。在使用服务主体进行身份验证时使用。
指纹字符串在 azure.azcollection 1.14.0 中添加	在x509_certificate_path中指定的私钥的指纹。在使用服务主体进行身份验证时使用。如果定义了x509_certificate_path，则需要此项。
卷列表 / 元素=字典	此容器组中的容器可以挂载的卷列表。
azure_file 字典	Azure 文件卷
只读布尔值	指示作为卷挂载的 Azure 文件共享是否为只读的标志选项 `false` `true`
share_name 字符串 / 必需	要作为卷挂载的 Azure 文件共享的名称
storage_account_key 字符串 / 必需	用于访问 Azure 文件共享的存储帐户访问密钥
storage_account_name 字符串 / 必需	包含 Azure 文件共享的存储帐户的名称
empty_dir 字典	空目录卷
git_repo 字典	git 仓库卷
目录字符串	目标目录名称
仓库字符串 / 必需	仓库 URL
版本字符串	指定版本的提交哈希
名称字符串 / 必需	卷的名称
密钥字典	密钥卷
x509_certificate_path 路径在 azure.azcollection 1.14.0 中添加	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 sample container group
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: public
    containers:
      - name: myContainer1
        image: httpd
        memory: 1.5
        ports:
          - 80
          - 81

- name: Create sample container group with azure file share volume
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroupz
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1
        volume_mounts:
          - name: filesharevolume
            mount_path: "/data/files"
        ports:
          - 80
          - 81
    volumes:
      - name: filesharevolume
        azure_file:
          storage_account_name: mystorageaccount
          share_name: acishare
          storage_account_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

- name: Create sample container group with git repo volume
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1
        volume_mounts:
          - name: myvolume1
            mount_path: "/mnt/test"
        ports:
          - 80
          - 81
    volumes:
      - name: myvolume1
        git_repo:
          repository: "https://github.com/Azure-Samples/aci-helloworld.git"

- name: Create sample container instance with subnet
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: private
    location: eastus
    subnet_ids:
      - "{{ subnet_id }}"
    ports:
      - 80
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1.5
        ports:
          - 80
          - 81

返回值 

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

键	描述
containers 列表 / 元素=字典	容器组中的容器。返回：始终示例： `[{"commands": null, "cpu": 1.0, "environment_variables": null, "image": "httpd", "memory": 1.0, "name": "mycontainer1", "ports": [80, 81], "volume_mounts": [{"mount_path": "/data/files", "name": "filesharevolume", "read_only": false}]}]`
id 字符串	资源 ID。返回：始终示例： `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89"`
ip_address 字符串	已创建容器组的公网 IP 地址。返回：如果地址是公网地址示例： `"175.12.233.11"`
provisioning_state 字符串	容器的预配状态。返回：始终示例： `"Creating"`
卷列表 / 元素=字典	容器组中容器挂载的卷列表返回：如果指定了卷
azure_file 字典	Azure 文件共享卷详细信息返回：如果请求了 Azure 文件共享类型的卷示例： `{"read_only": null, "share_name": "acishare", "storage_account_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "storage_account_name": "mystorageaccount"}`
empty_dir 字典	空目录卷详细信息返回：如果请求了空目录类型的卷示例： `{}`
git_repo 字典	Git 代码库卷详细信息返回：如果请求了 Git 代码库类型的卷示例： `{"directory": null, "repository": "https://github.com/Azure-Samples/aci-helloworld.git", "revision": null}`
名称字符串	卷的名称返回：始终示例： `"filesharevolume"`
密钥字典	密钥卷详细信息返回：如果请求了密钥类型的卷示例： `{}`

作者

Zim Kalinowski (@zikalino)