你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.ContainerInstance containerGroups 2018-06-01
Bicep 资源定义
可以使用目标操作部署 containerGroups 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.ContainerInstance/containerGroups 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2018-06-01' = {
location: 'string'
name: 'string'
properties: {
containers: [
{
name: 'string'
properties: {
command: [
'string'
]
environmentVariables: [
{
name: 'string'
secureValue: 'string'
value: 'string'
}
]
image: 'string'
livenessProbe: {
exec: {
command: [
'string'
]
}
failureThreshold: int
httpGet: {
path: 'string'
port: int
scheme: 'string'
}
initialDelaySeconds: int
periodSeconds: int
successThreshold: int
timeoutSeconds: int
}
ports: [
{
port: int
protocol: 'string'
}
]
readinessProbe: {
exec: {
command: [
'string'
]
}
failureThreshold: int
httpGet: {
path: 'string'
port: int
scheme: 'string'
}
initialDelaySeconds: int
periodSeconds: int
successThreshold: int
timeoutSeconds: int
}
resources: {
limits: {
cpu: int
memoryInGB: int
}
requests: {
cpu: int
memoryInGB: int
}
}
volumeMounts: [
{
mountPath: 'string'
name: 'string'
readOnly: bool
}
]
}
}
]
diagnostics: {
logAnalytics: {
workspaceId: 'string'
workspaceKey: 'string'
}
}
imageRegistryCredentials: [
{
password: 'string'
server: 'string'
username: 'string'
}
]
ipAddress: {
dnsNameLabel: 'string'
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'string'
}
osType: 'string'
restartPolicy: 'string'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
emptyDir: any(Azure.Bicep.Types.Concrete.AnyType)
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {
{customized property}: 'string'
}
}
]
}
tags: {
{customized property}: 'string'
}
}
属性值
AzureFileVolume
名字 |
描述 |
价值 |
readOnly |
指示装载为卷的 Azure 文件共享是否为只读的标志。 |
bool |
shareName |
要装载为卷的 Azure 文件共享的名称。 |
string (必需) |
storageAccountKey |
用于访问 Azure 文件共享的存储帐户访问密钥。 |
字符串 |
storageAccountName |
包含 Azure 文件共享的存储帐户的名称。 |
string (必需) |
容器
ContainerExec
名字 |
描述 |
价值 |
命令 |
在容器中执行的命令。 |
string[] |
ContainerGroupDiagnostics
ContainerGroupProperties
名字 |
描述 |
价值 |
器皿 |
容器组中的容器。 |
容器[] (必需) |
诊断 |
容器组的诊断信息。 |
ContainerGroupDiagnostics |
imageRegistryCredentials |
从中创建容器组的映像注册表凭据。 |
ImageRegistryCredential[] |
ipAddress |
容器组的 IP 地址类型。 |
IpAddress |
osType |
容器组中容器所需的操作系统类型。 |
“Linux” “Windows”(必需) |
restartPolicy |
重启容器组中所有容器的策略。
-
Always 始终重启
-
OnFailure 失败时重启
-
Never 永不重启 |
“Always” “永不” “OnFailure” |
卷 |
此容器组中的容器可以装载的卷列表。 |
卷[] |
ContainerHttpGet
名字 |
描述 |
价值 |
路径 |
探测的路径。 |
字符串 |
港口 |
要探测的端口号。 |
int (必需) |
方案 |
方案。 |
“http” “https” |
ContainerPort
名字 |
描述 |
价值 |
港口 |
容器组中公开的端口号。 |
int (必需) |
协议 |
与端口关联的协议。 |
“TCP” “UDP” |
ContainerProbe
名字 |
描述 |
价值 |
exec |
要探测的执行命令 |
ContainerExec |
failureThreshold |
失败阈值。 |
int |
httpGet |
要探测的 Http 获取设置 |
ContainerHttpGet |
initialDelaySeconds |
初始延迟秒。 |
int |
periodSeconds |
时间段秒。 |
int |
successThreshold |
成功阈值。 |
int |
timeoutSeconds |
超时秒。 |
int |
ContainerProperties
EnvironmentVariable
名字 |
描述 |
价值 |
名字 |
环境变量的名称。 |
string (必需) |
secureValue |
安全环境变量的值。 |
字符串 |
价值 |
环境变量的值。 |
字符串 |
GitRepoVolume
名字 |
描述 |
价值 |
目录 |
目标目录名称。 不得包含或以“..”开头。 如果提供了“.”,卷目录将是 git 存储库。 否则,如果指定,卷将包含具有给定名称的子目录中的 git 存储库。 |
字符串 |
存储 库 |
存储库 URL |
string (必需) |
校订 |
指定修订的提交哈希。 |
字符串 |
ImageRegistryCredential
名字 |
描述 |
价值 |
密码 |
专用注册表的密码。 |
字符串 |
服务器 |
没有协议(如“http”和“https”)的 Docker 映像注册表服务器。 |
string (必需) |
username |
专用注册表的用户名。 |
string (必需) |
IpAddress
名字 |
描述 |
价值 |
dnsNameLabel |
IP 的 Dns 名称标签。 |
字符串 |
ip |
公开给公共 Internet 的 IP。 |
字符串 |
港口 |
容器组上公开的端口列表。 |
端口[] (必需) |
类型 |
指定 IP 是否向公共 Internet 公开。 |
“Public”(必需) |
LogAnalytics
名字 |
描述 |
价值 |
workspaceId |
Log Analytics 的工作区 ID |
string (必需) |
workspaceKey |
Log Analytics 的工作区密钥 |
string (必需) |
Microsoft.ContainerInstance/containerGroups
港口
名字 |
描述 |
价值 |
港口 |
端口号。 |
int (必需) |
协议 |
与端口关联的协议。 |
“TCP” “UDP” |
ResourceLimits
名字 |
描述 |
价值 |
中央处理器 |
此容器实例的 CPU 限制。 |
int |
memoryInGB |
此容器实例的内存限制(以 GB 为单位)。 |
int |
ResourceRequests
名字 |
描述 |
价值 |
中央处理器 |
此容器实例的 CPU 请求。 |
int (必需) |
memoryInGB |
此容器实例的内存请求(以 GB 为单位)。 |
int (必需) |
ResourceRequirements
SecretVolume
卷
VolumeMount
名字 |
描述 |
价值 |
mountPath |
应装载卷的容器中的路径。 不得包含冒号 (:)。 |
string (必需) |
名字 |
卷装载的名称。 |
string (必需) |
readOnly |
指示卷装载是否为只读的标志。 |
bool |
快速入门示例
以下快速入门示例部署此资源类型。
Bicep 文件 |
描述 |
Azure 容器实例 - BC 与 SQL Server 和 IIS |
在 Azure 容器实例上部署具有功能齐全的独立Microsoft Dynamics 365 Business Central 环境的单个 Windows 容器。 |
Azure 容器实例 - 包含机密的容器 |
使用 Azure 容器实例部署具有机密卷的 Linux 容器。 |
Azure 容器实例 - 具有公共 IP 的 Linux 容器 |
使用 Azure 容器实例部署可通过公共 IP 访问的单个 Linux 容器。 |
Azure 容器实例 - VNet |
将容器实例部署到 Azure 虚拟网络。 |
创建 WordPress 网站 |
此模板在容器实例上创建 WordPress 站点 |
创建具有持久性存储 的按需 SFTP 服务器 |
此模板演示使用 Azure 容器实例(ACI)的按需 SFTP 服务器。 |
使用证书创建应用程序网关 |
此模板演示如何生成 Key Vault 自签名证书,然后从应用程序网关引用。 |
使用 Azure 容器实例 Front Door 标准版/高级版 |
此模板使用容器组创建 Front Door 标准版/高级版。 |
使用容器实例和应用程序网关 Front Door |
此模板使用容器组和应用程序网关创建 Front Door 标准版/高级版。 |
AKS 上的 SQL Server 可用性组 |
这会创建新的 AKS 群集,然后使用使用 Duffle 和 ACI 部署的 CNAB 包将 SQL Server 可用性组部署到其中 |
ARM 模板资源定义
可以使用目标操作部署 containerGroups 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.ContainerInstance/containerGroups 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2018-06-01",
"name": "string",
"location": "string",
"properties": {
"containers": [
{
"name": "string",
"properties": {
"command": [ "string" ],
"environmentVariables": [
{
"name": "string",
"secureValue": "string",
"value": "string"
}
],
"image": "string",
"livenessProbe": {
"exec": {
"command": [ "string" ]
},
"failureThreshold": "int",
"httpGet": {
"path": "string",
"port": "int",
"scheme": "string"
},
"initialDelaySeconds": "int",
"periodSeconds": "int",
"successThreshold": "int",
"timeoutSeconds": "int"
},
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"readinessProbe": {
"exec": {
"command": [ "string" ]
},
"failureThreshold": "int",
"httpGet": {
"path": "string",
"port": "int",
"scheme": "string"
},
"initialDelaySeconds": "int",
"periodSeconds": "int",
"successThreshold": "int",
"timeoutSeconds": "int"
},
"resources": {
"limits": {
"cpu": "int",
"memoryInGB": "int"
},
"requests": {
"cpu": "int",
"memoryInGB": "int"
}
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": "bool"
}
]
}
}
],
"diagnostics": {
"logAnalytics": {
"workspaceId": "string",
"workspaceKey": "string"
}
},
"imageRegistryCredentials": [
{
"password": "string",
"server": "string",
"username": "string"
}
],
"ipAddress": {
"dnsNameLabel": "string",
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "string"
},
"osType": "string",
"restartPolicy": "string",
"volumes": [
{
"azureFile": {
"readOnly": "bool",
"shareName": "string",
"storageAccountKey": "string",
"storageAccountName": "string"
},
"emptyDir": {},
"gitRepo": {
"directory": "string",
"repository": "string",
"revision": "string"
},
"name": "string",
"secret": {
"{customized property}": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
属性值
AzureFileVolume
名字 |
描述 |
价值 |
readOnly |
指示装载为卷的 Azure 文件共享是否为只读的标志。 |
bool |
shareName |
要装载为卷的 Azure 文件共享的名称。 |
string (必需) |
storageAccountKey |
用于访问 Azure 文件共享的存储帐户访问密钥。 |
字符串 |
storageAccountName |
包含 Azure 文件共享的存储帐户的名称。 |
string (必需) |
容器
ContainerExec
名字 |
描述 |
价值 |
命令 |
在容器中执行的命令。 |
string[] |
ContainerGroupDiagnostics
ContainerGroupProperties
名字 |
描述 |
价值 |
器皿 |
容器组中的容器。 |
容器[] (必需) |
诊断 |
容器组的诊断信息。 |
ContainerGroupDiagnostics |
imageRegistryCredentials |
从中创建容器组的映像注册表凭据。 |
ImageRegistryCredential[] |
ipAddress |
容器组的 IP 地址类型。 |
IpAddress |
osType |
容器组中容器所需的操作系统类型。 |
“Linux” “Windows”(必需) |
restartPolicy |
重启容器组中所有容器的策略。
-
Always 始终重启
-
OnFailure 失败时重启
-
Never 永不重启 |
“Always” “永不” “OnFailure” |
卷 |
此容器组中的容器可以装载的卷列表。 |
卷[] |
ContainerHttpGet
名字 |
描述 |
价值 |
路径 |
探测的路径。 |
字符串 |
港口 |
要探测的端口号。 |
int (必需) |
方案 |
方案。 |
“http” “https” |
ContainerPort
名字 |
描述 |
价值 |
港口 |
容器组中公开的端口号。 |
int (必需) |
协议 |
与端口关联的协议。 |
“TCP” “UDP” |
ContainerProbe
名字 |
描述 |
价值 |
exec |
要探测的执行命令 |
ContainerExec |
failureThreshold |
失败阈值。 |
int |
httpGet |
要探测的 Http 获取设置 |
ContainerHttpGet |
initialDelaySeconds |
初始延迟秒。 |
int |
periodSeconds |
时间段秒。 |
int |
successThreshold |
成功阈值。 |
int |
timeoutSeconds |
超时秒。 |
int |
ContainerProperties
EnvironmentVariable
名字 |
描述 |
价值 |
名字 |
环境变量的名称。 |
string (必需) |
secureValue |
安全环境变量的值。 |
字符串 |
价值 |
环境变量的值。 |
字符串 |
GitRepoVolume
名字 |
描述 |
价值 |
目录 |
目标目录名称。 不得包含或以“..”开头。 如果提供了“.”,卷目录将是 git 存储库。 否则,如果指定,卷将包含具有给定名称的子目录中的 git 存储库。 |
字符串 |
存储 库 |
存储库 URL |
string (必需) |
校订 |
指定修订的提交哈希。 |
字符串 |
ImageRegistryCredential
名字 |
描述 |
价值 |
密码 |
专用注册表的密码。 |
字符串 |
服务器 |
没有协议(如“http”和“https”)的 Docker 映像注册表服务器。 |
string (必需) |
username |
专用注册表的用户名。 |
string (必需) |
IpAddress
名字 |
描述 |
价值 |
dnsNameLabel |
IP 的 Dns 名称标签。 |
字符串 |
ip |
公开给公共 Internet 的 IP。 |
字符串 |
港口 |
容器组上公开的端口列表。 |
端口[] (必需) |
类型 |
指定 IP 是否向公共 Internet 公开。 |
“Public”(必需) |
LogAnalytics
名字 |
描述 |
价值 |
workspaceId |
Log Analytics 的工作区 ID |
string (必需) |
workspaceKey |
Log Analytics 的工作区密钥 |
string (必需) |
Microsoft.ContainerInstance/containerGroups
名字 |
描述 |
价值 |
apiVersion |
API 版本 |
'2018-06-01' |
位置 |
资源位置。 |
字符串 |
名字 |
资源名称 |
string (必需) |
性能 |
|
ContainerGroupProperties(必需) |
标签 |
资源标记 |
标记名称和值的字典。 请参阅模板 中的 标记 |
类型 |
资源类型 |
“Microsoft.ContainerInstance/containerGroups” |
港口
名字 |
描述 |
价值 |
港口 |
端口号。 |
int (必需) |
协议 |
与端口关联的协议。 |
“TCP” “UDP” |
ResourceLimits
名字 |
描述 |
价值 |
中央处理器 |
此容器实例的 CPU 限制。 |
int |
memoryInGB |
此容器实例的内存限制(以 GB 为单位)。 |
int |
ResourceRequests
名字 |
描述 |
价值 |
中央处理器 |
此容器实例的 CPU 请求。 |
int (必需) |
memoryInGB |
此容器实例的内存请求(以 GB 为单位)。 |
int (必需) |
ResourceRequirements
SecretVolume
卷
VolumeMount
名字 |
描述 |
价值 |
mountPath |
应装载卷的容器中的路径。 不得包含冒号 (:)。 |
string (必需) |
名字 |
卷装载的名称。 |
string (必需) |
readOnly |
指示卷装载是否为只读的标志。 |
bool |
快速入门模板
以下快速入门模板部署此资源类型。
可以使用目标操作部署 containerGroups 资源类型:
有关每个 API 版本中已更改属性的列表,请参阅 更改日志。
若要创建 Microsoft.ContainerInstance/containerGroups 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2018-06-01"
name = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
containers = [
{
name = "string"
properties = {
command = [
"string"
]
environmentVariables = [
{
name = "string"
secureValue = "string"
value = "string"
}
]
image = "string"
livenessProbe = {
exec = {
command = [
"string"
]
}
failureThreshold = int
httpGet = {
path = "string"
port = int
scheme = "string"
}
initialDelaySeconds = int
periodSeconds = int
successThreshold = int
timeoutSeconds = int
}
ports = [
{
port = int
protocol = "string"
}
]
readinessProbe = {
exec = {
command = [
"string"
]
}
failureThreshold = int
httpGet = {
path = "string"
port = int
scheme = "string"
}
initialDelaySeconds = int
periodSeconds = int
successThreshold = int
timeoutSeconds = int
}
resources = {
limits = {
cpu = int
memoryInGB = int
}
requests = {
cpu = int
memoryInGB = int
}
}
volumeMounts = [
{
mountPath = "string"
name = "string"
readOnly = bool
}
]
}
}
]
diagnostics = {
logAnalytics = {
workspaceId = "string"
workspaceKey = "string"
}
}
imageRegistryCredentials = [
{
password = "string"
server = "string"
username = "string"
}
]
ipAddress = {
dnsNameLabel = "string"
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "string"
}
osType = "string"
restartPolicy = "string"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
emptyDir = ?
gitRepo = {
directory = "string"
repository = "string"
revision = "string"
}
name = "string"
secret = {
{customized property} = "string"
}
}
]
}
})
}
属性值
AzureFileVolume
名字 |
描述 |
价值 |
readOnly |
指示装载为卷的 Azure 文件共享是否为只读的标志。 |
bool |
shareName |
要装载为卷的 Azure 文件共享的名称。 |
string (必需) |
storageAccountKey |
用于访问 Azure 文件共享的存储帐户访问密钥。 |
字符串 |
storageAccountName |
包含 Azure 文件共享的存储帐户的名称。 |
string (必需) |
容器
ContainerExec
名字 |
描述 |
价值 |
命令 |
在容器中执行的命令。 |
string[] |
ContainerGroupDiagnostics
ContainerGroupProperties
名字 |
描述 |
价值 |
器皿 |
容器组中的容器。 |
容器[] (必需) |
诊断 |
容器组的诊断信息。 |
ContainerGroupDiagnostics |
imageRegistryCredentials |
从中创建容器组的映像注册表凭据。 |
ImageRegistryCredential[] |
ipAddress |
容器组的 IP 地址类型。 |
IpAddress |
osType |
容器组中容器所需的操作系统类型。 |
“Linux” “Windows”(必需) |
restartPolicy |
重启容器组中所有容器的策略。
-
Always 始终重启
-
OnFailure 失败时重启
-
Never 永不重启 |
“Always” “永不” “OnFailure” |
卷 |
此容器组中的容器可以装载的卷列表。 |
卷[] |
ContainerHttpGet
名字 |
描述 |
价值 |
路径 |
探测的路径。 |
字符串 |
港口 |
要探测的端口号。 |
int (必需) |
方案 |
方案。 |
“http” “https” |
ContainerPort
名字 |
描述 |
价值 |
港口 |
容器组中公开的端口号。 |
int (必需) |
协议 |
与端口关联的协议。 |
“TCP” “UDP” |
ContainerProbe
名字 |
描述 |
价值 |
exec |
要探测的执行命令 |
ContainerExec |
failureThreshold |
失败阈值。 |
int |
httpGet |
要探测的 Http 获取设置 |
ContainerHttpGet |
initialDelaySeconds |
初始延迟秒。 |
int |
periodSeconds |
时间段秒。 |
int |
successThreshold |
成功阈值。 |
int |
timeoutSeconds |
超时秒。 |
int |
ContainerProperties
EnvironmentVariable
名字 |
描述 |
价值 |
名字 |
环境变量的名称。 |
string (必需) |
secureValue |
安全环境变量的值。 |
字符串 |
价值 |
环境变量的值。 |
字符串 |
GitRepoVolume
名字 |
描述 |
价值 |
目录 |
目标目录名称。 不得包含或以“..”开头。 如果提供了“.”,卷目录将是 git 存储库。 否则,如果指定,卷将包含具有给定名称的子目录中的 git 存储库。 |
字符串 |
存储 库 |
存储库 URL |
string (必需) |
校订 |
指定修订的提交哈希。 |
字符串 |
ImageRegistryCredential
名字 |
描述 |
价值 |
密码 |
专用注册表的密码。 |
字符串 |
服务器 |
没有协议(如“http”和“https”)的 Docker 映像注册表服务器。 |
string (必需) |
username |
专用注册表的用户名。 |
string (必需) |
IpAddress
名字 |
描述 |
价值 |
dnsNameLabel |
IP 的 Dns 名称标签。 |
字符串 |
ip |
公开给公共 Internet 的 IP。 |
字符串 |
港口 |
容器组上公开的端口列表。 |
端口[] (必需) |
类型 |
指定 IP 是否向公共 Internet 公开。 |
“Public”(必需) |
LogAnalytics
名字 |
描述 |
价值 |
workspaceId |
Log Analytics 的工作区 ID |
string (必需) |
workspaceKey |
Log Analytics 的工作区密钥 |
string (必需) |
Microsoft.ContainerInstance/containerGroups
名字 |
描述 |
价值 |
位置 |
资源位置。 |
字符串 |
名字 |
资源名称 |
string (必需) |
性能 |
|
ContainerGroupProperties(必需) |
标签 |
资源标记 |
标记名称和值的字典。 |
类型 |
资源类型 |
“Microsoft.ContainerInstance/containerGroups@2018-06-01” |
港口
名字 |
描述 |
价值 |
港口 |
端口号。 |
int (必需) |
协议 |
与端口关联的协议。 |
“TCP” “UDP” |
ResourceLimits
名字 |
描述 |
价值 |
中央处理器 |
此容器实例的 CPU 限制。 |
int |
memoryInGB |
此容器实例的内存限制(以 GB 为单位)。 |
int |
ResourceRequests
名字 |
描述 |
价值 |
中央处理器 |
此容器实例的 CPU 请求。 |
int (必需) |
memoryInGB |
此容器实例的内存请求(以 GB 为单位)。 |
int (必需) |
ResourceRequirements
SecretVolume
卷
VolumeMount
名字 |
描述 |
价值 |
mountPath |
应装载卷的容器中的路径。 不得包含冒号 (:)。 |
string (必需) |
名字 |
卷装载的名称。 |
string (必需) |
readOnly |
指示卷装载是否为只读的标志。 |
bool |