azure.azcollection.azure_rm_registrationdefinition_info – Get RegistrationDefinition info
azure.azcollection.azure_rm_registrationdefinition_info – Get RegistrationDefinition info
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_registrationdefinition_info
.
New in version 1.3.0: of azure.azcollection
Synopsis
- Get info of RegistrationDefinition.
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 |
append_tags boolean |
|
Use to control if tags field is canonical or just appends to existing tags. When canonical, any tags not found in the tags parameter will be removed from the object's metadata. |
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, |
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. | |
registration_definition_id string |
ID of the registration definition. | |
scope string |
The subscription ID defines the subscription in which the registration definition will be retrieved. If not specified, will use the subscription derived from AzureRMAuth. | |
secret string |
Azure client secret. Use when authenticating with a Service Principal. | |
subscription_id string |
Your Azure subscription Id. | |
tags dictionary |
Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false. | |
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: Get Registration Definition
azure_rm_registrationdefinition_info:
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
- name: Get All Registration Definitions from AzureRMAuth's subscription
azure_rm_registrationdefinition_info:
- name: Get All Registration Definitions in the subscription levle
azure_rm_registrationdefinition_info:
scope: 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 | |||
---|---|---|---|---|---|
registration_definitions complex |
always |
A list of dict results where the key is the name of the RegistrationDefinition and the values are the facts for that RegistrationDefinition.
| |||
id string |
always |
Fully qualified path of the registration definition.
| |||
name string |
always |
Name of the registration definition.
| |||
plan complex |
always |
Plan details for the managed services.
| |||
name string |
always |
The plan name.
| |||
product string |
always |
The product code.
| |||
publisher string |
always |
The publisher ID.
| |||
version string |
always |
The plan's version.
| |||
properties complex |
always |
Properties of a registration definition.
| |||
authorizations complex |
always |
Authorization tuple containing principal ID of the user/security group or service principal and id of the build-in role.
| |||
principal_id string |
always |
Principal ID of the security group/service principal/user that would be assigned permissions to the projected subscription.
| |||
role_definition_id string |
always |
The role definition identifier. The role will define all the permissions that the security group/service principal/user must have on the subscription. The role cannot be an owner role.
| |||
description string |
always |
Description of the registration definition.
| |||
managed_by_tenant_id string |
always |
ID of the managedBy tenant.
| |||
registration_definition_name string |
always |
Name of the registration definition.
| |||
type string |
always |
Type of the resource.
|
Authors
- Fred-Sun (@Fred-Sun)
© 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_registrationdefinition_info_module.html