Skip to content

describe_component_configuration_recommendation

describe_component_configuration_recommendation(
    resource_group_name: ResourceGroupName,
    component_name: ComponentName,
    tier: Tier,
    *,
    config_overrides: Optional[ApplicationInsightsClientConfig] = None,
    workload_name: Optional[WorkloadName] = None,
    recommendation_type: Optional[RecommendationType] = None,
) -> DescribeComponentConfigurationRecommendationResponse

Describes the recommended monitoring configuration of the component.

Parameters:

  • resource_group_name (ResourceGroupName) –

    The name of the resource group.

  • component_name (ComponentName) –

    The name of the component.

  • tier (Tier) –

    The tier of the application component.

  • workload_name (Optional[WorkloadName], default: None ) –

    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.

  • recommendation_type (Optional[RecommendationType], default: None ) –

    The recommended configuration type.

Raises:

Source code in docs_src/capo_application_insights/_services/application_insights.py
def describe_component_configuration_recommendation(
    self,
    resource_group_name: "capo_application_insights.types.resource_group_name.ResourceGroupName",
    component_name: "capo_application_insights.types.component_name.ComponentName",
    tier: "capo_application_insights.types.tier.Tier",
    *,
    config_overrides: Optional[ApplicationInsightsClientConfig] = None,
    workload_name: Optional[
        "capo_application_insights.types.workload_name.WorkloadName"
    ] = None,
    recommendation_type: Optional[
        "capo_application_insights.types.recommendation_type.RecommendationType"
    ] = None,
) -> "capo_application_insights.types.describe_component_configuration_recommendation_response.DescribeComponentConfigurationRecommendationResponse":
    """<p>Describes the recommended monitoring configuration of the component.</p>

    Args:
        resource_group_name: <p>The name of the resource group.</p>
        component_name: <p>The name of the component.</p>
        tier: <p>The tier of the application component.</p>
        workload_name: <p>The name of the workload. The name of the workload is required when the tier of the application component is <code>SAP_ASE_SINGLE_NODE</code> or <code>SAP_ASE_HIGH_AVAILABILITY</code>.</p>
        recommendation_type: <p>The recommended configuration type.</p>

    Raises:
        capo_application_insights.errors.internal_server_exception.InternalServerException: <p>The server encountered an internal error and is unable to complete the request.</p>
        capo_application_insights.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource does not exist in the customer account.</p>
        capo_application_insights.errors.validation_exception.ValidationException: <p>The parameter is not valid.</p>
        capo_application_insights.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_application_insights.types.describe_component_configuration_recommendation_request.DescribeComponentConfigurationRecommendationRequest]",
    ) -> OperationResponse[
        "capo_application_insights.types.describe_component_configuration_recommendation_response.DescribeComponentConfigurationRecommendationResponse"
    ]:
        import capo_application_insights._operations.ec2_windows_barley_service.describe_component_configuration_recommendation

        output, http_response = (
            capo_application_insights._operations.ec2_windows_barley_service.describe_component_configuration_recommendation.describe_component_configuration_recommendation(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DescribeComponentConfigurationRecommendation"),
    )
    input_: capo_application_insights.types.describe_component_configuration_recommendation_request.DescribeComponentConfigurationRecommendationRequest = {
        "resource_group_name": resource_group_name,
        "component_name": component_name,
        "tier": tier,
    }
    if workload_name is not None:
        input_["workload_name"] = workload_name
    if recommendation_type is not None:
        input_["recommendation_type"] = recommendation_type

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output