Microsoft.ContainerInstance containerGroups 2018-09-01
Bicep 資源定義
containerGroups 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.ContainerInstance/containerGroups 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.ContainerInstance/containerGroups@2018-09-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: {
logType: 'string'
metadata: {
{customized property}: 'string'
}
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(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 檔案共享名稱。 |
字串 (必要) |
storageAccountKey |
用來存取 Azure 檔案共用的記憶體帳戶存取金鑰。 |
字串 |
storageAccountName |
包含 Azure 檔案共用的記憶體帳戶名稱。 |
字串 (必要) |
容器
ContainerExec
名字 |
描述 |
價值 |
命令 |
在容器內執行的命令。 |
string[] |
ContainerGroupDiagnostics
ContainerGroupNetworkProfile
名字 |
描述 |
價值 |
id |
網路配置檔的識別碼。 |
字串 (必要) |
ContainerGroupProperties
ContainerHttpGet
名字 |
描述 |
價值 |
路徑 |
探查的路徑。 |
字串 |
港口 |
要探查的埠號碼。 |
int (必要) |
方案 |
配置。 |
'http' 'https' |
ContainerPort
名字 |
描述 |
價值 |
港口 |
容器群組內公開的埠號碼。 |
int (必要) |
協定 |
與埠相關聯的通訊協定。 |
'TCP' 'UDP' |
ContainerProbe
名字 |
描述 |
價值 |
exec |
要探查的執行命令 |
ContainerExec |
failureThreshold |
失敗臨界值。 |
int |
httpGet |
要探查的 Http Get 設定 |
ContainerHttpGet |
initialDelaySeconds |
初始延遲秒。 |
int |
periodSeconds |
句點秒數。 |
int |
successThreshold |
成功臨界值。 |
int |
timeoutSeconds |
逾時秒數。 |
int |
ContainerProperties
EnvironmentVariable
名字 |
描述 |
價值 |
名字 |
環境變數的名稱。 |
字串 (必要) |
secureValue |
安全環境變數的值。 |
字串 |
價值 |
環境變數的值。 |
字串 |
GitRepoVolume
名字 |
描述 |
價值 |
目錄 |
目標目錄名稱。 不得包含或開頭為 『..』。 如果提供 『.』,磁碟區目錄將會是 git 存放庫。 否則,如果指定,磁碟區將會在具有指定名稱的子目錄中包含 git 存放庫。 |
字串 |
存儲庫 |
存放庫 URL |
字串 (必要) |
校訂 |
認可指定修訂的哈希。 |
字串 |
ImageRegistryCredential
名字 |
描述 |
價值 |
密碼 |
私人登錄的密碼。 |
字串 |
伺服器 |
沒有通訊協定的 Docker 映射登錄伺服器,例如 「HTTP」 和 「HTTPs」。 |
字串 (必要) |
username |
私人登錄的用戶名稱。 |
字串 (必要) |
IpAddress
名字 |
描述 |
價值 |
dnsNameLabel |
IP 的 Dns 名稱標籤。 |
字串 |
ip |
公開至公用因特網的IP。 |
字串 |
港口 |
容器群組上公開的埠清單。 |
埠[] (必要) |
類型 |
指定IP是否公開至公用因特網。 |
'Private' 'Public' (必要) |
LogAnalytics
名字 |
描述 |
價值 |
logType |
要使用的記錄類型。 |
'ContainerInsights' 'ContainerInstanceLogs' |
元數據 |
記錄分析的元數據。 |
LogAnalyticsMetadata |
workspaceId |
記錄分析的工作區標識碼 |
字串 (必要) |
workspaceKey |
記錄分析的工作區金鑰 |
字串 (必要) |
Microsoft.ContainerInstance/containerGroups
港口
名字 |
描述 |
價值 |
港口 |
埠號碼。 |
int (必要) |
協定 |
與埠相關聯的通訊協定。 |
'TCP' 'UDP' |
ResourceLimits
名字 |
描述 |
價值 |
中央處理器 |
這個容器實例的CPU限制。 |
int |
memoryInGB |
此容器實例的 GB 記憶體限制。 |
int |
ResourceRequests
名字 |
描述 |
價值 |
中央處理器 |
這個容器實例的CPU要求。 |
int (必要) |
memoryInGB |
此容器實例的 GB 記憶體要求。 |
int (必要) |
ResourceRequirements
SecretVolume
卷
VolumeMount
名字 |
描述 |
價值 |
mountPath |
容器內應掛接磁碟區的路徑。 不得包含冒號 (:)。 |
字串 (必要) |
名字 |
磁碟區掛接的名稱。 |
字串 (必要) |
readOnly |
指出磁碟區掛接是否為唯讀的旗標。 |
bool |
快速入門範例
下列快速入門範例會部署此資源類型。
ARM 樣本資源定義
containerGroups 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.ContainerInstance/containerGroups 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.ContainerInstance/containerGroups",
"apiVersion": "2018-09-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": {
"logType": "string",
"metadata": {
"{customized property}": "string"
},
"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": {
"{customized property}": "string"
}
}
]
},
"tags": {
"{customized property}": "string"
}
}
屬性值
AzureFileVolume
名字 |
描述 |
價值 |
readOnly |
旗標,指出掛接為磁碟區的 Azure 檔案共用是否為唯讀。 |
bool |
shareName |
要掛接為磁碟區的 Azure 檔案共享名稱。 |
字串 (必要) |
storageAccountKey |
用來存取 Azure 檔案共用的記憶體帳戶存取金鑰。 |
字串 |
storageAccountName |
包含 Azure 檔案共用的記憶體帳戶名稱。 |
字串 (必要) |
容器
ContainerExec
名字 |
描述 |
價值 |
命令 |
在容器內執行的命令。 |
string[] |
ContainerGroupDiagnostics
ContainerGroupNetworkProfile
名字 |
描述 |
價值 |
id |
網路配置檔的識別碼。 |
字串 (必要) |
ContainerGroupProperties
ContainerHttpGet
名字 |
描述 |
價值 |
路徑 |
探查的路徑。 |
字串 |
港口 |
要探查的埠號碼。 |
int (必要) |
方案 |
配置。 |
'http' 'https' |
ContainerPort
名字 |
描述 |
價值 |
港口 |
容器群組內公開的埠號碼。 |
int (必要) |
協定 |
與埠相關聯的通訊協定。 |
'TCP' 'UDP' |
ContainerProbe
名字 |
描述 |
價值 |
exec |
要探查的執行命令 |
ContainerExec |
failureThreshold |
失敗臨界值。 |
int |
httpGet |
要探查的 Http Get 設定 |
ContainerHttpGet |
initialDelaySeconds |
初始延遲秒。 |
int |
periodSeconds |
句點秒數。 |
int |
successThreshold |
成功臨界值。 |
int |
timeoutSeconds |
逾時秒數。 |
int |
ContainerProperties
EnvironmentVariable
名字 |
描述 |
價值 |
名字 |
環境變數的名稱。 |
字串 (必要) |
secureValue |
安全環境變數的值。 |
字串 |
價值 |
環境變數的值。 |
字串 |
GitRepoVolume
名字 |
描述 |
價值 |
目錄 |
目標目錄名稱。 不得包含或開頭為 『..』。 如果提供 『.』,磁碟區目錄將會是 git 存放庫。 否則,如果指定,磁碟區將會在具有指定名稱的子目錄中包含 git 存放庫。 |
字串 |
存儲庫 |
存放庫 URL |
字串 (必要) |
校訂 |
認可指定修訂的哈希。 |
字串 |
ImageRegistryCredential
名字 |
描述 |
價值 |
密碼 |
私人登錄的密碼。 |
字串 |
伺服器 |
沒有通訊協定的 Docker 映射登錄伺服器,例如 「HTTP」 和 「HTTPs」。 |
字串 (必要) |
username |
私人登錄的用戶名稱。 |
字串 (必要) |
IpAddress
名字 |
描述 |
價值 |
dnsNameLabel |
IP 的 Dns 名稱標籤。 |
字串 |
ip |
公開至公用因特網的IP。 |
字串 |
港口 |
容器群組上公開的埠清單。 |
埠[] (必要) |
類型 |
指定IP是否公開至公用因特網。 |
'Private' 'Public' (必要) |
LogAnalytics
名字 |
描述 |
價值 |
logType |
要使用的記錄類型。 |
'ContainerInsights' 'ContainerInstanceLogs' |
元數據 |
記錄分析的元數據。 |
LogAnalyticsMetadata |
workspaceId |
記錄分析的工作區標識碼 |
字串 (必要) |
workspaceKey |
記錄分析的工作區金鑰 |
字串 (必要) |
Microsoft.ContainerInstance/containerGroups
名字 |
描述 |
價值 |
apiVersion |
API 版本 |
'2018-09-01' |
位置 |
資源位置。 |
字串 |
名字 |
資源名稱 |
字串 (必要) |
性能 |
|
ContainerGroupProperties (必要) |
標籤 |
資源標籤 |
標記名稱和值的字典。 請參閱範本中的 標籤 |
類型 |
資源類型 |
'Microsoft.ContainerInstance/containerGroups' |
港口
名字 |
描述 |
價值 |
港口 |
埠號碼。 |
int (必要) |
協定 |
與埠相關聯的通訊協定。 |
'TCP' 'UDP' |
ResourceLimits
名字 |
描述 |
價值 |
中央處理器 |
這個容器實例的CPU限制。 |
int |
memoryInGB |
此容器實例的 GB 記憶體限制。 |
int |
ResourceRequests
名字 |
描述 |
價值 |
中央處理器 |
這個容器實例的CPU要求。 |
int (必要) |
memoryInGB |
此容器實例的 GB 記憶體要求。 |
int (必要) |
ResourceRequirements
SecretVolume
卷
VolumeMount
名字 |
描述 |
價值 |
mountPath |
容器內應掛接磁碟區的路徑。 不得包含冒號 (:)。 |
字串 (必要) |
名字 |
磁碟區掛接的名稱。 |
字串 (必要) |
readOnly |
指出磁碟區掛接是否為唯讀的旗標。 |
bool |
快速入門範本
下列快速入門範本會部署此資源類型。
containerGroups 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.ContainerInstance/containerGroups 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ContainerInstance/containerGroups@2018-09-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 = {
logType = "string"
metadata = {
{customized property} = "string"
}
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 = {
{customized property} = "string"
}
}
]
}
})
}
屬性值
AzureFileVolume
名字 |
描述 |
價值 |
readOnly |
旗標,指出掛接為磁碟區的 Azure 檔案共用是否為唯讀。 |
bool |
shareName |
要掛接為磁碟區的 Azure 檔案共享名稱。 |
字串 (必要) |
storageAccountKey |
用來存取 Azure 檔案共用的記憶體帳戶存取金鑰。 |
字串 |
storageAccountName |
包含 Azure 檔案共用的記憶體帳戶名稱。 |
字串 (必要) |
容器
ContainerExec
名字 |
描述 |
價值 |
命令 |
在容器內執行的命令。 |
string[] |
ContainerGroupDiagnostics
ContainerGroupNetworkProfile
名字 |
描述 |
價值 |
id |
網路配置檔的識別碼。 |
字串 (必要) |
ContainerGroupProperties
ContainerHttpGet
名字 |
描述 |
價值 |
路徑 |
探查的路徑。 |
字串 |
港口 |
要探查的埠號碼。 |
int (必要) |
方案 |
配置。 |
'http' 'https' |
ContainerPort
名字 |
描述 |
價值 |
港口 |
容器群組內公開的埠號碼。 |
int (必要) |
協定 |
與埠相關聯的通訊協定。 |
'TCP' 'UDP' |
ContainerProbe
名字 |
描述 |
價值 |
exec |
要探查的執行命令 |
ContainerExec |
failureThreshold |
失敗臨界值。 |
int |
httpGet |
要探查的 Http Get 設定 |
ContainerHttpGet |
initialDelaySeconds |
初始延遲秒。 |
int |
periodSeconds |
句點秒數。 |
int |
successThreshold |
成功臨界值。 |
int |
timeoutSeconds |
逾時秒數。 |
int |
ContainerProperties
EnvironmentVariable
名字 |
描述 |
價值 |
名字 |
環境變數的名稱。 |
字串 (必要) |
secureValue |
安全環境變數的值。 |
字串 |
價值 |
環境變數的值。 |
字串 |
GitRepoVolume
名字 |
描述 |
價值 |
目錄 |
目標目錄名稱。 不得包含或開頭為 『..』。 如果提供 『.』,磁碟區目錄將會是 git 存放庫。 否則,如果指定,磁碟區將會在具有指定名稱的子目錄中包含 git 存放庫。 |
字串 |
存儲庫 |
存放庫 URL |
字串 (必要) |
校訂 |
認可指定修訂的哈希。 |
字串 |
ImageRegistryCredential
名字 |
描述 |
價值 |
密碼 |
私人登錄的密碼。 |
字串 |
伺服器 |
沒有通訊協定的 Docker 映射登錄伺服器,例如 「HTTP」 和 「HTTPs」。 |
字串 (必要) |
username |
私人登錄的用戶名稱。 |
字串 (必要) |
IpAddress
名字 |
描述 |
價值 |
dnsNameLabel |
IP 的 Dns 名稱標籤。 |
字串 |
ip |
公開至公用因特網的IP。 |
字串 |
港口 |
容器群組上公開的埠清單。 |
埠[] (必要) |
類型 |
指定IP是否公開至公用因特網。 |
'Private' 'Public' (必要) |
LogAnalytics
名字 |
描述 |
價值 |
logType |
要使用的記錄類型。 |
'ContainerInsights' 'ContainerInstanceLogs' |
元數據 |
記錄分析的元數據。 |
LogAnalyticsMetadata |
workspaceId |
記錄分析的工作區標識碼 |
字串 (必要) |
workspaceKey |
記錄分析的工作區金鑰 |
字串 (必要) |
Microsoft.ContainerInstance/containerGroups
名字 |
描述 |
價值 |
位置 |
資源位置。 |
字串 |
名字 |
資源名稱 |
字串 (必要) |
性能 |
|
ContainerGroupProperties (必要) |
標籤 |
資源標籤 |
標記名稱和值的字典。 |
類型 |
資源類型 |
“Microsoft.ContainerInstance/containerGroups@2018-09-01” |
港口
名字 |
描述 |
價值 |
港口 |
埠號碼。 |
int (必要) |
協定 |
與埠相關聯的通訊協定。 |
'TCP' 'UDP' |
ResourceLimits
名字 |
描述 |
價值 |
中央處理器 |
這個容器實例的CPU限制。 |
int |
memoryInGB |
此容器實例的 GB 記憶體限制。 |
int |
ResourceRequests
名字 |
描述 |
價值 |
中央處理器 |
這個容器實例的CPU要求。 |
int (必要) |
memoryInGB |
此容器實例的 GB 記憶體要求。 |
int (必要) |
ResourceRequirements
SecretVolume
卷
VolumeMount
名字 |
描述 |
價值 |
mountPath |
容器內應掛接磁碟區的路徑。 不得包含冒號 (:)。 |
字串 (必要) |
名字 |
磁碟區掛接的名稱。 |
字串 (必要) |
readOnly |
指出磁碟區掛接是否為唯讀的旗標。 |
bool |