Azure Container Instance

Status: Production

Tier: Premium

Version: 2019-12-01

Name

Summary

Subscriptions_List ([internal][Optional]string x-ms-api-version)

List subscriptions

ResourceGroups_List ([internal]string x-ms-api-version, string subscriptionId)

List resource groups

AsyncOperations_GetResult (string subscriptionId, string resourceGroupName, string containerGroupName, string operationId, [internal]string api-version)

Get async operation result

AsyncOperations_GetLocationResult (string subscriptionId, string location, string operationId, [internal]string api-version)

Get async operation result in a location

AsyncOperations_GetStatus (string subscriptionId, string location, string operationId, [internal]string api-version)

Get async operation status

ContainerGroups_List (string subscriptionId, [internal]string x-ms-api-version)

Get a list of container groups in a subscription

ContainerGroups_ListByResourceGroup (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName)

Get a list of container groups in a resource group

ContainerGroups_Get (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName)

Get properties of a container group

ContainerGroups_CreateOrUpdate (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName, ContainerGroup containerGroup)

Create or update a container group

ContainerGroups_Update (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName, Resource Resource)

Update a container group location or tags

ContainerGroups_Delete (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName)

Delete a container group

ContainerGroups_Restart (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName)

Restart containers in a container group

ContainerGroups_Stop (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName)

Stop containers in a container group

ContainerGroups_Start (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName)

Start containers in a container group

Location_ListUsage (string subscriptionId, string location, [internal]string x-ms-api-version)

Get current usage

ContainerLogs_List (string subscriptionId, [internal]string x-ms-api-version, string resourceGroupName, string containerGroupName, string containerName, [Optional]integer tail)

Get logs from a container instance

Location_ListCachedImages (string subscriptionId, string location, [internal]string x-ms-api-version)

Get cached images

Location_ListCapabilities (string subscriptionId, string location, [internal]string x-ms-api-version)

Get capabilities

Name

Summary

Name

Summary

AsyncOperations_GetStatusResponse

AzureFileVolume

cachedImages

CachedImagesListResult

Capabilities

CapabilitiesListResult

Container

ContainerExec

ContainerGroup

ContainerGroupDiagnostics

ContainerGroupIdentity

ContainerGroupListResult

ContainerGroupNetworkProfile

ContainerHttpGet

ContainerPort

ContainerProbeLiveness

ContainerProbeReadiness

ContainerProperties

ContainerState

DnsConfiguration

EmptyDirVolume

EncryptionProperties

EnvironmentVariable

Event

GitRepoVolume

GpuResource

ImageRegistryCredential

InitContainerDefinition

InitContainerPropertiesDefinition

IpAddress

LogAnalytics

Logs

Port

Resource

ResourceGroup

ResourceGroupListResult

ResourceLimits

ResourceRequests

ResourceRequirements

SecretVolume

Subscription

SubscriptionListResult

Usage

UsageListResult

Volume

VolumeMount

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

False

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

Client API version

True

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

operationId

string

The operation Id.

True

api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

location

string

(Location)

The identifier for the physical azure location.

True

operationId

string

The operation Id.

True

api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

location

string

(Location)

The identifier for the physical azure location.

True

operationId

string

The operation Id.

True

api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

containerGroup

ContainerGroup

A container group.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

Resource

Resource

The Resource model definition.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

location

string

(Location)

The identifier for the physical azure location.

True

x-ms-api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

x-ms-api-version

string

(API Version)

Client API version

True

resourceGroupName

string

(Resource Group)

The name of the resource group.

True

ResourceGroups_List

containerGroupName

string

(Container Group Name)

The name of the container group.

True

containerName

string

(Container Name)

The name of the container instance.

True

tail

integer

(Tail Lines)

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.

False

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

location

string

(Location)

The identifier for the physical azure location.

True

x-ms-api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Required

Related Action

subscriptionId

string

(Subscription Id)

Microsoft Azure subscription.

True

Subscriptions_List

location

string

(Location)

The identifier for the physical azure location.

True

x-ms-api-version

string

(API Version)

Client API version

True

Name

Type

Summary

Name

Type

Summary

shareName

string

The name of the Azure File share to be mounted as a volume.

readOnly

boolean

The flag indicating whether the Azure File shared mounted as a volume is read-only.

storageAccountName

string

The name of the storage account that contains the Azure File share.

storageAccountKey

string

The storage account access key used to access the Azure File share.

Name

Type

Summary

osType

string

The OS type of the cached image.

image

string

The cached image name.

Name

Type

Summary

value

array of (cachedImages)

The list of cached images.

nextLink

string

The URI to fetch the next page of cached images.

Name

Type

Summary

resourceType

string

The resource type that this capability describes.

osType

string

The OS type that this capability describes.

location

string

The resource location.

ipAddressType

string

The ip address type that this capability describes.

gpu

string

The GPU sku that this capability describes.

capabilities

Capabilities

The supported capabilities.

Name

Type

Summary

maxMemoryInGB

number

The maximum allowed memory request in GB.

maxCpu

number

The maximum allowed CPU request in cores.

maxGpuCount

number

The maximum allowed GPU count.

