Connectors Reference

Azure Container Instance

Easily run containers on Azure with a single command. Create container groups, get the logs of a container and more.

 

Status: Preview

Tier: Standard

Version: 2017-10-01-preview

 

Actions:

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

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

Get a list of container groups in subscription

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

Get a list of container groups in 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 container group

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

Delete container group

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

Get logs of a container

 

Triggers:

Name

Summary

 

Objects:

Name

Summary

AzureFileVolume

 

Container

 

ContainerGroup

 

ContainerGroupListResult

 

ContainerPort

 

ContainerProperties

 

ContainerState

 

EnvironmentVariable

 

Event

 

ImageRegistryCredential

 

IpAddress

 

Logs

 

Port

 

ResourceGroup

 

ResourceGroupListResult

 

ResourceLimits

 

ResourceRequests

 

ResourceRequirements

 

Subscription

 

SubscriptionListResult

 

Volume

 

VolumeMount

 

 

Actions:

Subscriptions_List

Summary: List subscriptions

Description: Gets a list of all the subscriptions to which the principal has access.

 

Syntax:

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

 

Parameters:

Name

Type

Summary

Required

Related Action

x-ms-api-version

string

(API Version)

 

False

 

Returns:

          Type:SubscriptionListResult

          Description: Subscription list operation response.

 

ResourceGroups_List

Summary: List resource groups

Description: Lists all the resource groups within the subscription. Paginates at 1,000 records.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:ResourceGroupListResult

          Description: List of resource groups.

 

ContainerGroups_List

Summary: Get a list of container groups in subscription

Description: 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.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:ContainerGroupListResult

          Description: The container group list response that contains the container group properties.

 

ContainerGroups_ListByResourceGroup

Summary: Get a list of container groups in resource group

Description: 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.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:ContainerGroupListResult

          Description: The container group list response that contains the container group properties.

 

ContainerGroups_Get

Summary: Get properties of a container group

Description: 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.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:ContainerGroup

          Description: A container group.

 

ContainerGroups_CreateOrUpdate

Summary: Create container group

Description: Create or update a container group with specified configurations.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:ContainerGroup

          Description: A container group.

 

ContainerGroups_Delete

Summary: Delete container group

Description: 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.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:ContainerGroup

          Description: A container group.

 

ContainerLogs_List

Summary: Get logs of a container

Description: Get the logs for a specified container instance in a specified resource group and container group.

 

Syntax:

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

 

Parameters:

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

 

Returns:

          Type:Logs

          Description: The logs.

 


 

AzureFileVolume

Summary:

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

 

          Properties:

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.


 

Container

Summary:

Description: A container instance.

 

          Properties:

Name

Type

Summary

name

string

 

The name of the container.

properties

ContainerProperties

 

The container properties.


 

ContainerGroup

Summary:

Description: A container group.

 

          Properties:

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.

properties

Properties

 

 

 

Tags

Summary:

Description: The resource tags.

 

          Properties:

Name

Type

Summary

 

Properties

Summary:

Description:

 

          Properties:

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.

 

InstanceView

Summary:

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

 

          Properties:

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.

 


 

ContainerGroupListResult

Summary:

Description: The container group list response that contains the container group properties.

 

          Properties:

Name

Type

Summary

value

array of (ContainerGroup)

 

The list of container groups.

nextLink

string

 

The URI to fetch the next page of container groups.


 

ContainerPort

Summary:

Description: The port exposed on the container instance.

 

          Properties:

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.


 

ContainerProperties

Summary:

Description: The container properties.

 

          Properties:

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.

 

InstanceView

Summary:

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

 

          Properties:

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.

 


 

ContainerState

Summary:

Description: The container instance state.

 

          Properties:

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.


 

EnvironmentVariable

Summary:

Description: The environment variable to set within the container instance.

 

          Properties:

Name

Type

Summary

name

string

 

The name of the environment variable.

value

string

 

The value of the environment variable.


 

Event

Summary:

Description: A container group or container instance event.

 

          Properties:

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.


 

ImageRegistryCredential

Summary:

Description: Image registry credential.

 

          Properties:

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.


 

IpAddress

Summary:

Description: IP address for the container group.

 

          Properties:

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]

ip

string

 

The IP exposed to the public internet.


 

Logs

Summary:

Description: The logs.

 

          Properties:

Name

Type

Summary

content

string

 

The content of the log.


 

Port

Summary:

Description: The port exposed on the container group.

 

          Properties:

Name

Type

Summary

protocol

string

 

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

port

integer(int32)

 

The port number.


 

ResourceGroup

Summary:

Description: Resource group information.

 

          Properties:

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.


 

ResourceGroupListResult

Summary:

Description: List of resource groups.

 

          Properties:

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.


 

ResourceLimits

Summary:

Description: The resource limits.

 

          Properties:

Name

Type

Summary

memoryInGB

number(double)

 

The memory limit in GB of this container.

cpu

number(double)

 

The CPU limit of this container.


 

ResourceRequests

Summary:

Description: The resource requests.

 

          Properties:

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


 

ResourceRequirements

Summary:

Description: The resource requirements.

 

          Properties:

Name

Type

Summary

requests

ResourceRequests

 

The resource requests.

limits

ResourceLimits

 

The resource limits.


 

Subscription

Summary:

Description: Subscription information.

 

          Properties:

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


 

SubscriptionListResult

Summary:

Description: Subscription list operation response.

 

          Properties:

Name

Type

Summary

value

array of (Subscription)

 

The subscriptions.

nextLink

string

Next Link

The URL to get the next set of results.


 

Volume

Summary:

Description: The properties of the volume.

 

          Properties:

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.


 

VolumeMount

Summary:

Description: The properties of the volume mount.

 

          Properties:

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.