Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. getDiagnostic
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.apimanagement.getDiagnostic

Explore with Pulumi AI

These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

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

Using getDiagnostic

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 getDiagnostic(args: GetDiagnosticArgs, opts?: InvokeOptions): Promise<GetDiagnosticResult>
function getDiagnosticOutput(args: GetDiagnosticOutputArgs, opts?: InvokeOptions): Output<GetDiagnosticResult>
Copy
def get_diagnostic(diagnostic_id: Optional[str] = None,
                   resource_group_name: Optional[str] = None,
                   service_name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDiagnosticResult
def get_diagnostic_output(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[GetDiagnosticResult]
Copy
func LookupDiagnostic(ctx *Context, args *LookupDiagnosticArgs, opts ...InvokeOption) (*LookupDiagnosticResult, error)
func LookupDiagnosticOutput(ctx *Context, args *LookupDiagnosticOutputArgs, opts ...InvokeOption) LookupDiagnosticResultOutput
Copy

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

public static class GetDiagnostic 
{
    public static Task<GetDiagnosticResult> InvokeAsync(GetDiagnosticArgs args, InvokeOptions? opts = null)
    public static Output<GetDiagnosticResult> Invoke(GetDiagnosticInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetDiagnosticResult> getDiagnostic(GetDiagnosticArgs args, InvokeOptions options)
public static Output<GetDiagnosticResult> getDiagnostic(GetDiagnosticArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getDiagnostic
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DiagnosticId
This property is required.
Changes to this property will trigger replacement.
string
Diagnostic identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
DiagnosticId
This property is required.
Changes to this property will trigger replacement.
string
Diagnostic identifier. Must be unique in the current API Management service instance.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
diagnosticId
This property is required.
Changes to this property will trigger replacement.
String
Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
diagnosticId
This property is required.
Changes to this property will trigger replacement.
string
Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
diagnostic_id
This property is required.
Changes to this property will trigger replacement.
str
Diagnostic identifier. Must be unique in the current API Management service instance.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
diagnosticId
This property is required.
Changes to this property will trigger replacement.
String
Diagnostic identifier. Must be unique in the current API Management service instance.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getDiagnostic 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 []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 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 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-v1 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native