ansible / ansible.builtin / v2.8.19 / module / azure_rm_loganalyticsworkspace_facts Get facts of Azure Log Analytics workspaces. | "added in version" 2.8 of ansible.builtin" Authors: Yuwei Zhou (@yuwzho) preview | supported by communityansible.builtin.azure_rm_loganalyticsworkspace_facts (v2.8.19) — module
pip
Install with pip install ansible==2.8.19
Get, query Azure Log Analytics workspaces.
- name: Query a workspace azure_rm_loganalyticsworkspace_facts: resource_group: myResourceGroup name: myLogAnalyticsWorkspace show_intelligence_packs: true show_management_groups: true show_shared_keys: true show_usages: true
name: description: - Name of the workspace. tags: description: - Limit results by providing a list of tags. Format tags as 'key' or 'key:value'. 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. 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 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 show_usages: description: - Show the list of usages for a workspace. - Note this will cost one more network overhead for each workspace, expected slow response. resource_group: description: - Name of resource group. required: true subscription_id: description: - Your Azure subscription Id. type: str show_shared_keys: description: - Show the shared keys for a workspace. - Note this will cost one more network overhead for each workspace, expected slow response. 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 show_management_groups: description: - Show the management groups for a workspace. - Note this will cost one more network overhead for each workspace, expected slow response. show_intelligence_packs: description: - Show the intelligence packs for a workspace. - Note this will cost one more network overhead for each workspace, expected slow response.
id: description: Workspace resource path. example: /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/m yLogAnalyticsWorkspace returned: success type: str intelligence_packs: description: - Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace. example: - name: CapacityPerformance - enabled: true returned: success type: list location: description: - Resource location. example: eastus returned: success type: str management_groups: description: - List of management groups connected to the workspace. example: '{''value'': []}' returned: success type: list retention_in_days: description: - The workspace data retention in days. - -1 means Unlimited retention for the C(unlimited) C(sku). - 730 days is the maximum allowed for all other C(sku)s. example: 40 returned: success type: int shared_keys: description: - Shared keys for the workspace. example: '{ ''primarySharedKey'': ''BozLY1JnZbxu0jWUQSY8iRPEM8ObmpP8rW+8bUl3+HpDJI+n689SxXgTgU7k1qdxo/WugRLxechxbolAfHM5uA=='', ''secondarySharedKey'': ''7tDt5W0JBrCQKtQA3igfFltLSzJeyr9LmuT+B/ibzd8cdC1neZ1ePOQLBx5NUzc0q2VUIK0cLhWNyFvo/hT8Ww=='' }' returned: success type: list sku: description: - The SKU of the workspace example: per_gb2018 returned: success type: str usages: description: - List of usage metrics for the workspace. example: '{ ''value'': [ { ''name'': { ''value'': ''DataAnalyzed'', ''localizedValue'': ''Data Analyzed'' }, ''unit'': ''Bytes'', ''currentValue'': 0, ''limit'': 524288000, ''nextResetTime'': ''2017-10-03T00:00:00Z'', ''quotaPeriod'': ''P1D'' } ] }' returned: success type: list