Docs4dev
Docs
ansible / latest / collections / azure / azcollection / azure_rm_containerinstance_module.html

azure.azcollection.azure_rm_containerinstance – Manage an Azure Container Instance

Note

This plugin is part of the azure.azcollection collection (version 1.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_containerinstance.

New in version 0.1.2: of azure.azcollection

Synopsis

  • Create, update and delete an Azure Container Instance.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 2.7
  • The host that executes this module must have the azure.azcollection collection installed via galaxy
  • All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
  • Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection

Parameters

Parameter Choices/Defaults Comments
ad_user
string
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url
string
added in 0.0.1 of azure.azcollection
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile
string
added in 0.0.1 of azure.azcollection
Default:
"latest"
Selects an API profile to use when communicating with Azure services. Default value of latest is appropriate for public clouds; future values will allow use with Azure Stack.
append_tags
boolean
    Choices:
  • no
  • yes ←
Use to control if tags field is canonical or just appends to existing tags.
When canonical, any tags not found in the tags parameter will be removed from the object's metadata.
auth_source
string
added in 0.0.1 of azure.azcollection
    Choices:
  • auto ←
  • cli
  • credential_file
  • env
  • msi
Controls the source of the credentials to use for authentication.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
When set to auto (the default) the precedence is module parameters -> env -> credential_file -> cli.
When set to env, the credentials will be read from the environment variables
When set to credential_file, it will read the profile from ~/.azure/credentials.
When set to cli, the credentials will be sources from the Azure CLI profile. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if more than one is present otherwise the default az cli subscription is used.
When set to msi, the host machine must be an azure resource with an enabled MSI extension. subscription_id or the environment variable AZURE_SUBSCRIPTION_ID can be used to identify the subscription ID if the resource is granted access to more than one subscription, otherwise the first subscription is chosen.
The msi was added in Ansible 2.6.
cert_validation_mode
string
added in 0.0.1 of azure.azcollection
    Choices:
  • ignore
  • validate
Controls the certificate validation behavior for Azure endpoints. By default, all modules will validate the server certificate, but when an HTTPS proxy is in use, or against Azure Stack, it may be necessary to disable this behavior by passing ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable.
client_id
string
Azure client ID. Use when authenticating with a Service Principal.
cloud_environment
string
added in 0.0.1 of azure.azcollection
Default:
"AzureCloud"
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, AzureChinaCloud, AzureUSGovernment), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the AZURE_CLOUD_ENVIRONMENT environment variable.
containers
list / elements=dictionary
List of containers.
Required when creation.
commands
list / elements=string
List of commands to execute within the container instance in exec form.
When updating existing container all existing commands will be replaced by new ones.
cpu
float
Default:
1
The required number of CPU cores of the containers.
environment_variables
list / elements=dictionary
List of container environment variables.
When updating existing container all existing variables will be replaced by new ones.
is_secure
boolean
    Choices:
  • no
  • yes
Is variable secure.
name
string / required
Environment variable name.
value
string / required
Environment variable value.
image
string / required
The container image name.
memory
float
Default:
1.5
The required memory of the containers in GB.
name
string / required
The name of the container instance.
ports
list / elements=integer
List of ports exposed within the container group.
volume_mounts
list / elements=dictionary
The volume mounts for the container instance
mount_path
string / required
The path within the container where the volume should be mounted
name
string / required
The name of the volume mount
read_only
boolean
    Choices:
  • no
  • yes
The flag indicating whether the volume mount is read-only
dns_name_label
string
The Dns name label for the IP.
force_update
boolean
    Choices:
  • no ←
  • yes
Force update of existing container instance. Any update will result in deletion and recreation of existing containers.
ip_address
string
    Choices:
  • public
  • none ←
The IP address type of the container group.
Default is none and creating an instance without public IP.
location
string
Valid azure location. Defaults to location of the resource group.
log_mode
string
Parent argument.
log_path
string
Parent argument.
name
string / required
The name of the container group.
os_type
string
    Choices:
  • linux ←
  • windows
The OS type of containers.
password
string
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
ports
list / elements=integer
List of ports exposed within the container group.
This option is deprecated, using ports under containers".
profile
string
Security profile found in ~/.azure/credentials file.
registry_login_server
string
The container image registry login server.
registry_password
string
The password to log in container image registry server.
registry_username
string
The username to log in container image registry server.
resource_group
string / required
Name of resource group.
restart_policy
string
    Choices:
  • always
  • on_failure
  • never
Restart policy for all containers within the container group.
secret
string
Azure client secret. Use when authenticating with a Service Principal.
state
string
    Choices:
  • absent
  • present ←