Name

Type

Summary

value

array of (Capabilities)

The list of capabilities.

nextLink

string

The URI to fetch the next page of capabilities.

Name

Type

Summary

name

string

The name of the container.

properties

ContainerProperties

The container properties.

Name

Type

Summary

command

array of (string)

The commands to execute within the container.

Name

Type

Summary

id

string

The resource id.

name

string

The resource name.

type

string

The resource type.

location

string

The location to deploy container group.

tags

Tags

The resource tags.

identity

ContainerGroupIdentity

Identity for the container group.

properties

Properties

Name

Type

Summary

Name

Type

Summary

provisioningState

string

The provisioning state of the container group. This only appears in the response.

containers

array of (Container)

The containers within the container group.

imageRegistryCredentials

array of (ImageRegistryCredential)

The image registry credentials by which the container group is created from.

restartPolicy

string

Restart policy for all containers within the container group.  Values: [Always, OnFailure, Never]

ipAddress

IpAddress

IP address for the container group.

osType

string

The operating system type required by the container.  Values: [Windows, Linux]

volumes

array of (Volume)

The list of volumes that can be mounted by containers in this container group.

instanceView

InstanceView

The instance view of the container group. Only valid in response.

diagnostics

ContainerGroupDiagnostics

Container group diagnostic information.

networkProfile

ContainerGroupNetworkProfile

Container group network profile information.

dnsConfig

DnsConfiguration

DNS configuration for the container group.

sku

string

The container group SKU.  Values: [Standard, Dedicated]

encryptionProperties

EncryptionProperties

The container group encryption properties.

initContainers

array of (InitContainerDefinition)

The init containers for a container group.

Name

Type

Summary

events

array of (Event)

The events of this container group.

state

string

The state of the container group. Only valid in response.

Name

Type

Summary

logAnalytics

LogAnalytics

Container group log analytics information.

Name

Type

Summary

principalId

string

The principal id of the container group identity. This property will only be provided for a system assigned identity.

tenantId

string

The tenant id associated with the container group. This property will only be provided for a system assigned identity.

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.  Values: [SystemAssigned, UserAssigned, SystemAssigned, UserAssigned, None]

userAssignedIdentities

UserAssignedIdentities

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}'.

Name

Type

Summary

Name

Type

Summary

value

array of (ContainerGroup)

The list of container groups.

nextLink

string

The URI to fetch the next page of container groups.

Name

Type

Summary

id

string

The identifier for a network profile.

Name

Type

Summary

path

string

The path to probe.

port

integer(int32)

The port number to probe.

scheme

string

The scheme.  Values: [http, https]

Name

Type

Summary

protocol

string

The protocol associated with the port.  Values: [TCP, UDP]

port

integer(int32)

The port number exposed within the container group.

Name

Type

Summary

exec

ContainerExec

The container execution command, for liveness or readiness probe

httpGet

ContainerHttpGet

The container Http Get settings, for liveness or readiness probe

initialDelaySeconds

integer(int32)

The initial delay seconds.

periodSeconds

integer(int32)

The period seconds.

failureThreshold

integer(int32)

The failure threshold.

successThreshold

integer(int32)

The success threshold.

timeoutSeconds

integer(int32)

The timeout seconds.

Name

Type

Summary

exec

ContainerExec

The container execution command, for liveness or readiness probe

httpGet

ContainerHttpGet

The container Http Get settings, for liveness or readiness probe

initialDelaySeconds

integer(int32)

The initial delay seconds.

periodSeconds

integer(int32)

The period seconds.

failureThreshold

integer(int32)

The failure threshold.

successThreshold

integer(int32)

The success threshold.

timeoutSeconds

integer(int32)

The timeout seconds.

Name

Type

Summary

image

string

The name of the image used to create the container. E.g. nginx:latest

command

array of (string)

The commands to execute within the container. E.g. [ "echo", "hello aci" ]

ports

array of (ContainerPort)

The exposed ports on the container instance.

environmentVariables

array of (EnvironmentVariable)

The environment variables to set in the container instance.

instanceView

InstanceView

The instance view of the container instance. Only valid in response.

resources

ResourceRequirements

The resource requirements.

volumeMounts

array of (VolumeMount)

The volume mounts available to the container instance.

livenessProbe

ContainerProbeLiveness

The container probe, for liveness

readinessProbe

ContainerProbeReadiness

The container probe, for readiness

Name

Type

Summary

restartCount

integer

The number of times that the container instance has been restarted.

currentState

ContainerState

The container instance state.

previousState

ContainerState

The container instance state.

events

array of (Event)

The events of the container instance.

Name

Type

Summary

state

string

The state of the container instance.

startTime

string(date-time)

The date-time when the container instance state started.

exitCode

integer

The container instance exit codes correspond to those from the `docker run` command.

finishTime

string(date-time)

The date-time when the container instance state finished.

detailStatus

string

The human-readable status of the container instance state.

Name

Type

Summary

nameServers

array of (string)

The DNS servers for the container group.

searchDomains

string

The DNS search domains for hostname lookup in the container group.

options

string

The DNS options for the container group.

Name

Type

Summary

Name

Type

