你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Microsoft.ContainerInstance containerGroups 2018-09-01
Bicep 资源定义
containerGroups 资源类型可以通过针对以下操作进行部署:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
若要创建 Microsoft.ContainerInstance/containerGroups 资源,请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2018-09-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
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: json('decimal-as-string')
}
requests: {
cpu: int
memoryInGB: json('decimal-as-string')
}
}
volumeMounts: [
{
mountPath: 'string'
name: 'string'
readOnly: bool
}
]
}
}
]
diagnostics: {
logAnalytics: {
logType: 'string'
metadata: {}
workspaceId: 'string'
workspaceKey: 'string'
}
}
imageRegistryCredentials: [
{
password: 'string'
server: 'string'
username: 'string'
}
]
ipAddress: {
dnsNameLabel: 'string'
ip: 'string'
ports: [
{
port: int
protocol: 'string'
}
]
type: 'string'
}
networkProfile: {
id: 'string'
}
osType: 'string'
restartPolicy: 'string'
volumes: [
{
azureFile: {
readOnly: bool
shareName: 'string'
storageAccountKey: 'string'
storageAccountName: 'string'
}
emptyDir: any()
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {}
}
]
}
}
属性值
containerGroups
名称 |
说明 |
值 |
name |
资源名称 |
字符串 (必需)
字符限制:1-63
有效字符: 小写字母、数字和连字符。
不能以连字符开头或结尾。 不允许连续的连字符。 |
location |
资源位置。 |
字符串 |
标记 |
资源标记。 |
标记名称和值的字典。 请参阅 模板中的标记 |
properties |
|
ContainerGroupProperties (必需) |
ContainerGroupProperties
容器
ContainerProperties
EnvironmentVariable
名称 |
说明 |
值 |
name |
环境变量的名称。 |
字符串 (必需) |
secureValue |
安全环境变量的值。 |
string |
value |
环境变量的值。 |
string |
ContainerProbe
名称 |
说明 |
Value |
exec |
要探测的执行命令 |
ContainerExec |
failureThreshold |
失败阈值。 |
int |
httpGet |
要探测的 Http Get 设置 |
ContainerHttpGet |
initialDelaySeconds |
初始延迟秒数。 |
int |
periodSeconds |
时间段秒数。 |
int |
successThreshold |
成功阈值。 |
int |
timeoutSeconds |
超时秒数。 |
int |
ContainerExec
名称 |
说明 |
Value |
command |
要在容器中执行的命令。 |
string[] |
ContainerHttpGet
名称 |
说明 |
Value |
path |
要探测的路径。 |
string |
port |
要探测的端口号。 |
int (必需) |
scheme |
方案。 |
'http' 'https' |
ContainerPort
名称 |
说明 |
值 |
port |
容器组中公开的端口号。 |
int (必需) |
protocol |
与端口关联的协议。 |
'TCP' 'UDP' |
ResourceRequirements
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 |
ContainerGroupDiagnostics
LogAnalytics
名称 |
说明 |
值 |
logType |
要使用的日志类型。 |
“ContainerInsights” “ContainerInstanceLogs” |
metadata |
Log Analytics 的元数据。 |
对象 (object) |
workspaceId |
Log Analytics 的工作区 ID |
字符串 (必需) |
workspaceKey |
Log Analytics 的工作区键 |
字符串 (必需) |
ImageRegistryCredential
名称 |
说明 |
值 |
password |
专用注册表的密码。 |
字符串 |
server |
没有协议(例如“http”或“https”)的 Docker 映像注册表服务器。 |
字符串 (必需) |
username |
专用注册表的用户名。 |
字符串 (必需) |
IpAddress
名称 |
说明 |
值 |
dnsNameLabel |
IP 的 DNS 名称标签。 |
字符串 |
ip |
向公共 Internet 公开的 IP。 |
字符串 |
ports |
容器组上公开的端口列表。 |
端口[] (必需的) |
类型 |
指定 IP 是否向公共 Internet 公开。 |
“Private” “Public” (必需) |
端口
名称 |
说明 |
值 |
port |
端口号。 |
int (必需) |
protocol |
与端口关联的协议。 |
“TCP” “UDP” |
ContainerGroupNetworkProfile
名称 |
说明 |
Value |
id |
网络配置文件的标识符。 |
字符串 (必需) |
数据量(Volume)
名称 |
说明 |
值 |
azureFile |
Azure 文件卷。 |
AzureFileVolume |
emptyDir |
空目录卷。 |
对于 Bicep,可以使用 any () 函数。 |
gitRepo |
Git 存储库卷。 |
GitRepoVolume |
name |
卷的名称。 |
字符串 (必需) |
secret |
机密卷。 |
对象 (object) |
AzureFileVolume
名称 |
说明 |
值 |
readOnly |
指示以卷形式装载的 Azure 文件共享是否为只读的标志。 |
bool |
shareName |
要以卷形式装载的 Azure 文件共享的名称。 |
字符串 (必需) |
storageAccountKey |
用于访问 Azure 文件共享的存储帐户访问密钥。 |
字符串 |
storageAccountName |
包含 Azure 文件共享的存储帐户的名称。 |
字符串 (必需) |
GitRepoVolume
名称 |
说明 |
Value |
目录 |
目标目录名称。 不得包含“..”,也不能以其开头。 如果提供了“.”,则卷目录将是 Git 存储库。 否则,卷将包含子目录中具有给定名称的 Git 存储库(如果已指定)。 |
字符串 |
repository |
存储库 URL |
字符串 (必需) |
revision |
指定的修订版的提交哈希。 |
string |
快速入门模板
以下快速入门模板部署此资源类型。
ARM 模板资源定义
containerGroups 资源类型可以通过针对以下操作进行部署:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
若要创建 Microsoft.ContainerInstance/containerGroups 资源,请将以下 JSON 添加到模板。
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2018-09-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"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": "[json('decimal-as-string')]"
},
"requests": {
"cpu": "int",
"memoryInGB": "[json('decimal-as-string')]"
}
},
"volumeMounts": [
{
"mountPath": "string",
"name": "string",
"readOnly": "bool"
}
]
}
}
],
"diagnostics": {
"logAnalytics": {
"logType": "string",
"metadata": {},
"workspaceId": "string",
"workspaceKey": "string"
}
},
"imageRegistryCredentials": [
{
"password": "string",
"server": "string",
"username": "string"
}
],
"ipAddress": {
"dnsNameLabel": "string",
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "string"
},
"networkProfile": {
"id": "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": {}
}
]
}
}
属性值
containerGroups
名称 |
说明 |
Value |
type |
资源类型 |
“Microsoft.ContainerInstance/containerGroups” |
apiVersion |
资源 API 版本 |
'2018-09-01' |
name |
资源名称 |
字符串 (必需)
字符限制:1-63
有效字符: 小写字母、数字和连字符。
不能以连字符开头或结尾。 不允许连续的连字符。 |
location |
资源位置。 |
string |
标记 |
资源标记。 |
标记名称和值的字典。 请参阅 模板中的标记 |
properties |
|
ContainerGroupProperties (必需) |
ContainerGroupProperties
容器
ContainerProperties
EnvironmentVariable
名称 |
说明 |
值 |
name |
环境变量的名称。 |
字符串 (必需) |
secureValue |
安全环境变量的值。 |
string |
value |
环境变量的值。 |
字符串 |
ContainerProbe
名称 |
说明 |
Value |
exec |
要探测的执行命令 |
ContainerExec |
failureThreshold |
失败阈值。 |
int |
httpGet |
要探测的 Http Get 设置 |
ContainerHttpGet |
initialDelaySeconds |
初始延迟秒数。 |
int |
periodSeconds |
时间段秒数。 |
int |
successThreshold |
成功阈值。 |
int |
timeoutSeconds |
超时秒数。 |
int |
ContainerExec
名称 |
说明 |
Value |
command |
要在容器中执行的命令。 |
string[] |
ContainerHttpGet
名称 |
说明 |
Value |
path |
要探测的路径。 |
string |
port |
要探测的端口号。 |
int (必需) |
scheme |
方案。 |
'http' 'https' |
ContainerPort
名称 |
说明 |
值 |
port |
容器组中公开的端口号。 |
int (必需) |
protocol |
与端口关联的协议。 |
'TCP' 'UDP' |
ResourceRequirements
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 |
ContainerGroupDiagnostics
LogAnalytics
名称 |
说明 |
值 |
logType |
要使用的日志类型。 |
“ContainerInsights” “ContainerInstanceLogs” |
metadata |
Log Analytics 的元数据。 |
对象 (object) |
workspaceId |
Log Analytics 的工作区 ID |
字符串 (必需) |
workspaceKey |
Log Analytics 的工作区键 |
字符串 (必需) |
ImageRegistryCredential
名称 |
说明 |
值 |
password |
专用注册表的密码。 |
string |
server |
没有协议(例如“http”或“https”)的 Docker 映像注册表服务器。 |
字符串 (必需) |
username |
专用注册表的用户名。 |
字符串 (必需) |
IpAddress
名称 |
说明 |
值 |
dnsNameLabel |
IP 的 DNS 名称标签。 |
字符串 |
ip |
向公共 Internet 公开的 IP。 |
字符串 |
ports |
容器组上公开的端口列表。 |
需要 Port[] () |
类型 |
指定 IP 是否向公共 Internet 公开。 |
“Private” “公共” () |
端口
名称 |
说明 |
值 |
port |
端口号。 |
int (必需) |
protocol |
与端口关联的协议。 |
“TCP” “UDP” |
ContainerGroupNetworkProfile
名称 |
说明 |
Value |
id |
网络配置文件的标识符。 |
字符串 (必需) |
数据量(Volume)
名称 |
说明 |
值 |
azureFile |
Azure 文件卷。 |
AzureFileVolume |
emptyDir |
空目录卷。 |
|
gitRepo |
Git 存储库卷。 |
GitRepoVolume |
name |
卷的名称。 |
字符串 (必需) |
secret |
机密卷。 |
对象 (object) |
AzureFileVolume
名称 |
说明 |
值 |
readOnly |
指示以卷形式装载的 Azure 文件共享是否为只读的标志。 |
bool |
shareName |
要以卷形式装载的 Azure 文件共享的名称。 |
字符串 (必需) |
storageAccountKey |
用于访问 Azure 文件共享的存储帐户访问密钥。 |
字符串 |
storageAccountName |
包含 Azure 文件共享的存储帐户的名称。 |
字符串 (必需) |
GitRepoVolume
名称 |
说明 |
Value |
目录 |
目标目录名称。 不得包含“..”,也不能以其开头。 如果提供了“.”,则卷目录将是 Git 存储库。 否则,卷将包含子目录中具有给定名称的 Git 存储库(如果已指定)。 |
字符串 |
repository |
存储库 URL |
字符串 (必需) |
revision |
指定的修订版的提交哈希。 |
字符串 |
快速入门模板
以下快速入门模板部署此资源类型。
containerGroups 资源类型可以通过针对以下操作进行部署:
有关每个 API 版本中更改的属性的列表,请参阅 更改日志。
若要创建 Microsoft.ContainerInstance/containerGroups 资源,请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2018-09-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
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 = "decimal-as-string"
}
requests = {
cpu = int
memoryInGB = "decimal-as-string"
}
}
volumeMounts = [
{
mountPath = "string"
name = "string"
readOnly = bool
}
]
}
}
]
diagnostics = {
logAnalytics = {
logType = "string"
metadata = {}
workspaceId = "string"
workspaceKey = "string"
}
}
imageRegistryCredentials = [
{
password = "string"
server = "string"
username = "string"
}
]
ipAddress = {
dnsNameLabel = "string"
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "string"
}
networkProfile = {
id = "string"
}
osType = "string"
restartPolicy = "string"
volumes = [
{
azureFile = {
readOnly = bool
shareName = "string"
storageAccountKey = "string"
storageAccountName = "string"
}
gitRepo = {
directory = "string"
repository = "string"
revision = "string"
}
name = "string"
secret = {}
}
]
}
})
}
属性值
containerGroups
名称 |
说明 |
Value |
type |
资源类型 |
“Microsoft.ContainerInstance/containerGroups@2018-09-01” |
name |
资源名称 |
字符串 (必需)
字符限制:1-63
有效字符: 小写字母、数字和连字符。
不能以连字符开头或结尾。 不允许连续的连字符。 |
location |
资源位置。 |
字符串 |
parent_id |
若要部署到资源组,请使用该资源组的 ID。 |
字符串 (必需) |
标记 |
资源标记。 |
标记名称和值的字典。 |
properties |
|
ContainerGroupProperties (必需) |
ContainerGroupProperties
容器
ContainerProperties
EnvironmentVariable
名称 |
说明 |
值 |
name |
环境变量的名称。 |
字符串 (必需) |
secureValue |
安全环境变量的值。 |
string |
value |
环境变量的值。 |
字符串 |
ContainerProbe
名称 |
说明 |
Value |
exec |
要探测的执行命令 |
ContainerExec |
failureThreshold |
失败阈值。 |
int |
httpGet |
要探测的 Http Get 设置 |
ContainerHttpGet |
initialDelaySeconds |
初始延迟秒数。 |
int |
periodSeconds |
时间段秒数。 |
int |
successThreshold |
成功阈值。 |
int |
timeoutSeconds |
超时秒数。 |
int |
ContainerExec
名称 |
说明 |
Value |
command |
要在容器中执行的命令。 |
string[] |
ContainerHttpGet
名称 |
说明 |
Value |
path |
要探测的路径。 |
string |
port |
要探测的端口号。 |
int (必需) |
scheme |
方案。 |
“http” “https” |
ContainerPort
名称 |
说明 |
值 |
port |
容器组中公开的端口号。 |
int (必需) |
protocol |
与端口关联的协议。 |
“TCP” “UDP” |
ResourceRequirements
ResourceLimits
名称 |
说明 |
值 |
cpu |
此容器实例的 CPU 限制。 |
int |
memoryInGB |
此容器实例的内存限制 (GB)。 将十进制值指定为字符串。 |
int 或 json decimal |
ResourceRequests
名称 |
说明 |
值 |
cpu |
此容器实例的 CPU 请求。 |
int (必需) |
memoryInGB |
此容器实例的内存请求 (GB)。 将十进制值指定为字符串。 |
需要 int 或 json decimal () |
VolumeMount
名称 |
说明 |
值 |
mountPath |
容器中要将该卷装载到的路径。 不得包含冒号 (:)。 |
字符串 (必需) |
name |
卷装入点的名称。 |
字符串 (必需) |
readOnly |
指示卷装入点是否为只读的标志。 |
bool |
ContainerGroupDiagnostics
LogAnalytics
名称 |
说明 |
值 |
logType |
要使用的日志类型。 |
“ContainerInsights” “ContainerInstanceLogs” |
metadata |
Log Analytics 的元数据。 |
对象 (object) |
workspaceId |
Log Analytics 的工作区 ID |
字符串 (必需) |
workspaceKey |
Log Analytics 的工作区键 |
字符串 (必需) |
ImageRegistryCredential
名称 |
说明 |
值 |
password |
专用注册表的密码。 |
string |
server |
没有协议(例如“http”或“https”)的 Docker 映像注册表服务器。 |
字符串 (必需) |
username |
专用注册表的用户名。 |
字符串 (必需) |
IpAddress
名称 |
说明 |
值 |
dnsNameLabel |
IP 的 DNS 名称标签。 |
string |
ip |
向公共 Internet 公开的 IP。 |
string |
ports |
容器组上公开的端口列表。 |
端口[] (必需的) |
类型 |
指定 IP 是否向公共 Internet 公开。 |
“Private” 需要“公共” () |
端口
名称 |
说明 |
值 |
port |
端口号。 |
int (必需) |
protocol |
与端口关联的协议。 |
“TCP” “UDP” |
ContainerGroupNetworkProfile
名称 |
说明 |
Value |
id |
网络配置文件的标识符。 |
字符串 (必需) |
数据量(Volume)
名称 |
说明 |
值 |
azureFile |
Azure 文件卷。 |
AzureFileVolume |
emptyDir |
空目录卷。 |
|
gitRepo |
Git 存储库卷。 |
GitRepoVolume |
name |
卷的名称。 |
字符串 (必需) |
secret |
机密卷。 |
对象 (object) |
AzureFileVolume
名称 |
说明 |
值 |
readOnly |
指示以卷形式装载的 Azure 文件共享是否为只读的标志。 |
bool |
shareName |
要以卷形式装载的 Azure 文件共享的名称。 |
字符串 (必需) |
storageAccountKey |
用于访问 Azure 文件共享的存储帐户访问密钥。 |
字符串 |
storageAccountName |
包含 Azure 文件共享的存储帐户的名称。 |
字符串 (必需) |
GitRepoVolume
名称 |
说明 |
Value |
目录 |
目标目录名称。 不得包含“..”,也不能以其开头。 如果提供了“.”,则卷目录将是 Git 存储库。 否则,卷将包含子目录中具有给定名称的 Git 存储库(如果已指定)。 |
string |
repository |
存储库 URL |
字符串 (必需) |
revision |
指定的修订版的提交哈希。 |
字符串 |