azure.mgmt.containerinstance.operations module¶

class azure.mgmt.containerinstance.operations.ContainerGroupsOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerInstanceManagementClient’s container_groups attribute.

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][source]¶

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

Create or update container groups.

Create or update container groups with specified configurations.

Parameters

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

Keyword Arguments

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

An instance of LROPoller that returns either ContainerGroup or the result of cls(response)

Return type

LROPoller[ContainerGroup]

Raises

HttpResponseError –

begin_delete(resource_group_name: str, container_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[azure.mgmt.containerinstance.models._models_py3.ContainerGroup][source]¶

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.

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.

Keyword Arguments

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

An instance of LROPoller that returns either ContainerGroup or the result of cls(response)

Return type

LROPoller[ContainerGroup]

Raises

HttpResponseError –

begin_restart(resource_group_name: str, container_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

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.

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.

Keyword Arguments

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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

begin_start(resource_group_name: str, container_group_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Starts all containers in a container group.

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.

Keyword Arguments

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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

get(resource_group_name: str, container_group_name: str, **kwargs: Any) → azure.mgmt.containerinstance.models._models_py3.ContainerGroup[source]¶

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.

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContainerGroup or the result of cls(response)

Return type

ContainerGroup

Raises

HttpResponseError –

get_outbound_network_dependencies_endpoints(resource_group_name: str, container_group_name: str, **kwargs: Any) → List[str][source]¶

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.

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

list of str or the result of cls(response)

Return type

list[str]

Raises

HttpResponseError –

list(**kwargs: Any) → Iterable[azure.mgmt.containerinstance.models._models_py3.ContainerGroup][source]¶

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.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ContainerGroup or the result of cls(response)
Return type: ItemPaged[ContainerGroup]
Raises: HttpResponseError –

list_by_resource_group(resource_group_name: str, **kwargs: Any) → Iterable[azure.mgmt.containerinstance.models._models_py3.ContainerGroup][source]¶

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.

Parameters: resource_group_name (str) – The name of the resource group. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either ContainerGroup or the result of cls(response)
Return type: ItemPaged[ContainerGroup]
Raises: HttpResponseError –

stop(resource_group_name: str, container_group_name: str, **kwargs: Any) → None [source]¶

Stops all containers in a container group.

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

None or the result of cls(response)

Return type

None

Raises

HttpResponseError –

update(resource_group_name: str, container_group_name: str, resource: _models.Resource, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ContainerGroup[source]¶

update(resource_group_name: str, container_group_name: str, resource: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ContainerGroup

Update container groups.

Updates container group tags with specified values.

Parameters

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

Keyword Arguments

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

ContainerGroup or the result of cls(response)

Return type

ContainerGroup

Raises

HttpResponseError –

models = <module 'azure.mgmt.containerinstance.models' from '/mnt/vss/_work/1/s/sdk/containerinstance/azure-mgmt-containerinstance/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/containerinstance/models/__init__.py'>¶

class azure.mgmt.containerinstance.operations.ContainersOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerInstanceManagementClient’s containers attribute.

attach(resource_group_name: str, container_group_name: str, container_name: str, **kwargs: Any) → azure.mgmt.containerinstance.models._models_py3.ContainerAttachResponse[source]¶

Attach to the output of a specific container instance.

Attach to the output stream of a specific container instance in a specified resource group and container group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.
container_name (str) – The name of the container instance. Required.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

ContainerAttachResponse or the result of cls(response)

Return type

ContainerAttachResponse

Raises

HttpResponseError –

execute_command(resource_group_name: str, container_group_name: str, container_name: str, container_exec_request: _models.ContainerExecRequest, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ContainerExecResponse[source]¶

execute_command(resource_group_name: str, container_group_name: str, container_name: str, container_exec_request: IO, *, content_type: str = "'application/json'", **kwargs: Any) → _models.ContainerExecResponse

Executes a command in a specific container instance.

Executes a command for a specific container instance in a specified resource group and container group.

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.
container_name (str) – The name of the container instance. Required.
container_exec_request (ContainerExecRequest or IO) – The request for the exec command. Is either a model type or a IO type. Required.

Keyword Arguments

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

ContainerExecResponse or the result of cls(response)

Return type

ContainerExecResponse

Raises

HttpResponseError –

list_logs(resource_group_name: str, container_group_name: str, container_name: str, tail: Optional[int] = None, timestamps: Optional[bool] = None, **kwargs: Any) → azure.mgmt.containerinstance.models._models_py3.Logs[source]¶

Get the logs for a specified container instance.

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

Parameters

resource_group_name (str) – The name of the resource group. Required.
container_group_name (str) – The name of the container group. Required.
container_name (str) – The name of the container instance. Required.
tail (int) – 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. Default value is None.
timestamps (bool) – If true, adds a timestamp at the beginning of every line of log output. If not provided, defaults to false. Default value is None.

Keyword Arguments

cls (callable) – A custom type or function that will be passed the direct response

Returns

Logs or the result of cls(response)

Return type

Logs

Raises

HttpResponseError –

models = <module 'azure.mgmt.containerinstance.models' from '/mnt/vss/_work/1/s/sdk/containerinstance/azure-mgmt-containerinstance/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/containerinstance/models/__init__.py'>¶

class azure.mgmt.containerinstance.operations.LocationOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerInstanceManagementClient’s location attribute.

list_cached_images(location: str, **kwargs: Any) → Iterable[azure.mgmt.containerinstance.models._models_py3.CachedImages][source]¶

Get the list of cached images.

Get the list of cached images on specific OS type for a subscription in a region.

Parameters: location (str) – The identifier for the physical azure location. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either CachedImages or the result of cls(response)
Return type: ItemPaged[CachedImages]
Raises: HttpResponseError –

list_capabilities(location: str, **kwargs: Any) → Iterable[azure.mgmt.containerinstance.models._models_py3.Capabilities][source]¶

Get the list of capabilities of the location.

Get the list of CPU/memory/GPU capabilities of a region.

Parameters: location (str) – The identifier for the physical azure location. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Capabilities or the result of cls(response)
Return type: ItemPaged[Capabilities]
Raises: HttpResponseError –

list_usage(location: str, **kwargs: Any) → Iterable[azure.mgmt.containerinstance.models._models_py3.Usage][source]¶

Get the usage for a subscription.

Parameters: location (str) – The identifier for the physical azure location. Required.
Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Usage or the result of cls(response)
Return type: ItemPaged[Usage]
Raises: HttpResponseError –

models = <module 'azure.mgmt.containerinstance.models' from '/mnt/vss/_work/1/s/sdk/containerinstance/azure-mgmt-containerinstance/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/containerinstance/models/__init__.py'>¶

class azure.mgmt.containerinstance.operations.Operations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerInstanceManagementClient’s operations attribute.

list(**kwargs: Any) → Iterable[azure.mgmt.containerinstance.models._models_py3.Operation][source]¶

List the operations for Azure Container Instance service.

Keyword Arguments: cls (callable) – A custom type or function that will be passed the direct response
Returns: An iterator like instance of either Operation or the result of cls(response)
Return type: ItemPaged[Operation]
Raises: HttpResponseError –

models = <module 'azure.mgmt.containerinstance.models' from '/mnt/vss/_work/1/s/sdk/containerinstance/azure-mgmt-containerinstance/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/containerinstance/models/__init__.py'>¶

class azure.mgmt.containerinstance.operations.SubnetServiceAssociationLinkOperations(*args, **kwargs)[source]¶

Bases: object

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through ContainerInstanceManagementClient’s subnet_service_association_link attribute.

begin_delete(resource_group_name: str, virtual_network_name: str, subnet_name: str, **kwargs: Any) → azure.core.polling._poller.LROPoller[None][source]¶

Delete container group virtual network association links.

Delete container group virtual network association links. The operation does not delete other resources provided by the user.

Parameters

resource_group_name (str) – The name of the resource group. Required.
virtual_network_name (str) – The name of the virtual network. Required.
subnet_name (str) – The name of the subnet. Required.

Keyword Arguments

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

An instance of LROPoller that returns either None or the result of cls(response)

Return type

LROPoller[None]

Raises

HttpResponseError –

models = <module 'azure.mgmt.containerinstance.models' from '/mnt/vss/_work/1/s/sdk/containerinstance/azure-mgmt-containerinstance/.tox/sphinx/lib/python3.9/site-packages/azure/mgmt/containerinstance/models/__init__.py'>¶