ansible / ansible.builtin / v2.9.17 / module / azure_rm_resource Create any Azure resource | "added in version" 2.6 of ansible.builtin" Authors: Zim Kalinowski (@zikalino) preview | supported by communityansible.builtin.azure_rm_resource (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
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 U(https://docs.microsoft.com/en-us/rest/api/) regarding details related to specific resource REST API.
- 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 }
url: description: - Azure RM Resource URL. body: description: - The body of the HTTP request/response to the web service. state: choices: - absent - present default: present description: - Assert the state of the resource. Use C(present) to create or update resource or C(absent) to delete resource. method: choices: - GET - PUT - POST - HEAD - PATCH - DELETE - MERGE default: PUT description: - The HTTP method of the request or response. It must be uppercase. secret: description: - Azure client secret. Use when authenticating with a Service Principal. type: str tenant: description: - Azure tenant ID. Use when authenticating with a Service Principal. type: str ad_user: description: - Active Directory username. Use when authenticating with an Active Directory user rather than service principal. type: str profile: description: - Security profile found in ~/.azure/credentials file. type: str password: description: - Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. type: str provider: description: - Provider type. - Required if URL is not specified. client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str api_profile: default: latest description: - Selects an API profile to use when communicating with Azure services. Default value of C(latest) is appropriate for public clouds; future values will allow use with Azure Stack. type: str version_added: 0.0.1 version_added_collection: azure.azcollection api_version: description: - Specific API version to be used. auth_source: choices: - auto - cli - credential_file - env - msi default: auto description: - Controls the source of the credentials to use for authentication. - Can also be set via the C(ANSIBLE_AZURE_AUTH_SOURCE) environment variable. - When set to C(auto) (the default) the precedence is module parameters -> C(env) -> C(credential_file) -> C(cli). - When set to C(env), the credentials will be read from the environment variables - When set to C(credential_file), it will read the profile from C(~/.azure/credentials). - When set to C(cli), the credentials will be sources from the Azure CLI profile. C(subscription_id) or the environment variable C(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 C(msi), the host machine must be an azure resource with an enabled MSI extension. C(subscription_id) or the environment variable C(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 C(msi) was added in Ansible 2.6. type: str version_added: 0.0.1 version_added_collection: azure.azcollection idempotency: default: false description: - If enabled, idempotency check will be done by using I(method=GET) first and then comparing with I(body). type: bool status_code: default: - 200 - 201 - 202 description: - A valid, numeric, HTTP status code that signifies success of the request. Can also be comma separated list of status codes. type: list subresource: description: - List of subresources. suboptions: name: description: - Subresource name. namespace: description: - Subresource namespace. type: description: - Subresource type. resource_name: description: - Resource name. - Required if URL Is not specified. resource_type: description: - Resource type. - Required if URL is not specified. resource_group: description: - Resource group to be used. - Required if URL is not specified. polling_timeout: default: 0 description: - If enabled, idempotency check will be done by using I(method=GET) first and then comparing with I(body). type: int version_added: '2.8' version_added_collection: ansible.builtin subscription_id: description: - Your Azure subscription Id. type: str polling_interval: default: 60 description: - If enabled, idempotency check will be done by using I(method=GET) first and then comparing with I(body). type: int version_added: '2.8' version_added_collection: ansible.builtin cloud_environment: default: AzureCloud description: - For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, C(AzureChinaCloud), C(AzureUSGovernment)), or a metadata discovery endpoint URL (required for Azure Stack). Can also be set via credential file profile or the C(AZURE_CLOUD_ENVIRONMENT) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection adfs_authority_url: description: - Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. type: str version_added: 0.0.1 version_added_collection: azure.azcollection cert_validation_mode: choices: - ignore - validate description: - 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 C(ignore). Can also be set via credential file profile or the C(AZURE_CERT_VALIDATION) environment variable. type: str version_added: 0.0.1 version_added_collection: azure.azcollection
response: contains: id: description: - Resource ID. returned: always sample: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Storage/storageAccounts/staccb57dc95183 type: str kind: description: - The kind of storage. returned: always sample: Storage type: str location: description: - The resource location, defaults to location of the resource group. returned: always sample: eastus type: str name: description: The storage account name. returned: always sample: staccb57dc95183 type: str properties: description: - 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 type: dict sku: description: - The storage account SKU. returned: always sample: name: Standard_GRS tier: Standard type: dict tags: description: - Resource tags. returned: always sample: key1: value1 type: dict type: description: - The resource type. returned: always sample: Microsoft.Storage/storageAccounts type: str description: - Response specific to resource type. returned: always type: complex