Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. apimanagement
  5. ApiDiagnostic
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.ApiDiagnostic

Explore with Pulumi AI

azure-native-v1 logo
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

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

    Example Usage

    ApiManagementCreateApiDiagnostic

    using System.Collections.Generic;
using System.Linq;
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",
    });

});

    Coming soon!

    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.PipelineDiagnosticSettingsResponseArgs(
        request={
            "body": azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            "headers": ["Content-type"],
        },
        response={
            "body": azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            "headers": ["Content-type"],
        },
    ),
    diagnostic_id="applicationinsights",
    frontend=azure_native.apimanagement.PipelineDiagnosticSettingsResponseArgs(
        request={
            "body": azure_native.apimanagement.BodyDiagnosticSettingsArgs(
                bytes=512,
            ),
            "headers": ["Content-type"],
        },
        response={
            "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 ApiDiagnostic Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiDiagnostic(name: string, args: ApiDiagnosticArgs, opts?: CustomResourceOptions);
    @overload
def ApiDiagnostic(resource_name: str,
                  args: ApiDiagnosticArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def ApiDiagnostic(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  logger_id: Optional[str] = None,
                  api_id: Optional[str] = None,
                  service_name: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  log_client_ip: Optional[bool] = None,
                  http_correlation_protocol: Optional[Union[str, HttpCorrelationProtocol]] = None,
                  always_log: Optional[Union[str, AlwaysLog]] = None,
                  frontend: Optional[PipelineDiagnosticSettingsArgs] = None,
                  metrics: Optional[bool] = None,
                  operation_name_format: Optional[Union[str, OperationNameFormat]] = None,
                  diagnostic_id: Optional[str] = None,
                  sampling: Optional[SamplingSettingsArgs] = None,
                  backend: Optional[PipelineDiagnosticSettingsArgs] = None,
                  verbosity: Optional[Union[str, Verbosity]] = 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.

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var apiDiagnosticResource = new AzureNative.Apimanagement.ApiDiagnostic("apiDiagnosticResource", new()
{
    LoggerId = "string",
    ApiId = "string",
    ServiceName = "string",
    ResourceGroupName = "string",
    LogClientIp = false,
    HttpCorrelationProtocol = "string",
    AlwaysLog = "string",
    Frontend = 
    {
        { "request", 
        {
            { "body", 
            {
                { "bytes", 0 },
            } },
            { "dataMasking", 
            {
                { "headers", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
                { "queryParams", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
            } },
            { "headers", new[]
            {
                "string",
            } },
        } },
        { "response", 
        {
            { "body", 
            {
                { "bytes", 0 },
            } },
            { "dataMasking", 
            {
                { "headers", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
                { "queryParams", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
            } },
            { "headers", new[]
            {
                "string",
            } },
        } },
    },
    Metrics = false,
    OperationNameFormat = "string",
    DiagnosticId = "string",
    Sampling = 
    {
        { "percentage", 0 },
        { "samplingType", "string" },
    },
    Backend = 
    {
        { "request", 
        {
            { "body", 
            {
                { "bytes", 0 },
            } },
            { "dataMasking", 
            {
                { "headers", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
                { "queryParams", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
            } },
            { "headers", new[]
            {
                "string",
            } },
        } },
        { "response", 
        {
            { "body", 
            {
                { "bytes", 0 },
            } },
            { "dataMasking", 
            {
                { "headers", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
                { "queryParams", new[]
                {
                    
                    {
                        { "mode", "string" },
                        { "value", "string" },
                    },
                } },
            } },
            { "headers", new[]
            {
                "string",
            } },
        } },
    },
    Verbosity = "string",
});

    example, err := apimanagement.NewApiDiagnostic(ctx, "apiDiagnosticResource", &apimanagement.ApiDiagnosticArgs{
	LoggerId:                "string",
	ApiId:                   "string",
	ServiceName:             "string",
	ResourceGroupName:       "string",
	LogClientIp:             false,
	HttpCorrelationProtocol: "string",
	AlwaysLog:               "string",
	Frontend: map[string]interface{}{
		"request": map[string]interface{}{
			"body": map[string]interface{}{
				"bytes": 0,
			},
			"dataMasking": map[string]interface{}{
				"headers": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
				"queryParams": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
			},
			"headers": []string{
				"string",
			},
		},
		"response": map[string]interface{}{
			"body": map[string]interface{}{
				"bytes": 0,
			},
			"dataMasking": map[string]interface{}{
				"headers": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
				"queryParams": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
			},
			"headers": []string{
				"string",
			},
		},
	},
	Metrics:             false,
	OperationNameFormat: "string",
	DiagnosticId:        "string",
	Sampling: map[string]interface{}{
		"percentage":   0,
		"samplingType": "string",
	},
	Backend: map[string]interface{}{
		"request": map[string]interface{}{
			"body": map[string]interface{}{
				"bytes": 0,
			},
			"dataMasking": map[string]interface{}{
				"headers": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
				"queryParams": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
			},
			"headers": []string{
				"string",
			},
		},
		"response": map[string]interface{}{
			"body": map[string]interface{}{
				"bytes": 0,
			},
			"dataMasking": map[string]interface{}{
				"headers": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
				"queryParams": []map[string]interface{}{
					map[string]interface{}{
						"mode":  "string",
						"value": "string",
					},
				},
			},
			"headers": []string{
				"string",
			},
		},
	},
	Verbosity: "string",
})

    var apiDiagnosticResource = new ApiDiagnostic("apiDiagnosticResource", ApiDiagnosticArgs.builder()
    .loggerId("string")
    .apiId("string")
    .serviceName("string")
    .resourceGroupName("string")
    .logClientIp(false)
    .httpCorrelationProtocol("string")
    .alwaysLog("string")
    .frontend(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .metrics(false)
    .operationNameFormat("string")
    .diagnosticId("string")
    .sampling(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .backend(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
    .verbosity("string")
    .build());

    api_diagnostic_resource = azure_native.apimanagement.ApiDiagnostic("apiDiagnosticResource",
    logger_id=string,
    api_id=string,
    service_name=string,
    resource_group_name=string,
    log_client_ip=False,
    http_correlation_protocol=string,
    always_log=string,
    frontend={
        request: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: string,
                    value: string,
                }],
                queryParams: [{
                    mode: string,
                    value: string,
                }],
            },
            headers: [string],
        },
        response: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: string,
                    value: string,
                }],
                queryParams: [{
                    mode: string,
                    value: string,
                }],
            },
            headers: [string],
        },
    },
    metrics=False,
    operation_name_format=string,
    diagnostic_id=string,
    sampling={
        percentage: 0,
        samplingType: string,
    },
    backend={
        request: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: string,
                    value: string,
                }],
                queryParams: [{
                    mode: string,
                    value: string,
                }],
            },
            headers: [string],
        },
        response: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: string,
                    value: string,
                }],
                queryParams: [{
                    mode: string,
                    value: string,
                }],
            },
            headers: [string],
        },
    },
    verbosity=string)

    const apiDiagnosticResource = new azure_native.apimanagement.ApiDiagnostic("apiDiagnosticResource", {
    loggerId: "string",
    apiId: "string",
    serviceName: "string",
    resourceGroupName: "string",
    logClientIp: false,
    httpCorrelationProtocol: "string",
    alwaysLog: "string",
    frontend: {
        request: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: "string",
                    value: "string",
                }],
                queryParams: [{
                    mode: "string",
                    value: "string",
                }],
            },
            headers: ["string"],
        },
        response: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: "string",
                    value: "string",
                }],
                queryParams: [{
                    mode: "string",
                    value: "string",
                }],
            },
            headers: ["string"],
        },
    },
    metrics: false,
    operationNameFormat: "string",
    diagnosticId: "string",
    sampling: {
        percentage: 0,
        samplingType: "string",
    },
    backend: {
        request: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: "string",
                    value: "string",
                }],
                queryParams: [{
                    mode: "string",
                    value: "string",
                }],
            },
            headers: ["string"],
        },
        response: {
            body: {
                bytes: 0,
            },
            dataMasking: {
                headers: [{
                    mode: "string",
                    value: "string",
                }],
                queryParams: [{
                    mode: "string",
                    value: "string",
                }],
            },
            headers: ["string"],
        },
    },
    verbosity: "string",
});

    type: azure-native:apimanagement:ApiDiagnostic
