exec.azurerm.application_insights.component

Azure Resource Manager (ARM) Application Insights Component Operations Execution Module

New in version 3.0.0.

maintainer:

<devops@eitr.tech>
configuration:

This module requires Azure Resource Manager credentials to be passed as keyword arguments to every function or via acct in order to work properly.

Required provider parameters:

if using username and password:
  • subscription_id
  • username
  • password
if using a service principal:
  • subscription_id
  • tenant
  • client_id
  • secret

Optional provider parameters:

cloud_environment: Used to point the cloud driver to different API endpoints, such as Azure GovCloud. Possible values: * AZURE_PUBLIC_CLOUD (default) * AZURE_CHINA_CLOUD * AZURE_US_GOV_CLOUD * AZURE_GERMAN_CLOUD
idem_azurerm.exec.azurerm.application_insights.component.create_or_update(hub, ctx, name, resource_group, kind, application_type, retention=None, immediate_purge_data=None, disable_ip_masking=None, ingestion_public_network_access=None, query_public_network_access=None, tags=None, **kwargs)

New in version 3.0.0.

Creates (or updates) an Application Insights component.

Parameters:
  • name – The name of the Application Insights component resource.
  • resource_group – The name of the resource group.
  • kind – The kind of application that this component refers to, used to customize UI. This value is a freeform string, values should typically be one of the following: “web”, “ios”, “other”, “store”, “java”, “phone”.
  • application_type – Type of application being monitored. Possible values include: ‘web’, ‘other’. Default to “web”.
  • retention – Retention period in days. Defaults to 90.
  • immediate_purge_data – A boolean value representing whether or not data should be purged immediately after 30 days.
  • disable_ip_masking – Disable IP masking.
  • tags – A dictionary of strings can be passed as tag metadata to the Application Insights Component object.

CLI Example:

azurerm.application_insights.component.create_or_update test_name test_group "web" "web"
idem_azurerm.exec.azurerm.application_insights.component.delete(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Deletes an Application Insights component.

Parameters:
  • name – The name of the component to delete.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.application_insights.component.delete test_name test_group
idem_azurerm.exec.azurerm.application_insights.component.get(hub, ctx, name, resource_group, **kwargs)

New in version 3.0.0.

Returns an Application Insights component.

Parameters:
  • name – The name of the component.
  • resource_group – The name of the resource group.

CLI Example:

azurerm.application_insights.component.get test_name test_group
idem_azurerm.exec.azurerm.application_insights.component.list_(hub, ctx, resource_group=None, **kwargs)

New in version 3.0.0.

Gets a list of all Application Insights components within a subscription.

Parameters:resource_group – The name of the resource group to limit the results.

CLI Example:

azurerm.application_insights.component.list