azure.azcollection.azure_rm_roledefinition module – Manage Azure Role Definition

Ansible

Ansible getting started

Getting started with Ansible
Getting started with Execution Environments

Installation, Upgrade & Configuration

Installation Guide
Ansible Porting Guides

Using Ansible

Building Ansible inventories
Using Ansible command line tools
Using Ansible playbooks
Protecting sensitive data with Ansible vault
Using Ansible modules and plugins
Using Ansible collections
Using Ansible on Windows and BSD
Ansible tips and tricks

Contributing to Ansible

Ansible Community Guide
Ansible Collections Contributor Guide
ansible-core Contributors Guide
Advanced Contributor Guide
Ansible documentation style guide

Extending Ansible

Developer Guide

Common Ansible Scenarios

Legacy Public Cloud Guides

Network Automation

Network Getting Started
Network Advanced Topics
Network Developer Guide

Ansible Galaxy

Galaxy User Guide
Galaxy Developer Guide

Reference & Appendices

Collection Index
- Collections in the Amazon Namespace
- Collections in the Ansible Namespace
- Collections in the Arista Namespace
- Collections in the Awx Namespace
- Collections in the Azure Namespace
  - Azure.Azcollection
    - Description
    - Plugin Index
- Collections in the Check_point Namespace
- Collections in the Chocolatey Namespace
- Collections in the Cisco Namespace
- Collections in the Cloud Namespace
- Collections in the Cloudscale_ch Namespace
- Collections in the Community Namespace
- Collections in the Containers Namespace
- Collections in the Cyberark Namespace
- Collections in the Dellemc Namespace
- Collections in the F5networks Namespace
- Collections in the Fortinet Namespace
- Collections in the Frr Namespace
- Collections in the Gluster Namespace
- Collections in the Google Namespace
- Collections in the Grafana Namespace
- Collections in the Hetzner Namespace
- Collections in the Hpe Namespace
- Collections in the Ibm Namespace
- Collections in the Ieisystem Namespace
- Collections in the Infinidat Namespace
- Collections in the Infoblox Namespace
- Collections in the Inspur Namespace
- Collections in the Junipernetworks Namespace
- Collections in the Kaytus Namespace
- Collections in the Kubernetes Namespace
- Collections in the Kubevirt Namespace
- Collections in the Lowlydba Namespace
- Collections in the Mellanox Namespace
- Collections in the Microsoft Namespace
- Collections in the Netapp Namespace
- Collections in the Netapp_eseries Namespace
- Collections in the Netbox Namespace
- Collections in the Ngine_io Namespace
- Collections in the Openstack Namespace
- Collections in the Openvswitch Namespace
- Collections in the Ovirt Namespace
- Collections in the Purestorage Namespace
- Collections in the Sensu Namespace
- Collections in the Servicenow Namespace
- Collections in the Splunk Namespace
- Collections in the T_systems_mms Namespace
- Collections in the Telekom_mms Namespace
- Collections in the Theforeman Namespace
- Collections in the Vmware Namespace
- Collections in the Vultr Namespace
- Collections in the Vyos Namespace
- Collections in the Wti Namespace
Indexes of all modules and plugins
Playbook Keywords
Return Values
Ansible Configuration Settings
Controlling how Ansible behaves: precedence rules
YAML Syntax
Python 3 Support
Interpreter Discovery
Releases and maintenance
Testing Strategies
Sanity Tests
Frequently Asked Questions
Glossary
Ansible Reference: Module Utilities
Special Variables
Red Hat Ansible Automation Platform
Ansible Automation Hub
Logging Ansible output

Roadmaps

Synopsis

Create, update and delete instance of Azure Role Definition.

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.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
ad_user string	Active Directory username. Use when authenticating with an Active Directory user rather than service principal.
adfs_authority_url string added in azure.azcollection 0.0.1	Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
api_profile string added in azure.azcollection 0.0.1	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. Default: `"latest"`
assignable_scopes list / elements=string	List of assignable scopes of this definition.
auth_source string added in azure.azcollection 0.0.1	Controls the source of the credentials to use for authentication. Can also be set via the `ANSIBLE_AZURE_AUTH_SOURCE` environment variable. When set to `auto` (the default) the precedence is module parameters -> `env` -> `credential_file` -> `cli`. When set to `env`, the credentials will be read from the environment variables When set to `credential_file`, it will read the profile from `~/.azure/credentials`. When set to `cli`, the credentials will be sources from the Azure CLI profile. `subscription_id` or the environment variable `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 `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. Choices: `"auto"` ← (default) `"cli"` `"credential_file"` `"env"` `"msi"`
cert_validation_mode string added in azure.azcollection 0.0.1	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. Choices: `"ignore"` `"validate"`
client_id string	Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the `AZURE_CLIENT_ID` environment variable.
cloud_environment string added in azure.azcollection 0.0.1	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. Default: `"AzureCloud"`
description string	The role definition description.
disable_instance_discovery boolean added in azure.azcollection 2.3.0	Determines whether or not instance discovery is performed when attempting to authenticate. Setting this to true will completely disable both instance discovery and authority validation. This functionality is intended for use in scenarios where the metadata endpoint cannot be reached such as in private clouds or Azure Stack. The process of instance discovery entails retrieving authority metadata from https://login.microsoft.com/ to validate the authority. By setting this to True, the validation of the authority is disabled. As a result, it is crucial to ensure that the configured authority host is valid and trustworthy. Set via credential file profile or the `AZURE_DISABLE_INSTANCE_DISCOVERY` environment variable. Choices: `false` ← (default) `true`
log_mode string	Parent argument.
log_path string	Parent argument.
name string / required	Unique name of role definition.
password string	Active Directory user password. Use when authenticating with an Active Directory user rather than service principal.
permissions list / elements=dictionary	Set of role definition permissions. See https://docs.microsoft.com/en-us/azure/app-service/app-service-web-overview for more info.
actions list / elements=string	List of allowed actions.
data_actions list / elements=string	List of allowed data actions.
not_actions list / elements=string	List of denied actions.
not_data_actions list / elements=string	List of denied data actions.
profile string	Security profile found in ~/.azure/credentials file.
scope string	The scope of the role definition.
secret string	Azure client secret. Use when authenticating with a Service Principal.
state string	Assert the state of the role definition. Use `present` to create or update a role definition; use `absent` to delete it. Choices: `"absent"` `"present"` ← (default)
subscription_id string	Your Azure subscription Id.
tenant string	Azure tenant ID. Use when authenticating with a Service Principal.
thumbprint string added in azure.azcollection 1.14.0	The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined.
x509_certificate_path path added in azure.azcollection 1.14.0	Path to the X509 certificate used to create the service principal in PEM format. The certificate must be appended to the private key. Use when authenticating with a Service Principal.

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.

Examples

- name: Create a role definition azure_rm_roledefinition: name: myTestRole scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myresourceGroup permissions: - actions: - "Microsoft.Compute/virtualMachines/read" data_actions: - "Microsoft.Storage/storageAccounts/blobServices/containers/blobs/write" assignable_scopes: - "/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

Return Values

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

Key	Description
id string	ID of current role definition. Returned: always Sample: `"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/roleDefinitionId"`

Authors

Yunge Zhu(@yungezz)

azure.azcollection.azure_rm_roledefinition module – Manage Azure Role Definition — Ansible Community Documentation (2024)