community / community.azure / 1.0.0 / module / azure_rm_resource_info Generic facts of Azure resources Authors: Zim Kalinowski (@zikalino) preview | supported by communitycommunity.azure.azure_rm_resource_info (1.0.0) — module
Install with ansible-galaxy collection install community.azure:==1.0.0
collections: - name: community.azure version: 1.0.0
Obtain facts of any resource using Azure REST API.
This module gives access to resources that are not supported via Ansible modules.
Refer to U(https://docs.microsoft.com/en-us/rest/api/) regarding details related to specific resource REST API.
- name: Get scaleset info community.azure.azure_rm_resource_info: resource_group: myResourceGroup provider: compute resource_type: virtualmachinescalesets resource_name: myVmss api_version: "2017-12-01"
- name: Query all the resources in the resource group community.azure.azure_rm_resource_info: resource_group: "{{ resource_group }}" resource_type: resources
url: description: - Azure RM Resource URL. 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 provider: description: - Provider type, should be specified in no URL is given. client_id: description: - Azure client ID. Use when authenticating with a Service Principal. type: str 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 api_version: description: - Specific API version to be used. 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 subresource: description: - List of subresources. suboptions: name: description: - Subresource name. namespace: description: - Subresource namespace. type: description: - Subresource type. resource_name: description: - Resource name. resource_type: description: - Resource type. resource_group: description: - Resource group to be used. - Required if URL is not specified. 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
response: contains: id: description: - Id of the Azure resource. returned: always sample: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/virtualMachines/myVM type: str location: description: - Resource location. returned: always sample: eastus type: str name: description: - Resource name. returned: always sample: myVM type: str properties: contains: diagnosticsProfile: contains: bootDiagnostics: description: - A debugging feature, which to view Console Output and Screenshot to diagnose VM status. returned: always sample: enabled: true storageUri: https://vxisurgdiag.blob.core.windows.net/ type: dict description: - Specifies the boot diagnostic settings state. returned: always type: complex hardwareProfile: description: - Specifies the hardware settings for the virtual machine. returned: always sample: vmSize: Standard_D2s_v3 type: dict networkProfile: contains: networkInterfaces: description: - Describes a network interface reference. returned: always sample: - id: /subscriptions/xxxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Network/networkInterfaces/myvm441 type: list description: - Specifies the network interfaces of the virtual machine. returned: always type: complex osProfile: contains: adminUsername: description: - Specifies the name of the administrator account. returned: always sample: azureuser type: str allowExtensionOperations: description: - Specifies whether extension operations should be allowed on the virtual machine. - This may only be set to False when no extensions are present on the virtual machine. returned: always sample: true type: bool computerName: description: - Specifies the host OS name of the virtual machine. returned: always sample: myVM type: str linuxConfiguration: description: - Specifies the Linux operating system settings on the virtual machine. returned: when OS type is Linux sample: disablePasswordAuthentication: false provisionVMAgent: true type: dict requireGuestProvisionSignale: description: - Specifies the host require guest provision signal or not. returned: always sample: true type: bool secrets: description: - Specifies set of certificates that should be installed onto the virtual machine. returned: always sample: [] type: list description: - Specifies the operating system settings for the virtual machine. returned: always type: complex provisioningState: description: - The provisioning state. returned: always sample: Succeeded type: str storageProfile: contains: dataDisks: description: - Specifies the parameters that are used to add a data disk to virtual machine. returned: always sample: - caching: None createOption: Attach diskSizeGB: 1023 lun: 2 managedDisk: id: /subscriptions/xxxx....xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk2 storageAccountType: StandardSSD_LRS name: testdisk2 - caching: None createOption: Attach diskSizeGB: 1023 lun: 1 managedDisk: id: /subscriptions/xxxx...xxxx/resourceGroups/V-XISURG/providers/Microsoft.Compute/disks/testdisk3 storageAccountType: StandardSSD_LRS name: testdisk3 type: list imageReference: description: - Specifies information about the image to use. returned: always sample: offer: UbuntuServer publisher: Canonical sku: 18.04-LTS version: latest type: dict osDisk: description: - Specifies information about the operating system disk used by the virtual machine. returned: always sample: caching: ReadWrite createOption: FromImage diskSizeGB: 30 managedDisk: id: /subscriptions/xxx...xxxx/resourceGroups/v-xisuRG/providers/Microsoft.Compute/disks/myVM_disk1_xxx storageAccountType: Premium_LRS name: myVM_disk1_xxx osType: Linux type: dict description: - Specifies the storage account type for the managed disk. returned: always type: complex vmID: description: - Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure laaS VMs SMBIOS. - It can be read using platform BIOS commands. returned: always sample: eb86d9bb-6725-4787-a487-2e497d5b340c type: str description: - Specifies the virtual machine's property. returned: always type: complex type: description: - The type of identity used for the virtual machine. returned: always sample: Microsoft.Compute/virtualMachines type: str description: - Response specific to resource type. returned: always type: complex