azure.azcollection.azure_rm_loganalyticsworkspace_info – Get facts of Azure Log Analytics workspaces
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_loganalyticsworkspace_info.
New in version 0.1.2: of azure.azcollection
Synopsis
- Get, query Azure Log Analytics workspaces.
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-azure.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 | 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.
|
| 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 variables
When 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
|
Name of the workspace.
|
|
| 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 / required
|
Name of resource group.
|
|
| secret
string
|
Azure client secret. Use when authenticating with a Service Principal.
|
|
| show_intelligence_packs
string
|
Show the intelligence packs for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
| show_management_groups
string
|
Show the management groups for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
| show_shared_keys
string
|
Show the shared keys for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
| show_usages
string
|
Show the list of usages for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
| subscription_id
string
|
Your Azure subscription Id.
|
|
| tags
string
|
Limit results by providing a list of tags. Format tags as 'key' or 'key:value'.
|
|
| 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
See also
- Sign in with Azure CLI
-
How to authenticate using the
az logincommand.
Examples
- name: Query a workspace
azure_rm_loganalyticsworkspace_info:
resource_group: myResourceGroup
name: myLogAnalyticsWorkspace
show_intelligence_packs: true
show_management_groups: true
show_shared_keys: true
show_usages: true
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| id
string
|
success |
Workspace resource path.
Sample:
/subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/m yLogAnalyticsWorkspace
|
| intelligence_packs
list / elements=string
|
success |
Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.
Sample:
[{'enabled': True, 'name': 'CapacityPerformance'}]
|
| location
string
|
success |
Resource location.
Sample:
eastus
|
| management_groups
dictionary
|
success |
Management groups connected to the workspace.
Sample:
{'value': []}
|
| retention_in_days
integer
|
success |
The workspace data retention in days.
-1 means Unlimited retention for sku=unlimited.
730 days is the maximum allowed for all other SKUs.
Sample:
40
|
| shared_keys
dictionary
|
success |
Shared keys for the workspace.
Sample:
{'primarySharedKey': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'secondarySharedKey': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}
|
| sku
string
|
success |
The SKU of the workspace.
Sample:
per_gb2018
|
| usages
dictionary
|
success |
Usage metrics for the workspace.
Sample:
{'value': [{'currentValue': 0, 'limit': 524288000, 'name': {'localizedValue': 'Data Analyzed', 'value': 'DataAnalyzed'}, 'nextResetTime': '2017-10-03T00:00:00Z', 'quotaPeriod': 'P1D', 'unit': 'Bytes'}]}
|
Authors
- Yuwei Zhou (@yuwzho)
© 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_loganalyticsworkspace_info_module.html