Parameter |
Choices/Defaults |
Comments |
ad_user
|
|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
|
adfs_authority_url
(added in 2.6) |
Default:
None
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
api_profile
(added in 2.5) |
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.
|
auth_source
(added in 2.5) |
Choices:
- auto
- cli
- credential_file
- env
- msi
|
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to auto if variable is not defined.
auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials .
When set to cli , the credentials will be sources from the default Azure CLI profile.
Can also be set via the ANSIBLE_AZURE_AUTH_SOURCE environment variable.
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
(added in 2.5) |
|
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
|
|
Azure client ID. Use when authenticating with a Service Principal.
|
cloud_environment
(added in 2.4) |
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 of containers.
|
|
name
required |
|
The name of the container instance.
|
|
image
required |
|
The container image name.
|
|
memory
|
Default:
1.5
|
The required memory of the containers in GB.
|
|
cpu
|
Default:
1
|
The required number of CPU cores of the containers.
|
|
ports
|
|
List of ports exposed within the container group.
|
force_update
bool |
|
Force update of existing container instance. Any update will result in deletion and recreation of existing containers.
|
ip_address
|
|
The IP address type of the container group (default is 'none')
|
location
|
|
Valid azure location. Defaults to location of the resource group.
|
name
required |
|
The name of the container group.
|
os_type
|
|
The OS type of containers.
|
password
|
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
ports
|
|
List of ports exposed within the container group.
|
profile
|
|
Security profile found in ~/.azure/credentials file.
|
registry_login_server
|
|
The container image registry login server.
|
registry_password
|
|
The password to log in container image registry server.
|
registry_username
|
|
The username to log in container image registry server.
|
resource_group
required |
|
Name of resource group.
|
secret
|
|
Azure client secret. Use when authenticating with a Service Principal.
|
state
|
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
|
|
Your Azure subscription Id.
|
tenant
|
|
Azure tenant ID. Use when authenticating with a Service Principal.
|