ApplicationInsights / Client / describe_component_configuration_recommendation

describe_component_configuration_recommendation#

ApplicationInsights.Client.describe_component_configuration_recommendation(**kwargs)#

Describes the recommended monitoring configuration of the component.

See also: AWS API Documentation

Request Syntax

response = client.describe_component_configuration_recommendation(
    ResourceGroupName='string',
    ComponentName='string',
    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'|'SAP_ASE_SINGLE_NODE'|'SAP_ASE_HIGH_AVAILABILITY'|'SQL_SERVER_FAILOVER_CLUSTER_INSTANCE'|'SHAREPOINT'|'ACTIVE_DIRECTORY'|'SAP_NETWEAVER_STANDARD'|'SAP_NETWEAVER_DISTRIBUTED'|'SAP_NETWEAVER_HIGH_AVAILABILITY',
    WorkloadName='string',
    RecommendationType='INFRA_ONLY'|'WORKLOAD_ONLY'|'ALL'
)
Parameters:
  • ResourceGroupName (string) –

    [REQUIRED]

    The name of the resource group.

  • ComponentName (string) –

    [REQUIRED]

    The name of the component.

  • Tier (string) –

    [REQUIRED]

    The tier of the application component.

  • WorkloadName (string) – The name of the workload. The name of the workload is required when the tier of the application component is SAP_ASE_SINGLE_NODE or SAP_ASE_HIGH_AVAILABILITY.

  • RecommendationType (string) – The recommended configuration type.

Return type:

dict

Returns:

Response Syntax

{
    'ComponentConfiguration': 'string'
}

Response Structure

  • (dict) –

    • ComponentConfiguration (string) –

      The recommended configuration settings of the component. The value is the escaped JSON of the configuration.

Exceptions

  • ApplicationInsights.Client.exceptions.ResourceNotFoundException

  • ApplicationInsights.Client.exceptions.ValidationException

  • ApplicationInsights.Client.exceptions.InternalServerException