你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.ContainerInstance containerGroups 2017-10-01-preview

项目
05/11/2023

Bicep 资源定义

可以使用面向以下操作部署 containerGroups 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.ContainerInstance/containerGroups 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2017-10-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  properties: {
    containers: [
      {
        name: 'string'
        properties: {
          command: [
            'string'
          ]
          environmentVariables: [
            {
              name: 'string'
              value: 'string'
            }
          ]
          image: 'string'
          ports: [
            {
              port: int
              protocol: 'string'
            }
          ]
          resources: {
            limits: {
              cpu: int
              memoryInGB: json('decimal-as-string')
            }
            requests: {
              cpu: int
              memoryInGB: json('decimal-as-string')
            }
          }
          volumeMounts: [
            {
              mountPath: 'string'
              name: 'string'
              readOnly: bool
            }
          ]
        }
      }
    ]
    imageRegistryCredentials: [
      {
        password: 'string'
        server: 'string'
        username: 'string'
      }
    ]
    ipAddress: {
      ip: 'string'
      ports: [
        {
          port: int
          protocol: 'string'
        }
      ]
      type: 'Public'
    }
    osType: 'string'
    restartPolicy: 'string'
    volumes: [
      {
        azureFile: {
          readOnly: bool
          shareName: 'string'
          storageAccountKey: 'string'
          storageAccountName: 'string'
        }
        emptyDir: any()
        name: 'string'
      }
    ]
  }
}

属性值

containerGroups

名称	说明	值
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：小写字母、数字和连字符。不能以连字符开头或结尾。不允许连续的连字符。
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
properties		ContainerGroupProperties (必需)

ContainerGroupProperties

名称	说明	Value
containers	容器组中的容器。	Container[] (所需的)
imageRegistryCredentials	创建容器组所依据的映像注册表凭据。	ImageRegistryCredential[]
ipAddress	容器组的 IP 地址类型。	IpAddress
osType	容器组中容器所需的操作系统类型。	'Linux' “Windows” (必需)
restartPolicy	容器组中所有容器的重启策略。 - `Always` 始终重启 - `OnFailure` 失败时重启 - `Never` 从不重启	“Always” “从不” “OnFailure”
volumes	此容器组中的容器可以装载的卷列表。	Volume[]

容器

名称	说明	值
name	用户提供的容器实例名称。	字符串 (必需)
properties	容器实例的属性。	ContainerProperties (必需)

ContainerProperties

名称	说明	Value
command	要在容器实例中执行的 exec 形式的命令。	string[]
environmentVariables	要在容器实例中设置的环境变量。	EnvironmentVariable[]
image	用于创建容器实例的映像的名称。	字符串 (必需)
ports	容器实例上的已公开端口。	ContainerPort[]
resources	容器实例的资源要求。	ResourceRequirements (必需的)
volumeMounts	容器实例可用的卷装入点数。	VolumeMount[]

EnvironmentVariable

名称	说明	值
name	环境变量的名称。	字符串 (必需)
value	环境变量的值。	字符串 (必需)

ContainerPort

名称	说明	值
port	容器组中公开的端口号。	int (必需)
protocol	与端口关联的协议。	“TCP” “UDP”

ResourceRequirements

名称	说明	值
限制	此容器实例的资源限制。	ResourceLimits
请求	此容器实例的资源请求。	ResourceRequests (必需)

ResourceLimits

名称	说明	值
cpu	此容器实例的 CPU 限制。	int
memoryInGB	此容器实例的内存限制 (GB)。若要指定十进制值，请使用 json () 函数。	int 或 json decimal

ResourceRequests

名称	说明	值
cpu	此容器实例的 CPU 请求。	int (必需)
memoryInGB	此容器实例的内存请求 (GB)。若要指定十进制值，请使用 json () 函数。	需要 int 或 json decimal ()

VolumeMount

名称	说明	值
mountPath	容器中要将该卷装载到的路径。不得包含冒号 (:)。	字符串 (必需)
name	卷装入点的名称。	字符串 (必需)
readOnly	指示卷装入点是否为只读的标志。	bool

ImageRegistryCredential

名称	说明	值
password	专用注册表的密码。	string
server	没有协议（例如“http”或“https”）的 Docker 映像注册表服务器。	字符串 (必需)
username	专用注册表的用户名。	字符串 (必需)

IpAddress

名称	说明	值
ip	向公共 Internet 公开的 IP。	string
ports	容器组上公开的端口列表。	需要 Port[] ()
类型	指定 IP 是否向公共 Internet 公开。	“公共” ()

