Azure Native

v1.80.0 published on Tuesday, Oct 4, 2022 by Pulumi

ApiDiagnostic

Diagnostic details. API Version: 2020-12-01.

Example Usage

ApiManagementCreateApiDiagnostic

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var apiDiagnostic = new AzureNative.ApiManagement.ApiDiagnostic("apiDiagnostic", new()
    {
        AlwaysLog = "allErrors",
        ApiId = "57d1f7558aa04f15146d9d8a",
        Backend = new AzureNative.ApiManagement.Inputs.PipelineDiagnosticSettingsArgs
        {
            Request = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
            {
                Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
                {
                    Bytes = 512,
                },
                Headers = new[]
                {
                    "Content-type",
                },
            },
            Response = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
            {
                Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
                {
                    Bytes = 512,
                },
                Headers = new[]
                {
                    "Content-type",
                },
            },
        },
        DiagnosticId = "applicationinsights",
        Frontend = new AzureNative.ApiManagement.Inputs.PipelineDiagnosticSettingsArgs
        {
            Request = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
            {
                Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
                {
                    Bytes = 512,
                },
                Headers = new[]
                {
                    "Content-type",
                },
            },
            Response = new AzureNative.ApiManagement.Inputs.HttpMessageDiagnosticArgs
            {
                Body = new AzureNative.ApiManagement.Inputs.BodyDiagnosticSettingsArgs
                {
                    Bytes = 512,
                },
                Headers = new[]
                {
                    "Content-type",
                },
            },
        },
        LoggerId = "/loggers/applicationinsights",
        ResourceGroupName = "rg1",
        Sampling = new AzureNative.ApiManagement.Inputs.SamplingSettingsArgs
        {
            Percentage = 50,
            SamplingType = "fixed",
        },
        ServiceName = "apimService1",
    });

});
package main

