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
|
|
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
|
|
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
string
|
|
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
dictionary
|
|
List of container environment variables.
When updating existing container all existing variables will be replaced by new ones.
|
|
|
is_secure
boolean
|
|
Is variable secure.
|
|
|
name
string
|
|
Environment variable name.
|
|
|
value
string
|
|
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=string
|
|
List of ports exposed within the container group.
|
dns_name_label
string
|
|
The Dns name label for the IP.
|
force_update
boolean
|
|
Force update of existing container instance. Any update will result in deletion and recreation of existing containers.
|
ip_address
string
|
|
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.
|
name
string
/ required
|
|
The name of the container group.
|
os_type
string
|
|
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=string
|
|
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.
|