端口

名称	说明	值
port	端口号。	int (必需)
protocol	与端口关联的协议。	'TCP' 'UDP'

数据量(Volume)

名称	说明	值
azureFile	Azure 文件卷的名称。	AzureFileVolume
emptyDir	空目录卷。	对于 Bicep，可以使用 any () 函数。
name	卷的名称。	字符串 (必需)

AzureFileVolume

名称	说明	值
readOnly	指示以卷形式装载的 Azure 文件共享是否为只读的标志。	bool
shareName	要以卷形式装载的 Azure 文件共享的名称。	字符串 (必需)
storageAccountKey	用于访问 Azure 文件共享的存储帐户访问密钥。	字符串
storageAccountName	包含 Azure 文件共享的存储帐户的名称。	字符串 (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 AKS 上SQL Server可用性组	这会创建一个新的 AKS 群集，然后使用使用 Duffle 和 ACI 部署的 CNAB 包将SQL Server可用性组部署到其中
创建 WordPress 站点	此模板在容器实例上创建 WordPress 站点
在虚拟网络中创建 WordPress 站点	此模板在虚拟网络中的容器实例上创建 WordPress 站点。并输出可访问 WordPress 站点的公共站点 FQDN。
Azure 容器实例 - BC with SQL Server and IIS	在 Azure 容器实例上部署具有功能齐全的独立 Microsoft Dynamics 365 Business Central 环境的单个 Windows 容器。
带有容器实例和应用程序网关的 Front Door	此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。
Front Door Standard/Premium with Azure 容器实例	此模板使用容器组创建 Front Door 标准版/高级版。
Azure 容器实例 - 具有运行状况探测的容器	使用 Azure 容器实例部署具有运行状况探测的 Linux 容器。
Azure 容器实例 - 具有公共 IP 的 Linux 容器	使用 Azure 容器实例部署可通过公共 IP 访问的单个 Linux 容器。
Azure 容器实例 - 具有 secure envVar 的容器	使用 Azure 容器实例部署具有安全环境变量的 Linux 容器。
Azure 容器实例 - 具有 emptyDir 的 Linux 容器	使用 Azure 容器实例部署两个共享 emptyDir 卷的 Linux 容器。
Azure 容器实例 - 包含 gitRepo 的 Linux 容器	使用 Azure 容器实例部署使用 gitRepo 卷的 Linux 容器。
Azure 容器实例 - 包含机密的容器	使用 Azure 容器实例部署具有机密卷的 Linux 容器。
创建具有持久性存储的按需 SFTP 服务器	此模板演示使用 Azure 容器实例 (ACI) 的按需 SFTP 服务器。
使用现有存储帐户的按需 SFTP 服务器	此模板演示使用 Azure 容器实例 (ACI) 的按需 SFTP 服务器。
通过容器创建存储帐户文件共享	此模板通过 azure-cli 在容器实例中创建存储帐户和文件共享
ACI 中的 UDP 容器	此模板创建 ACI 资源并通过 UDP 公开容器
Azure 容器实例 - VNet	将容器实例部署到 Azure 虚拟网络。
使用证书创建应用程序网关	此模板演示如何生成密钥保管库自签名证书，然后从应用程序网关引用。

ARM 模板资源定义

可以使用面向以下操作部署 containerGroups 资源类型：

资源组 - 请参阅资源组部署命令

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.ContainerInstance/containerGroups 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ContainerInstance/containerGroups",
  "apiVersion": "2017-10-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "properties": {
    "containers": [
      {
        "name": "string",
        "properties": {
          "command": [ "string" ],
          "environmentVariables": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "image": "string",
          "ports": [
            {
              "port": "int",
              "protocol": "string"
            }
          ],
          "resources": {
            "limits": {
              "cpu": "int",
              "memoryInGB": "[json('decimal-as-string')]"
            },
            "requests": {
              "cpu": "int",
              "memoryInGB": "[json('decimal-as-string')]"
            }
          },
          "volumeMounts": [
            {
              "mountPath": "string",
              "name": "string",
              "readOnly": "bool"
            }
          ]
        }
      }
    ],
    "imageRegistryCredentials": [
      {
        "password": "string",
        "server": "string",
        "username": "string"
      }
    ],
    "ipAddress": {
      "ip": "string",
      "ports": [
        {
          "port": "int",
          "protocol": "string"
        }
      ],
      "type": "Public"
    },
    "osType": "string",
    "restartPolicy": "string",
    "volumes": [
      {
        "azureFile": {
          "readOnly": "bool",
          "shareName": "string",
          "storageAccountKey": "string",
          "storageAccountName": "string"
        },
        "emptyDir": {},
        "name": "string"
      }
    ]
  }
}

