ContainerGroupsOperations class

Definition

ContainerGroupsOperations operations.

ContainerGroupsOperations(client, config, serializer, deserializer)
Inheritance
builtins.object
ContainerGroupsOperations

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

api_version
class
Client API version. Constant value: "2018-10-01".

Methods

create_or_update(resource_group_name, container_group_name, container_group, custom_headers=None, raw=False, polling=True, **operation_config)

Create or update container groups.

Create or update container groups with specified configurations.

delete(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

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.

get(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

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.

list(custom_headers=None, raw=False, **operation_config)

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(resource_group_name, custom_headers=None, raw=False, **operation_config)

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.

restart(resource_group_name, container_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

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.

start(resource_group_name, container_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Starts all containers in a container group.

Starts all containers in a container group.

stop(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

Stops all containers in a container group.

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

update(resource_group_name, container_group_name, location=None, tags=None, custom_headers=None, raw=False, **operation_config)

Update container groups.

Updates container group tags with specified values.

create_or_update(resource_group_name, container_group_name, container_group, custom_headers=None, raw=False, polling=True, **operation_config)

Create or update container groups.

Create or update container groups with specified configurations.

create_or_update(resource_group_name, container_group_name, container_group, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

container_group
ContainerGroup

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

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns ContainerGroup or ClientRawResponse if raw==True

Return type

Exceptions

delete(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

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.

delete(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ContainerGroup or ClientRawResponse if raw=true

Return type

Exceptions

get(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

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, container_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ContainerGroup or ClientRawResponse if raw=true

Return type

Exceptions

list(custom_headers=None, raw=False, **operation_config)

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(custom_headers=None, raw=False, **operation_config)

Parameters

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of ContainerGroup

Return type

Exceptions

list_by_resource_group(resource_group_name, custom_headers=None, raw=False, **operation_config)

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, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

An iterator like instance of ContainerGroup

Return type

Exceptions

restart(resource_group_name, container_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

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.

restart(resource_group_name, container_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

start(resource_group_name, container_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Starts all containers in a container group.

Starts all containers in a container group.

start(resource_group_name, container_group_name, custom_headers=None, raw=False, polling=True, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

The poller return type is ClientRawResponse, the direct response alongside the deserialized response

default value: False
polling

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

default value: True

Returns

An instance of LROPoller that returns None or ClientRawResponse if raw==True

Return type

Exceptions

stop(resource_group_name, container_group_name, custom_headers=None, raw=False, **operation_config)

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, container_group_name, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

None or ClientRawResponse if raw=true

Return type

Exceptions

update(resource_group_name, container_group_name, location=None, tags=None, custom_headers=None, raw=False, **operation_config)

Update container groups.

Updates container group tags with specified values.

update(resource_group_name, container_group_name, location=None, tags=None, custom_headers=None, raw=False, **operation_config)

Parameters

resource_group_name
str

The name of the resource group.

container_group_name
str

The name of the container group.

location
str

The resource location.

default value: None
tags
dict[str or str]

The resource tags.

default value: None
custom_headers
dict

headers that will be added to the request

default value: None
raw
bool

returns the direct response alongside the deserialized response

default value: False
operation_config

Operation configuration overrides.

Returns

ContainerGroup or ClientRawResponse if raw=true

Return type

Exceptions

Attributes

models

models = <module 'azure.mgmt.containerinstance.models' from 'c:\\hostedtoolcache\\windows\\python\\3.6.8\\x64\\lib\\site-packages\\azure\\mgmt\\containerinstance\\models\\__init__.py'>