Assert the state of the container instance. Use present to create or update an container instance and absent to delete it.
subscription_id
string
Your Azure subscription Id.
tags
dictionary
Dictionary of string:string pairs to assign as metadata to the object.
Metadata tags on the object will be updated with any provided values.
To remove tags set append_tags option to false.
Currently, Azure DNS zones and Traffic Manager services also don't allow the use of spaces in the tag.
Azure Front Door doesn't support the use of
Azure Automation and Azure CDN only support 15 tags on resources.
tenant
string
Azure tenant ID. Use when authenticating with a Service Principal.
volumes
list / elements=dictionary
List of Volumes that can be mounted by containers in this container group.
azure_file
dictionary
The Azure File volume
read_only
boolean
    Choices:
  • no
  • yes
The flag indicating whether the Azure File shared mounted as a volume is read-only
share_name
string / required
The name of the Azure File share to be mounted as a volume
storage_account_key
string / required
The storage account access key used to access the Azure File share
storage_account_name
string / required
The name of the storage account that contains the Azure File share
empty_dir
dictionary
The empty directory volume
git_repo
dictionary
The git repo volume
directory
string
Target directory name
repository
string / required
Repository URL
revision
string
Commit hash for the specified revision
name
string / required
The name of the Volume
secret
dictionary
The secret volume

Notes

Note

  • For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with az login.
  • Authentication is also possible using a service principal or Active Directory user.
  • To authenticate via service principal, pass subscription_id, client_id, secret and tenant or set environment variables AZURE_SUBSCRIPTION_ID, AZURE_CLIENT_ID, AZURE_SECRET and AZURE_TENANT.
  • To authenticate via Active Directory user, pass ad_user and password, or set AZURE_AD_USER and AZURE_PASSWORD in the environment.
  • Alternatively, credentials can be stored in ~/.azure/credentials. This is an ini file containing a [default] section and the following keys: subscription_id, client_id, secret and tenant or subscription_id, ad_user and password. It is also possible to add additional profiles. Specify the profile by passing profile or setting AZURE_PROFILE in the environment.

See Also

See also

Sign in with Azure CLI

How to authenticate using the az login command.

Examples

- name: Create sample container group
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: public
    containers:
      - name: myContainer1
        image: httpd
        memory: 1.5
        ports:
          - 80
          - 81

- name: Create sample container group with azure file share volume
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroupz
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1
        volume_mounts:
          - name: filesharevolume
            mount_path: "/data/files"
        ports:
          - 80
          - 81
    volumes:
      - name: filesharevolume
        azure_file:
          storage_account_name: mystorageaccount
          share_name: acishare
          storage_account_key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

- name: Create sample container group with git repo volume
  azure_rm_containerinstance:
    resource_group: myResourceGroup
    name: myContainerInstanceGroup
    os_type: linux
    ip_address: public
    containers:
      - name: mycontainer1
        image: httpd
        memory: 1
        volume_mounts:
          - name: myvolume1
            mount_path: "/mnt/test"
        ports:
          - 80
          - 81
    volumes:
      - name: myvolume1
        git_repo:
          repository: "https://github.com/Azure-Samples/aci-helloworld.git"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
containers
list / elements=dictionary
always
The containers within the container group.

Sample:
[{'commands': None, 'cpu': 1.0, 'environment_variables': None, 'image': 'httpd', 'memory': 1.0, 'name': 'mycontainer1', 'ports': [80, 81], 'volume_mounts': [{'mount_path': '/data/files', 'name': 'filesharevolume', 'read_only': False}]}]
id
string
always
Resource ID.

Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/containerGroups/aci1b6dd89
ip_address
string
if address is public
Public IP Address of created container group.

Sample:
175.12.233.11
provisioning_state
string
always
Provisioning state of the container.

Sample:
Creating
volumes
list / elements=dictionary
if volumes specified
The list of volumes that mounted by containers in container group

azure_file
dictionary
If Azure file share type of volume requested
Azure file share volume details

Sample:
{'read_only': None, 'share_name': 'acishare', 'storage_account_key': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'storage_account_name': 'mystorageaccount'}
empty_dir
dictionary
If Empty directory type of volume requested
Empty directory volume details

git_repo
dictionary
If Git repo type of volume requested
Git Repo volume details

Sample:
{'directory': None, 'repository': 'https://github.com/Azure-Samples/aci-helloworld.git', 'revision': None}
name
string
always
The name of the Volume

Sample:
filesharevolume
secret
dictionary
If Secret type of volume requested
Secret volume details



Authors

  • Zim Kalinowski (@zikalino)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_containerinstance_module.html