ContainerGroups interface

Package:

@azure/arm-containerinstance

Interface representing a ContainerGroups.

Methods

beginCreateOrUpdate(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)	Create or update container groups with specified configurations.
beginCreateOrUpdateAndWait(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)	Create or update container groups with specified configurations.
beginDelete(string, string, ContainerGroupsDeleteOptionalParams)	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.
beginDeleteAndWait(string, string, ContainerGroupsDeleteOptionalParams)	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.
beginRestart(string, string, ContainerGroupsRestartOptionalParams)	Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
beginRestartAndWait(string, string, ContainerGroupsRestartOptionalParams)	Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
beginStart(string, string, ContainerGroupsStartOptionalParams)	Starts all containers in a container group. Compute resources will be allocated and billing will start.
beginStartAndWait(string, string, ContainerGroupsStartOptionalParams)	Starts all containers in a container group. Compute resources will be allocated and billing will start.
get(string, string, ContainerGroupsGetOptionalParams)	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.
getOutboundNetworkDependenciesEndpoints(string, string, ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams)	Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.
list(ContainerGroupsListOptionalParams)	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.
listByResourceGroup(string, ContainerGroupsListByResourceGroupOptionalParams)	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.
stop(string, string, ContainerGroupsStopOptionalParams)	Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
update(string, string, Resource, ContainerGroupsUpdateOptionalParams)	Updates container group tags with specified values.

Method Details

beginCreateOrUpdate(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)

Create or update container groups with specified configurations.

function beginCreateOrUpdate(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

containerGroup

ContainerGroup

The properties of the container group to be created or updated.

options

ContainerGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

beginCreateOrUpdateAndWait(string, string, ContainerGroup, ContainerGroupsCreateOrUpdateOptionalParams)

Create or update container groups with specified configurations.

function beginCreateOrUpdateAndWait(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams): Promise<ContainerGroup>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

containerGroup

ContainerGroup

The properties of the container group to be created or updated.

options

ContainerGroupsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ContainerGroup>

beginDelete(string, string, ContainerGroupsDeleteOptionalParams)

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.

function beginDelete(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ContainerGroup>, ContainerGroup>>

beginDeleteAndWait(string, string, ContainerGroupsDeleteOptionalParams)

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.

function beginDeleteAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams): Promise<ContainerGroup>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsDeleteOptionalParams

The options parameters.

Returns

Promise<ContainerGroup>

beginRestart(string, string, ContainerGroupsRestartOptionalParams)

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

function beginRestart(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsRestartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginRestartAndWait(string, string, ContainerGroupsRestartOptionalParams)

Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.

function beginRestartAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsRestartOptionalParams

The options parameters.

Returns

Promise<void>

beginStart(string, string, ContainerGroupsStartOptionalParams)

Starts all containers in a container group. Compute resources will be allocated and billing will start.

function beginStart(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsStartOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>

beginStartAndWait(string, string, ContainerGroupsStartOptionalParams)

Starts all containers in a container group. Compute resources will be allocated and billing will start.

function beginStartAndWait(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsStartOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, ContainerGroupsGetOptionalParams)

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.

function get(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOptionalParams): Promise<ContainerGroup>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsGetOptionalParams

The options parameters.

Returns

Promise<ContainerGroup>

getOutboundNetworkDependenciesEndpoints(string, string, ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams)

Gets all the network dependencies for this container group to allow complete control of network setting and configuration. For container groups, this will always be an empty list.

function getOutboundNetworkDependenciesEndpoints(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams): Promise<ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsGetOutboundNetworkDependenciesEndpointsOptionalParams

The options parameters.

Returns

Promise<ContainerGroupsGetOutboundNetworkDependenciesEndpointsResponse>

list(ContainerGroupsListOptionalParams)

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.

function list(options?: ContainerGroupsListOptionalParams): PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

Parameters

options

ContainerGroupsListOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

listByResourceGroup(string, ContainerGroupsListByResourceGroupOptionalParams)

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.

function listByResourceGroup(resourceGroupName: string, options?: ContainerGroupsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group.

options

ContainerGroupsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ContainerGroup, ContainerGroup[], PageSettings>

stop(string, string, ContainerGroupsStopOptionalParams)

Stops all containers in a container group. Compute resources will be deallocated and billing will stop.

function stop(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStopOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

options

ContainerGroupsStopOptionalParams

The options parameters.

Returns

Promise<void>

update(string, string, Resource, ContainerGroupsUpdateOptionalParams)

Updates container group tags with specified values.

function update(resourceGroupName: string, containerGroupName: string, resource: Resource, options?: ContainerGroupsUpdateOptionalParams): Promise<ContainerGroup>

Parameters

resourceGroupName

string

The name of the resource group.

containerGroupName

string

The name of the container group.

resource

Resource

The container group resource with just the tags to be updated.

options

ContainerGroupsUpdateOptionalParams

The options parameters.

Returns

Promise<ContainerGroup>