azure.azcollection.azure_rm_roleassignment – Manage Azure Role Assignment
azure.azcollection.azure_rm_roleassignment – Manage Azure Role Assignment
Note
This plugin is part of the azure.azcollection collection (version 1.4.0).
To install it use: ansible-galaxy collection install azure.azcollection
.
To use it in a playbook, specify: azure.azcollection.azure_rm_roleassignment
.
New in version 0.1.2: of azure.azcollection
Synopsis
- Create and delete instance of Azure Role Assignment.
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 |
assignee_object_id string |
The object id of assignee. This maps to the ID inside the Active Directory. It can point to a user, service principal or security group. Required when creating role assignment. | |
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 |
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, |
id string |
Fully qualified id of assignment to delete or create. Mutually Exclusive with scope and name | |
name string |
Unique name of role assignment. The role assignment name must be a GUID, sample as "3ce0cbb0-58c4-4e6d-a16d-99d86a78b3ca". Mutually Exclusive with id | |
password string |
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. | |
profile string |
Security profile found in ~/.azure/credentials file. | |
role_definition_id string |
The role definition id used in the role assignment. Required when creating role assignment. | |
scope string |
The scope of the role assignment to create. For example, use /subscriptions/{subscription-id}/ for subscription. /subscriptions/{subscription-id}/resourceGroups/{resource-group-name} for resource group. /subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name} for resource. Mutually Exclusive with id | |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
state string |
|
Assert the state of the role assignment. Use If |
subscription_id string |
Your Azure subscription Id. | |
tenant string |
Azure tenant ID. 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.
See Also
Examples
- name: Create a role assignment
azure_rm_roleassignment:
scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
assignee_object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id:
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- name: Create a role assignment
azure_rm_roleassignment:
name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
assignee_object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id:
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
- name: Delete a role assignment
azure_rm_roleassignment:
name: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: absent
- name: Delete a role assignment
azure_rm_roleassignment:
id: /subscriptions/xxx-sub-guid-xxx/resourceGroups/rgname/providers/Microsoft.Authorization/roleAssignments/xxx-assign-guid-xxx"
- name: Delete a role assignment
azure_rm_roleassignment:
scope: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
assignee_object_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id:
"/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
assignee_object_id string |
always |
Principal Id of the role assignee.
Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
id string |
always |
Id of current role assignment.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleAssignments/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
name string |
always |
Name of role assignment.
Sample: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
principal_type string |
always |
Principal type of the role assigned to.
Sample: ServicePrincipal |
role_definition_id string |
always |
Role definition id that was assigned to principal_id.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/providers/Microsoft.Authorization/roleDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
scope string |
always |
The role assignment scope.
Sample: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx |
type string |
always |
Type of role assignment.
Sample: Microsoft.Authorization/roleAssignments |
Authors
- Yunge Zhu(@yungezz)
- Paul Aiton(@paultaiton)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/azure/azcollection/azure_rm_roleassignment_module.html