azure_rm_resource - Create any Azure resource.¶

New in version 2.6.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
Maintenance
- Author

Synopsis ¶

Create, update or delete any Azure resource using Azure REST API.
This module gives access to resources that are not supported via Ansible modules.
Refer to https://docs.microsoft.com/en-us/rest/api/ regarding details related to specific resource REST API.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
azure >= 2.0.0

Parameters ¶

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: null	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.
api_version required			Specific API version to be used.
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.
body			The body of the http request/response to the web service.
cert_validation_mode (added in 2.5)		Choices: validate ignore	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.
idempotency bool		Choices: no ← yes	If enabled, idempotency check will be done by using GET method first and then comparing with body
method		Choices: GET PUT ← POST HEAD PATCH DELETE MERGE	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.
profile			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			Azure client secret. Use when authenticating with a Service Principal.
state		Choices: absent present ←	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
	namespace		Subresource namespace
	type		Subresource type
	name		Subresource name
subscription_id			Your Azure subscription Id.
tenant			Azure tenant ID. Use when authenticating with a Service Principal.
url			Azure RM Resource URL.

Notes ¶

Note

For authentication with Azure you can pass parameters, set environment variables or use a profile stored in ~/.azure/credentials. Authentication is 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.

Examples ¶

- name: Update scaleset info using azure_rm_resource
  azure_rm_resource:
    resource_group: "{{ resource_group }}"
    provider: compute
    resource_type: virtualmachinescalesets
    resource_name: "{{ scaleset_name }}"
    api_version: "2017-12-01"
    body: "{{ body }}"

Return Values ¶

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

Key	Returned	Description
response dict	always	Response specific to resource type.

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Maintenance ¶

This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.

Author ¶

Zim Kalinowski (@zikalino)

Hint

If you notice any issues in this documentation you can edit this document to improve it.