import (
	apimanagement "github.com/pulumi/pulumi-azure-native/sdk/go/azure/apimanagement"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewApiDiagnostic(ctx, "apiDiagnostic", &apimanagement.ApiDiagnosticArgs{
			AlwaysLog: pulumi.String("allErrors"),
			ApiId:     pulumi.String("57d1f7558aa04f15146d9d8a"),
			Backend: &apimanagement.PipelineDiagnosticSettingsArgs{
				Request: &apimanagement.HttpMessageDiagnosticArgs{
					Body: &apimanagement.BodyDiagnosticSettingsArgs{
						Bytes: pulumi.Int(512),
					},
					Headers: pulumi.StringArray{
						pulumi.String("Content-type"),
					},
				},
				Response: &apimanagement.HttpMessageDiagnosticArgs{
					Body: &apimanagement.BodyDiagnosticSettingsArgs{
						Bytes: pulumi.Int(512),
					},
					Headers: pulumi.StringArray{
						pulumi.String("Content-type"),
					},
				},
			},
			DiagnosticId: pulumi.String("applicationinsights"),
			Frontend: &apimanagement.PipelineDiagnosticSettingsArgs{
				Request: &apimanagement.HttpMessageDiagnosticArgs{
					Body: &apimanagement.BodyDiagnosticSettingsArgs{
						Bytes: pulumi.Int(512),
					},
					Headers: pulumi.StringArray{
						pulumi.String("Content-type"),
					},
				},
				Response: &apimanagement.HttpMessageDiagnosticArgs{
					Body: &apimanagement.BodyDiagnosticSettingsArgs{
						Bytes: pulumi.Int(512),
					},
					Headers: pulumi.StringArray{
						pulumi.String("Content-type"),
					},
				},
			},
			LoggerId:          pulumi.String("/loggers/applicationinsights"),
			ResourceGroupName: pulumi.String("rg1"),
			Sampling: &apimanagement.SamplingSettingsArgs{
				Percentage:   pulumi.Float64(50),
				SamplingType: pulumi.String("fixed"),
			},
			ServiceName: pulumi.String("apimService1"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.ApiDiagnostic;
import com.pulumi.azurenative.apimanagement.ApiDiagnosticArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var apiDiagnostic = new ApiDiagnostic("apiDiagnostic", ApiDiagnosticArgs.builder()        
            .alwaysLog("allErrors")
            .apiId("57d1f7558aa04f15146d9d8a")
            .backend(Map.ofEntries(
                Map.entry("request", Map.ofEntries(
                    Map.entry("body", Map.of("bytes", 512)),
                    Map.entry("headers", "Content-type")
                )),
                Map.entry("response", Map.ofEntries(
                    Map.entry("body", Map.of("bytes", 512)),
                    Map.entry("headers", "Content-type")
                ))
            ))
            .diagnosticId("applicationinsights")
            .frontend(Map.ofEntries(
                Map.entry("request", Map.ofEntries(
                    Map.entry("body", Map.of("bytes", 512)),
                    Map.entry("headers", "Content-type")
                )),
                Map.entry("response", Map.ofEntries(
                    Map.entry("body", Map.of("bytes", 512)),
                    Map.entry("headers", "Content-type")
                ))
            ))
            .loggerId("/loggers/applicationinsights")
            .resourceGroupName("rg1")
            .sampling(Map.ofEntries(
                Map.entry("percentage", 50),
                Map.entry("samplingType", "fixed")
            ))
            .serviceName("apimService1")
            .build());

    }
}
import pulumi
import pulumi_azure_native as azure_native

api_diagnostic = azure_native.apimanagement.ApiDiagnostic("apiDiagnostic",
    always_log="allErrors",
    api_id="57d1f7558aa04f15146d9d8a",
    backend=azure_native.apimanagement.PipelineDiagnosticSettingsArgs(
        request=azure_native.apimanagement.HttpMessageDiagnosticArgs(
            body=azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            headers=["Content-type"],
        ),
        response=azure_native.apimanagement.HttpMessageDiagnosticArgs(
            body=azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            headers=["Content-type"],
        ),
    ),
    diagnostic_id="applicationinsights",
    frontend=azure_native.apimanagement.PipelineDiagnosticSettingsArgs(
        request=azure_native.apimanagement.HttpMessageDiagnosticArgs(
            body=azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            headers=["Content-type"],
        ),
        response=azure_native.apimanagement.HttpMessageDiagnosticArgs(
            body=azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            headers=["Content-type"],
        ),
    ),
    logger_id="/loggers/applicationinsights",
    resource_group_name="rg1",
    sampling=azure_native.apimanagement.SamplingSettingsArgs(
        percentage=50,
        sampling_type="fixed",
    ),
    service_name="apimService1")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const apiDiagnostic = new azure_native.apimanagement.ApiDiagnostic("apiDiagnostic", {
    alwaysLog: "allErrors",
    apiId: "57d1f7558aa04f15146d9d8a",
    backend: {
        request: {
            body: {
                bytes: 512,
            },
            headers: ["Content-type"],
        },
        response: {
            body: {
                bytes: 512,
            },
            headers: ["Content-type"],
        },
    },
    diagnosticId: "applicationinsights",
    frontend: {
        request: {
            body: {
                bytes: 512,
            },
            headers: ["Content-type"],
        },
        response: {
            body: {
                bytes: 512,
            },
            headers: ["Content-type"],
        },
    },
    loggerId: "/loggers/applicationinsights",
    resourceGroupName: "rg1",
    sampling: {
        percentage: 50,
        samplingType: "fixed",
    },
    serviceName: "apimService1",
});
resources:
  apiDiagnostic:
    type: azure-native:apimanagement:ApiDiagnostic
    properties:
      alwaysLog: allErrors
      apiId: 57d1f7558aa04f15146d9d8a
      backend:
        request:
          body:
            bytes: 512
          headers:
            - Content-type
        response:
          body:
            bytes: 512
          headers:
            - Content-type
      diagnosticId: applicationinsights
      frontend:
        request:
          body:
            bytes: 512
          headers:
            - Content-type
        response:
          body:
            bytes: 512
          headers:
            - Content-type
      loggerId: /loggers/applicationinsights
      resourceGroupName: rg1
      sampling:
        percentage: 50
        samplingType: fixed
      serviceName: apimService1

Create a ApiDiagnostic Resource

new ApiDiagnostic(name: string, args: ApiDiagnosticArgs, opts?: CustomResourceOptions);
@overload
def ApiDiagnostic(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  always_log: Optional[Union[str, AlwaysLog]] = None,
                  api_id: Optional[str] = None,
                  backend: Optional[PipelineDiagnosticSettingsArgs] = None,
                  diagnostic_id: Optional[str] = None,
                  frontend: Optional[PipelineDiagnosticSettingsArgs] = None,
                  http_correlation_protocol: Optional[Union[str, HttpCorrelationProtocol]] = None,
                  log_client_ip: Optional[bool] = None,
                  logger_id: Optional[str] = None,
                  metrics: Optional[bool] = None,
                  operation_name_format: Optional[Union[str, OperationNameFormat]] = None,
                  resource_group_name: Optional[str] = None,
                  sampling: Optional[SamplingSettingsArgs] = None,
                  service_name: Optional[str] = None,
                  verbosity: Optional[Union[str, Verbosity]] = None)
@overload
def ApiDiagnostic(resource_name: str,
                  args: ApiDiagnosticArgs,
                  opts: Optional[ResourceOptions] = None)
func NewApiDiagnostic(ctx *Context, name string, args ApiDiagnosticArgs, opts ...ResourceOption) (*ApiDiagnostic, error)
public ApiDiagnostic(string name, ApiDiagnosticArgs args, CustomResourceOptions? opts = null)
public ApiDiagnostic(String name, ApiDiagnosticArgs args)
public ApiDiagnostic(String name, ApiDiagnosticArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:ApiDiagnostic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args ApiDiagnosticArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args ApiDiagnosticArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args ApiDiagnosticArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args ApiDiagnosticArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args ApiDiagnosticArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

ApiDiagnostic Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ApiDiagnostic resource accepts the following input properties:

ApiId string

API identifier. Must be unique in the current API Management service instance.

LoggerId string

Resource Id of a target logger.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

AlwaysLog string | Pulumi.AzureNative.ApiManagement.AlwaysLog

Specifies for what type of messages sampling settings should not apply.

Backend Pulumi.AzureNative.ApiManagement.Inputs.PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

DiagnosticId string

Diagnostic identifier. Must be unique in the current API Management service instance.

Frontend Pulumi.AzureNative.ApiManagement.Inputs.PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

HttpCorrelationProtocol string | Pulumi.AzureNative.ApiManagement.HttpCorrelationProtocol

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 | Pulumi.AzureNative.ApiManagement.OperationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

Sampling Pulumi.AzureNative.ApiManagement.Inputs.SamplingSettingsArgs

Sampling settings for Diagnostic.

Verbosity string | Pulumi.AzureNative.ApiManagement.Verbosity

The verbosity level applied to traces emitted by trace policies.

ApiId string

API identifier. Must be unique in the current API Management service instance.

LoggerId string

Resource Id of a target logger.

ResourceGroupName string

The name of the resource group.

ServiceName string

The name of the API Management service.

AlwaysLog string | AlwaysLog

Specifies for what type of messages sampling settings should not apply.

Backend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

DiagnosticId string

Diagnostic identifier. Must be unique in the current API Management service instance.

Frontend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

HttpCorrelationProtocol string | HttpCorrelationProtocol

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 | OperationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

Sampling SamplingSettingsArgs

Sampling settings for Diagnostic.

Verbosity string | Verbosity

The verbosity level applied to traces emitted by trace policies.

apiId String

API identifier. Must be unique in the current API Management service instance.

loggerId String

Resource Id of a target logger.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

alwaysLog String | AlwaysLog

Specifies for what type of messages sampling settings should not apply.

backend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

diagnosticId String

Diagnostic identifier. Must be unique in the current API Management service instance.

frontend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

httpCorrelationProtocol String | HttpCorrelationProtocol

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 | OperationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

sampling SamplingSettingsArgs

Sampling settings for Diagnostic.

verbosity String | Verbosity

The verbosity level applied to traces emitted by trace policies.

apiId string

API identifier. Must be unique in the current API Management service instance.

loggerId string

Resource Id of a target logger.

resourceGroupName string

The name of the resource group.

serviceName string

The name of the API Management service.

alwaysLog string | AlwaysLog

Specifies for what type of messages sampling settings should not apply.

backend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

diagnosticId string

Diagnostic identifier. Must be unique in the current API Management service instance.

frontend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

httpCorrelationProtocol string | HttpCorrelationProtocol

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 | OperationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

sampling SamplingSettingsArgs

Sampling settings for Diagnostic.

verbosity string | Verbosity

The verbosity level applied to traces emitted by trace policies.

api_id str

API identifier. Must be unique in the current API Management service instance.

logger_id str

Resource Id of a target logger.

resource_group_name str

The name of the resource group.

service_name str

The name of the API Management service.

always_log str | AlwaysLog

Specifies for what type of messages sampling settings should not apply.

backend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

diagnostic_id str

Diagnostic identifier. Must be unique in the current API Management service instance.

frontend PipelineDiagnosticSettingsArgs

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

http_correlation_protocol str | HttpCorrelationProtocol

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 | OperationNameFormat

The format of the Operation Name for Application Insights telemetries. Default is Name.

sampling SamplingSettingsArgs

Sampling settings for Diagnostic.

verbosity str | Verbosity

The verbosity level applied to traces emitted by trace policies.

apiId String

API identifier. Must be unique in the current API Management service instance.

loggerId String

Resource Id of a target logger.

resourceGroupName String

The name of the resource group.

serviceName String

The name of the API Management service.

alwaysLog String | "allErrors"

Specifies for what type of messages sampling settings should not apply.

backend Property Map

Diagnostic settings for incoming/outgoing HTTP messages to the Backend

diagnosticId String

Diagnostic identifier. Must be unique in the current API Management service instance.

frontend Property Map

Diagnostic settings for incoming/outgoing HTTP messages to the Gateway.

httpCorrelationProtocol String | "None" | "Legacy" | "W3C"

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 | "Name" | "Url"

The format of the Operation Name for Application Insights telemetries. Default is Name.

sampling Property Map

Sampling settings for Diagnostic.

verbosity String | "verbose" | "information" | "error"

The verbosity level applied to traces emitted by trace policies.

Outputs

All input properties are implicitly available as output properties. Additionally, the ApiDiagnostic resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

Id string

The provider-assigned unique ID for this managed resource.

Name string

Resource name.

Type string

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

id string

The provider-assigned unique ID for this managed resource.

name string

Resource name.

type string

Resource type for API Management resource.

id str

The provider-assigned unique ID for this managed resource.

name str

Resource name.

type str

Resource type for API Management resource.

id String

The provider-assigned unique ID for this managed resource.

name String

Resource name.

type String

Resource type for API Management resource.

Supporting Types

AlwaysLog

AllErrors
allErrors

Always log all erroneous request regardless of sampling settings.

AlwaysLogAllErrors
allErrors

Always log all erroneous request regardless of sampling settings.

AllErrors
allErrors

Always log all erroneous request regardless of sampling settings.

AllErrors
allErrors

Always log all erroneous request regardless of sampling settings.

ALL_ERRORS
allErrors

Always log all erroneous request regardless of sampling settings.

"allErrors"
allErrors

Always log all erroneous request regardless of sampling settings.

BodyDiagnosticSettings

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.

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.

DataMasking

Headers []DataMaskingEntity

Masking settings for headers

QueryParams []DataMaskingEntity

Masking settings for Url query parameters

headers List<DataMaskingEntity>

Masking settings for headers

queryParams List<DataMaskingEntity>

Masking settings for Url query parameters

headers DataMaskingEntity[]

Masking settings for headers

queryParams DataMaskingEntity[]

Masking settings for Url query parameters

headers Sequence[DataMaskingEntity]

Masking settings for headers

query_params Sequence[DataMaskingEntity]

Masking settings for Url query parameters

headers List<Property Map>

Masking settings for headers

queryParams List<Property Map>

Masking settings for Url query parameters

DataMaskingEntity

Mode string | Pulumi.AzureNative.ApiManagement.DataMaskingMode

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 | DataMaskingMode

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 | DataMaskingMode

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 | DataMaskingMode

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 | DataMaskingMode

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 | "Mask" | "Hide"

Data masking mode.

value String

The name of an entity to mask (e.g. a name of a header or a query parameter).

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).

DataMaskingMode

Mask
Mask

Mask the value of an entity.

Hide
Hide

Hide the presence of an entity.

DataMaskingModeMask
Mask

Mask the value of an entity.

DataMaskingModeHide
Hide

Hide the presence of an entity.

Mask
Mask

Mask the value of an entity.

Hide
Hide

Hide the presence of an entity.

Mask
Mask

Mask the value of an entity.

Hide
Hide

Hide the presence of an entity.

MASK
Mask

Mask the value of an entity.

HIDE
Hide

Hide the presence of an entity.

"Mask"
Mask

Mask the value of an entity.

"Hide"
Hide

Hide the presence of an entity.

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

HttpCorrelationProtocol

None
None

Do not read and inject correlation headers.

Legacy
Legacy

Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

W3C
W3C

Inject Trace Context headers. See https://w3c.github.io/trace-context.

HttpCorrelationProtocolNone
None

Do not read and inject correlation headers.

HttpCorrelationProtocolLegacy
Legacy

Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

HttpCorrelationProtocolW3C
W3C

Inject Trace Context headers. See https://w3c.github.io/trace-context.

None
None

Do not read and inject correlation headers.

Legacy
Legacy

Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

W3C
W3C

Inject Trace Context headers. See https://w3c.github.io/trace-context.

None
None

Do not read and inject correlation headers.

Legacy
Legacy

Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

W3C
W3C

Inject Trace Context headers. See https://w3c.github.io/trace-context.

NONE
None

Do not read and inject correlation headers.

LEGACY
Legacy

Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

W3_C
W3C

Inject Trace Context headers. See https://w3c.github.io/trace-context.

"None"
None

Do not read and inject correlation headers.

"Legacy"
Legacy

Inject Request-Id and Request-Context headers with request correlation data. See https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

"W3C"
W3C

Inject Trace Context headers. See https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Body BodyDiagnosticSettings

Body logging settings.

DataMasking DataMasking

Data masking settings.

Headers []string

Array of HTTP Headers to log.

body BodyDiagnosticSettings

Body logging settings.

dataMasking DataMasking

Data masking settings.

headers List<String>

Array of HTTP Headers to log.

body BodyDiagnosticSettings

Body logging settings.

dataMasking DataMasking

Data masking settings.

headers string[]

Array of HTTP Headers to log.

body BodyDiagnosticSettings

Body logging settings.

data_masking DataMasking

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.

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.

OperationNameFormat

Name
Name

API_NAME;rev=API_REVISION - OPERATION_NAME

Url
Url

HTTP_VERB URL

OperationNameFormatName
Name

API_NAME;rev=API_REVISION - OPERATION_NAME

OperationNameFormatUrl
Url

HTTP_VERB URL

Name
Name

API_NAME;rev=API_REVISION - OPERATION_NAME

Url
Url

HTTP_VERB URL

Name
Name

API_NAME;rev=API_REVISION - OPERATION_NAME

Url
Url

HTTP_VERB URL

NAME
Name

API_NAME;rev=API_REVISION - OPERATION_NAME

URL
Url

HTTP_VERB URL

"Name"
Name

API_NAME;rev=API_REVISION - OPERATION_NAME

"Url"
Url

HTTP_VERB URL

PipelineDiagnosticSettings

Request HttpMessageDiagnostic

Diagnostic settings for request.

Response HttpMessageDiagnostic

Diagnostic settings for response.

request HttpMessageDiagnostic

Diagnostic settings for request.

response HttpMessageDiagnostic

Diagnostic settings for response.

request HttpMessageDiagnostic

Diagnostic settings for request.

response HttpMessageDiagnostic

Diagnostic settings for response.

request HttpMessageDiagnostic

Diagnostic settings for request.

response HttpMessageDiagnostic

Diagnostic settings for response.

request Property Map

Diagnostic settings for request.

response Property Map

Diagnostic settings for response.

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.

SamplingSettings

Percentage double

Rate of sampling for fixed-rate sampling.

SamplingType string | Pulumi.AzureNative.ApiManagement.SamplingType

Sampling type.

Percentage float64

Rate of sampling for fixed-rate sampling.

SamplingType string | SamplingType

Sampling type.

percentage Double

Rate of sampling for fixed-rate sampling.

samplingType String | SamplingType

Sampling type.

percentage number

Rate of sampling for fixed-rate sampling.

samplingType string | SamplingType

Sampling type.

percentage float

Rate of sampling for fixed-rate sampling.

sampling_type str | SamplingType

Sampling type.

percentage Number

Rate of sampling for fixed-rate sampling.

samplingType String | "fixed"

Sampling type.

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.

SamplingType

@Fixed
fixed

Fixed-rate sampling.

SamplingTypeFixed
fixed

Fixed-rate sampling.

Fixed
fixed

Fixed-rate sampling.

Fixed
fixed

Fixed-rate sampling.

FIXED
fixed

Fixed-rate sampling.

"fixed"
fixed

Fixed-rate sampling.

Verbosity

Verbose
verbose

All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

Information
information

Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.

Error
error

Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

VerbosityVerbose
verbose

All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

VerbosityInformation
information

Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.

VerbosityError
error

Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

Verbose
verbose

All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

Information
information

Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.

Error
error

Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

Verbose
verbose

All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

Information
information

Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.

Error
error

Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

VERBOSE
verbose

All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

INFORMATION
information

Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.

ERROR
error

Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

"verbose"
verbose

All the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.

"information"
information

Traces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.

"error"
error

Only traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:apimanagement:ApiDiagnostic applicationinsights /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/diagnostics/applicationinsights 

Package Details

Repository
https://github.com/pulumi/pulumi-azure-native
License
Apache-2.0