Microsoft.ContainerInstance (preview:2024-11-01)

2025/09/09 • 8 updated methods

CGProfiles_ListBySubscription (updated)
Description Gets a list of all container group profiles under a subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfiles_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A container group profile object",
            "old": "container group profile object"
          },
          "$properties": {
            "properties": [
              {
                "#name": "containers",
                "Required": {
                  "new": true,
                  "old": false
                },
                "$items": {
                  "$properties": {
                    "properties": [
                      {
                        "#name": "image",
                        "Required": {
                          "new": false,
                          "old": true
                        }
                      },
                      {
                        "#name": "resources",
                        "Required": {
                          "new": false,
                          "old": true
                        }
                      },
                      {
                        "@added_810a71b630514cd1b96a3e451f2e320e": {
                          "#name": "configMap",
                          "Description": "The config map.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "keyValuePairs",
                              "Description": "The key value pairs dictionary in the config map.",
                              "Required": false,
                              "Type": "object"
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              },
              {
                "#name": "osType",
                "Required": {
                  "new": true,
                  "old": false
                }
              },
              {
                "#name": "revision",
                "Format": {
                  "new": "int32",
                  "old": "int64"
                }
              },
              {
                "registeredRevisions": {
                  "Format": {
                    "new": "int32",
                    "old": "int64"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroupProfiles
{
subscriptionId: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
CGProfiles_ListByResourceGroup (updated)
Description Gets a list of all container group profiles under a resource group.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfiles_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A container group profile object",
            "old": "container group profile object"
          },
          "$properties": {
            "properties": [
              {
                "#name": "containers",
                "Required": {
                  "new": true,
                  "old": false
                },
                "$items": {
                  "$properties": {
                    "properties": [
                      {
                        "#name": "image",
                        "Required": {
                          "new": false,
                          "old": true
                        }
                      },
                      {
                        "#name": "resources",
                        "Required": {
                          "new": false,
                          "old": true
                        }
                      },
                      {
                        "@added_449d7278196a40b3adeab7a35cbcbde0": {
                          "#name": "configMap",
                          "Description": "The config map.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "keyValuePairs",
                              "Description": "The key value pairs dictionary in the config map.",
                              "Required": false,
                              "Type": "object"
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              },
              {
                "#name": "osType",
                "Required": {
                  "new": true,
                  "old": false
                }
              },
              {
                "#name": "revision",
                "Format": {
                  "new": "int32",
                  "old": "int64"
                }
              },
              {
                "registeredRevisions": {
                  "Format": {
                    "new": "int32",
                    "old": "int64"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles
{
subscriptionId: string ,
resourceGroupName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
CGProfile_CreateOrUpdate (updated)
Description Create a CGProfile if it doesn't exist or update an existing CGProfile.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfile_CreateOrUpdate",
  "$parameters": {
    "ContainerGroupProfile": {
      "Description": {
        "new": "A container group profile object",
        "old": "container group profile object"
      },
      "$properties": {
        "properties": [
          {
            "#name": "containers",
            "Required": {
              "new": true,
              "old": false
            },
            "$items": {
              "$properties": {
                "properties": [
                  {
                    "#name": "image",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "#name": "resources",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "@added_2473f0abf48a4a86baa7916dc8a2002d": {
                      "#name": "configMap",
                      "Description": "The config map.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyValuePairs",
                          "Description": "The key value pairs dictionary in the config map.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "osType",
            "Required": {
              "new": true,
              "old": false
            }
          },
          {
            "#name": "revision",
            "Format": {
              "new": "int32",
              "old": "int64"
            }
          },
          {
            "registeredRevisions": {
              "Format": {
                "new": "int32",
                "old": "int64"
              }
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "A container group profile object",
        "old": "container group profile object"
      },
      "$properties": {
        "properties": [
          {
            "#name": "containers",
            "Required": {
              "new": true,
              "old": false
            },
            "$items": {
              "$properties": {
                "properties": [
                  {
                    "#name": "image",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "#name": "resources",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "@added_1ef835234f684c2289c23a171d120548": {
                      "#name": "configMap",
                      "Description": "The config map.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyValuePairs",
                          "Description": "The key value pairs dictionary in the config map.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "osType",
            "Required": {
              "new": true,
              "old": false
            }
          },
          {
            "#name": "revision",
            "Format": {
              "new": "int32",
              "old": "int64"
            }
          },
          {
            "registeredRevisions": {
              "Format": {
                "new": "int32",
                "old": "int64"
              }
            }
          }
        ]
      }
    },
    "201": {
      "Description": {
        "new": "A container group profile object",
        "old": "container group profile object"
      },
      "$properties": {
        "properties": [
          {
            "#name": "containers",
            "Required": {
              "new": true,
              "old": false
            },
            "$items": {
              "$properties": {
                "properties": [
                  {
                    "#name": "image",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "#name": "resources",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "@added_7e278a8d17ca4701982a5d5fcc2fa961": {
                      "#name": "configMap",
                      "Description": "The config map.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyValuePairs",
                          "Description": "The key value pairs dictionary in the config map.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "osType",
            "Required": {
              "new": true,
              "old": false
            }
          },
          {
            "#name": "revision",
            "Format": {
              "new": "int32",
              "old": "int64"
            }
          },
          {
            "registeredRevisions": {
              "Format": {
                "new": "int32",
                "old": "int64"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId: string ,
resourceGroupName: string ,
containerGroupProfileName: string ,
ContainerGroupProfile:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
api-version: string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CGProfile_Update (updated)
Description Update a specified container group profile.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfile_Update",
  "$responses": {
    "200": {
      "Description": {
        "new": "A container group profile object",
        "old": "container group profile object"
      },
      "$properties": {
        "properties": [
          {
            "#name": "containers",
            "Required": {
              "new": true,
              "old": false
            },
            "$items": {
              "$properties": {
                "properties": [
                  {
                    "#name": "image",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "#name": "resources",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "@added_fa7aaf65fd394982b076f3149a053fa8": {
                      "#name": "configMap",
                      "Description": "The config map.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyValuePairs",
                          "Description": "The key value pairs dictionary in the config map.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "osType",
            "Required": {
              "new": true,
              "old": false
            }
          },
          {
            "#name": "revision",
            "Format": {
              "new": "int32",
              "old": "int64"
            }
          },
          {
            "registeredRevisions": {
              "Format": {
                "new": "int32",
                "old": "int64"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId: string ,
resourceGroupName: string ,
containerGroupProfileName: string ,
properties:
{
tags: object ,
}
,
api-version: string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-correlation-request-id: string ,
}
,
$schema:
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CGProfile_Get (updated)
Description Get the properties of the specified container group profile.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfile_Get",
  "$responses": {
    "200": {
      "Description": {
        "new": "A container group profile object",
        "old": "container group profile object"
      },
      "$properties": {
        "properties": [
          {
            "#name": "containers",
            "Required": {
              "new": true,
              "old": false
            },
            "$items": {
              "$properties": {
                "properties": [
                  {
                    "#name": "image",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "#name": "resources",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "@added_bc740ac04aa74278a98e556485e31896": {
                      "#name": "configMap",
                      "Description": "The config map.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyValuePairs",
                          "Description": "The key value pairs dictionary in the config map.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "osType",
            "Required": {
              "new": true,
              "old": false
            }
          },
          {
            "#name": "revision",
            "Format": {
              "new": "int32",
              "old": "int64"
            }
          },
          {
            "registeredRevisions": {
              "Format": {
                "new": "int32",
                "old": "int64"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId: string ,
resourceGroupName: string ,
containerGroupProfileName: string ,
api-version: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
CGProfile_Delete (updated)
Description Deletes a container group profile.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfile_Delete",
  "$responses": {
    "@added_41b4781ef3fa4bb288acfdd7bdaa48cf": {
      "#status": "200"
    },
    "@removed_12aca3909ba04fb1a1c696f01ca104dd": {
      "202": [
        {
          "#name": "x-ms-correlation-request-id",
          "Type": "string"
        },
        {
          "#name": "location",
          "Type": "string"
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}
{
subscriptionId: string ,
resourceGroupName: string ,
containerGroupProfileName: string ,
api-version: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
CGProfile_ListAllRevisions (updated)
Description Get a list of all the revisions of the specified container group profile in the given subscription and resource group. This operation returns properties of each revision of the specified container group profile including containers, image registry credentials, restart policy, IP address type, OS type volumes, revision number, etc.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfile_ListAllRevisions",
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "Description": {
            "new": "A container group profile object",
            "old": "container group profile object"
          },
          "$properties": {
            "properties": [
              {
                "#name": "containers",
                "Required": {
                  "new": true,
                  "old": false
                },
                "$items": {
                  "$properties": {
                    "properties": [
                      {
                        "#name": "image",
                        "Required": {
                          "new": false,
                          "old": true
                        }
                      },
                      {
                        "#name": "resources",
                        "Required": {
                          "new": false,
                          "old": true
                        }
                      },
                      {
                        "@added_23a36283f992404cae31ef16d7fd573e": {
                          "#name": "configMap",
                          "Description": "The config map.",
                          "Required": false,
                          "Type": "object",
                          "$properties": [
                            {
                              "#name": "keyValuePairs",
                              "Description": "The key value pairs dictionary in the config map.",
                              "Required": false,
                              "Type": "object"
                            }
                          ]
                        }
                      }
                    ]
                  }
                }
              },
              {
                "#name": "osType",
                "Required": {
                  "new": true,
                  "old": false
                }
              },
              {
                "#name": "revision",
                "Format": {
                  "new": "int32",
                  "old": "int64"
                }
              },
              {
                "registeredRevisions": {
                  "Format": {
                    "new": "int32",
                    "old": "int64"
                  }
                }
              }
            ]
          }
        }
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions
{
subscriptionId: string ,
resourceGroupName: string ,
containerGroupProfileName: string ,
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}
CGProfile_GetByRevisionNumber (updated)
Description Gets the properties of the specified revision of the container group profile in the given subscription and resource group. The operation returns the properties of container group profile including containers, image registry credentials, restart policy, IP address type, OS type, volumes, current revision number, etc.
Reference Link ¶

⚶ Changes

{
  "#id": "CGProfile_GetByRevisionNumber",
  "$responses": {
    "200": {
      "Description": {
        "new": "A container group profile object",
        "old": "container group profile object"
      },
      "$properties": {
        "properties": [
          {
            "#name": "containers",
            "Required": {
              "new": true,
              "old": false
            },
            "$items": {
              "$properties": {
                "properties": [
                  {
                    "#name": "image",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "#name": "resources",
                    "Required": {
                      "new": false,
                      "old": true
                    }
                  },
                  {
                    "@added_c942dca9908b44ee9f03b380050a19a0": {
                      "#name": "configMap",
                      "Description": "The config map.",
                      "Required": false,
                      "Type": "object",
                      "$properties": [
                        {
                          "#name": "keyValuePairs",
                          "Description": "The key value pairs dictionary in the config map.",
                          "Required": false,
                          "Type": "object"
                        }
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "osType",
            "Required": {
              "new": true,
              "old": false
            }
          },
          {
            "#name": "revision",
            "Format": {
              "new": "int32",
              "old": "int64"
            }
          },
          {
            "registeredRevisions": {
              "Format": {
                "new": "int32",
                "old": "int64"
              }
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroupProfiles/{containerGroupProfileName}/revisions/{revisionNumber}
{
subscriptionId: string ,
resourceGroupName: string ,
containerGroupProfileName: string ,
revisionNumber: string ,
api-version: string ,
}

⚐ Response (200)

{
systemData:
{
createdBy: string ,
createdByType: enum ,
createdAt: string ,
lastModifiedBy: string ,
lastModifiedByType: enum ,
lastModifiedAt: string ,
}
,
properties:
{
sku: enum ,
encryptionProperties:
{
vaultBaseUrl: string ,
keyName: string ,
keyVersion: string ,
identity: string ,
}
,
containers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
resources:
{
requests:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
limits:
{
memoryInGB: number ,
cpu: number ,
gpu:
{
count: integer ,
sku: enum ,
}
,
}
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
livenessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
readinessProbe:
{
exec:
{
command:
[
string ,
]
,
}
,
httpGet:
{
path: string ,
port: integer ,
scheme: enum ,
httpHeaders:
[
{
name: string ,
value: string ,
}
,
]
,
}
,
initialDelaySeconds: integer ,
periodSeconds: integer ,
failureThreshold: integer ,
successThreshold: integer ,
timeoutSeconds: integer ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
configMap:
{
keyValuePairs: object ,
}
,
}
,
}
,
]
,
initContainers:
[
{
name: string ,
properties:
{
image: string ,
command:
[
string ,
]
,
environmentVariables:
[
{
name: string ,
value: string ,
secureValue: string ,
secureValueReference: string ,
}
,
]
,
instanceView:
{
restartCount: integer ,
currentState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
previousState:
{
state: string ,
startTime: string ,
exitCode: integer ,
finishTime: string ,
detailStatus: string ,
}
,
events:
[
{
count: integer ,
firstTimestamp: string ,
lastTimestamp: string ,
name: string ,
message: string ,
type: string ,
}
,
]
,
}
,
volumeMounts:
[
{
name: string ,
mountPath: string ,
readOnly: boolean ,
}
,
]
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
}
,
}
,
]
,
extensions:
[
{
name: string ,
properties:
{
extensionType: string ,
version: string ,
settings: object ,
protectedSettings: object ,
}
,
}
,
]
,
imageRegistryCredentials:
[
{
server: string ,
username: string ,
password: string ,
passwordReference: string ,
identity: string ,
identityUrl: string ,
}
,
]
,
restartPolicy: enum ,
shutdownGracePeriod: string ,
ipAddress:
{
ports:
[
{
protocol: enum ,
port: integer ,
}
,
]
,
type: enum ,
ip: string ,
dnsNameLabel: string ,
autoGeneratedDomainNameLabelScope: enum ,
fqdn: string ,
}
,
timeToLive: string ,
osType: enum ,
volumes:
[
{
name: string ,
azureFile:
{
shareName: string ,
readOnly: boolean ,
storageAccountName: string ,
storageAccountKey: string ,
storageAccountKeyReference: string ,
}
,
emptyDir: object ,
secret: object ,
secretReference: object ,
gitRepo:
{
directory: string ,
repository: string ,
revision: string ,
}
,
}
,
]
,
diagnostics:
{
logAnalytics:
{
workspaceId: string ,
workspaceKey: string ,
logType: enum ,
metadata: object ,
workspaceResourceId: string ,
}
,
}
,
priority: enum ,
confidentialComputeProperties:
{
ccePolicy: string ,
}
,
securityContext:
{
privileged: boolean ,
allowPrivilegeEscalation: boolean ,
capabilities:
{
add:
[
string ,
]
,
drop:
[
string ,
]
,
}
,
runAsGroup: integer ,
runAsUser: integer ,
seccompProfile: string ,
}
,
revision: integer ,
registeredRevisions:
[
integer ,
]
,
useKrypton: boolean ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
}
,
}