Summary

vaultBaseUrl

string

The keyvault base url.

keyName

string

The encryption key name.

keyVersion

string

The encryption key version.

Name

Type

Summary

name

string

The name of the environment variable.

value

string

The value of the environment variable.

Name

Type

Summary

count

integer

The count of the event.

firstTimestamp

string(date-time)

The date-time of the earliest logged event.

lastTimestamp

string(date-time)

The date-time of the latest logged event.

name

string

The event name.

message

string

The event message.

type

string

The event type.

Name

Type

Summary

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

string

Repository URL

revision

string

Commit hash for the specified revision.

Name

Type

Summary

count

integer(int32)

The count of the GPU resource.

sku

string

The SKU of the GPU resource.  Values: [K80, P100, V100]

Name

Type

Summary

server

string

The Docker image registry server without a protocol such as "myacr.azurecr.io".

username

string

The username for the private registry.

password

string

The password for the private registry.

Name

Type

Summary

name

string

The name for the init container.

properties

InitContainerPropertiesDefinition

The init container definition properties.

Name

Type

Summary

image

string

The image of the init container.

command

array of (string)

The command to execute within the init container in exec form.

environmentVariables

array of (EnvironmentVariable)

The environment variables to set in the init container.

instanceView

InstanceView

The instance view of the init container. Only valid in response.

volumeMounts

array of (VolumeMount)

The volume mounts available to the init container.

Name

Type

Summary

restartCount

integer

The number of times that the init container has been restarted.

currentState

ContainerState

The container instance state.

previousState

ContainerState

The container instance state.

events

array of (Event)

The events of the init container.

Name

Type

Summary

ports

array of (Port)

The list of ports exposed on the container group.

type

string

Specifies if the IP is exposed to the public internet.  Values: [Public, Private]

ip

string

The IP exposed to the public internet.

dnsNameLabel

string

The Dns name label for the IP.

fqdn

string

The FQDN for the IP.

Name

Type

Summary

workspaceId

string

The workspace id for log analytics

workspaceKey

string

The workspace key for log analytics

logType

string

The log type to be used.  Values: [ContainerInsights, ContainerInstanceLogs]

metadata

Metadata

Metadata for log analytics.

Name

Type

Summary

Name

Type

Summary

content

string

The content of the log.

Name

Type

Summary

protocol

string

The protocol associated with the port.  Values: [TCP, UDP]

port

integer(int32)

The port number.

Name

Type

Summary

id

string

The resource id.

name

string

The resource name.

type

string

The resource type.

location

string

The resource location.

tags

Tags

The resource tags.

Name

Type

Summary

Name

Type

Summary

id

string

Id

The ID of the resource group (e.g. /subscriptions/XXX/resourceGroups/YYY).

name

string

Name

The Name of the resource group.

managedBy

string

Managed By

Id of the resource that manages this resource group.

Name

Type

Summary

value

array of (ResourceGroup)

The list of resource groups.

nextLink

string

Next Link

The URL to get the next set of results.

Name

Type

Summary

memoryInGB

number(double)

The memory limit in GB of this container.

cpu

number(double)

The CPU limit of this container.

gpu

GpuResource

The GPU resource.

Name

Type

Summary

memoryInGB

number

The memory request in GB of this container. E.g. 3.5

cpu

number

The CPU request of this container. E.g. 2.0

gpu

GpuResource

The GPU resource.

Name

Type

Summary

requests

ResourceRequests

The resource requests.

limits

ResourceLimits

The resource limits.

Name

Type

Summary

Name

Type

Summary

id

string

Id

The fully qualified Id. For example, /subscriptions/00000000-0000-0000-0000-000000000000.

subscriptionId

string

Subscription Id

The subscription Id.

tenantId

string

Tenant Id

The tenant Id.

displayName

string

Display Name

The subscription display name.

state

string

State

The subscription state.  Values: [Enabled, Warned, PastDue, Disabled, Deleted]

authorizationSource

string

Authorization Source

The authorization source of the request. Valid values are one or more combinations of Legacy, RoleBased, Bypassed, Direct and Management. For example, 'Legacy, RoleBased'.

Name

Type

Summary

value

array of (Subscription)

The subscriptions.

nextLink

string

Next Link

The URL to get the next set of results.

Name

Type

Summary

unit

string

Unit of the usage result

currentValue

integer

The current usage of the resource

limit

integer

The maximum permitted usage of the resource.

name

Name

The name object of the resource

Name

Type

Summary

value

string

The name of the resource

localizedValue

string

The localized name of the resource

Name

Type

Summary

value

array of (Usage)

The usage data.

Name

Type

Summary

name

string

The name of the volume.

azureFile

AzureFileVolume

The properties of the Azure File volume. Azure File shares are mounted as volumes.

emptyDir

EmptyDirVolume

The empty directory volume.

secret

SecretVolume

The secret volume.

gitRepo

GitRepoVolume

Represents a volume that is populated with the contents of a git repository

Name

Type

Summary

name

string

The name of the volume.

mountPath

string

The path within the container where the volume should be mounted. Must not contain colon (:).

readOnly

boolean

The flag indicating whether the volume mount is read-only.