Container Groups - Create Or Update
使用指定的組態建立或更新容器群組。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}?api-version=2023-05-01
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
container
|
path | True |
string |
容器群組的名稱。 |
resource
|
path | True |
string |
資源群組的名稱。 |
subscription
|
path | True |
string |
可唯一識別Microsoft Azure 訂用帳戶的訂用帳戶認證。 訂用帳戶標識碼會形成每個服務呼叫 URI 的一部分。 |
api-version
|
query | True |
string |
用戶端 API 版本 |
要求本文
名稱 | 必要 | 類型 | Description |
---|---|---|---|
properties.containers | True |
容器群組內的容器。 |
|
properties.osType | True |
容器群組中容器所需的操作系統類型。 |
|
identity |
如果已設定,容器群組的身分識別。 |
||
location |
string |
資源位置。 |
|
properties.confidentialComputeProperties |
機密容器群組的屬性 |
||
properties.diagnostics |
容器群組的診斷資訊。 |
||
properties.dnsConfig |
容器群組的 DNS 設定資訊。 |
||
properties.encryptionProperties |
容器群組的加密屬性。 |
||
properties.extensions |
virtual kubelet 所使用的擴充功能 |
||
properties.imageRegistryCredentials |
建立容器群組的來源映像登錄認證。 |
||
properties.initContainers |
容器群組的 init 容器。 |
||
properties.ipAddress |
容器群組的IP位址類型。 |
||
properties.priority |
容器群組的優先順序。 |
||
properties.restartPolicy |
重新啟動容器群組內所有容器的原則。
|
||
properties.sku |
容器群組的 SKU。 |
||
properties.subnetIds |
容器群組的子網資源標識碼。 |
||
properties.volumes |
Volume[] |
此容器群組中的容器可以掛接的磁碟區清單。 |
|
tags |
object |
資源標記。 |
|
zones |
string[] |
容器群組的區域。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
還行 |
|
201 Created |
建立 - 建立容器群組。 |
|
Other Status Codes |
描述作業失敗原因的錯誤回應。 |
安全性
azure_auth
Azure Active Directory OAuth2 Flow
類型:
oauth2
Flow:
implicit
授權 URL:
https://login.microsoftonline.com/common/oauth2/authorize
範圍
名稱 | Description |
---|---|
user_impersonation | 模擬您的用戶帳戶 |
範例
Confidential |
Container |
Container |
Container |
Container |
ConfidentialContainerGroup
範例要求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1?api-version=2023-05-01
{
"location": "westeurope",
"properties": {
"containers": [
{
"name": "accdemo",
"properties": {
"command": [],
"environmentVariables": [],
"image": "confiimage",
"ports": [
{
"port": 8000
}
],
"resources": {
"requests": {
"cpu": 1,
"memoryInGB": 1.5
}
},
"securityContext": {
"privileged": false,
"capabilities": {
"add": [
"CAP_NET_ADMIN"
]
}
}
}
}
],
"imageRegistryCredentials": [],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 8000
}
],
"type": "Public"
},
"osType": "Linux",
"sku": "Confidential",
"confidentialComputeProperties": {
"ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19"
}
}
}
範例回覆
{
"properties": {
"sku": "Confidential",
"provisioningState": "Succeeded",
"containers": [
{
"name": "accdemo",
"properties": {
"image": "confiimage",
"command": [],
"ports": [
{
"port": 8000
}
],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1.5,
"cpu": 1
}
},
"securityContext": {
"privileged": false,
"capabilities": {
"add": [
"CAP_NET_ADMIN"
]
}
}
}
}
],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 8000
}
],
"type": "Public"
},
"initContainers": [],
"imageRegistryCredentials": [],
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Running"
},
"confidentialComputeProperties": {
"ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19"
}
},
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "westeurope"
}
{
"properties": {
"sku": "Confidential",
"provisioningState": "Succeeded",
"containers": [
{
"name": "accdemo",
"properties": {
"image": "confiimage",
"command": [],
"ports": [
{
"port": 8000
}
],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1.5,
"cpu": 1
}
},
"securityContext": {
"privileged": false,
"capabilities": {
"add": [
"CAP_NET_ADMIN"
]
}
}
}
}
],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 8000
}
],
"type": "Public"
},
"initContainers": [],
"imageRegistryCredentials": [],
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Running"
},
"confidentialComputeProperties": {
"ccePolicy": "eyJhbGxvd19hbGwiOiB0cnVlLCAiY29udGFpbmVycyI6IHsibGVuZ3RoIjogMCwgImVsZW1lbnRzIjogbnVsbH19"
}
},
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "westeurope"
}
ContainerGroupCreateWithExtensions
範例要求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1?api-version=2023-05-01
{
"location": "eastus2",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": [],
"environmentVariables": [],
"image": "nginx",
"ports": [
{
"port": 80
}
],
"resources": {
"requests": {
"cpu": 1,
"memoryInGB": 1.5
}
}
}
}
],
"imageRegistryCredentials": [],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 80
}
],
"type": "Private"
},
"osType": "Linux",
"subnetIds": [
{
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet"
}
],
"extensions": [
{
"name": "kube-proxy",
"properties": {
"extensionType": "kube-proxy",
"version": "1.0",
"settings": {
"clusterCidr": "10.240.0.0/16",
"kubeVersion": "v1.9.10"
},
"protectedSettings": {
"kubeConfig": "<kubeconfig encoded string>"
}
}
},
{
"name": "vk-realtime-metrics",
"properties": {
"extensionType": "realtime-metrics",
"version": "1.0"
}
}
]
}
}
範例回覆
{
"properties": {
"sku": "Standard",
"provisioningState": "Pending",
"containers": [
{
"name": "demo1",
"properties": {
"image": "nginx",
"command": [],
"ports": [
{
"port": 80
}
],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1.5,
"cpu": 1
}
}
}
}
],
"initContainers": [],
"extensions": [
{
"name": "kube-proxy",
"properties": {
"extensionType": "kube-proxy",
"version": "1.0",
"settings": {
"clusterCidr": "10.240.0.0/16",
"kubeVersion": "v1.9.10"
}
}
},
{
"name": "vk-realtime-metrics",
"properties": {
"extensionType": "realtime-metrics",
"version": "1.0"
}
}
],
"imageRegistryCredentials": [],
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Pending"
},
"subnetIds": [
{
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet"
}
]
},
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "eastus2"
}
{
"properties": {
"sku": "Standard",
"provisioningState": "Pending",
"containers": [
{
"name": "demo1",
"properties": {
"image": "nginx",
"command": [],
"ports": [
{
"port": 80
}
],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1.5,
"cpu": 1
}
}
}
}
],
"initContainers": [],
"extensions": [
{
"name": "kube-proxy",
"properties": {
"extensionType": "kube-proxy",
"version": "1.0",
"settings": {
"clusterCidr": "10.240.0.0/16",
"kubeVersion": "v1.9.10"
}
}
},
{
"name": "vk-realtime-metrics",
"properties": {
"extensionType": "realtime-metrics",
"version": "1.0"
}
}
],
"imageRegistryCredentials": [],
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Running"
},
"subnetIds": [
{
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-rg-vnet/subnets/test-subnet"
}
]
},
"id": "/subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "eastus2"
}
ContainerGroupsCreateOrUpdate
範例要求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1?api-version=2023-05-01
{
"location": "west us",
"identity": {
"type": "SystemAssigned, UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {}
}
},
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": [],
"environmentVariables": [],
"image": "nginx",
"ports": [
{
"port": 80
}
],
"resources": {
"requests": {
"cpu": 1,
"memoryInGB": 1.5,
"gpu": {
"count": 1,
"sku": "K80"
}
}
},
"volumeMounts": [
{
"name": "volume1",
"mountPath": "/mnt/volume1",
"readOnly": false
},
{
"name": "volume2",
"mountPath": "/mnt/volume2",
"readOnly": false
},
{
"name": "volume3",
"mountPath": "/mnt/volume3",
"readOnly": true
}
]
}
}
],
"diagnostics": {
"logAnalytics": {
"workspaceId": "workspaceid",
"workspaceKey": "workspaceKey",
"logType": "ContainerInsights",
"metadata": {
"test-key": "test-metadata-value"
},
"workspaceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg/providers/microsoft.operationalinsights/workspaces/workspace"
}
},
"subnetIds": [
{
"id": "[resourceId('Microsoft.Network/virtualNetworks/subnets', parameters('vnetName'), parameters('subnetName'))]"
}
],
"dnsConfig": {
"nameServers": [
"1.1.1.1"
],
"searchDomains": "cluster.local svc.cluster.local",
"options": "ndots:2"
},
"imageRegistryCredentials": [],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 80
}
],
"type": "Public",
"dnsNameLabel": "dnsnamelabel1",
"autoGeneratedDomainNameLabelScope": "Unsecure"
},
"osType": "Linux",
"volumes": [
{
"name": "volume1",
"azureFile": {
"shareName": "shareName",
"storageAccountName": "accountName",
"storageAccountKey": "accountKey"
}
},
{
"name": "volume2",
"emptyDir": {}
},
{
"name": "volume3",
"secret": {
"secretKey1": "SecretValue1InBase64",
"secretKey2": "SecretValue2InBase64"
}
}
]
}
}
範例回覆
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"location": "WestUs",
"zones": [
"1"
],
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": [],
"environmentVariables": [],
"image": "nginx",
"ports": [
{
"port": 80
}
],
"resources": {
"requests": {
"cpu": 1,
"memoryInGB": 1.5,
"gpu": {
"count": 1,
"sku": "K80"
}
}
},
"volumeMounts": [
{
"name": "volume1",
"mountPath": "/mnt/volume1",
"readOnly": false
},
{
"name": "volume2",
"mountPath": "/mnt/volume2",
"readOnly": false
},
{
"name": "volume3",
"mountPath": "/mnt/volume3",
"readOnly": true
}
]
}
}
],
"diagnostics": {
"logAnalytics": {
"workspaceId": "workspaceid"
}
},
"dnsConfig": {
"nameServers": [
"1.1.1.1"
],
"searchDomains": "cluster.local svc.cluster.local",
"options": "ndots:2"
},
"imageRegistryCredentials": [],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": 80,
"protocol": "TCP"
}
],
"type": "Public",
"dnsNameLabel": "dnsnamelabel1",
"autoGeneratedDomainNameLabelScope": "Unsecure",
"fqdn": "dnsnamelabel1.azure-container.io"
},
"osType": "Linux",
"provisioningState": "Succeeded",
"volumes": [
{
"name": "volume1",
"azureFile": {
"shareName": "shareName",
"storageAccountName": "accountName"
}
},
{
"name": "volume2",
"emptyDir": {}
},
{
"name": "volume3",
"secret": {}
}
]
},
"type": "Microsoft.ContainerInstance/containerGroups"
}
{
"id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"location": "WestUs",
"zones": [
"1"
],
"name": "demo1",
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": [],
"environmentVariables": [],
"image": "nginx",
"ports": [
{
"port": 80
}
],
"resources": {
"requests": {
"cpu": 1,
"memoryInGB": 1.5,
"gpu": {
"count": 1,
"sku": "K80"
}
}
},
"volumeMounts": [
{
"name": "volume1",
"mountPath": "/mnt/volume1",
"readOnly": false
},
{
"name": "volume2",
"mountPath": "/mnt/volume2",
"readOnly": false
},
{
"name": "volume3",
"mountPath": "/mnt/volume3",
"readOnly": true
}
]
}
}
],
"dnsConfig": {
"nameServers": [
"1.1.1.1"
]
},
"imageRegistryCredentials": [],
"ipAddress": {
"ip": "10.0.0.1",
"ports": [
{
"port": 80,
"protocol": "TCP"
}
],
"type": "Public",
"dnsNameLabel": "dnsnamelabel1",
"autoGeneratedDomainNameLabelScope": "Unsecure",
"fqdn": "dnsnamelabel1.azure-container.io"
},
"osType": "Linux",
"provisioningState": "Succeeded",
"volumes": [
{
"name": "volume1",
"azureFile": {
"shareName": "shareName",
"storageAccountName": "accountName"
}
},
{
"name": "volume2",
"emptyDir": {}
},
{
"name": "volume3",
"secret": {}
}
]
},
"type": "Microsoft.ContainerInstance/containerGroups"
}
ContainerGroupsCreateWithPriority
範例要求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1?api-version=2023-05-01
{
"properties": {
"sku": "Standard",
"containers": [
{
"name": "test-container-001",
"properties": {
"image": "alpine:latest",
"command": [
"/bin/sh",
"-c",
"sleep 10"
],
"resources": {
"requests": {
"memoryInGB": 1,
"cpu": 1
}
}
}
}
],
"restartPolicy": "Never",
"osType": "Linux",
"priority": "Spot"
},
"location": "eastus"
}
範例回覆
{
"properties": {
"sku": "Standard",
"provisioningState": "Succeeded",
"containers": [
{
"name": "test-container-001",
"properties": {
"image": "alpine:latest",
"command": [
"/bin/sh",
"-c",
"sleep 10"
],
"ports": [],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1,
"cpu": 1
}
}
}
}
],
"initContainers": [],
"restartPolicy": "Never",
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Succeeded"
},
"priority": "Spot"
},
"id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "eastus"
}
{
"properties": {
"sku": "Standard",
"provisioningState": "Created",
"containers": [
{
"name": "test-container-001",
"properties": {
"image": "alpine:latest",
"command": [
"/bin/sh",
"-c",
"sleep 10"
],
"ports": [],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1,
"cpu": 1
}
}
}
}
],
"initContainers": [],
"restartPolicy": "Never",
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Created"
},
"priority": "Spot"
},
"id": "/subscriptions/subId/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "eastus"
}
ContainerGroupWithEncryptionProperties
範例要求
PUT https://management.azure.com/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1?api-version=2023-05-01
{
"location": "eastus2",
"identity": {
"type": "UserAssigned",
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {}
}
},
"properties": {
"containers": [
{
"name": "demo1",
"properties": {
"command": [],
"environmentVariables": [],
"image": "nginx",
"ports": [
{
"port": 80
}
],
"resources": {
"requests": {
"cpu": 1,
"memoryInGB": 1.5
}
}
}
}
],
"imageRegistryCredentials": [],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 80
}
],
"type": "Public"
},
"osType": "Linux",
"encryptionProperties": {
"vaultBaseUrl": "https://testkeyvault.vault.azure.net",
"keyName": "test-key",
"keyVersion": "<key version>",
"identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity"
}
}
}
範例回覆
{
"properties": {
"sku": "Standard",
"encryptionProperties": {
"vaultBaseUrl": "https://testkeyvault.vault.azure.net/",
"keyName": "test-key",
"keyVersion": "<key version>",
"identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity"
},
"provisioningState": "Pending",
"containers": [
{
"name": "demo1",
"properties": {
"image": "nginx",
"command": [],
"ports": [
{
"port": 80
}
],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1.5,
"cpu": 1
}
}
}
}
],
"initContainers": [],
"imageRegistryCredentials": [],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 80
}
],
"type": "Public"
},
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Pending"
}
},
"identity": {
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {
"principalId": "<principal id>",
"clientId": "<client id>"
}
},
"tenantId": "<tenant id>",
"type": "UserAssigned"
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "eastus2"
}
{
"properties": {
"sku": "Standard",
"encryptionProperties": {
"vaultBaseUrl": "https://testkeyvault.vault.azure.net/",
"keyName": "test-key",
"keyVersion": "key version",
"identity": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity"
},
"provisioningState": "Running",
"containers": [
{
"name": "demo1",
"properties": {
"image": "nginx",
"command": [],
"ports": [
{
"port": 80
}
],
"environmentVariables": [],
"resources": {
"requests": {
"memoryInGB": 1.5,
"cpu": 1
}
}
}
}
],
"initContainers": [],
"imageRegistryCredentials": [],
"ipAddress": {
"ports": [
{
"protocol": "TCP",
"port": 80
}
],
"type": "Public"
},
"osType": "Linux",
"instanceView": {
"events": [],
"state": "Pending"
}
},
"identity": {
"userAssignedIdentities": {
"/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/container-group-identity": {
"principalId": "<principal id>",
"clientId": "<client id>"
}
},
"tenantId": "<tenant id>",
"type": "UserAssigned"
},
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/test-rg/providers/Microsoft.ContainerInstance/containerGroups/demo1",
"name": "demo1",
"type": "Microsoft.ContainerInstance/containerGroups",
"location": "eastus2"
}
定義
名稱 | Description |
---|---|
Azure |
Azure 檔案磁碟區的屬性。 Azure 檔案共用會掛接為磁碟區。 |
Cloud |
來自容器實例服務的錯誤回應。 |
Cloud |
來自容器實例服務的錯誤回應。 |
Confidential |
機密容器群組的屬性 |
Container |
容器實例。 |
Container |
容器執行命令,用於即時性或整備探查 |
Container |
容器群組。 |
Container |
容器群組診斷資訊。 |
Container |
容器群組的身分識別。 |
Container |
指定IP是否公開至公用因特網或私人 VNET。 |
Container |
與埠相關聯的通訊協定。 |
Container |
容器群組的優先順序。 |
Container |
容器群組的實例檢視。 只有在回應中才有效。 |
Container |
重新啟動容器群組內所有容器的原則。
|
Container |
容器群組 SKU。 |
Container |
容器群組子網資訊。 |
Container |
容器 Http Get 設定,用於即時性或整備探查 |
Container |
與埠相關聯的通訊協定。 |
Container |
在容器實例上公開的埠。 |
Container |
容器探查,以取得活躍度或整備程度 |
Container |
容器實例狀態。 |
Deployment |
要新增至部署的擴充功能提要。 |
Dns |
容器群組的 DNS 組態。 |
dns |
表示安全性列舉的值。 如果未選取,則 'Unsecure' 值是預設值,表示物件的域名卷標不會受到子域接管的保護。 如果選取 'TenantReuse' 值,則為預設值,表示物件域名標籤可以在相同的租用戶內重複使用。 'SubscriptionReuse' 值表示物件域名標籤可以在相同的訂用帳戶內重複使用。 'ResourceGroupReuse' 值表示物件域名標籤可以在相同的資源群組內重複使用。 'NoReuse' 值表示物件功能變數名稱標籤無法在相同的資源群組、訂用帳戶或租用戶內重複使用。 |
Empty |
空的目錄磁碟區。 |
Encryption |
容器群組加密屬性。 |
Environment |
要設定於容器實例內的環境變數。 |
Event |
容器群組或容器實例事件。 |
Git |
表示填入 Git 存放庫內容的磁碟區 |
Gpu |
GPU 資源。 |
Gpu |
GPU 資源的 SKU。 |
Http |
HTTP 標頭。 |
Image |
映射登錄認證。 |
Init |
init 容器定義。 |
Init |
init 容器的實例檢視。 只有在回應中才有效。 |
Instance |
容器實例的實例檢視。 只有在回應中才有效。 |
Ip |
容器群組的IP位址。 |
Log |
容器群組記錄分析資訊。 |
Log |
要使用的記錄類型。 |
Operating |
容器群組中容器所需的操作系統類型。 |
Port |
在容器群組上公開的埠。 |
Resource |
用於容器群組的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從容器群組中移除任何身分識別。 |
Resource |
資源限制。 |
Resource |
資源要求。 |
Resource |
資源需求。 |
Scheme |
配置。 |
Security |
從容器新增或卸除的功能。 |
Security |
容器的安全性內容。 |
User |
與容器群組相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。 |
Volume |
磁碟區的屬性。 |
Volume |
磁碟區掛接的屬性。 |
AzureFileVolume
Azure 檔案磁碟區的屬性。 Azure 檔案共用會掛接為磁碟區。
名稱 | 類型 | Description |
---|---|---|
readOnly |
boolean |
旗標,指出掛接為磁碟區的 Azure 檔案共用是否為唯讀。 |
shareName |
string |
要掛接為磁碟區的 Azure 檔案共享名稱。 |
storageAccountKey |
string |
用來存取 Azure 檔案共用的記憶體帳戶存取金鑰。 |
storageAccountName |
string |
包含 Azure 檔案共用的記憶體帳戶名稱。 |
CloudError
來自容器實例服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
error |
來自容器實例服務的錯誤回應。 |
CloudErrorBody
來自容器實例服務的錯誤回應。
名稱 | 類型 | Description |
---|---|---|
code |
string |
錯誤的識別碼。 程序代碼是不變的,而且是要以程序設計方式取用。 |
details |
錯誤的其他詳細數據清單。 |
|
message |
string |
描述錯誤的訊息,適用於在使用者介面中顯示。 |
target |
string |
特定錯誤的目標。 例如,錯誤中的屬性名稱。 |
ConfidentialComputeProperties
機密容器群組的屬性
名稱 | 類型 | Description |
---|---|---|
ccePolicy |
string |
base64 編碼的機密計算強制執行原則 |
Container
容器實例。
名稱 | 類型 | Description |
---|---|---|
name |
string |
容器實例的使用者提供名稱。 |
properties.command |
string[] |
要以 exec 形式在容器實例內執行的命令。 |
properties.environmentVariables |
要設定於容器實例中的環境變數。 |
|
properties.image |
string |
用來建立容器實例的映像名稱。 |
properties.instanceView |
容器實例的實例檢視。 只有在回應中才有效。 |
|
properties.livenessProbe |
活躍度探查。 |
|
properties.ports |
容器實例上公開的埠。 |
|
properties.readinessProbe |
整備探查。 |
|
properties.resources |
容器實例的資源需求。 |
|
properties.securityContext |
容器安全性屬性。 |
|
properties.volumeMounts |
磁碟區會掛接給容器實例。 |
ContainerExec
容器執行命令,用於即時性或整備探查
名稱 | 類型 | Description |
---|---|---|
command |
string[] |
在容器內執行的命令。 |
ContainerGroup
容器群組。
名稱 | 類型 | Description |
---|---|---|
id |
string |
資源標識碼。 |
identity |
如果已設定,容器群組的身分識別。 |
|
location |
string |
資源位置。 |
name |
string |
資源名稱。 |
properties.confidentialComputeProperties |
機密容器群組的屬性 |
|
properties.containers |
容器群組內的容器。 |
|
properties.diagnostics |
容器群組的診斷資訊。 |
|
properties.dnsConfig |
容器群組的 DNS 設定資訊。 |
|
properties.encryptionProperties |
容器群組的加密屬性。 |
|
properties.extensions |
virtual kubelet 所使用的擴充功能 |
|
properties.imageRegistryCredentials |
建立容器群組的來源映像登錄認證。 |
|
properties.initContainers |
容器群組的 init 容器。 |
|
properties.instanceView |
容器群組的實例檢視。 只有在回應中才有效。 |
|
properties.ipAddress |
容器群組的IP位址類型。 |
|
properties.osType |
容器群組中容器所需的操作系統類型。 |
|
properties.priority |
容器群組的優先順序。 |
|
properties.provisioningState |
string |
容器群組的布建狀態。 這隻會出現在回應中。 |
properties.restartPolicy |
重新啟動容器群組內所有容器的原則。
|
|
properties.sku |
容器群組的 SKU。 |
|
properties.subnetIds |
容器群組的子網資源標識碼。 |
|
properties.volumes |
Volume[] |
此容器群組中的容器可以掛接的磁碟區清單。 |
tags |
object |
資源標記。 |
type |
string |
資源類型。 |
zones |
string[] |
容器群組的區域。 |
ContainerGroupDiagnostics
容器群組診斷資訊。
名稱 | 類型 | Description |
---|---|---|
logAnalytics |
容器群組記錄分析資訊。 |
ContainerGroupIdentity
容器群組的身分識別。
名稱 | 類型 | Description |
---|---|---|
principalId |
string |
容器群組身分識別的主體標識碼。 此屬性只會針對系統指派的身分識別提供。 |
tenantId |
string |
與容器群組相關聯的租用戶標識碼。 此屬性只會針對系統指派的身分識別提供。 |
type |
用於容器群組的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從容器群組中移除任何身分識別。 |
|
userAssignedIdentities |
<string,
User |
與容器群組相關聯的使用者身分識別清單。 |
ContainerGroupIpAddressType
指定IP是否公開至公用因特網或私人 VNET。
值 | Description |
---|---|
Private | |
Public |
ContainerGroupNetworkProtocol
與埠相關聯的通訊協定。
值 | Description |
---|---|
TCP | |
UDP |
ContainerGroupPriority
容器群組的優先順序。
值 | Description |
---|---|
Regular | |
Spot |
ContainerGroupProperties.properties.InstanceView
容器群組的實例檢視。 只有在回應中才有效。
名稱 | 類型 | Description |
---|---|---|
events |
Event[] |
這個容器群組的事件。 |
state |
string |
容器群組的狀態。 只有在回應中才有效。 |
ContainerGroupRestartPolicy
重新啟動容器群組內所有容器的原則。
-
Always
永遠重新啟動 -
OnFailure
失敗時重新啟動 -
Never
永不重新啟動
值 | Description |
---|---|
Always | |
Never | |
OnFailure |
ContainerGroupSku
容器群組 SKU。
值 | Description |
---|---|
Confidential | |
Dedicated | |
Standard |
ContainerGroupSubnetId
容器群組子網資訊。
名稱 | 類型 | Description |
---|---|---|
id |
string |
虛擬網路和子網的資源標識碼。 |
name |
string |
子網的易記名稱。 |
ContainerHttpGet
容器 Http Get 設定,用於即時性或整備探查
名稱 | 類型 | Description |
---|---|---|
httpHeaders |
HTTP 標頭。 |
|
path |
string |
探查的路徑。 |
port |
integer (int32) |
要探查的埠號碼。 |
scheme |
配置。 |
ContainerNetworkProtocol
與埠相關聯的通訊協定。
值 | Description |
---|---|
TCP | |
UDP |
ContainerPort
在容器實例上公開的埠。
名稱 | 類型 | Description |
---|---|---|
port |
integer (int32) |
容器群組內公開的埠號碼。 |
protocol |
與埠相關聯的通訊協定。 |
ContainerProbe
容器探查,以取得活躍度或整備程度
名稱 | 類型 | Description |
---|---|---|
exec |
要探查的執行命令 |
|
failureThreshold |
integer (int32) |
失敗臨界值。 |
httpGet |
要探查的 Http Get 設定 |
|
initialDelaySeconds |
integer (int32) |
初始延遲秒。 |
periodSeconds |
integer (int32) |
句點秒數。 |
successThreshold |
integer (int32) |
成功臨界值。 |
timeoutSeconds |
integer (int32) |
逾時秒數。 |
ContainerState
容器實例狀態。
名稱 | 類型 | Description |
---|---|---|
detailStatus |
string |
容器實例狀態的人類可讀取狀態。 |
exitCode |
integer (int32) |
容器實例結束代碼會對應至來自 |
finishTime |
string (date-time) |
容器實例狀態完成的日期時間。 |
startTime |
string (date-time) |
容器實例狀態啟動時的日期時間。 |
state |
string |
容器實例的狀態。 |
DeploymentExtensionSpec
要新增至部署的擴充功能提要。
名稱 | 類型 | Description |
---|---|---|
name |
string |
延伸模組的名稱。 |
properties.extensionType |
string |
要加入的延伸模組類型。 |
properties.protectedSettings |
object |
延伸模組的受保護設定。 |
properties.settings |
object |
延伸模組的設定。 |
properties.version |
string |
所使用的擴充功能版本。 |
DnsConfiguration
容器群組的 DNS 組態。
名稱 | 類型 | Description |
---|---|---|
nameServers |
string[] |
容器群組的 DNS 伺服器。 |
options |
string |
容器群組的 DNS 選項。 |
searchDomains |
string |
容器群組中主機名查閱的 DNS 搜尋網域。 |
dnsNameLabelReusePolicy
表示安全性列舉的值。 如果未選取,則 'Unsecure' 值是預設值,表示物件的域名卷標不會受到子域接管的保護。 如果選取 'TenantReuse' 值,則為預設值,表示物件域名標籤可以在相同的租用戶內重複使用。 'SubscriptionReuse' 值表示物件域名標籤可以在相同的訂用帳戶內重複使用。 'ResourceGroupReuse' 值表示物件域名標籤可以在相同的資源群組內重複使用。 'NoReuse' 值表示物件功能變數名稱標籤無法在相同的資源群組、訂用帳戶或租用戶內重複使用。
值 | Description |
---|---|
Noreuse | |
ResourceGroupReuse | |
SubscriptionReuse | |
TenantReuse | |
Unsecure |
EmptyDirVolume
空的目錄磁碟區。
EncryptionProperties
容器群組加密屬性。
名稱 | 類型 | Description |
---|---|---|
identity |
string |
keyvault 受控識別。 |
keyName |
string |
加密金鑰名稱。 |
keyVersion |
string |
加密金鑰版本。 |
vaultBaseUrl |
string |
keyvault 基底 URL。 |
EnvironmentVariable
要設定於容器實例內的環境變數。
名稱 | 類型 | Description |
---|---|---|
name |
string |
環境變數的名稱。 |
secureValue |
string |
安全環境變數的值。 |
value |
string |
環境變數的值。 |
Event
容器群組或容器實例事件。
名稱 | 類型 | Description |
---|---|---|
count |
integer (int32) |
事件的計數。 |
firstTimestamp |
string (date-time) |
最早記錄事件的日期時間。 |
lastTimestamp |
string (date-time) |
最新記錄事件的日期時間。 |
message |
string |
事件訊息。 |
name |
string |
事件名稱。 |
type |
string |
事件類型。 |
GitRepoVolume
表示填入 Git 存放庫內容的磁碟區
名稱 | 類型 | Description |
---|---|---|
directory |
string |
目標目錄名稱。 不得包含或開頭為 『..』。 如果提供 『.』,磁碟區目錄將會是 git 存放庫。 否則,如果指定,磁碟區將會在具有指定名稱的子目錄中包含 git 存放庫。 |
repository |
string |
存放庫 URL |
revision |
string |
認可指定修訂的哈希。 |
GpuResource
GPU 資源。
名稱 | 類型 | Description |
---|---|---|
count |
integer (int32) |
GPU 資源的計數。 |
sku |
GPU 資源的 SKU。 |
GpuSku
GPU 資源的 SKU。
值 | Description |
---|---|
K80 | |
P100 | |
V100 |
HttpHeader
HTTP 標頭。
名稱 | 類型 | Description |
---|---|---|
name |
string |
標頭名稱。 |
value |
string |
標頭值。 |
ImageRegistryCredential
映射登錄認證。
名稱 | 類型 | Description |
---|---|---|
identity |
string |
私人登錄的身分識別。 |
identityUrl |
string |
私人登錄的識別 URL。 |
password |
string |
私人登錄的密碼。 |
server |
string |
沒有通訊協定的 Docker 映射登錄伺服器,例如 「HTTP」 和 「HTTPs」。 |
username |
string |
私人登錄的用戶名稱。 |
InitContainerDefinition
init 容器定義。
名稱 | 類型 | Description |
---|---|---|
name |
string |
init 容器的名稱。 |
properties.command |
string[] |
在 exec 表單的 init 容器內執行的命令。 |
properties.environmentVariables |
在 init 容器中設定的環境變數。 |
|
properties.image |
string |
init 容器的映像。 |
properties.instanceView |
init 容器的實例檢視。 只有在回應中才有效。 |
|
properties.securityContext |
容器安全性屬性。 |
|
properties.volumeMounts |
磁碟區掛接可供 init 容器使用。 |
InitContainerPropertiesDefinition.InstanceView
init 容器的實例檢視。 只有在回應中才有效。
名稱 | 類型 | Description |
---|---|---|
currentState |
init 容器的目前狀態。 |
|
events |
Event[] |
init 容器的事件。 |
previousState |
init 容器的先前狀態。 |
|
restartCount |
integer (int32) |
init 容器已重新啟動的次數。 |
InstanceView
容器實例的實例檢視。 只有在回應中才有效。
名稱 | 類型 | Description |
---|---|---|
currentState |
目前的容器實例狀態。 |
|
events |
Event[] |
容器實例的事件。 |
previousState |
先前的容器實例狀態。 |
|
restartCount |
integer (int32) |
容器實例已重新啟動的次數。 |
IpAddress
容器群組的IP位址。
名稱 | 類型 | 預設值 | Description |
---|---|---|---|
autoGeneratedDomainNameLabelScope | Unsecure |
表示安全性列舉的值。 如果未選取,則 'Unsecure' 值是預設值,表示物件的域名卷標不會受到子域接管的保護。 如果選取 'TenantReuse' 值,則為預設值,表示物件域名標籤可以在相同的租用戶內重複使用。 'SubscriptionReuse' 值表示物件域名標籤可以在相同的訂用帳戶內重複使用。 'ResourceGroupReuse' 值表示物件域名標籤可以在相同的資源群組內重複使用。 'NoReuse' 值表示物件功能變數名稱標籤無法在相同的資源群組、訂用帳戶或租用戶內重複使用。 |
|
dnsNameLabel |
string |
IP 的 Dns 名稱標籤。 |
|
fqdn |
string |
IP 的 FQDN。 |
|
ip |
string |
公開至公用因特網的IP。 |
|
ports |
Port[] |
容器群組上公開的埠清單。 |
|
type |
指定IP是否公開至公用因特網或私人 VNET。 |
LogAnalytics
容器群組記錄分析資訊。
名稱 | 類型 | Description |
---|---|---|
logType |
要使用的記錄類型。 |
|
metadata |
object |
記錄分析的元數據。 |
workspaceId |
string |
記錄分析的工作區標識碼 |
workspaceKey |
string |
記錄分析的工作區金鑰 |
workspaceResourceId |
string |
記錄分析的工作區資源標識碼 |
LogAnalyticsLogType
要使用的記錄類型。
值 | Description |
---|---|
ContainerInsights | |
ContainerInstanceLogs |
OperatingSystemTypes
容器群組中容器所需的操作系統類型。
值 | Description |
---|---|
Linux | |
Windows |
Port
在容器群組上公開的埠。
名稱 | 類型 | Description |
---|---|---|
port |
integer (int32) |
埠號碼。 |
protocol |
與埠相關聯的通訊協定。 |
ResourceIdentityType
用於容器群組的身分識別類型。 類型 'SystemAssigned, UserAssigned' 包含隱含建立的身分識別和一組使用者指派的身分識別。 類型 『None』 會從容器群組中移除任何身分識別。
值 | Description |
---|---|
None | |
SystemAssigned | |
SystemAssigned, UserAssigned | |
UserAssigned |
ResourceLimits
資源限制。
名稱 | 類型 | Description |
---|---|---|
cpu |
number (double) |
這個容器實例的CPU限制。 |
gpu |
此容器實例的 GPU 限制。 |
|
memoryInGB |
number (double) |
此容器實例的 GB 記憶體限制。 |
ResourceRequests
資源要求。
名稱 | 類型 | Description |
---|---|---|
cpu |
number (double) |
這個容器實例的CPU要求。 |
gpu |
這個容器實例的 GPU 要求。 |
|
memoryInGB |
number (double) |
此容器實例的 GB 記憶體要求。 |
ResourceRequirements
資源需求。
名稱 | 類型 | Description |
---|---|---|
limits |
此容器實例的資源限制。 |
|
requests |
此容器實例的資源要求。 |
Scheme
配置。
值 | Description |
---|---|
http | |
https |
SecurityContextCapabilitiesDefinition
從容器新增或卸除的功能。
名稱 | 類型 | Description |
---|---|---|
add |
string[] |
要新增至容器的功能。 |
drop |
string[] |
要從容器卸除的功能。 |
SecurityContextDefinition
容器的安全性內容。
名稱 | 類型 | Description |
---|---|---|
allowPrivilegeEscalation |
boolean |
布爾值,指出 init 進程是否可以提高其許可權 |
capabilities |
從容器新增或卸除的功能。 |
|
privileged |
boolean |
用來判斷容器許可權是否提升為 Privileged 的旗標。 |
runAsGroup |
integer (int32) |
設定容器的使用者 GID。 |
runAsUser |
integer (int32) |
設定容器的使用者 UID。 |
seccompProfile |
string |
base64 編碼字串,其中包含 seccomp 配置檔中 JSON 的內容 |
UserAssignedIdentities
與容器群組相關聯的使用者身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'。
名稱 | 類型 | Description |
---|---|---|
clientId |
string |
使用者指派身分識別的用戶端標識碼。 |
principalId |
string |
使用者指派身分識別的主體標識碼。 |
Volume
磁碟區的屬性。
名稱 | 類型 | Description |
---|---|---|
azureFile |
Azure 檔案磁碟區。 |
|
emptyDir |
空的目錄磁碟區。 |
|
gitRepo |
git 存放庫磁碟區。 |
|
name |
string |
磁碟區的名稱。 |
secret |
object |
秘密磁碟區。 |
VolumeMount
磁碟區掛接的屬性。
名稱 | 類型 | Description |
---|---|---|
mountPath |
string |
容器內應掛接磁碟區的路徑。 不得包含冒號 (:)。 |
name |
string |
磁碟區掛接的名稱。 |
readOnly |
boolean |
指出磁碟區掛接是否為唯讀的旗標。 |