Try SpotterManage Azure RegistrationDefinition instance
| "added in version" 1.3.0 of azure.azcollection"
Authors: Fred-Sun (@Fred-Sun)
Install with ansible-galaxy collection install azure.azcollection:==2.3.0
collections:
- name: azure.azcollection
version: 2.3.0Create, update and delete instance of Azure RegistrationDefinition.
- name: Create Registration Definition without scope
azure_rm_registrationdefinition:
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
properties:
description: test
authorizations:
- principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
registration_definition_name: def4
- name: Create Registration Definition with scope
azure_rm_registrationdefinition:
scope: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
properties:
description: test
authorizations:
- principal_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
role_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
managed_by_tenant_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
registration_definition_name: def5
- name: Delete Registration Definition
azure_rm_registrationdefinition:
registration_definition_id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
state: absent
plan:
description:
- Plan details for the managed services.
suboptions:
name:
description:
- The plan name.
required: true
type: str
product:
description:
- The product code.
required: true
type: str
publisher:
description:
- The publisher ID.
required: true
type: str
version:
description:
- The plan's version.
required: true
type: str
type: dict
tags:
description:
- 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.
- Currently, Azure DNS zones and Traffic Manager services also don't allow the use
of spaces in the tag.
- Azure Front Door doesn't support the use of
- Azure Automation and Azure CDN only support 15 tags on resources.
type: dict
scope:
description:
- The subscription ID defines the subscription in which the registration definition
will be created.
- If not specified, will use the subscription derived from AzureRMAuth.
type: str
state:
choices:
- absent
- present
default: present
description:
- Assert the state of the RegistrationDefinition.
- Use C(present) to create or update an RegistrationDefinition and C(absent) to delete
it.
type: str
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
log_mode:
description:
- Parent argument.
type: str
log_path:
description:
- Parent argument.
type: str
password:
description:
- Active Directory user password. Use when authenticating with an Active Directory
user rather than service principal.
type: str
client_id:
description:
- Azure client ID. Use when authenticating with a Service Principal or Managed Identity
(msi).
- Can also be set via the C(AZURE_CLIENT_ID) environment variable.
type: str
properties:
description:
- Properties of a registration definition.
suboptions:
authorizations:
description:
- Authorization tuple containing principal ID of the user/security group or service
principal and ID of the build-in role.
elements: dict
required: true
suboptions:
principal_id:
description:
- Principal ID of the security group/service principal/user that would be
assigned permissions to the projected subscription.
required: true
type: str
role_definition_id:
description:
- The role definition identifier.
- This role will define all the permissions that the security group/service
principal/user must have on the projected subscription.
- This role cannot be an owner role.
required: true
type: str
type: list
description:
description:
- Description of the registration definition.
type: str
managed_by_tenant_id:
description:
- ID of the managedBy tenant.
required: true
type: str
registration_definition_name:
description:
- Name of the registration definition.
type: str
type: dict
thumbprint:
description:
- The thumbprint of the private key specified in I(x509_certificate_path).
- Use when authenticating with a Service Principal.
- Required if I(x509_certificate_path) is defined.
type: str
version_added: 1.14.0
version_added_collection: azure.azcollection
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
append_tags:
default: true
description:
- 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.
type: bool
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
subscription_id:
description:
- Your Azure subscription Id.
type: str
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
x509_certificate_path:
description:
- 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.
type: path
version_added: 1.14.0
version_added_collection: azure.azcollection
disable_instance_discovery:
default: false
description:
- 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 C(AZURE_DISABLE_INSTANCE_DISCOVERY) environment
variable.
type: bool
version_added: 2.3.0
version_added_collection: azure.azcollection
registration_definition_id:
description:
- ID of the registration definition.
- If is not specified, an UUID will be generated for it.
type: str
state:
contains:
id:
description:
- Fully qualified path of the registration definition.
returned: always
sample: null
type: str
name:
description:
- Name of the registration definition.
returned: always
sample: /subscriptions/xxx-xxx/providers/Microsoft.ManagedServices/registrationDefinitions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
type: str
plan:
contains:
name:
description:
- The plan name.
returned: always
sample: null
type: str
product:
description:
- The product code.
returned: always
sample: null
type: str
publisher:
description:
- The publisher ID.
returned: always
sample: null
type: str
version:
description:
- The plan's version.
returned: always
sample: null
type: str
description:
- Plan details for the managed services.
returned: always
type: complex
properties:
contains:
authorizations:
contains:
principal_id:
description:
- Principal ID of the security group/service principal/user that would
be assigned permissions to the projected subscription
returned: always
sample: 99e3227f-8701-4099-869f-bc3efc7f1e64
type: str
role_definition_id:
description:
- The role definition identifier.
- This role will define all the permissions that the security group/service
principal/user must have on the subscription.
- This role cannot be an owner role.
returned: always
sample: b24988ac-6180-42a0-ab88-20f7382dd24c
type: str
description:
- Authorization tuple containing principal ID of the user/security group
or service principal and ID of the build-in role.
returned: always
type: complex
description:
description:
- Description of the registration definition.
returned: always
sample: test
type: str
managed_by_tenant_id:
description:
- ID of the managedBy tenant.
returned: always
sample: null
type: str
registration_definition_name:
description:
- Name of the registration definition.
returned: always
sample: null
type: str
description:
- Properties of a registration definition.
returned: always
type: complex
type:
description:
- Type of the resource.
returned: always
sample: Microsoft.ManagedServices/registrationDefinitions
type: str
description:
- The state info of the registration assignment.
returned: always
type: complex