airflow.providers.microsoft.azure.hooks.container_instance

Module Contents

Classes

AzureContainerInstanceHook

A hook to communicate with Azure Container Instances.
class airflow.providers.microsoft.azure.hooks.container_instance.AzureContainerInstanceHook(conn_id: str = default_conn_name)[source]

Bases: airflow.providers.microsoft.azure.hooks.base_azure.AzureBaseHook

A hook to communicate with Azure Container Instances.

This hook requires a service principal in order to work. After creating this service principal (Azure Active Directory/App Registrations), you need to fill in the client_id (Application ID) as login, the generated password as password, and tenantId and subscriptionId in the extra's field as a json.

Parameters

conn_id -- Azure connection id of a service principal which will be used to start the container instance.

conn_name_attr = azure_conn_id[source]
default_conn_name = azure_default[source]
conn_type = azure_container_instance[source]
hook_name = Azure Container Instance[source]
create_or_update(self, resource_group: str, name: str, container_group: azure.mgmt.containerinstance.models.ContainerGroup) → None[source]

Create a new container group

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

  • container_group (azure.mgmt.containerinstance.models.ContainerGroup) -- the properties of the container group

get_state_exitcode_details(self, resource_group: str, name: str) → tuple[source]

Get the state and exitcode of a container group

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

Returns

A tuple with the state, exitcode, and details. If the exitcode is unknown 0 is returned.

Return type

tuple(state,exitcode,details)

get_messages(self, resource_group: str, name: str) → list[source]

Get the messages of a container group

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

Returns

A list of the event messages

Return type

list[str]

get_state(self, resource_group: str, name: str) → Any[source]

Get the state of a container group

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

Returns

ContainerGroup

Return type

ContainerGroup

get_logs(self, resource_group: str, name: str, tail: int = 1000) → list[source]

Get the tail from logs of a container group

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

  • tail (int) -- the size of the tail

Returns

A list of log messages

Return type

list[str]

delete(self, resource_group: str, name: str) → None[source]

Delete a container group

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

exists(self, resource_group: str, name: str) → bool[source]

Test if a container group exists

Parameters

  • resource_group (str) -- the name of the resource group

  • name (str) -- the name of the container group

Was this entry helpful?