azure.azcollection.azure_rm_loganalyticsworkspace – Manage Azure Log Analytics workspaces

azure.azcollection.azure_rm_loganalyticsworkspace – Manage Azure Log Analytics workspaces

Note

This plugin is part of the azure.azcollection collection (version 1.4.0).

To install it use: ansible-galaxy collection install azure.azcollection.

To use it in a playbook, specify: azure.azcollection.azure_rm_loganalyticsworkspace.

New in version 0.1.2: of azure.azcollection

• Synopsis
• Requirements
• Parameters
• Notes
• See Also
• Examples
• Return Values

Synopsis

• Create, delete Azure Log Analytics workspaces.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 2.7
• azure >= 2.0.0

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.
append_tags boolean	no yes ←	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	auto ← cli credential_file env msi	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	ignore validate	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.
force boolean	no ← yes	Deletes the workspace without the recovery option. A workspace that was deleted with this flag cannot be recovered.
intelligence_packs dictionary		Manage intelligence packs possible for this workspace. Enable one pack by setting it to true. For example "Backup:true". Disable one pack by setting it to false. For example "Backup:false". Other intelligence packs not list in this property will not be changed.
location string		Resource location.
name string / required		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.
retention_in_days string		The workspace data retention in days. -1 means Unlimited retention for sku=unlimited. 730 days is the maximum allowed for all other SKUs.
secret string		Azure client secret. Use when authenticating with a Service Principal.
sku string	free standard premium unlimited per_node per_gb2018 ← standalone	The SKU of the workspace.
state string	absent present ←	Assert the state of the image. Use present to create or update a image and absent to delete an image.
subscription_id string		Your Azure subscription Id.
tags dictionary		Dictionary of string:string pairs to assign as metadata to the object. Metadata tags on the object will be updated with any provided values. To remove tags set append_tags option to false.
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 login command.

Examples

- name: Create a workspace with backup enabled
  azure_rm_loganalyticsworkspace:
    resource_group: myResourceGroup
    name: myLogAnalyticsWorkspace
    intelligence_pack:
        Backup: 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: [{'name': 'CapacityPerformance'}, {'enabled': True}]
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': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'secondarySharedKey': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'}
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/2.11/collections/azure/azcollection/azure_rm_loganalyticsworkspace_module.html