New in version 2.8.
The below requirements are needed on the host that executes this module.
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 2.6 |
Azure AD authority url. Use when authenticating with Username/password, and has your own ADFS authority.
|
|
api_profile
string
added in 2.5 |
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 2.5 |
|
Controls the source of the credentials to use for authentication.
If not specified, ANSIBLE_AZURE_AUTH_SOURCE environment variable will be used and default to
auto if variable is not defined.auto will follow the default precedence of module parameters -> environment variables -> default profile in credential file ~/.azure/credentials .When set to
cli , the credentials will be sources from the default Azure CLI profile.Can also be set via the
ANSIBLE_AZURE_AUTH_SOURCE environment variable.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 2.5 |
|
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 2.4 |
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. |
name
-
|
Name of the workspace.
|
|
password
-
|
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
-
/ required
|
Name of resource group.
|
|
secret
string
|
Azure client secret. Use when authenticating with a Service Principal.
|
|
show_intelligence_packs
-
|
Show the intelligence packs for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
show_management_groups
-
|
Show the management groups for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
show_shared_keys
-
|
Show the shared keys for a workspace.
Note this will cost one more network overhead for each workspace, expected slow response.
|
|
show_usages
-
|
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
-
|
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.
|
Note
az login
.See also
az login
command.- 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
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
id
string
|
success |
Workspace resource path.
|
intelligence_packs
list
|
success |
Lists all the intelligence packs possible and whether they are enabled or disabled for a given workspace.
|
location
string
|
success |
Resource location.
|
management_groups
list
|
success |
List of management groups connected to the workspace.
|
retention_in_days
integer
|
success |
The workspace data retention in days.
-1 means Unlimited retention for the
unlimited sku .730 days is the maximum allowed for all other
sku s. |
shared_keys
list
|
success |
Shared keys for the workspace.
|
sku
string
|
success |
The SKU of the workspace
|
usages
list
|
success |
List of usage metrics for the workspace.
|
Hint
If you notice any issues in this documentation you can edit this document to improve it.