属性值

containerGroups

名称	说明	Value
type	资源类型	“Microsoft.ContainerInstance/containerGroups”
apiVersion	资源 API 版本	'2017-10-01-preview'
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：小写字母、数字和连字符。不能以连字符开头或结尾。不允许连续的连字符。
location	资源位置。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。请参阅模板中的标记
properties		ContainerGroupProperties (必需)

ContainerGroupProperties

名称	说明	Value
containers	容器组中的容器。	Container[] (所需的)
imageRegistryCredentials	创建容器组所依据的映像注册表凭据。	ImageRegistryCredential[]
ipAddress	容器组的 IP 地址类型。	IpAddress
osType	容器组中容器所需的操作系统类型。	'Linux' “Windows” (必需)
restartPolicy	容器组中所有容器的重启策略。 - `Always` 始终重启 - `OnFailure` 失败时重启 - `Never` 从不重启	“Always” “从不” “OnFailure”
volumes	此容器组中的容器可以装载的卷列表。	Volume[]

容器

名称	说明	值
name	用户提供的容器实例名称。	字符串 (必需)
properties	容器实例的属性。	ContainerProperties (必需)

ContainerProperties

名称	说明	Value
command	要在容器实例中执行的 exec 形式的命令。	string[]
environmentVariables	要在容器实例中设置的环境变量。	EnvironmentVariable[]
image	用于创建容器实例的映像的名称。	字符串 (必需)
ports	容器实例上的已公开端口。	ContainerPort[]
resources	容器实例的资源要求。	ResourceRequirements (必需)
volumeMounts	容器实例可用的卷装入点数。	VolumeMount[]

EnvironmentVariable

名称	说明	值
name	环境变量的名称。	字符串 (必需)
value	环境变量的值。	字符串 (必需)

ContainerPort

名称	说明	值
port	容器组中公开的端口号。	int (必需)
protocol	与端口关联的协议。	“TCP” “UDP”

ResourceRequirements

名称	说明	值
限制	此容器实例的资源限制。	ResourceLimits
请求	此容器实例的资源请求。	ResourceRequests (必需)

ResourceLimits

名称	说明	值
cpu	此容器实例的 CPU 限制。	int
memoryInGB	此容器实例的内存限制 (GB)。若要指定十进制值，请使用 json () 函数。	int 或 json decimal

ResourceRequests

名称	说明	值
cpu	此容器实例的 CPU 请求。	int (必需)
memoryInGB	此容器实例的内存请求 (GB)。若要指定十进制值，请使用 json () 函数。	需要 int 或 json decimal ()

VolumeMount

名称	说明	值
mountPath	容器中要将该卷装载到的路径。不得包含冒号 (:)。	字符串 (必需)
name	卷装入点的名称。	字符串 (必需)
readOnly	指示卷装入点是否为只读的标志。	bool

ImageRegistryCredential

名称	说明	值
password	专用注册表的密码。	字符串
server	没有协议（例如“http”或“https”）的 Docker 映像注册表服务器。	字符串 (必需)
username	专用注册表的用户名。	字符串 (必需)

IpAddress

名称	说明	值
ip	向公共 Internet 公开的 IP。	string
ports	容器组上公开的端口列表。	端口[] (必需的)
类型	指定 IP 是否向公共 Internet 公开。	“Public” (必需)

端口

名称	说明	值
port	端口号。	int (必需)
protocol	与端口关联的协议。	“TCP” 'UDP'

数据量(Volume)

名称	说明	值
azureFile	Azure 文件卷的名称。	AzureFileVolume
emptyDir	空目录卷。
name	卷的名称。	字符串 (必需)

AzureFileVolume

名称	说明	值
readOnly	指示以卷形式装载的 Azure 文件共享是否为只读的标志。	bool
shareName	要以卷形式装载的 Azure 文件共享的名称。	字符串 (必需)
storageAccountKey	用于访问 Azure 文件共享的存储帐户访问密钥。	字符串
storageAccountName	包含 Azure 文件共享的存储帐户的名称。	字符串 (必需)

快速入门模板

以下快速入门模板部署此资源类型。

