azure.azcollection.azure_rm_resource – Create any Azure resource
Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_resource
.
New in version 0.1.2: of azure.azcollection
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
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements-azure.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: “latest” |
|
Specific API version to be used. |
|
Controls the source of the credentials to use for authentication. Can also be set via the When set to When set to When set to When set to When set to The Choices:
|
|
The body of the HTTP request/response to the web service. |
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal. |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: “AzureCloud” |
|
If enabled, idempotency check will be done by using method=GET first and then comparing with body. Choices:
|
|
Parent argument. |
|
Parent argument. |
|
The HTTP method of the request or response. It must be uppercase. Choices:
|
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
If enabled, idempotency check will be done by using method=GET first and then comparing with body. Default: 60 |
|
If enabled, idempotency check will be done by using method=GET first and then comparing with body. Default: 0 |
|
Security profile found in ~/.azure/credentials file. |
|
Provider type. Required if URL is not specified. |
|
Resource group to be used. Required if URL is not specified. |
|
Resource name. Required if URL Is not specified. |
|
Resource type. Required if URL is not specified. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Assert the state of the resource. Use Choices:
|
|
A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes. Default: [200, 201, 202] |
|
List of subresources. |
|
Subresource name. |
|
Subresource namespace. |
|
Subresource type. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
Azure RM Resource URL. |
Notes
Note
For authentication with Azure you can pass parameters, set environment variables, use a profile stored in ~/.azure/credentials, or log in before you run your tasks or playbook with
az login
.Authentication is also 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.
See Also
See also
- Sign in with Azure CLI
How to authenticate using the
az login
command.
Examples
- 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 }
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Response specific to resource type. Returned: always |
|
Resource ID. Returned: always Sample: “/subscriptions/xxxx…xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Storage/storageAccounts/staccb57dc95183” |
|
The kind of storage. Returned: always Sample: “Storage” |
|
The resource location, defaults to location of the resource group. Returned: always Sample: “eastus” |
|
The storage account name. Returned: always Sample: “staccb57dc95183” |
|
The storage account’s related properties. Returned: always Sample: {“creationTime”: “2019-06-13T06:34:33.0996676Z”, “encryption”: {“keySource”: “Microsoft.Storage”, “services”: {“blob”: {“enabled”: true, “lastEnabledTime”: “2019-06-13T06:34:33.1934074Z”}, “file”: {“enabled”: true, “lastEnabledTime”: “2019-06-13T06:34:33.1934074Z”}}}, “networkAcls”: {“bypass”: “AzureServices”, “defaultAction”: “Allow”, “ipRules”: [], “virtualNetworkRules”: []}, “primaryEndpoints”: {“blob”: “https://staccb57dc95183.blob.core.windows.net/”, “file”: “https://staccb57dc95183.file.core.windows.net/”, “queue”: “https://staccb57dc95183.queue.core.windows.net/”, “table”: “https://staccb57dc95183.table.core.windows.net/”}, “primaryLocation”: “eastus”, “provisioningState”: “Succeeded”, “secondaryLocation”: “westus”, “statusOfPrimary”: “available”, “statusOfSecondary”: “available”, “supportsHttpsTrafficOnly”: false} |
|
The storage account SKU. Returned: always Sample: {“name”: “Standard_GRS”, “tier”: “Standard”} |
|
Resource tags. Returned: always Sample: {“key1”: “value1”} |
|
The resource type. Returned: always Sample: “Microsoft.Storage/storageAccounts” |
Authors
Zim Kalinowski (@zikalino)