Azure Native v1.103.0, Jun 2 23

azure-native.apimanagement.getApiDiagnostic

Explore with Pulumi AI

Gets the details of the Diagnostic for an API specified by its identifier. API Version: 2020-12-01.

Using getApiDiagnostic

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApiDiagnostic(args: GetApiDiagnosticArgs, opts?: InvokeOptions): Promise<GetApiDiagnosticResult>
function getApiDiagnosticOutput(args: GetApiDiagnosticOutputArgs, opts?: InvokeOptions): Output<GetApiDiagnosticResult>

def get_api_diagnostic(api_id: Optional[str] = None,
                       diagnostic_id: Optional[str] = None,
                       resource_group_name: Optional[str] = None,
                       service_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetApiDiagnosticResult
def get_api_diagnostic_output(api_id: Optional[pulumi.Input[str]] = None,
                       diagnostic_id: Optional[pulumi.Input[str]] = None,
                       resource_group_name: Optional[pulumi.Input[str]] = None,
                       service_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetApiDiagnosticResult]

func LookupApiDiagnostic(ctx *Context, args *LookupApiDiagnosticArgs, opts ...InvokeOption) (*LookupApiDiagnosticResult, error)
func LookupApiDiagnosticOutput(ctx *Context, args *LookupApiDiagnosticOutputArgs, opts ...InvokeOption) LookupApiDiagnosticResultOutput

> Note: This function is named LookupApiDiagnostic in the Go SDK.

public static class GetApiDiagnostic 
{
    public static Task<GetApiDiagnosticResult> InvokeAsync(GetApiDiagnosticArgs args, InvokeOptions? opts = null)
    public static Output<GetApiDiagnosticResult> Invoke(GetApiDiagnosticInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetApiDiagnosticResult> getApiDiagnostic(GetApiDiagnosticArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: azure-native:apimanagement:getApiDiagnostic
  arguments:
    # arguments dictionary

The following arguments are supported:

ApiId string: API identifier. Must be unique in the current API Management service instance.
DiagnosticId string: Diagnostic identifier. Must be unique in the current API Management service instance.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.

ApiId string: API identifier. Must be unique in the current API Management service instance.
DiagnosticId string: Diagnostic identifier. Must be unique in the current API Management service instance.
ResourceGroupName string: The name of the resource group.
ServiceName string: The name of the API Management service.

apiId String: API identifier. Must be unique in the current API Management service instance.
diagnosticId String: Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.

apiId string: API identifier. Must be unique in the current API Management service instance.
diagnosticId string: Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName string: The name of the resource group.
serviceName string: The name of the API Management service.

api_id str: API identifier. Must be unique in the current API Management service instance.
diagnostic_id str: Diagnostic identifier. Must be unique in the current API Management service instance.
resource_group_name str: The name of the resource group.
service_name str: The name of the API Management service.

apiId String: API identifier. Must be unique in the current API Management service instance.
diagnosticId String: Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName String: The name of the resource group.
serviceName String: The name of the API Management service.

getApiDiagnostic Result

The following output properties are available:

Id string: Resource ID.
LoggerId string: Resource Id of a target logger.
Name string: Resource name.
Type string: Resource type for API Management resource.
AlwaysLog string: Specifies for what type of messages sampling settings should not apply.
Backend Pulumi.AzureNative.ApiManagement.Outputs.PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Backend
Frontend Pulumi.AzureNative.ApiManagement.Outputs.PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
HttpCorrelationProtocol string: Sets correlation protocol to use for Application Insights diagnostics.
LogClientIp bool: Log the ClientIP. Default is false.
Metrics bool: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
OperationNameFormat string: The format of the Operation Name for Application Insights telemetries. Default is Name.
Sampling Pulumi.AzureNative.ApiManagement.Outputs.SamplingSettingsResponse: Sampling settings for Diagnostic.
Verbosity string: The verbosity level applied to traces emitted by trace policies.

Id string: Resource ID.
LoggerId string: Resource Id of a target logger.
Name string: Resource name.
Type string: Resource type for API Management resource.
AlwaysLog string: Specifies for what type of messages sampling settings should not apply.
Backend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Backend
Frontend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
HttpCorrelationProtocol string: Sets correlation protocol to use for Application Insights diagnostics.
LogClientIp bool: Log the ClientIP. Default is false.
Metrics bool: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
OperationNameFormat string: The format of the Operation Name for Application Insights telemetries. Default is Name.
Sampling SamplingSettingsResponse: Sampling settings for Diagnostic.
Verbosity string: The verbosity level applied to traces emitted by trace policies.

id String: Resource ID.
loggerId String: Resource Id of a target logger.
name String: Resource name.
type String: Resource type for API Management resource.
alwaysLog String: Specifies for what type of messages sampling settings should not apply.
backend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol String: Sets correlation protocol to use for Application Insights diagnostics.
logClientIp Boolean: Log the ClientIP. Default is false.
metrics Boolean: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat String: The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling SamplingSettingsResponse: Sampling settings for Diagnostic.
verbosity String: The verbosity level applied to traces emitted by trace policies.

id string: Resource ID.
loggerId string: Resource Id of a target logger.
name string: Resource name.
type string: Resource type for API Management resource.
alwaysLog string: Specifies for what type of messages sampling settings should not apply.
backend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol string: Sets correlation protocol to use for Application Insights diagnostics.
logClientIp boolean: Log the ClientIP. Default is false.
metrics boolean: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat string: The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling SamplingSettingsResponse: Sampling settings for Diagnostic.
verbosity string: The verbosity level applied to traces emitted by trace policies.

id str: Resource ID.
logger_id str: Resource Id of a target logger.
name str: Resource name.
type str: Resource type for API Management resource.
always_log str: Specifies for what type of messages sampling settings should not apply.
backend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend PipelineDiagnosticSettingsResponse: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
http_correlation_protocol str: Sets correlation protocol to use for Application Insights diagnostics.
log_client_ip bool: Log the ClientIP. Default is false.
metrics bool: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operation_name_format str: The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling SamplingSettingsResponse: Sampling settings for Diagnostic.
verbosity str: The verbosity level applied to traces emitted by trace policies.

id String: Resource ID.
loggerId String: Resource Id of a target logger.
name String: Resource name.
type String: Resource type for API Management resource.
alwaysLog String: Specifies for what type of messages sampling settings should not apply.
backend Property Map: Diagnostic settings for incoming/outgoing HTTP messages to the Backend
frontend Property Map: Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.
httpCorrelationProtocol String: Sets correlation protocol to use for Application Insights diagnostics.
logClientIp Boolean: Log the ClientIP. Default is false.
metrics Boolean: Emit custom metrics via emit-metric policy. Applicable only to Application Insights diagnostic settings.
operationNameFormat String: The format of the Operation Name for Application Insights telemetries. Default is Name.
sampling Property Map: Sampling settings for Diagnostic.
verbosity String: The verbosity level applied to traces emitted by trace policies.

Supporting Types

BodyDiagnosticSettingsResponse

Bytes int: Number of request body bytes to log.

Bytes int: Number of request body bytes to log.

bytes Integer: Number of request body bytes to log.

bytes number: Number of request body bytes to log.

bytes int: Number of request body bytes to log.

bytes Number: Number of request body bytes to log.

DataMaskingEntityResponse

Mode string: Data masking mode.
Value string: The name of an entity to mask (e.g. a name of a header or a query parameter).

Mode string: Data masking mode.
Value string: The name of an entity to mask (e.g. a name of a header or a query parameter).

mode String: Data masking mode.
value String: The name of an entity to mask (e.g. a name of a header or a query parameter).

mode string: Data masking mode.
value string: The name of an entity to mask (e.g. a name of a header or a query parameter).

mode str: Data masking mode.
value str: The name of an entity to mask (e.g. a name of a header or a query parameter).

mode String: Data masking mode.
value String: The name of an entity to mask (e.g. a name of a header or a query parameter).

DataMaskingResponse

Headers List<Pulumi.AzureNative.ApiManagement.Inputs.DataMaskingEntityResponse>: Masking settings for headers
QueryParams List<Pulumi.AzureNative.ApiManagement.Inputs.DataMaskingEntityResponse>: Masking settings for Url query parameters

Headers []DataMaskingEntityResponse: Masking settings for headers
QueryParams []DataMaskingEntityResponse: Masking settings for Url query parameters

headers List<DataMaskingEntityResponse>: Masking settings for headers
queryParams List<DataMaskingEntityResponse>: Masking settings for Url query parameters

headers DataMaskingEntityResponse[]: Masking settings for headers
queryParams DataMaskingEntityResponse[]: Masking settings for Url query parameters

headers Sequence[DataMaskingEntityResponse]: Masking settings for headers
query_params Sequence[DataMaskingEntityResponse]: Masking settings for Url query parameters

headers List<Property Map>: Masking settings for headers
queryParams List<Property Map>: Masking settings for Url query parameters

HttpMessageDiagnosticResponse

Body Pulumi.AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsResponse: Body logging settings.
DataMasking Pulumi.AzureNative.ApiManagement.Inputs.DataMaskingResponse: Data masking settings.
Headers List<string>: Array of HTTP Headers to log.

Body BodyDiagnosticSettingsResponse: Body logging settings.
DataMasking DataMaskingResponse: Data masking settings.
Headers []string: Array of HTTP Headers to log.

body BodyDiagnosticSettingsResponse: Body logging settings.
dataMasking DataMaskingResponse: Data masking settings.
headers List<String>: Array of HTTP Headers to log.

body BodyDiagnosticSettingsResponse: Body logging settings.
dataMasking DataMaskingResponse: Data masking settings.
headers string[]: Array of HTTP Headers to log.

body BodyDiagnosticSettingsResponse: Body logging settings.
data_masking DataMaskingResponse: Data masking settings.
headers Sequence[str]: Array of HTTP Headers to log.

body Property Map: Body logging settings.
dataMasking Property Map: Data masking settings.
headers List<String>: Array of HTTP Headers to log.

PipelineDiagnosticSettingsResponse

Request Pulumi.AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticResponse: Diagnostic settings for request.
Response Pulumi.AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticResponse: Diagnostic settings for response.

Request HttpMessageDiagnosticResponse: Diagnostic settings for request.
Response HttpMessageDiagnosticResponse: Diagnostic settings for response.

request HttpMessageDiagnosticResponse: Diagnostic settings for request.
response HttpMessageDiagnosticResponse: Diagnostic settings for response.

request HttpMessageDiagnosticResponse: Diagnostic settings for request.
response HttpMessageDiagnosticResponse: Diagnostic settings for response.

request HttpMessageDiagnosticResponse: Diagnostic settings for request.
response HttpMessageDiagnosticResponse: Diagnostic settings for response.

request Property Map: Diagnostic settings for request.
response Property Map: Diagnostic settings for response.

SamplingSettingsResponse

Percentage double: Rate of sampling for fixed-rate sampling.
SamplingType string: Sampling type.

Percentage float64: Rate of sampling for fixed-rate sampling.
SamplingType string: Sampling type.

percentage Double: Rate of sampling for fixed-rate sampling.
samplingType String: Sampling type.

percentage number: Rate of sampling for fixed-rate sampling.
samplingType string: Sampling type.

percentage float: Rate of sampling for fixed-rate sampling.
sampling_type str: Sampling type.

percentage Number: Rate of sampling for fixed-rate sampling.
samplingType String: Sampling type.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0