properties:
    alwaysLog: string
    apiId: string
    backend:
        request:
            body:
                bytes: 0
            dataMasking:
                headers:
                    - mode: string
                      value: string
                queryParams:
                    - mode: string
                      value: string
            headers:
                - string
        response:
            body:
                bytes: 0
            dataMasking:
                headers:
                    - mode: string
                      value: string
                queryParams:
                    - mode: string
                      value: string
            headers:
                - string
    diagnosticId: string
    frontend:
        request:
            body:
                bytes: 0
            dataMasking:
                headers:
                    - mode: string
                      value: string
                queryParams:
                    - mode: string
                      value: string
            headers:
                - string
        response:
            body:
                bytes: 0
            dataMasking:
                headers:
                    - mode: string
                      value: string
                queryParams:
                    - mode: string
                      value: string
            headers:
                - string
    httpCorrelationProtocol: string
    logClientIp: false
    loggerId: string
    metrics: false
    operationNameFormat: string
    resourceGroupName: string
    sampling:
        percentage: 0
        samplingType: string
    serviceName: string
    verbosity: string

    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

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    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.PipelineDiagnosticSettings
    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.PipelineDiagnosticSettings
    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.SamplingSettings
    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 PipelineDiagnosticSettings
    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 PipelineDiagnosticSettings
    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 SamplingSettings
    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 PipelineDiagnosticSettings
    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 PipelineDiagnosticSettings
    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 SamplingSettings
    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, AlwaysLogArgs

    AllErrors
    allErrorsAlways log all erroneous request regardless of sampling settings.
    AlwaysLogAllErrors
    allErrorsAlways log all erroneous request regardless of sampling settings.
    AllErrors
    allErrorsAlways log all erroneous request regardless of sampling settings.
    AllErrors
    allErrorsAlways log all erroneous request regardless of sampling settings.
    ALL_ERRORS
    allErrorsAlways log all erroneous request regardless of sampling settings.
    "allErrors"
    allErrorsAlways log all erroneous request regardless of sampling settings.

    BodyDiagnosticSettings, BodyDiagnosticSettingsArgs

    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, BodyDiagnosticSettingsResponseArgs

    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, DataMaskingArgs

    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, DataMaskingEntityArgs

    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, DataMaskingEntityResponseArgs

    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, DataMaskingModeArgs

    Mask
    MaskMask the value of an entity.
    Hide
    HideHide the presence of an entity.
    DataMaskingModeMask
    MaskMask the value of an entity.
    DataMaskingModeHide
    HideHide the presence of an entity.
    Mask
    MaskMask the value of an entity.
    Hide
    HideHide the presence of an entity.
    Mask
    MaskMask the value of an entity.
    Hide
    HideHide the presence of an entity.
    MASK
    MaskMask the value of an entity.
    HIDE
    HideHide the presence of an entity.
    "Mask"
    MaskMask the value of an entity.
    "Hide"
    HideHide the presence of an entity.

    DataMaskingResponse, DataMaskingResponseArgs

    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, HttpCorrelationProtocolArgs

    None
    NoneDo not read and inject correlation headers.
    Legacy
    LegacyInject 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
    W3CInject Trace Context headers. See https://w3c.github.io/trace-context.
    HttpCorrelationProtocolNone
    NoneDo not read and inject correlation headers.
    HttpCorrelationProtocolLegacy
    LegacyInject 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
    W3CInject Trace Context headers. See https://w3c.github.io/trace-context.
    None
    NoneDo not read and inject correlation headers.
    Legacy
    LegacyInject 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
    W3CInject Trace Context headers. See https://w3c.github.io/trace-context.
    None
    NoneDo not read and inject correlation headers.
    Legacy
    LegacyInject 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
    W3CInject Trace Context headers. See https://w3c.github.io/trace-context.
    NONE
    NoneDo not read and inject correlation headers.
    LEGACY
    LegacyInject 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
    W3CInject Trace Context headers. See https://w3c.github.io/trace-context.
    "None"
    NoneDo not read and inject correlation headers.
    "Legacy"
    LegacyInject 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"
    W3CInject Trace Context headers. See https://w3c.github.io/trace-context.

    HttpMessageDiagnostic, HttpMessageDiagnosticArgs

    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, HttpMessageDiagnosticResponseArgs

    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, OperationNameFormatArgs

    Name
    NameAPI_NAME;rev=API_REVISION - OPERATION_NAME
    Url
    UrlHTTP_VERB URL
    OperationNameFormatName
    NameAPI_NAME;rev=API_REVISION - OPERATION_NAME
    OperationNameFormatUrl
    UrlHTTP_VERB URL
    Name
    NameAPI_NAME;rev=API_REVISION - OPERATION_NAME
    Url
    UrlHTTP_VERB URL
    Name
    NameAPI_NAME;rev=API_REVISION - OPERATION_NAME
    Url
    UrlHTTP_VERB URL
    NAME
    NameAPI_NAME;rev=API_REVISION - OPERATION_NAME
    URL
    UrlHTTP_VERB URL
    "Name"
    NameAPI_NAME;rev=API_REVISION - OPERATION_NAME
    "Url"
    UrlHTTP_VERB URL

    PipelineDiagnosticSettings, PipelineDiagnosticSettingsArgs

    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, PipelineDiagnosticSettingsResponseArgs

    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, SamplingSettingsArgs

    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, SamplingSettingsResponseArgs

    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, SamplingTypeArgs

    @Fixed
    fixedFixed-rate sampling.
    SamplingTypeFixed
    fixedFixed-rate sampling.
    Fixed
    fixedFixed-rate sampling.
    Fixed
    fixedFixed-rate sampling.
    FIXED
    fixedFixed-rate sampling.
    "fixed"
    fixedFixed-rate sampling.

    Verbosity, VerbosityArgs

    Verbose
    verboseAll the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
    Information
    informationTraces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
    Error
    errorOnly traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
    VerbosityVerbose
    verboseAll the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
    VerbosityInformation
    informationTraces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
    VerbosityError
    errorOnly traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
    Verbose
    verboseAll the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
    Information
    informationTraces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
    Error
    errorOnly traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
    Verbose
    verboseAll the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
    Information
    informationTraces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
    Error
    errorOnly traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
    VERBOSE
    verboseAll the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
    INFORMATION
    informationTraces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
    ERROR
    errorOnly traces with 'severity' set to 'error' will be sent to the logger attached to this diagnostic instance.
    "verbose"
    verboseAll the traces emitted by trace policies will be sent to the logger attached to this diagnostic instance.
    "information"
    informationTraces with 'severity' set to 'information' and 'error' will be sent to the logger attached to this diagnostic instance.
    "error"
    errorOnly 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

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    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