Note
This plugin is part of the azure.azcollection collection (version 1.10.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install azure.azcollection.
To use it in a playbook, specify: azure.azcollection.azure_rm_proximityplacementgroup_info.
New in version 1.6.0: of azure.azcollection
The below requirements are needed on the host that executes this module.
| 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 latest is appropriate for public clouds; future values will allow use with Azure Stack. |
| 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 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 variablesWhen 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. |
| 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 ignore. Can also be set via credential file profile or the AZURE_CERT_VALIDATION environment variable. |
| 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, 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. |
| log_mode string | Parent argument. | |
| log_path string | Parent argument. | |
| name string | The name of the proximity placement group. | |
| 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. | |
| resource_group string | Name of resource group. | |
| secret string | Azure client secret. Use when authenticating with a Service Principal. | |
| subscription_id string | Your Azure subscription Id. | |
| tags dictionary | Limit the results by providing resource tags. | |
| tenant string | Azure tenant ID. Use when authenticating with a Service Principal. |
Note
az login.See also
How to authenticate using the az login command.
- name: Get facts for one proximity placement group
azure_rm_proximityplacementgroup_info:
resource_group: myAzureResourceGroup
name: myppg
- name: Get facts for all proximity placement groups in resource group
azure_rm_proximityplacementgroup_info:
resource_group: myAzureResourceGroup
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| proximityplacementgroups list / elements=dictionary | always | Gets a list of proximity placement groups. Sample: [{'availability_sets': [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/ providers/Microsoft.Compute/availabilitySets/availabilityset1'}, {'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/ providers/Microsoft.Compute/availabilitySets/availabilityset2'}], 'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/providers/ Microsoft.Compute/proximityPlacementGroups/myppg', 'location': 'eastus', 'name': 'myppg', 'proximity_placement_group_type': 'Standard', 'tags': {}, 'virtual_machine_scale_sets': [], 'virtual_machines': [{'id': '/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myAzureResourceGroup/ providers/Microsoft.Compute/virtualMachines/mylinuxvm'}]}] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/azure/azcollection/azure_rm_proximityplacementgroup_info_module.html