ApplicationInsights / Client / update_component_configuration

update_component_configuration#

ApplicationInsights.Client.update_component_configuration(**kwargs)#

Updates the monitoring configurations for the component. The configuration input parameter is an escaped JSON of the configuration and should match the schema of what is returned by DescribeComponentConfigurationRecommendation .

See also: AWS API Documentation

Request Syntax

response = client.update_component_configuration(
    ResourceGroupName='string',
    ComponentName='string',
    Monitor=True|False,
    Tier='CUSTOM'|'DEFAULT'|'DOT_NET_CORE'|'DOT_NET_WORKER'|'DOT_NET_WEB_TIER'|'DOT_NET_WEB'|'SQL_SERVER'|'SQL_SERVER_ALWAYSON_AVAILABILITY_GROUP'|'MYSQL'|'POSTGRESQL'|'JAVA_JMX'|'ORACLE'|'SAP_HANA_MULTI_NODE'|'SAP_HANA_SINGLE_NODE'|'SAP_HANA_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY',
    ComponentConfiguration='string',
    AutoConfigEnabled=True|False
)
Parameters:

  • ResourceGroupName (string) –

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) –

    [REQUIRED]

    The name of the component.

  • Monitor (boolean) – Indicates whether the application component is monitored.

  • Tier (string) – The tier of the application component.

  • ComponentConfiguration (string) – The configuration settings of the component. The value is the escaped JSON of the configuration. For more information about the JSON format, see Working with JSON. You can send a request to DescribeComponentConfigurationRecommendation to see the recommended configuration for a component. For the complete format of the component configuration file, see Component Configuration.

  • AutoConfigEnabled (boolean) – Automatically configures the component by applying the recommended configurations.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • ApplicationInsights.Client.exceptions.ResourceNotFoundException

  • ApplicationInsights.Client.exceptions.ValidationException

  • ApplicationInsights.Client.exceptions.InternalServerException