azure.azcollection.azure_rm_containerinstance_info module – Get Azure Container Instance facts

Note

This module is part of the azure.azcollection collection (version 2.7.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. You need further requirements to be able to use this module, see Requirements for details.

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

New in azure.azcollection 0.1.2

Synopsis

  • Get facts of 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.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

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 azure.azcollection 0.0.1

Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.

api_profile

string

added in azure.azcollection 0.0.1

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.

Default: "latest"

auth_source

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "auto" ← (default)

  • "cli"

  • "credential_file"

  • "env"

  • "msi"

cert_validation_mode

string

added in azure.azcollection 0.0.1

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.

Choices:

  • "ignore"

  • "validate"

client_id

string

Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi).

Can also be set via the AZURE_CLIENT_ID environment variable.

cloud_environment

string

added in azure.azcollection 0.0.1

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.

Default: "AzureCloud"

disable_instance_discovery

boolean

added in azure.azcollection 2.3.0

Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to **True**, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy.

Set via credential file profile or the AZURE_DISABLE_INSTANCE_DISCOVERY environment variable.

Choices:

  • false ← (default)

  • true

log_mode

string

Parent argument.

log_path

string

Parent argument.

name

string

The name of the container instance.

password

string

Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.

profile

string

Security profile found in ~/.azure/credentials file.

resource_group

string / required

The name of the resource group.

secret

string

Azure client secret. Use when authenticating with a Service Principal.

subscription_id

string

Your Azure subscription Id.

tags

list / elements=string

Limit results by providing of tags. Format tags ‘key:value’.

tenant

string

Azure tenant ID. Use when authenticating with a Service Principal.

thumbprint

string

added in azure.azcollection 1.14.0

The thumbprint of the private key specified in x509_certificate_path.

Use when authenticating with a Service Principal.

Required if x509_certificate_path is defined.

x509_certificate_path

path

added in azure.azcollection 1.14.0

Path to the X509 certificate used to create the service principal in PEM format.

The certificate must be appended to the private key.

Use when authenticating with a Service Principal.

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: Get specific Container Instance facts
  azure_rm_containerinstance_info:
    resource_group: myResourceGroup
    name: myContainer

- name: List Container Instances in a specified resource group name
  azure_rm_containerinstance_info:
    resource_group: myResourceGroup
    tags:
      - key
      - key:value

Return Values

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

Key

Description

container_groups

complex

A list of Container Instance dictionaries.

Returned: always

containers

complex

The containers within the container group.

Returned: always

Sample: "containers"

commands

list / elements=string

List of commands to execute within the container instance in exec form.

Returned: always

Sample: ["pip install abc"]

cpu

integer

The required number of CPU cores of the containers.

Returned: always

Sample: 1

environment_variables

complex

List of container environment variables.

Returned: success

name

string

Environment variable name.

Returned: success

value

string

Environment variable value.

Returned: success

image

string

The container image name.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance /containerGroups/myContainer"

memory

float

The required memory of the containers in GB.

Returned: always

Sample: 1.5

name

string

The name of the container instance.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance /containerGroups/myContainer"

ports

list / elements=string

List of ports exposed within the container group.

Returned: always

Sample: [80, 81]

volume_mounts

list / elements=string

The list of volumes mounted in container instance

Returned: If volumes mounted in container instance

Sample: [{"mount_path": "/mnt/repo", "name": "myvolume1"}]

dns_name_label

string

The Dns name label for the IP.

Returned: always

Sample: "mydomain"

id

string

The resource id.

Returned: always

Sample: "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.ContainerInstance/contain erGroups/myContainer"

identity

complex

Identity for the Server.

Returned: when available

type

string

Type of the managed identity

Returned: always

Sample: "UserAssigned"

user_assigned_identities

complex

User Assigned Managed Identities and its options

Returned: always

id

dictionary

Dict of the user assigned identities IDs associated to the Resource

Returned: always

ip_address

string

IP address of the container instance.

Returned: always

Sample: "173.15.18.1"

location

string

The resource location.

Returned: always

Sample: "westus"

name

string

The resource name.

Returned: always

Sample: "mycontainers"

os_type

string

The OS type of containers.

Returned: always

Sample: "linux"

ports

list / elements=string

List of ports exposed by the container instance.

Returned: always

Sample: [80, 81]

resource_group

string

Resource group where the container exists.

Returned: always

Sample: "testrg"

subnet_ids

list / elements=string

The subnet resource IDs for a container group.

Returned: always

Sample: [{"id": "/subscriptions/xxx-xxx/resourceGroups/myRG/providers/Microsoft.Network/virtualNetworks/vnetrpfx/subnets/subrpfx"}]

tags

dictionary

Tags assigned to the resource. Dictionary of string:string pairs.

Returned: success

Sample: {"tag1": "abc"}

volumes

list / elements=string

The list of Volumes that can be mounted by container instances

Returned: If container group has volumes

Sample: [{"git_repo": {"repository": "https://github.com/Azure-Samples/aci-helloworld.git"}, "name": "myvolume1"}]

Authors

  • Zim Kalinowski (@zikalino)