ContainerGroupsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

ContainerInstanceManagementClient's

<xref:container_groups> attribute.

Constructor

ContainerGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update	Create or update container groups. Create or update container groups with specified configurations.
begin_delete	Delete the specified 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.
begin_restart	Restarts all containers in a container group. Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.
begin_start	Starts all containers in a container group. Starts all containers in a container group. Compute resources will be allocated and billing will start.
get	Get the properties of the specified 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.
get_outbound_network_dependencies_endpoints	Get all network dependencies for container group. 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. 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_by_resource_group	Get a list of container groups in the specified subscription and 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.
stop	Stops all containers in a container group. Stops all containers in a container group. Compute resources will be deallocated and billing will stop.
update	Update container groups. Updates container group tags with specified values.

begin_create_or_update

Create or update container groups.

Create or update container groups with specified configurations.

begin_create_or_update(resource_group_name: str, container_group_name: str, container_group: _models.ContainerGroup, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.ContainerGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.
container_group Required	ContainerGroup or IO The properties of the container group to be created or updated. Is either a ContainerGroup type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[ContainerGroup]	An instance of LROPoller that returns either ContainerGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete the specified 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.

begin_delete(resource_group_name: str, container_group_name: str, **kwargs: Any) -> LROPoller[ContainerGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[ContainerGroup]	An instance of LROPoller that returns either ContainerGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_restart

Restarts all containers in a container group.

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

begin_restart(resource_group_name: str, container_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_start

Starts all containers in a container group.

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

begin_start(resource_group_name: str, container_group_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response
continuation_token	str A continuation token to restart a poller from a saved state.
polling	bool or PollingMethod By default, your polling method will be ARMPolling. Pass in False for this operation to not poll, or pass in your own initialized polling object for a personal polling strategy.
polling_interval	int Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Get the properties of the specified 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.

get(resource_group_name: str, container_group_name: str, **kwargs: Any) -> ContainerGroup

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ContainerGroup	ContainerGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_outbound_network_dependencies_endpoints

Get all network dependencies for container group.

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.

get_outbound_network_dependencies_endpoints(resource_group_name: str, container_group_name: str, **kwargs: Any) -> List[str]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
list[str]	list of str or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Get a list of container groups in the specified 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.

list(**kwargs: Any) -> Iterable[ContainerGroup]

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[ContainerGroup]	An iterator like instance of either ContainerGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_by_resource_group

Get a list of container groups in the specified subscription and 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.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[ContainerGroup]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ItemPaged[ContainerGroup]	An iterator like instance of either ContainerGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

stop

Stops all containers in a container group.

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

stop(resource_group_name: str, container_group_name: str, **kwargs: Any) -> None

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.

Keyword-Only Parameters

Name	Description
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
None	None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update

Update container groups.

Updates container group tags with specified values.

update(resource_group_name: str, container_group_name: str, resource: _models.Resource, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ContainerGroup

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
container_group_name Required	str The name of the container group. Required.
resource Required	Resource or IO The container group resource with just the tags to be updated. Is either a Resource type or a IO type. Required.

Keyword-Only Parameters

Name	Description
content_type	str Body Parameter content-type. Known values are: 'application/json'. Default value is None.
cls	callable A custom type or function that will be passed the direct response

Returns

Type	Description
ContainerGroup	ContainerGroup or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.containerinstance.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv96\\Lib\\site-packages\\azure\\mgmt\\containerinstance\\models\\__init__.py'>