Azure Container Instance
Easily run containers on Azure with a single command. Create container groups, get the logs of a container and more.
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions |
Power Automate | Premium | All Power Automate regions |
Power Apps | Premium | All Power Apps regions |
Contact | |
---|---|
Name | Microsoft |
URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
Connector Metadata | |
---|---|
Publisher | Microsoft |
Website | https://azure.microsoft.com/services/container-instances/ |
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Create or update a container group |
Create or update a container group with specified configurations. |
Delete a container group |
Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes. |
Get a list of container groups in a resource group |
Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. |
Get a list of container groups in a subscription |
Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. |
Get cached images |
Get the list of cached images on specific OS type for a subscription in a region. |
Get capabilities |
Get the list of CPU/memory/GPU capabilities for a subscription in a region. |
Get current usage |
Get the usage for a subscription |
Get logs from a container instance |
Get the logs for a specified container instance in a specified resource group and container group. |
Get properties of a container group |
Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes. |
Restart containers in a container group |
Restarts all containers in a container group in place. If container image has updates, new image will be downloaded. |
Start containers in a container group |
Starts all containers in a container group. Compute resources will be allocated and billing will start. |
Stop containers in a container group |
Stops all containers in a container group. Compute resources will be deallocated and billing will stop. |
Update a container group location or tags |
Update a container group with the specified tags and/or location. |
Create or update a container group with specified configurations.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
id
|
id | string |
The resource id. |
|
name
|
name | string |
The resource name. |
|
type
|
type | string |
The resource type. |
|
Location
|
location | True | string |
The location to deploy container group. |
Tags
|
tags | object |
The resource tags. |
|
principalId
|
principalId | string |
The principal id of the container group identity. This property will only be provided for a system assigned identity. |
|
tenantId
|
tenantId | string |
The tenant id associated with the container group. This property will only be provided for a system assigned identity. |
|
Type
|
type | string |
The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. |
|
User Assigned Identities
|
userAssignedIdentities | object |
The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
|
provisioningState
|
provisioningState | string |
The provisioning state of the container group. This only appears in the response. |
|
Name
|
name | True | string |
The name of the container. |
Image
|
image | True | string |
The name of the image used to create the container. E.g. nginx:latest |
Command
|
command | array of string |
The commands to execute within the container. E.g. [ "echo", "hello aci" ] |
|
Protocol
|
protocol | string |
The protocol associated with the port. |
|
Number
|
port | True | integer |
The port number exposed within the container group. |
Name
|
name | True | string |
The name of the environment variable. |
Value
|
value | True | string |
The value of the environment variable. |
restartCount
|
restartCount | integer |
The number of times that the container instance has been restarted. |
|
state
|
state | string |
The state of the container instance. |
|
startTime
|
startTime | date-time |
The date-time when the container instance state started. |
|
exitCode
|
exitCode | integer |
The container instance exit codes correspond to those from the |
|
finishTime
|
finishTime | date-time |
The date-time when the container instance state finished. |
|
detailStatus
|
detailStatus | string |
The human-readable status of the container instance state. |
|
count
|
count | integer |
The count of the event. |
|
firstTimestamp
|
firstTimestamp | date-time |
The date-time of the earliest logged event. |
|
lastTimestamp
|
lastTimestamp | date-time |
The date-time of the latest logged event. |
|
name
|
name | string |
The event name. |
|
message
|
message | string |
The event message. |
|
type
|
type | string |
The event type. |
|
Memory
|
memoryInGB | True | number |
The memory request in GB of this container. E.g. 3.5 |
CPU
|
cpu | True | number |
The CPU request of this container. E.g. 2.0 |
Count
|
count | True | integer |
The count of the GPU resource. |
SKU
|
sku | True | string |
The SKU of the GPU resource. |
Memory
|
memoryInGB | double |
The memory limit in GB of this container. |
|
CPU
|
cpu | double |
The CPU limit of this container. |
|
Name
|
name | True | string |
The name of the volume. |
Path
|
mountPath | True | string |
The path within the container where the volume should be mounted. Must not contain colon (:). |
Readonly
|
readOnly | boolean |
The flag indicating whether the volume mount is read-only. |
|
Command
|
command | True | array of string |
The commands to execute within the container. |
Path
|
path | string |
The path to probe. |
|
Port
|
port | True | integer |
The port number to probe. |
Scheme
|
scheme | string |
The scheme. |
|
Initial Delay
|
initialDelaySeconds | integer |
The initial delay seconds. |
|
Period
|
periodSeconds | integer |
The period seconds. |
|
Failure Threshold
|
failureThreshold | integer |
The failure threshold. |
|
Success Threshold
|
successThreshold | integer |
The success threshold. |
|
Timeout
|
timeoutSeconds | integer |
The timeout seconds. |
|
Initial Delay
|
initialDelaySeconds | integer |
The initial delay seconds. |
|
Period
|
periodSeconds | integer |
The period seconds. |
|
Failure Threshold
|
failureThreshold | integer |
The failure threshold. |
|
Success Threshold
|
successThreshold | integer |
The success threshold. |
|
Timeout
|
timeoutSeconds | integer |
The timeout seconds. |
|
Server
|
server | True | string |
The Docker image registry server without a protocol such as "myacr.azurecr.io". |
User Name
|
username | True | string |
The username for the private registry. |
Password
|
password | string |
The password for the private registry. |
|
Restart Policy
|
restartPolicy | string |
Restart policy for all containers within the container group. |
|
Protocol
|
protocol | string |
The protocol associated with the port. |
|
Number
|
port | True | integer |
The port number. |
Type
|
type | True | string |
Specifies if the IP is exposed to the public internet. |
ip
|
ip | string |
The IP exposed to the public internet. |
|
Dns Name
|
dnsNameLabel | string |
The Dns name label for the IP. |
|
fqdn
|
fqdn | string |
The FQDN for the IP. |
|
OS Type
|
osType | True | string |
The operating system type required by the container. |
Name
|
name | True | string |
The name of the volume. |
Share Name
|
shareName | True | string |
The name of the Azure File share to be mounted as a volume. |
ReadOnly
|
readOnly | boolean |
The flag indicating whether the Azure File shared mounted as a volume is read-only. |
|
Storage Account Name
|
storageAccountName | True | string |
The name of the storage account that contains the Azure File share. |
Storage Account Key
|
storageAccountKey | string |
The storage account access key used to access the Azure File share. |
|
Secret Volume
|
secret | object |
The secret volume. |
|
Directory
|
directory | string |
Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
|
Repository
|
repository | True | string |
Repository URL |
Revision
|
revision | string |
Commit hash for the specified revision. |
|
count
|
count | integer |
The count of the event. |
|
firstTimestamp
|
firstTimestamp | date-time |
The date-time of the earliest logged event. |
|
lastTimestamp
|
lastTimestamp | date-time |
The date-time of the latest logged event. |
|
name
|
name | string |
The event name. |
|
message
|
message | string |
The event message. |
|
type
|
type | string |
The event type. |
|
state
|
state | string |
The state of the container group. Only valid in response. |
|
Workspace Id
|
workspaceId | True | string |
The workspace id for log analytics |
Workspace Key
|
workspaceKey | True | string |
The workspace key for log analytics |
Log Type
|
logType | string |
The log type to be used. |
|
Metadata
|
metadata | object |
Metadata for log analytics. |
|
Network Profile Id
|
id | True | string |
The identifier for a network profile. |
Name Servers
|
nameServers | True | array of string |
The DNS servers for the container group. |
Search Domains
|
searchDomains | string |
The DNS search domains for hostname lookup in the container group. |
|
Options
|
options | string |
The DNS options for the container group. |
|
SKU
|
sku | string |
The container group SKU. |
|
Vault Url
|
vaultBaseUrl | True | string |
The keyvault base url. |
Key Name
|
keyName | True | string |
The encryption key name. |
Key Version
|
keyVersion | True | string |
The encryption key version. |
Name
|
name | True | string |
The name for the init container. |
Image
|
image | string |
The image of the init container. |
|
Command
|
command | array of string |
The command to execute within the init container in exec form. |
|
Name
|
name | True | string |
The name of the environment variable. |
Value
|
value | True | string |
The value of the environment variable. |
restartCount
|
restartCount | integer |
The number of times that the init container has been restarted. |
|
state
|
state | string |
The state of the container instance. |
|
startTime
|
startTime | date-time |
The date-time when the container instance state started. |
|
exitCode
|
exitCode | integer |
The container instance exit codes correspond to those from the |
|
finishTime
|
finishTime | date-time |
The date-time when the container instance state finished. |
|
detailStatus
|
detailStatus | string |
The human-readable status of the container instance state. |
|
count
|
count | integer |
The count of the event. |
|
firstTimestamp
|
firstTimestamp | date-time |
The date-time of the earliest logged event. |
|
lastTimestamp
|
lastTimestamp | date-time |
The date-time of the latest logged event. |
|
name
|
name | string |
The event name. |
|
message
|
message | string |
The event message. |
|
type
|
type | string |
The event type. |
|
Name
|
name | True | string |
The name of the volume. |
Path
|
mountPath | True | string |
The path within the container where the volume should be mounted. Must not contain colon (:). |
Readonly
|
readOnly | boolean |
The flag indicating whether the volume mount is read-only. |
Returns
A container group.
- ContainerGroup
- ContainerGroup
Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
Returns
A container group.
- ContainerGroup
- ContainerGroup
Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Returns
The container group list response that contains the container group properties.
Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Returns
The container group list response that contains the container group properties.
Get the list of cached images on specific OS type for a subscription in a region.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Location
|
location | True | string |
The identifier for the physical azure location. |
Returns
The response containing cached images.
Get the list of CPU/memory/GPU capabilities for a subscription in a region.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Location
|
location | True | string |
The identifier for the physical azure location. |
Returns
The response containing list of capabilities.
Get the usage for a subscription
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Location
|
location | True | string |
The identifier for the physical azure location. |
Returns
The response containing the usage data
- Body
- UsageListResult
Get the logs for a specified container instance in a specified resource group and container group.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
Container Name
|
containerName | True | string |
The name of the container instance. |
Tail Lines
|
tail | integer |
The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb. |
Returns
The logs.
- Body
- Logs
Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
Returns
A container group.
- ContainerGroup
- ContainerGroup
Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
Starts all containers in a container group. Compute resources will be allocated and billing will start.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
Update a container group with the specified tags and/or location.
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Subscription Id
|
subscriptionId | True | string |
Microsoft Azure subscription. |
Resource Group
|
resourceGroupName | True | string |
The name of the resource group. |
Container Group Name
|
containerGroupName | True | string |
The name of the container group. |
id
|
id | string |
The resource id. |
|
name
|
name | string |
The resource name. |
|
type
|
type | string |
The resource type. |
|
Location
|
location | string |
The resource location. |
|
Tags
|
tags | object |
The resource tags. |
Returns
A container group.
- ContainerGroup
- ContainerGroup
A container instance.
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name of the container. |
properties
|
properties | ContainerProperties |
The container properties. |
The container properties.
Name | Path | Type | Description |
---|---|---|---|
Image
|
image | string |
The name of the image used to create the container. E.g. nginx:latest |
Command
|
command | array of string |
The commands to execute within the container. E.g. [ "echo", "hello aci" ] |
Ports
|
ports | array of ContainerPort |
The exposed ports on the container instance. |
Environment Variables
|
environmentVariables | array of EnvironmentVariable |
The environment variables to set in the container instance. |
restartCount
|
instanceView.restartCount | integer |
The number of times that the container instance has been restarted. |
currentState
|
instanceView.currentState | ContainerState |
The container instance state. |
previousState
|
instanceView.previousState | ContainerState |
The container instance state. |
events
|
instanceView.events | array of Event |
The events of the container instance. |
resources
|
resources | ResourceRequirements |
The resource requirements. |
Volume Mounts
|
volumeMounts | array of VolumeMount |
The volume mounts available to the container instance. |
Liveness Probe
|
livenessProbe | ContainerProbeLiveness |
The container probe, for liveness |
Readiness Probe
|
readinessProbe | ContainerProbeReadiness |
The container probe, for readiness |
The container instance state.
Name | Path | Type | Description |
---|---|---|---|
state
|
state | string |
The state of the container instance. |
startTime
|
startTime | date-time |
The date-time when the container instance state started. |
exitCode
|
exitCode | integer |
The container instance exit codes correspond to those from the |
finishTime
|
finishTime | date-time |
The date-time when the container instance state finished. |
detailStatus
|
detailStatus | string |
The human-readable status of the container instance state. |
A container group or container instance event.
Name | Path | Type | Description |
---|---|---|---|
count
|
count | integer |
The count of the event. |
firstTimestamp
|
firstTimestamp | date-time |
The date-time of the earliest logged event. |
lastTimestamp
|
lastTimestamp | date-time |
The date-time of the latest logged event. |
name
|
name | string |
The event name. |
message
|
message | string |
The event message. |
type
|
type | string |
The event type. |
The resource requirements.
Name | Path | Type | Description |
---|---|---|---|
Resource Requests
|
requests | ResourceRequests |
The resource requests. |
Resource Limits
|
limits | ResourceLimits |
The resource limits. |
The resource requests.
Name | Path | Type | Description |
---|---|---|---|
Memory
|
memoryInGB | number |
The memory request in GB of this container. E.g. 3.5 |
CPU
|
cpu | number |
The CPU request of this container. E.g. 2.0 |
GPU
|
gpu | GpuResource |
The GPU resource. |
The resource limits.
Name | Path | Type | Description |
---|---|---|---|
Memory
|
memoryInGB | double |
The memory limit in GB of this container. |
CPU
|
cpu | double |
The CPU limit of this container. |
GPU
|
gpu | GpuResource |
The GPU resource. |
The GPU resource.
Name | Path | Type | Description |
---|---|---|---|
Count
|
count | integer |
The count of the GPU resource. |
SKU
|
sku | string |
The SKU of the GPU resource. |
The properties of the Azure File volume. Azure File shares are mounted as volumes.
Name | Path | Type | Description |
---|---|---|---|
Share Name
|
shareName | string |
The name of the Azure File share to be mounted as a volume. |
ReadOnly
|
readOnly | boolean |
The flag indicating whether the Azure File shared mounted as a volume is read-only. |
Storage Account Name
|
storageAccountName | string |
The name of the storage account that contains the Azure File share. |
Storage Account Key
|
storageAccountKey | string |
The storage account access key used to access the Azure File share. |
The empty directory volume.
The secret volume.
Name | Path | Type | Description |
---|---|---|---|
Secret Volume
|
object |
The secret volume. |
Represents a volume that is populated with the contents of a git repository
Name | Path | Type | Description |
---|---|---|---|
Directory
|
directory | string |
Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name. |
Repository
|
repository | string |
Repository URL |
Revision
|
revision | string |
Commit hash for the specified revision. |
The properties of the volume.
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name of the volume. |
Azure File Volume
|
azureFile | AzureFileVolume |
The properties of the Azure File volume. Azure File shares are mounted as volumes. |
Empty Directory Volume
|
emptyDir | EmptyDirVolume |
The empty directory volume. |
Secret Volume
|
secret | SecretVolume |
The secret volume. |
Git Repo Volume
|
gitRepo | GitRepoVolume |
Represents a volume that is populated with the contents of a git repository |
The properties of the volume mount.
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name of the volume. |
Path
|
mountPath | string |
The path within the container where the volume should be mounted. Must not contain colon (:). |
Readonly
|
readOnly | boolean |
The flag indicating whether the volume mount is read-only. |
The container execution command, for liveness or readiness probe
Name | Path | Type | Description |
---|---|---|---|
Command
|
command | array of string |
The commands to execute within the container. |
The container Http Get settings, for liveness or readiness probe
Name | Path | Type | Description |
---|---|---|---|
Path
|
path | string |
The path to probe. |
Port
|
port | integer |
The port number to probe. |
Scheme
|
scheme | string |
The scheme. |
The container probe, for liveness
Name | Path | Type | Description |
---|---|---|---|
Exec
|
exec | ContainerExec |
The container execution command, for liveness or readiness probe |
HTTP GET
|
httpGet | ContainerHttpGet |
The container Http Get settings, for liveness or readiness probe |
Initial Delay
|
initialDelaySeconds | integer |
The initial delay seconds. |
Period
|
periodSeconds | integer |
The period seconds. |
Failure Threshold
|
failureThreshold | integer |
The failure threshold. |
Success Threshold
|
successThreshold | integer |
The success threshold. |
Timeout
|
timeoutSeconds | integer |
The timeout seconds. |
The container probe, for readiness
Name | Path | Type | Description |
---|---|---|---|
Exec
|
exec | ContainerExec |
The container execution command, for liveness or readiness probe |
HTTP GET
|
httpGet | ContainerHttpGet |
The container Http Get settings, for liveness or readiness probe |
Initial Delay
|
initialDelaySeconds | integer |
The initial delay seconds. |
Period
|
periodSeconds | integer |
The period seconds. |
Failure Threshold
|
failureThreshold | integer |
The failure threshold. |
Success Threshold
|
successThreshold | integer |
The success threshold. |
Timeout
|
timeoutSeconds | integer |
The timeout seconds. |
A container group.
Name | Path | Type | Description |
---|---|---|---|
id
|
id | string |
The resource id. |
name
|
name | string |
The resource name. |
type
|
type | string |
The resource type. |
Location
|
location | string |
The location to deploy container group. |
Tags
|
tags | object |
The resource tags. |
Managed Identity
|
identity | ContainerGroupIdentity |
Identity for the container group. |
provisioningState
|
properties.provisioningState | string |
The provisioning state of the container group. This only appears in the response. |
Containers
|
properties.containers | array of Container |
The containers within the container group. |
Image Registries
|
properties.imageRegistryCredentials | array of ImageRegistryCredential |
The image registry credentials by which the container group is created from. |
Restart Policy
|
properties.restartPolicy | string |
Restart policy for all containers within the container group. |
IP Address
|
properties.ipAddress | IpAddress |
IP address for the container group. |
OS Type
|
properties.osType | string |
The operating system type required by the container. |
Volumes
|
properties.volumes | array of Volume |
The list of volumes that can be mounted by containers in this container group. |
events
|
properties.instanceView.events | array of Event |
The events of this container group. |
state
|
properties.instanceView.state | string |
The state of the container group. Only valid in response. |
diagnostics
|
properties.diagnostics | ContainerGroupDiagnostics |
Container group diagnostic information. |
networkProfile
|
properties.networkProfile | ContainerGroupNetworkProfile |
Container group network profile information. |
DNS Configuration
|
properties.dnsConfig | DnsConfiguration |
DNS configuration for the container group. |
SKU
|
properties.sku | ContainerGroupSku |
The container group SKU. |
Encryption
|
properties.encryptionProperties | EncryptionProperties |
The container group encryption properties. |
Init Containers
|
properties.initContainers | array of InitContainerDefinition |
The init containers for a container group. |
Identity for the container group.
Name | Path | Type | Description |
---|---|---|---|
principalId
|
principalId | string |
The principal id of the container group identity. This property will only be provided for a system assigned identity. |
tenantId
|
tenantId | string |
The tenant id associated with the container group. This property will only be provided for a system assigned identity. |
Type
|
type | string |
The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group. |
User Assigned Identities
|
userAssignedIdentities | object |
The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'. |
Image registry credential.
Name | Path | Type | Description |
---|---|---|---|
Server
|
server | string |
The Docker image registry server without a protocol such as "myacr.azurecr.io". |
User Name
|
username | string |
The username for the private registry. |
Password
|
password | string |
The password for the private registry. |
Container group diagnostic information.
Name | Path | Type | Description |
---|---|---|---|
Log Analytics
|
logAnalytics | LogAnalytics |
Container group log analytics information. |
Container group log analytics information.
Name | Path | Type | Description |
---|---|---|---|
Workspace Id
|
workspaceId | string |
The workspace id for log analytics |
Workspace Key
|
workspaceKey | string |
The workspace key for log analytics |
Log Type
|
logType | string |
The log type to be used. |
Metadata
|
metadata | object |
Metadata for log analytics. |
Container group network profile information.
Name | Path | Type | Description |
---|---|---|---|
Network Profile Id
|
id | string |
The identifier for a network profile. |
IP address for the container group.
Name | Path | Type | Description |
---|---|---|---|
Ports
|
ports | array of Port |
The list of ports exposed on the container group. |
Type
|
type | string |
Specifies if the IP is exposed to the public internet. |
ip
|
ip | string |
The IP exposed to the public internet. |
Dns Name
|
dnsNameLabel | string |
The Dns name label for the IP. |
fqdn
|
fqdn | string |
The FQDN for the IP. |
The port exposed on the container group.
Name | Path | Type | Description |
---|---|---|---|
Protocol
|
protocol | string |
The protocol associated with the port. |
Number
|
port | integer |
The port number. |
The port exposed on the container instance.
Name | Path | Type | Description |
---|---|---|---|
Protocol
|
protocol | string |
The protocol associated with the port. |
Number
|
port | integer |
The port number exposed within the container group. |
The environment variable to set within the container instance.
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name of the environment variable. |
Value
|
value | string |
The value of the environment variable. |
The response containing the usage data
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of Usage |
The usage data. |
A single usage result
Name | Path | Type | Description |
---|---|---|---|
unit
|
unit | string |
Unit of the usage result |
currentValue
|
currentValue | integer |
The current usage of the resource |
limit
|
limit | integer |
The maximum permitted usage of the resource. |
value
|
name.value | string |
The name of the resource |
localizedValue
|
name.localizedValue | string |
The localized name of the resource |
The container group list response that contains the container group properties.
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of ContainerGroup |
The list of container groups. |
nextLink
|
nextLink | string |
The URI to fetch the next page of container groups. |
The logs.
Name | Path | Type | Description |
---|---|---|---|
content
|
content | string |
The content of the log. |
DNS configuration for the container group.
Name | Path | Type | Description |
---|---|---|---|
Name Servers
|
nameServers | array of string |
The DNS servers for the container group. |
Search Domains
|
searchDomains | string |
The DNS search domains for hostname lookup in the container group. |
Options
|
options | string |
The DNS options for the container group. |
The response containing cached images.
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of cachedImages |
The list of cached images. |
nextLink
|
nextLink | string |
The URI to fetch the next page of cached images. |
The cached image and OS type.
Name | Path | Type | Description |
---|---|---|---|
osType
|
osType | string |
The OS type of the cached image. |
image
|
image | string |
The cached image name. |
The response containing list of capabilities.
Name | Path | Type | Description |
---|---|---|---|
value
|
value | array of Capabilities |
The list of capabilities. |
nextLink
|
nextLink | string |
The URI to fetch the next page of capabilities. |
The regional capabilities.
Name | Path | Type | Description |
---|---|---|---|
resourceType
|
resourceType | string |
The resource type that this capability describes. |
osType
|
osType | string |
The OS type that this capability describes. |
location
|
location | string |
The resource location. |
ipAddressType
|
ipAddressType | string |
The ip address type that this capability describes. |
gpu
|
gpu | string |
The GPU sku that this capability describes. |
maxMemoryInGB
|
capabilities.maxMemoryInGB | number |
The maximum allowed memory request in GB. |
maxCpu
|
capabilities.maxCpu | number |
The maximum allowed CPU request in cores. |
maxGpuCount
|
capabilities.maxGpuCount | number |
The maximum allowed GPU count. |
The container group encryption properties.
Name | Path | Type | Description |
---|---|---|---|
Vault Url
|
vaultBaseUrl | string |
The keyvault base url. |
Key Name
|
keyName | string |
The encryption key name. |
Key Version
|
keyVersion | string |
The encryption key version. |
The init container definition.
Name | Path | Type | Description |
---|---|---|---|
Name
|
name | string |
The name for the init container. |
properties
|
properties | InitContainerPropertiesDefinition |
The init container definition properties. |
The init container definition properties.
Name | Path | Type | Description |
---|---|---|---|
Image
|
image | string |
The image of the init container. |
Command
|
command | array of string |
The command to execute within the init container in exec form. |
Environment Variables
|
environmentVariables | array of EnvironmentVariable |
The environment variables to set in the init container. |
restartCount
|
instanceView.restartCount | integer |
The number of times that the init container has been restarted. |
currentState
|
instanceView.currentState | ContainerState |
The container instance state. |
previousState
|
instanceView.previousState | ContainerState |
The container instance state. |
events
|
instanceView.events | array of Event |
The events of the init container. |
Volume Mounts
|
volumeMounts | array of VolumeMount |
The volume mounts available to the init container. |