azure.azcollection.azure_rm_resourcehealthstates_info module – Get or list the current availability status for the resource
Note
This module is part of the azure.azcollection collection (version 3.3.1).
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.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: azure.azcollection.azure_rm_resourcehealthstates_info.
New in azure.azcollection 3.3.0
Synopsis
Get or list the current availability status for the resource.
Requirements
The below requirements are needed on the host that executes this module.
python >= 2.7
The host that executes this module must have the azure.azcollection collection installed via galaxy
All python packages listed in collection’s requirements.txt must be installed via pip on the host that executes modules from azure.azcollection
Full installation instructions may be found https://galaxy.ansible.com/azure/azcollection
Parameters
Parameter |
Comments |
|---|---|
Active Directory username. Use when authenticating with an Active Directory user rather than service principal. |
|
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority. |
|
Selects an API profile to use when communicating with Azure services. Default value of Default: |
|
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 Choices:
|
|
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 Choices:
|
|
Azure client ID. Use when authenticating with a Service Principal or Managed Identity (msi). Can also be set via the |
|
For cloud environments other than the US public cloud, the environment name (as defined by Azure Python SDK, eg, Default: |
|
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 Choices:
|
|
Whether lists all historical availability transitions and impacting events for a single resource. Choices:
|
|
Parent argument. |
|
Parent argument. |
|
Active Directory user password. Use when authenticating with an Active Directory user rather than service principal. |
|
Security profile found in ~/.azure/credentials file. |
|
Name of resource group. |
|
The fully qualified ID of the resource, including the resource name and resource type. Currently the API support not nested and one nesting level resource types, such as ‘/subscriptions/{subscriptionId}/resourceGroups/{resource-group-name}/providers/{resource-provider-name}/ {resource-type}/{resource-name}’ and ‘/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/ providers/{resource-provider-name}/{parentResourceType}/{parentResourceName}/{resourceType}/{resourceName}’. |
|
Azure client secret. Use when authenticating with a Service Principal. |
|
Your Azure subscription Id. |
|
Azure tenant ID. Use when authenticating with a Service Principal. |
|
The thumbprint of the private key specified in x509_certificate_path. Use when authenticating with a Service Principal. Required if x509_certificate_path is defined. |
|
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. |
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
See also
- Sign in with Azure CLI
How to authenticate using the
az logincommand.
Examples
- name: Lists the current availability status for all the resources in the subscription.
azure_rm_resourcehealthstates_info:
- name: Lists the current availability status for all the resources in the resource group.
azure_rm_resourcehealthstates_info:
resource_group: "{{ resource_group }}"
- name: Gets current availability status for a single resource.
azure_rm_resourcehealthstates_info:
resource_uri: "/subscriptions/xxxx-xxx/resourcegroups/v-xisurg/providers/microsoft.compute/virtualmachines/testvm"
- name: Lists all historical availability transitions and impacting events for a single resource.
azure_rm_resourcehealthstates_info:
resource_uri: "/subscriptions/xxxx-xxx/resourcegroups/v-xisurg/providers/microsoft.compute/virtualmachines/testvm"
list_all: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The facts of availabilityStatus of a resource. Returned: always |
|
Azure Resource Manager Identity for the availabilityStatuses resource. Returned: always Sample: |
|
Azure Resource Manager geo location of the resource. Returned: always Sample: |
|
Properties of availability state. Returned: success |
|
Availability status of the resource. Returned: always Sample: |
|
When a context field is set to Platform, this field will reflect if the event was planned or unplanned. If the context field does not have a value of Platform, then this field will be ignored. Returned: always Sample: |
|
This field is connected to the category field in this object. Returned: always Sample: |
|
Timestamp for when last change in health status occurred. Returned: always Sample: |
|
Chronicity of the availability transition. Returned: always Sample: |
|
When the resource’s availabilityState is Unavailable, it describes where the health impacting event was originated. Returned: always Sample: |
|
Timestamp for when the health was last checked. Returned: always Sample: |
|
Summary description of the availability status. Returned: always Sample: |
|
Title description of the availability status. Returned: always Sample: |
|
Microsoft.ResourceHealth/AvailabilityStatuses. Returned: always Sample: |