模板	说明
在 AKS 上SQL Server可用性组	这会创建一个新的 AKS 群集，然后使用使用 Duffle 和 ACI 部署的 CNAB 包将SQL Server可用性组部署到其中
创建 WordPress 站点	此模板在容器实例上创建 WordPress 站点
在虚拟网络中创建 WordPress 站点	此模板在虚拟网络中的容器实例上创建 WordPress 站点。并输出可访问 WordPress 站点的公共站点 FQDN。
Azure 容器实例 - BC with SQL Server and IIS	在 Azure 容器实例上部署具有功能齐全的独立 Microsoft Dynamics 365 Business Central 环境的单个 Windows 容器。
带有容器实例和应用程序网关的 Front Door	此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。
Front Door Standard/Premium with Azure 容器实例	此模板使用容器组创建 Front Door 标准版/高级版。
Azure 容器实例 - 具有运行状况探测的容器	使用 Azure 容器实例部署具有运行状况探测的 Linux 容器。
Azure 容器实例 - 具有公共 IP 的 Linux 容器	使用 Azure 容器实例部署可通过公共 IP 访问的单个 Linux 容器。
Azure 容器实例 - 具有 secure envVar 的容器	使用 Azure 容器实例部署具有安全环境变量的 Linux 容器。
Azure 容器实例 - 具有 emptyDir 的 Linux 容器	使用 Azure 容器实例部署两个共享 emptyDir 卷的 Linux 容器。
Azure 容器实例 - 包含 gitRepo 的 Linux 容器	使用 Azure 容器实例部署使用 gitRepo 卷的 Linux 容器。
Azure 容器实例 - 包含机密的容器	使用 Azure 容器实例部署具有机密卷的 Linux 容器。
创建具有持久性存储的按需 SFTP 服务器	此模板演示使用 Azure 容器实例 (ACI) 的按需 SFTP 服务器。
使用现有存储帐户的按需 SFTP 服务器	此模板演示使用 Azure 容器实例 (ACI) 的按需 SFTP 服务器。
通过容器创建存储帐户文件共享	此模板通过 azure-cli 在容器实例中创建存储帐户和文件共享
ACI 中的 UDP 容器	此模板创建 ACI 资源并通过 UDP 公开容器
Azure 容器实例 - VNet	将容器实例部署到 Azure 虚拟网络。
使用证书创建应用程序网关	此模板演示如何生成密钥保管库自签名证书，然后从应用程序网关引用。

Terraform (AzAPI 提供程序) 资源定义

可以使用面向以下操作部署 containerGroups 资源类型：

资源组

有关每个 API 版本中已更改属性的列表，请参阅更改日志。

资源格式

若要创建 Microsoft.ContainerInstance/containerGroups 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ContainerInstance/containerGroups@2017-10-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      containers = [
        {
          name = "string"
          properties = {
            command = [
              "string"
            ]
            environmentVariables = [
              {
                name = "string"
                value = "string"
              }
            ]
            image = "string"
            ports = [
              {
                port = int
                protocol = "string"
              }
            ]
            resources = {
              limits = {
                cpu = int
                memoryInGB = "decimal-as-string"
              }
              requests = {
                cpu = int
                memoryInGB = "decimal-as-string"
              }
            }
            volumeMounts = [
              {
                mountPath = "string"
                name = "string"
                readOnly = bool
              }
            ]
          }
        }
      ]
      imageRegistryCredentials = [
        {
          password = "string"
          server = "string"
          username = "string"
        }
      ]
      ipAddress = {
        ip = "string"
        ports = [
          {
            port = int
            protocol = "string"
          }
        ]
        type = "Public"
      }
      osType = "string"
      restartPolicy = "string"
      volumes = [
        {
          azureFile = {
            readOnly = bool
            shareName = "string"
            storageAccountKey = "string"
            storageAccountName = "string"
          }
          name = "string"
        }
      ]
    }
  })
}

属性值

containerGroups

名称	说明	Value
type	资源类型	“Microsoft.ContainerInstance/containerGroups@2017-10-01-preview”
name	资源名称	字符串 (必需) 字符限制：1-63 有效字符：小写字母、数字和连字符。不能以连字符开头或结尾。不允许连续的连字符。
location	资源位置。	字符串 (必需)
parent_id	若要部署到资源组，请使用该资源组的 ID。	字符串 (必需)
标记	资源标记。	标记名称和值的字典。
properties		ContainerGroupProperties (必需)

ContainerGroupProperties

