azure.azcollection.azure_rm_resource – Create any Azure resource
azure.azcollection.azure_rm_resource – Create any Azure resource
Note
This plugin is part of the azure.azcollection collection (version 1.3.1).
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
- azure >= 2.0.0
Parameters
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 | |
api_version string |
Specific API version to be used. | ||
auth_source string added in 0.0.1 of azure.azcollection |
|
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 | |
body string |
The body of the HTTP request/response to the web service. | ||
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 | |
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, | |
idempotency boolean |
|
If enabled, idempotency check will be done by using method=GET first and then comparing with body. | |
method string |
|
The HTTP method of the request or response. It must be uppercase. | |
password string |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | ||
polling_interval integer |
Default: 60 |
If enabled, idempotency check will be done by using method=GET first and then comparing with body. | |
polling_timeout integer |
Default: 0 |
If enabled, idempotency check will be done by using method=GET first and then comparing with body. | |
profile string |
Security profile found in ~/.azure/credentials file. | ||
provider string |
Provider type. Required if URL is not specified. | ||
resource_group string |
Resource group to be used. Required if URL is not specified. | ||
resource_name string |
Resource name. Required if URL Is not specified. | ||
resource_type string |
Resource type. Required if URL is not specified. | ||
secret string |
Azure client secret. Use when authenticating with a Service Principal. | ||
state string |
|
Assert the state of the resource. Use | |
status_code list / elements=string |
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 string |
List of subresources. | ||
name string |
Subresource name. | ||
namespace string |
Subresource namespace. | ||
type string |
Subresource type. | ||
subscription_id string |
Your Azure subscription Id. | ||
tenant string |
Azure tenant ID. Use when authenticating with a Service Principal. | ||
url string |
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
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 | Returned | Description | |
---|---|---|---|
response complex |
always |
Response specific to resource type.
| |
id string |
always |
Resource ID.
Sample: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Storage/storageAccounts/staccb57dc95183 | |
kind string |
always |
The kind of storage.
Sample: Storage | |
location string |
always |
The resource location, defaults to location of the resource group.
Sample: eastus | |
name string |
always |
The storage account name.
Sample: staccb57dc95183 | |
properties dictionary |
always |
The storage account's related properties.
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} | |
sku dictionary |
always |
The storage account SKU.
Sample: {'name': 'Standard_GRS', 'tier': 'Standard'} | |
tags dictionary |
always |
Resource tags.
Sample: {'key1': 'value1'} | |
type string |
always |
The resource type.
Sample: Microsoft.Storage/storageAccounts |
Authors
- Zim Kalinowski (@zikalino)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/azure/azcollection/azure_rm_resource_module.html