Microsoft.ContainerInstance containerGroups 2018-02-01-preview
Bicep 資源定義
containerGroups 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
若要建立 Microsoft.ContainerInstance/containerGroups 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2018-02-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: {
dnsNameLabel: 'string'
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()
gitRepo: {
directory: 'string'
repository: 'string'
revision: 'string'
}
name: 'string'
secret: {}
}
]
}
}
屬性值
containerGroups
| 名稱 |
描述 |
值 |
| NAME |
資源名稱 |
需要字串 ()
字元限制：1-63
合法字元：
小寫字母、數字和連字號。
不能以連字號開頭或結尾。 不允許連續的連字號。 |
| location |
資源位置。 |
字串 |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標籤 |
| properties |
|
ContainerGroupProperties (必要) |
ContainerGroupProperties
| 名稱 |
描述 |
值 |
| containers |
容器群組中的容器。 |
Container[] 必要) ( |
| imageRegistryCredentials |
建立容器群組的來源映像登錄認證。 |
ImageRegistryCredential[] |
| ipAddress |
容器群組的 IP 位址類型。 |
IpAddress |
| osType |
容器群組中容器所需的作業系統類型。 |
'Linux'
需要 『Windows』 () |
| restartPolicy |
容器群組中所有容器的重新啟動原則。
- Always 一律重新啟動
- OnFailure 失敗時重新啟動
- Never 永不重新啟動 |
'Always'
'Never'
'OnFailure' |
| 磁碟區 |
此容器群組中容器可裝載的磁碟區清單。 |
Volume[] |
容器
ContainerProperties
EnvironmentVariable
| 名稱 |
描述 |
值 |
| NAME |
環境變數的名稱。 |
需要字串 () |
| 值 |
環境變數的值。 |
需要字串 () |
ContainerPort
| 名稱 |
描述 |
值 |
| 連接埠 |
容器群組中公開的連接埠號碼。 |
需要 int () |
| protocol |
連接埠相關的通訊協定。 |
'TCP'
'UDP' |
ResourceRequirements
ResourceLimits
| 名稱 |
描述 |
值 |
| cpu |
此容器執行個體的 CPU 限制。 |
int |
| memoryInGB |
此容器執行個體的記憶體限制 GB。 若要指定十進位值，請使用 json () 函式。 |
int 或 json decimal |
ResourceRequests
| 名稱 |
描述 |
值 |
| cpu |
此容器執行個體的 CPU 要求。 |
需要 int () |
| memoryInGB |
此容器執行個體的記憶體要求 GB。 若要指定十進位值，請使用 json () 函式。 |
需要 int 或 json 十進位 () |
VolumeMount
| 名稱 |
描述 |
值 |
| mountPath |
容器中磁碟區的裝載路徑。 不得包含冒號 (:)。 |
需要字串 () |
| NAME |
磁碟區裝載的名稱。 |
需要字串 () |
| readOnly |
此旗標指出磁碟區裝載是否為唯讀。 |
bool |
ImageRegistryCredential
| 名稱 |
描述 |
值 |
| password |
私人登錄的密碼。 |
字串 |
| 伺服器 |
Docker 映像登錄伺服器不具通訊協定 (例如「http」和「https」)。 |
需要字串 () |
| 使用者名稱 |
私人登錄的使用者名稱。 |
需要字串 () |
IpAddress
| 名稱 |
描述 |
值 |
| dnsNameLabel |
IP 的 DNS 名稱標籤。 |
字串 |
| ip |
公開至公用網際網路的 IP。 |
字串 |
| 連接埠 |
容器群組上公開的連接埠清單。 |
埠[] (必要) |
| 類型 |
指定IP是否公開給公用因特網。 |
必要) 'Public' ( |
連接埠
| 名稱 |
描述 |
值 |
| 連接埠 |
連接埠號碼。 |
int (必要) |
| protocol |
連接埠相關的通訊協定。 |
'TCP'
'UDP' |
磁碟區
| 名稱 |
描述 |
值 |
| azureFile |
Azure 檔案磁碟區。 |
AzureFileVolume |
| emptyDir |
空白的目錄磁碟區。 |
針對 Bicep，您可以使用 any () 函式。 |
| gitRepo |
Git 存放庫磁碟區。 |
GitRepoVolume |
| NAME |
磁碟區的名稱。 |
字串 (必要) |
| secret |
祕密磁碟區。 |
物件 (object) |
AzureFileVolume
| 名稱 |
描述 |
值 |
| readOnly |
此旗標指出作為磁碟區裝載的 Azure 檔案共用是否為唯讀。 |
bool |
| shareName |
作為磁碟區裝載的 Azure 檔案共用名稱。 |
字串 (必要) |
| storageAccountKey |
存取 Azure 檔案共用使用的儲存體帳戶存取金鑰。 |
字串 |
| storageAccountName |
包含 Azure 檔案共用的儲存體帳戶名稱。 |
字串 (必要) |
GitRepoVolume
| 名稱 |
描述 |
值 |
| directory |
目標目錄名稱。 不能包含「..」或以「..」為開頭。 如果提供「.」，磁片區目錄即為 git 存放庫。 此外，若有指定，磁片區會包含在指定名稱子目錄中的 git 存放庫。 |
字串 |
| repository |
存放庫 URL |
字串 (必要) |
| revision |
認可指定修訂的雜湊。 |
字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
ARM 範本資源定義
containerGroups 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.ContainerInstance/containerGroups 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2018-02-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": {
"dnsNameLabel": "string",
"ip": "string",
"ports": [
{
"port": "int",
"protocol": "string"
}
],
"type": "Public"
},
"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
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
'Microsoft.ContainerInstance/containerGroups' |
| apiVersion |
資源 API 版本 |
'2018-02-01-preview' |
| NAME |
資源名稱 |
字串 (必要)
字元限制：1-63
合法字元：
小寫字母、數字和連字號。
不能以連字號開頭或結尾。 不允許連續的連字號。 |
| location |
資源位置。 |
字串 |
| tags |
資源標籤。 |
標記名稱和值的字典。 請參閱 範本中的標記 |
| properties |
|
ContainerGroupProperties (必要) |
ContainerGroupProperties
| 名稱 |
描述 |
值 |
| containers |
容器群組中的容器。 |
Container[] (必要) |
| imageRegistryCredentials |
建立容器群組的來源映像登錄認證。 |
ImageRegistryCredential[] |
| ipAddress |
容器群組的 IP 位址類型。 |
IpAddress |
| osType |
容器群組中容器所需的作業系統類型。 |
'Linux'
'Windows' (必要) |
| restartPolicy |
容器群組中所有容器的重新啟動原則。
- Always 一律重新啟動
- OnFailure 失敗時重新啟動
- Never 永不重新啟動 |
'Always'
'Never'
'OnFailure' |
| 磁碟區 |
此容器群組中容器可裝載的磁碟區清單。 |
Volume[] |
容器
ContainerProperties
EnvironmentVariable
| 名稱 |
描述 |
值 |
| NAME |
環境變數的名稱。 |
字串 (必要) |
| 值 |
環境變數的值。 |
字串 (必要) |
ContainerPort
| 名稱 |
描述 |
值 |
| 連接埠 |
容器群組中公開的連接埠號碼。 |
int (必要) |
| protocol |
連接埠相關的通訊協定。 |
'TCP'
'UDP' |
ResourceRequirements
ResourceLimits
| 名稱 |
描述 |
值 |
| cpu |
此容器執行個體的 CPU 限制。 |
int |
| memoryInGB |
此容器執行個體的記憶體限制 GB。 若要指定十進位值，請使用 json () 函式。 |
int 或 json decimal |
ResourceRequests
| 名稱 |
描述 |
值 |
| cpu |
此容器執行個體的 CPU 要求。 |
int (必要) |
| memoryInGB |
此容器執行個體的記憶體要求 GB。 若要指定十進位值，請使用 json () 函式。 |
int 或 json 十進位 (必要) |
VolumeMount
| 名稱 |
描述 |
值 |
| mountPath |
容器中磁碟區的裝載路徑。 不得包含冒號 (:)。 |
字串 (必要) |
| NAME |
磁碟區裝載的名稱。 |
字串 (必要) |
| readOnly |
此旗標指出磁碟區裝載是否為唯讀。 |
bool |
ImageRegistryCredential
| 名稱 |
描述 |
值 |
| password |
私人登錄的密碼。 |
字串 |
| 伺服器 |
Docker 映像登錄伺服器不具通訊協定 (例如「http」和「https」)。 |
字串 (必要) |
| 使用者名稱 |
私人登錄的使用者名稱。 |
需要字串 () |
IpAddress
| 名稱 |
描述 |
值 |
| dnsNameLabel |
IP 的 DNS 名稱標籤。 |
字串 |
| ip |
公開至公用網際網路的 IP。 |
字串 |
| 連接埠 |
容器群組上公開的連接埠清單。 |
Port[] (必要) |
| 類型 |
指定IP是否公開至公用因特網。 |
必要) 'Public' ( |
連接埠
| 名稱 |
描述 |
值 |
| 連接埠 |
連接埠號碼。 |
需要 int () |
| protocol |
連接埠相關的通訊協定。 |
'TCP'
'UDP' |
磁碟區
| 名稱 |
描述 |
值 |
| azureFile |
Azure 檔案磁碟區。 |
AzureFileVolume |
| emptyDir |
空白的目錄磁碟區。 |
|
| gitRepo |
Git 存放庫磁碟區。 |
GitRepoVolume |
| NAME |
磁碟區的名稱。 |
需要字串 () |
| secret |
祕密磁碟區。 |
物件 (object) |
AzureFileVolume
| 名稱 |
描述 |
值 |
| readOnly |
此旗標指出作為磁碟區裝載的 Azure 檔案共用是否為唯讀。 |
bool |
| shareName |
作為磁碟區裝載的 Azure 檔案共用名稱。 |
需要字串 () |
| storageAccountKey |
存取 Azure 檔案共用使用的儲存體帳戶存取金鑰。 |
字串 |
| storageAccountName |
包含 Azure 檔案共用的儲存體帳戶名稱。 |
需要字串 () |
GitRepoVolume
| 名稱 |
描述 |
值 |
| directory |
目標目錄名稱。 不能包含「..」或以「..」為開頭。 如果提供「.」，磁片區目錄即為 git 存放庫。 此外，若有指定，磁片區會包含在指定名稱子目錄中的 git 存放庫。 |
字串 |
| repository |
存放庫 URL |
需要字串 () |
| revision |
認可指定修訂的雜湊。 |
字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
containerGroups 資源類型可以使用目標作業來部署：
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
若要建立 Microsoft.ContainerInstance/containerGroups 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2018-02-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 = {
dnsNameLabel = "string"
ip = "string"
ports = [
{
port = int
protocol = "string"
}
]
type = "Public"
}
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
| 名稱 |
描述 |
值 |
| 類型 |
資源類型 |
“Microsoft.ContainerInstance/containerGroups@2018-02-01-preview” |
| NAME |
資源名稱 |
字串 (必要)
字元限制：1-63
合法字元：
小寫字母、數字和連字號。
不能以連字號開頭或結尾。 不允許連續的連字號。 |
| location |
資源位置。 |
字串 |
| parent_id |
若要部署至資源群組，請使用該資源群組的標識碼。 |
字串 (必要) |
| tags |
資源標籤。 |
標記名稱和值的字典。 |
| properties |
|
ContainerGroupProperties (必要) |
ContainerGroupProperties
| 名稱 |
描述 |
值 |
| containers |
容器群組中的容器。 |
Container[] (必要) |
| imageRegistryCredentials |
建立容器群組的來源映像登錄認證。 |
ImageRegistryCredential[] |
| ipAddress |
容器群組的 IP 位址類型。 |
IpAddress |
| osType |
容器群組中容器所需的作業系統類型。 |
"Linux"
“Windows” (必要) |
| restartPolicy |
容器群組中所有容器的重新啟動原則。
- Always 一律重新啟動
- OnFailure 失敗時重新啟動
- Never 永不重新啟動 |
“Always”
“Never”
“OnFailure” |
| 磁碟區 |
此容器群組中容器可裝載的磁碟區清單。 |
Volume[] |
容器
ContainerProperties
EnvironmentVariable
| 名稱 |
描述 |
值 |
| NAME |
環境變數的名稱。 |
字串 (必要) |
| 值 |
環境變數的值。 |
字串 (必要) |
ContainerPort
| 名稱 |
描述 |
值 |
| 連接埠 |
容器群組中公開的連接埠號碼。 |
int (必要) |
| protocol |
連接埠相關的通訊協定。 |
“TCP”
“UDP” |
ResourceRequirements
ResourceLimits
| 名稱 |
描述 |
值 |
| cpu |
此容器執行個體的 CPU 限制。 |
int |
| memoryInGB |
此容器執行個體的記憶體限制 GB。 將十進位值指定為字串。 |
int 或 json decimal |
ResourceRequests
| 名稱 |
描述 |
值 |
| cpu |
此容器執行個體的 CPU 要求。 |
int (必要) |
| memoryInGB |
此容器執行個體的記憶體要求 GB。 將十進位值指定為字串。 |
int 或 json 十進位 (必要) |
VolumeMount
| 名稱 |
描述 |
值 |
| mountPath |
容器中磁碟區的裝載路徑。 不得包含冒號 (:)。 |
字串 (必要) |
| NAME |
磁碟區裝載的名稱。 |
字串 (必要) |
| readOnly |
此旗標指出磁碟區裝載是否為唯讀。 |
bool |
ImageRegistryCredential
| 名稱 |
描述 |
值 |
| password |
私人登錄的密碼。 |
字串 |
| 伺服器 |
Docker 映像登錄伺服器不具通訊協定 (例如「http」和「https」)。 |
需要字串 () |
| 使用者名稱 |
私人登錄的使用者名稱。 |
需要字串 () |
IpAddress
| 名稱 |
描述 |
值 |
| dnsNameLabel |
IP 的 DNS 名稱標籤。 |
字串 |
| ip |
公開至公用網際網路的 IP。 |
字串 |
| 連接埠 |
容器群組上公開的連接埠清單。 |
Port[] (必要) |
| 類型 |
指定IP是否公開至公用因特網。 |
“Public” (必要) |
連接埠
| 名稱 |
描述 |
值 |
| 連接埠 |
連接埠號碼。 |
需要 int () |
| protocol |
連接埠相關的通訊協定。 |
“TCP”
“UDP” |
磁碟區
| 名稱 |
描述 |
值 |
| azureFile |
Azure 檔案磁碟區。 |
AzureFileVolume |
| emptyDir |
空白的目錄磁碟區。 |
|
| gitRepo |
Git 存放庫磁碟區。 |
GitRepoVolume |
| NAME |
磁碟區的名稱。 |
需要字串 () |
| secret |
祕密磁碟區。 |
物件 (object) |
AzureFileVolume
| 名稱 |
描述 |
值 |
| readOnly |
此旗標指出作為磁碟區裝載的 Azure 檔案共用是否為唯讀。 |
bool |
| shareName |
作為磁碟區裝載的 Azure 檔案共用名稱。 |
需要字串 () |
| storageAccountKey |
存取 Azure 檔案共用使用的儲存體帳戶存取金鑰。 |
字串 |
| storageAccountName |
包含 Azure 檔案共用的儲存體帳戶名稱。 |
需要字串 () |
GitRepoVolume
| 名稱 |
描述 |
值 |
| directory |
目標目錄名稱。 不能包含「..」或以「..」為開頭。 如果提供「.」，磁片區目錄即為 git 存放庫。 此外，若有指定，磁片區會包含在指定名稱子目錄中的 git 存放庫。 |
字串 |
| repository |
存放庫 URL |
需要字串 () |
| revision |
認可指定修訂的雜湊。 |
字串 |