名称	说明	Value
containers	容器组中的容器。	Container[] (必需的)
imageRegistryCredentials	创建容器组所依据的映像注册表凭据。	ImageRegistryCredential[]
ipAddress	容器组的 IP 地址类型。	IpAddress
osType	容器组中容器所需的操作系统类型。	“Linux” “Windows” (必需)
restartPolicy	容器组中所有容器的重启策略。 - `Always` 始终重启 - `OnFailure` 失败时重启 - `Never` 从不重启	“Always” “从不” “OnFailure”
volumes	此容器组中的容器可以装载的卷列表。	Volume[]

容器

名称	说明	值
name	用户提供的容器实例名称。	字符串 (必需)
properties	容器实例的属性。	ContainerProperties (必需)

ContainerProperties

名称	说明	Value
command	要在容器实例中执行的 exec 形式的命令。	string[]
environmentVariables	要在容器实例中设置的环境变量。	EnvironmentVariable[]
image	用于创建容器实例的映像的名称。	字符串 (必需)
ports	容器实例上的已公开端口。	ContainerPort[]
resources	容器实例的资源要求。	ResourceRequirements (必需的)
volumeMounts	容器实例可用的卷装入点数。	VolumeMount[]

EnvironmentVariable

名称	说明	值
name	环境变量的名称。	字符串 (必需)
value	环境变量的值。	字符串 (必需)

ContainerPort

名称	说明	值
port	容器组中公开的端口号。	int (必需)
protocol	与端口关联的协议。	“TCP” “UDP”

ResourceRequirements

名称	说明	值
限制	此容器实例的资源限制。	ResourceLimits
请求	此容器实例的资源请求。	ResourceRequests (所需的)

ResourceLimits

名称	说明	值
cpu	此容器实例的 CPU 限制。	int
memoryInGB	此容器实例的内存限制 (GB)。将十进制值指定为字符串。	int 或 json decimal

ResourceRequests

名称	说明	值
cpu	此容器实例的 CPU 请求。	int (必需)
memoryInGB	此容器实例的内存请求 (GB)。将十进制值指定为字符串。	需要 int 或 json decimal ()

VolumeMount

名称	说明	值
mountPath	容器中要将该卷装载到的路径。不得包含冒号 (:)。	字符串 (必需)
name	卷装入点的名称。	字符串 (必需)
readOnly	指示卷装入点是否为只读的标志。	bool

ImageRegistryCredential

名称	说明	值
password	专用注册表的密码。	字符串
server	没有协议（例如“http”或“https”）的 Docker 映像注册表服务器。	字符串 (必需)
username	专用注册表的用户名。	字符串 (必需)

IpAddress

名称	说明	值
ip	向公共 Internet 公开的 IP。	字符串
ports	容器组上公开的端口列表。	需要 Port[] ()
类型	指定 IP 是否向公共 Internet 公开。	需要“公共” ()

端口

名称	说明	值
port	端口号。	int (必需)
protocol	与端口关联的协议。	“TCP” “UDP”

数据量(Volume)

名称	说明	值
azureFile	Azure 文件卷的名称。	AzureFileVolume
emptyDir	空目录卷。
name	卷的名称。	字符串 (必需)

AzureFileVolume

名称	说明	值
readOnly	指示以卷形式装载的 Azure 文件共享是否为只读的标志。	bool
shareName	要以卷形式装载的 Azure 文件共享的名称。	字符串 (必需)
storageAccountKey	用于访问 Azure 文件共享的存储帐户访问密钥。	字符串
storageAccountName	包含 Azure 文件共享的存储帐户的名称。	字符串 (必需)

通过

Microsoft.ContainerInstance containerGroups 2017-10-01-preview

Bicep 资源定义

资源格式

属性值

containerGroups

ContainerGroupProperties

容器

ContainerProperties

EnvironmentVariable

ContainerPort

ResourceRequirements

ResourceLimits

ResourceRequests

VolumeMount

ImageRegistryCredential

IpAddress

端口

数据量(Volume)

AzureFileVolume

快速入门模板

ARM 模板资源定义

资源格式

属性值

containerGroups

ContainerGroupProperties

容器

ContainerProperties

EnvironmentVariable

ContainerPort

ResourceRequirements

ResourceLimits

ResourceRequests

VolumeMount

ImageRegistryCredential

IpAddress

端口

数据量(Volume)

AzureFileVolume

快速入门模板

Terraform (AzAPI 提供程序) 资源定义

资源格式

属性值

containerGroups

ContainerGroupProperties

容器

ContainerProperties

EnvironmentVariable

ContainerPort

ResourceRequirements

ResourceLimits

ResourceRequests

VolumeMount

ImageRegistryCredential

IpAddress

端口

数据量(Volume)

AzureFileVolume

反馈

其他资源