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 找到
参数
参数 |
注释 |
|---|---|
用于访问注册表服务器的标识。 |
|
Active Directory 用户名。在使用 Active Directory 用户而不是服务主体进行身份验证时使用。 |
|
Azure AD 授权 URL。在使用用户名/密码进行身份验证并且拥有自己的 ADFS 授权时使用。 |
|
选择与 Azure 服务通信时要使用的 API 配置文件。 默认值： |
|
用于控制标签字段是规范的还是只是附加到现有标签。 当规范时，在 tags 参数中找不到的任何标签都将从对象的元数据中删除。 选项
|
|
控制用于身份验证的凭据来源。 也可以通过 当设置为 当设置为 当设置为 当设置为 当设置为
选项
|
|
控制 Azure 端点的证书验证行为。默认情况下，所有模块都将验证服务器证书，但在使用 HTTPS 代理或针对 Azure Stack 时，可能需要通过传递 选项
|
|
Azure 客户端 ID。使用服务主体或托管标识 (MSI) 进行身份验证时使用。 也可以通过 |
|
对于美国公共云以外的云环境，环境名称（由 Azure Python SDK 定义，例如 默认值： |
|
容器列表。 创建时必需。 |
|
在容器实例中以 exec 形式执行的命令列表。 更新现有容器时，所有现有命令将被新的命令替换。 |
|
容器所需的 CPU 核心数。 默认值： |
|
容器环境变量列表。 更新现有容器时，所有现有变量将被新的变量替换。 |
|
变量是否安全。 选项
|
|
环境变量名称。 |
|
环境变量值。 |
|
容器镜像名称。 |
|
容器所需的内存（以 GB 为单位）。 默认值： |
|
容器实例的名称。 |
|
在容器组中公开的端口列表。 |
|
容器实例的卷挂载 |
|
容器内应挂载卷的路径 |
|
卷挂载的名称 |
|
指示卷挂载是否为只读的标志 选项
|
|
确定尝试进行身份验证时是否执行实例发现。将其设置为 true 将完全禁用实例发现和权限验证。此功能适用于无法访问元数据端点的情况，例如私有云或 Azure Stack。实例发现过程需要从 https://login.microsoft.com/ 获取权限元数据以验证权限。将其设置为 **True** 将禁用权限验证。因此，务必确保配置的权限主机有效且值得信赖。 通过凭据文件配置文件或 选项
|
|
IP 的 DNS 名称标签。 |
|
强制更新现有容器实例。任何更新都将导致删除和重新创建现有容器。 选项
|
|
服务器的身份。 |
|
托管标识的类型 选项
默认值： |
|
用户分配的托管标识及其选项 默认值： |
|
与 VM 关联的用户分配的标识 ID 列表 默认值： |
|
容器组的 IP 地址类型。 默认为 选项
|
|
有效的 Azure 位置。默认为资源组的位置。 |
|
父参数。 |
|
父参数。 |
|
容器组的名称。 |
|
容器的操作系统类型。 选项
|
|
Active Directory 用户密码。使用服务主体进行身份验证时使用。 |
|
在容器组中公开的端口列表。 此选项已弃用，请使用容器下的端口。 默认值： |
|
在 ~/.azure/credentials 文件中找到的安全配置文件。 |
|
容器镜像注册表登录服务器。 |
|
登录容器镜像注册表服务器的密码。 |
|
登录容器镜像注册表服务器的用户名。 |
|
资源组的名称。 |
|
容器组内所有容器的重启策略。 选项
|
|
Azure 客户端密钥。使用服务主体进行身份验证时使用。 |
|
声明容器实例的状态。使用 选项
|
|
容器组的子网资源 ID。 尚不支持多个子网。只能使用一个子网。 |
|
您的 Azure 订阅 ID。 |
|
字符串：字符串对的字典，作为元数据分配给对象。 对象上的元数据标签将使用任何提供的数值进行更新。 要删除标签，请将 append_tags 选项设置为 false。 目前，Azure DNS 区域和流量管理器服务也不允许在标签中使用空格。 Azure 前端门户不支持使用 Azure 自动化和 Azure CDN 仅支持资源上的 15 个标签。 |
|
Azure 租户 ID。使用服务主体进行身份验证时使用。 |
|
在 *x509_certificate_path* 中指定的私钥的指纹。 使用服务主体进行身份验证时使用。 如果定义了 *x509_certificate_path*，则需要。 |
|
此容器组中的容器可以挂载的卷列表。 |
|
Azure 文件卷 |
|
指示作为卷挂载的 Azure 文件共享是否为只读的标志 选项
|
|
要作为卷挂载的 Azure 文件共享的名称 |
|
用于访问 Azure 文件共享的存储帐户访问密钥 |
|
包含 Azure 文件共享的存储帐户的名称 |
|
空目录卷 |
|
Git 仓库卷 |
|
目标目录名称 |
|
仓库 URL |
|
指定版本的提交哈希 |
|
卷的名称 |
|
密钥卷 |
|
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 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
返回值
常见的返回值已在此处记录 这里，以下是此模块特有的字段
密钥 |
描述 |
|---|---|
容器组中的容器。 返回：始终 示例： |
|
资源 ID。 返回：始终 示例： |
|
已创建容器组的公有 IP 地址。 返回：如果地址是公有的 示例： |
|
容器的预配状态。 返回：始终 示例： |
|
容器组中容器挂载的卷列表 返回：如果指定了卷 |
|
Azure 文件共享卷详细信息 返回：如果请求了 Azure 文件共享类型的卷 示例： |
|
空目录卷详细信息 返回：如果请求了空目录类型的卷 示例： |
|
Git 仓库卷详细信息 返回：如果请求了 Git 仓库类型的卷 示例： |
|
卷的名称 返回：始终 示例： |
|
密钥卷详细信息 返回：如果请求了密钥类型的卷 示例： |