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.
|
auto_delete_on_idle_in_seconds
integer
|
|
Time idle interval after which a subscription is automatically deleted.
The minimum duration is 5 minutes.
|
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.
|
dead_lettering_on_filter_evaluation_exceptions
boolean
|
|
Value that indicates whether a subscription has dead letter support on filter evaluation exceptions.
|
dead_lettering_on_message_expiration
boolean
|
|
A value that indicates whether a subscription has dead letter support when a message expires.
|
default_message_time_to_live_seconds
integer
|
|
Default message timespan to live value.
This is the duration after which the message expires, starting from when the message is sent to Service Bus.
This is the default value used when TimeToLive is not set on a message itself.
|
duplicate_detection_time_in_seconds
integer
|
|
TimeSpan structure that defines the duration of the duplicate detection history.
|
enable_batched_operations
boolean
|
|
Value that indicates whether server-side batched operations are enabled.
|
forward_dead_lettered_messages_to
string
|
|
Queue or topic name to forward the Dead Letter message for a subscription.
|
forward_to
string
|
|
Queue or topic name to forward the messages for a subscription.
|
lock_duration_in_seconds
integer
|
|
Timespan duration of a peek-lock.
The amount of time that the message is locked for other receivers.
The maximum value for LockDuration is 5 minutes.
|
max_delivery_count
integer
|
|
he maximum delivery count.
A message is automatically deadlettered after this number of deliveries.
|
name
string
/ required
|
|
Name of the servicebus subscription.
|
namespace
string
/ required
|
|
Servicebus namespace name.
A namespace is a scoping container for all messaging components.
Multiple subscriptions and topics can reside within a single namespace, and namespaces often serve as application containers.
|
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.
|
requires_session
boolean
|
|
A value that indicates whether the subscription supports the concept of sessions.
|
resource_group
string
/ required
|
|
Name of resource group.
|
secret
string
|
|
Azure client secret. Use when authenticating with a Service Principal.
|
state
string
|
Choices:
- absent
present ←
|
Assert the state of the servicebus subscription. Use present to create or update and use absent to delete.
|
status
string
|
Choices:
- active
- disabled
- send_disabled
- receive_disabled
|
Status of the entity.
|
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.
|
topic
string
/ required
|
|
Topic name which the subscription subscribe to.
|