New in version 2.6.
The below requirements are needed on the host that executes this module.
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 2.6 |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
||
api_profile
string
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. |
|
api_version
-
|
Specific API version to be used.
|
||
auth_source
string
added in 2.5 |
|
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. |
|
body
-
|
The body of the http request/response to the web service.
|
||
cert_validation_mode
string
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
string
|
Azure client ID. Use when authenticating with a Service Principal.
|
||
cloud_environment
string
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. |
|
idempotency
boolean
|
|
If enabled, idempotency check will be done by using GET method first and then comparing with body
|
|
method
-
|
|
The HTTP method of the request or response. It MUST be uppercase.
|
|
password
-
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
|
||
polling_interval
integer
added in 2.8 |
Default: 60
|
If enabled, idempotency check will be done by using GET method first and then comparing with body
|
|
polling_timeout
integer
added in 2.8 |
Default: 0
|
If enabled, idempotency check will be done by using GET method first and then comparing with body
|
|
profile
string
|
Security profile found in ~/.azure/credentials file.
|
||
provider
-
|
Provider type.
Required if URL is not specified.
|
||
resource_group
-
|
Resource group to be used.
Required if URL is not specified.
|
||
resource_name
-
|
Resource name.
Required if URL Is not specified.
|
||
resource_type
-
|
Resource type.
Required if URL is not specified.
|
||
secret
string
|
Azure client secret. Use when authenticating with a Service Principal.
|
||
state
-
|
|
Assert the state of the resource. Use
present to create or update resource or absent to delete resource. |
|
status_code
-
|
Default: [200, 201, 202]
|
A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes.
|
|
subresource
-
|
List of subresources
|
||
name
-
|
Subresource name
|
||
namespace
-
|
Subresource namespace
|
||
type
-
|
Subresource type
|
||
subscription_id
string
|
Your Azure subscription Id.
|
||
tenant
string
|
Azure tenant ID. Use when authenticating with a Service Principal.
|
||
url
-
|
Azure RM Resource URL.
|
Note
az login
.See also
az login
command.- name: Update scaleset info using azure_rm_resource
azure_rm_resource:
resource_group: myResourceGroup
provider: compute
resource_type: virtualmachinescalesets
resource_name: myVmss
api_version: "2017-12-01"
body: { body }
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
response
dictionary
|
always |
Response specific to resource type.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.