ContainerGroupsOperations interface

Interface representing a ContainerGroups operations.

Properties

beginCreateOrUpdate
beginCreateOrUpdateAndWait
beginDelete
beginDeleteAndWait
beginRestart
beginRestartAndWait
beginStart
beginStartAndWait
createOrUpdate

Create or update container groups with specified configurations.

delete

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

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

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

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

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.

restart

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

start

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

stop

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

update

Updates container group tags with specified values.

Property Details

beginCreateOrUpdate

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginCreateOrUpdateAndWait

Warning

This API is now deprecated.

use createOrUpdate instead

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

Property Value

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

beginDelete

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginDeleteAndWait

Warning

This API is now deprecated.

use delete instead

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

Property Value

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

beginRestart

Warning

This API is now deprecated.

use restart instead

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

Property Value

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

beginRestartAndWait

Warning

This API is now deprecated.

use restart instead

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

Property Value

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

beginStart

Warning

This API is now deprecated.

use start instead

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

Property Value

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

beginStartAndWait

Warning

This API is now deprecated.

use start instead

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

Property Value

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

createOrUpdate

Create or update container groups with specified configurations.

createOrUpdate: (resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ContainerGroup>, ContainerGroup>

Property Value

(resourceGroupName: string, containerGroupName: string, containerGroup: ContainerGroup, options?: ContainerGroupsCreateOrUpdateOptionalParams) => PollerLike<OperationState<ContainerGroup>, ContainerGroup>

delete

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.

delete: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams) => PollerLike<OperationState<ContainerGroup>, ContainerGroup>

Property Value

(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsDeleteOptionalParams) => PollerLike<OperationState<ContainerGroup>, ContainerGroup>

get

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.

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

Property Value

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

getOutboundNetworkDependenciesEndpoints

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.

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

Property Value

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

list

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.

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

Property Value

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

listByResourceGroup

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.

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

Property Value

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

restart

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

restart: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsRestartOptionalParams) => PollerLike<OperationState<void>, void>

start

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

start: (resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams) => PollerLike<OperationState<void>, void>

Property Value

(resourceGroupName: string, containerGroupName: string, options?: ContainerGroupsStartOptionalParams) => PollerLike<OperationState<void>, void>

stop

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

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

Property Value

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

update

Updates container group tags with specified values.

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

Property Value

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