1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. ApiDiagnostic

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

azure.apimanagement.ApiDiagnostic

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi

    Manages a API Management Service API Diagnostics Logs.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = new azure.core.ResourceGroup("example", {
        name: "example-resources",
        location: "West Europe",
    });
    const exampleInsights = new azure.appinsights.Insights("example", {
        name: "example-appinsights",
        location: example.location,
        resourceGroupName: example.name,
        applicationType: "web",
    });
    const exampleService = new azure.apimanagement.Service("example", {
        name: "example-apim",
        location: example.location,
        resourceGroupName: example.name,
        publisherName: "My Company",
        publisherEmail: "company@mycompany.io",
        skuName: "Developer_1",
    });
    const exampleApi = new azure.apimanagement.Api("example", {
        name: "example-api",
        resourceGroupName: example.name,
        apiManagementName: exampleService.name,
        revision: "1",
        displayName: "Example API",
        path: "example",
        protocols: ["https"],
        "import": {
            contentFormat: "swagger-link-json",
            contentValue: "http://conferenceapi.azurewebsites.net/?format=json",
        },
    });
    const exampleLogger = new azure.apimanagement.Logger("example", {
        name: "example-apimlogger",
        apiManagementName: exampleService.name,
        resourceGroupName: example.name,
        applicationInsights: {
            instrumentationKey: exampleInsights.instrumentationKey,
        },
    });
    const exampleApiDiagnostic = new azure.apimanagement.ApiDiagnostic("example", {
        identifier: "applicationinsights",
        resourceGroupName: example.name,
        apiManagementName: exampleService.name,
        apiName: exampleApi.name,
        apiManagementLoggerId: exampleLogger.id,
        samplingPercentage: 5,
        alwaysLogErrors: true,
        logClientIp: true,
        verbosity: "verbose",
        httpCorrelationProtocol: "W3C",
        frontendRequest: {
            bodyBytes: 32,
            headersToLogs: [
                "content-type",
                "accept",
                "origin",
            ],
        },
        frontendResponse: {
            bodyBytes: 32,
            headersToLogs: [
                "content-type",
                "content-length",
                "origin",
            ],
        },
        backendRequest: {
            bodyBytes: 32,
            headersToLogs: [
                "content-type",
                "accept",
                "origin",
            ],
        },
        backendResponse: {
            bodyBytes: 32,
            headersToLogs: [
                "content-type",
                "content-length",
                "origin",
            ],
        },
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.core.ResourceGroup("example",
        name="example-resources",
        location="West Europe")
    example_insights = azure.appinsights.Insights("example",
        name="example-appinsights",
        location=example.location,
        resource_group_name=example.name,
        application_type="web")
    example_service = azure.apimanagement.Service("example",
        name="example-apim",
        location=example.location,
        resource_group_name=example.name,
        publisher_name="My Company",
        publisher_email="company@mycompany.io",
        sku_name="Developer_1")
    example_api = azure.apimanagement.Api("example",
        name="example-api",
        resource_group_name=example.name,
        api_management_name=example_service.name,
        revision="1",
        display_name="Example API",
        path="example",
        protocols=["https"],
        import_=azure.apimanagement.ApiImportArgs(
            content_format="swagger-link-json",
            content_value="http://conferenceapi.azurewebsites.net/?format=json",
        ))
    example_logger = azure.apimanagement.Logger("example",
        name="example-apimlogger",
        api_management_name=example_service.name,
        resource_group_name=example.name,
        application_insights=azure.apimanagement.LoggerApplicationInsightsArgs(
            instrumentation_key=example_insights.instrumentation_key,
        ))
    example_api_diagnostic = azure.apimanagement.ApiDiagnostic("example",
        identifier="applicationinsights",
        resource_group_name=example.name,
        api_management_name=example_service.name,
        api_name=example_api.name,
        api_management_logger_id=example_logger.id,
        sampling_percentage=5,
        always_log_errors=True,
        log_client_ip=True,
        verbosity="verbose",
        http_correlation_protocol="W3C",
        frontend_request=azure.apimanagement.ApiDiagnosticFrontendRequestArgs(
            body_bytes=32,
            headers_to_logs=[
                "content-type",
                "accept",
                "origin",
            ],
        ),
        frontend_response=azure.apimanagement.ApiDiagnosticFrontendResponseArgs(
            body_bytes=32,
            headers_to_logs=[
                "content-type",
                "content-length",
                "origin",
            ],
        ),
        backend_request=azure.apimanagement.ApiDiagnosticBackendRequestArgs(
            body_bytes=32,
            headers_to_logs=[
                "content-type",
                "accept",
                "origin",
            ],
        ),
        backend_response=azure.apimanagement.ApiDiagnosticBackendResponseArgs(
            body_bytes=32,
            headers_to_logs=[
                "content-type",
                "content-length",
                "origin",
            ],
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/appinsights"
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := core.NewResourceGroup(ctx, "example", &core.ResourceGroupArgs{
    			Name:     pulumi.String("example-resources"),
    			Location: pulumi.String("West Europe"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleInsights, err := appinsights.NewInsights(ctx, "example", &appinsights.InsightsArgs{
    			Name:              pulumi.String("example-appinsights"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			ApplicationType:   pulumi.String("web"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleService, err := apimanagement.NewService(ctx, "example", &apimanagement.ServiceArgs{
    			Name:              pulumi.String("example-apim"),
    			Location:          example.Location,
    			ResourceGroupName: example.Name,
    			PublisherName:     pulumi.String("My Company"),
    			PublisherEmail:    pulumi.String("company@mycompany.io"),
    			SkuName:           pulumi.String("Developer_1"),
    		})
    		if err != nil {
    			return err
    		}
    		exampleApi, err := apimanagement.NewApi(ctx, "example", &apimanagement.ApiArgs{
    			Name:              pulumi.String("example-api"),
    			ResourceGroupName: example.Name,
    			ApiManagementName: exampleService.Name,
    			Revision:          pulumi.String("1"),
    			DisplayName:       pulumi.String("Example API"),
    			Path:              pulumi.String("example"),
    			Protocols: pulumi.StringArray{
    				pulumi.String("https"),
    			},
    			Import: &apimanagement.ApiImportArgs{
    				ContentFormat: pulumi.String("swagger-link-json"),
    				ContentValue:  pulumi.String("http://conferenceapi.azurewebsites.net/?format=json"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		exampleLogger, err := apimanagement.NewLogger(ctx, "example", &apimanagement.LoggerArgs{
    			Name:              pulumi.String("example-apimlogger"),
    			ApiManagementName: exampleService.Name,
    			ResourceGroupName: example.Name,
    			ApplicationInsights: &apimanagement.LoggerApplicationInsightsArgs{
    				InstrumentationKey: exampleInsights.InstrumentationKey,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewApiDiagnostic(ctx, "example", &apimanagement.ApiDiagnosticArgs{
    			Identifier:              pulumi.String("applicationinsights"),
    			ResourceGroupName:       example.Name,
    			ApiManagementName:       exampleService.Name,
    			ApiName:                 exampleApi.Name,
    			ApiManagementLoggerId:   exampleLogger.ID(),
    			SamplingPercentage:      pulumi.Float64(5),
    			AlwaysLogErrors:         pulumi.Bool(true),
    			LogClientIp:             pulumi.Bool(true),
    			Verbosity:               pulumi.String("verbose"),
    			HttpCorrelationProtocol: pulumi.String("W3C"),
    			FrontendRequest: &apimanagement.ApiDiagnosticFrontendRequestArgs{
    				BodyBytes: pulumi.Int(32),
    				HeadersToLogs: pulumi.StringArray{
    					pulumi.String("content-type"),
    					pulumi.String("accept"),
    					pulumi.String("origin"),
    				},
    			},
    			FrontendResponse: &apimanagement.ApiDiagnosticFrontendResponseArgs{
    				BodyBytes: pulumi.Int(32),
    				HeadersToLogs: pulumi.StringArray{
    					pulumi.String("content-type"),
    					pulumi.String("content-length"),
    					pulumi.String("origin"),
    				},
    			},
    			BackendRequest: &apimanagement.ApiDiagnosticBackendRequestArgs{
    				BodyBytes: pulumi.Int(32),
    				HeadersToLogs: pulumi.StringArray{
    					pulumi.String("content-type"),
    					pulumi.String("accept"),
    					pulumi.String("origin"),
    				},
    			},
    			BackendResponse: &apimanagement.ApiDiagnosticBackendResponseArgs{
    				BodyBytes: pulumi.Int(32),
    				HeadersToLogs: pulumi.StringArray{
    					pulumi.String("content-type"),
    					pulumi.String("content-length"),
    					pulumi.String("origin"),
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Azure.Core.ResourceGroup("example", new()
        {
            Name = "example-resources",
            Location = "West Europe",
        });
    
        var exampleInsights = new Azure.AppInsights.Insights("example", new()
        {
            Name = "example-appinsights",
            Location = example.Location,
            ResourceGroupName = example.Name,
            ApplicationType = "web",
        });
    
        var exampleService = new Azure.ApiManagement.Service("example", new()
        {
            Name = "example-apim",
            Location = example.Location,
            ResourceGroupName = example.Name,
            PublisherName = "My Company",
            PublisherEmail = "company@mycompany.io",
            SkuName = "Developer_1",
        });
    
        var exampleApi = new Azure.ApiManagement.Api("example", new()
        {
            Name = "example-api",
            ResourceGroupName = example.Name,
            ApiManagementName = exampleService.Name,
            Revision = "1",
            DisplayName = "Example API",
            Path = "example",
            Protocols = new[]
            {
                "https",
            },
            Import = new Azure.ApiManagement.Inputs.ApiImportArgs
            {
                ContentFormat = "swagger-link-json",
                ContentValue = "http://conferenceapi.azurewebsites.net/?format=json",
            },
        });
    
        var exampleLogger = new Azure.ApiManagement.Logger("example", new()
        {
            Name = "example-apimlogger",
            ApiManagementName = exampleService.Name,
            ResourceGroupName = example.Name,
            ApplicationInsights = new Azure.ApiManagement.Inputs.LoggerApplicationInsightsArgs
            {
                InstrumentationKey = exampleInsights.InstrumentationKey,
            },
        });
    
        var exampleApiDiagnostic = new Azure.ApiManagement.ApiDiagnostic("example", new()
        {
            Identifier = "applicationinsights",
            ResourceGroupName = example.Name,
            ApiManagementName = exampleService.Name,
            ApiName = exampleApi.Name,
            ApiManagementLoggerId = exampleLogger.Id,
            SamplingPercentage = 5,
            AlwaysLogErrors = true,
            LogClientIp = true,
            Verbosity = "verbose",
            HttpCorrelationProtocol = "W3C",
            FrontendRequest = new Azure.ApiManagement.Inputs.ApiDiagnosticFrontendRequestArgs
            {
                BodyBytes = 32,
                HeadersToLogs = new[]
                {
                    "content-type",
                    "accept",
                    "origin",
                },
            },
            FrontendResponse = new Azure.ApiManagement.Inputs.ApiDiagnosticFrontendResponseArgs
            {
                BodyBytes = 32,
                HeadersToLogs = new[]
                {
                    "content-type",
                    "content-length",
                    "origin",
                },
            },
            BackendRequest = new Azure.ApiManagement.Inputs.ApiDiagnosticBackendRequestArgs
            {
                BodyBytes = 32,
                HeadersToLogs = new[]
                {
                    "content-type",
                    "accept",
                    "origin",
                },
            },
            BackendResponse = new Azure.ApiManagement.Inputs.ApiDiagnosticBackendResponseArgs
            {
                BodyBytes = 32,
                HeadersToLogs = new[]
                {
                    "content-type",
                    "content-length",
                    "origin",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.core.ResourceGroup;
    import com.pulumi.azure.core.ResourceGroupArgs;
    import com.pulumi.azure.appinsights.Insights;
    import com.pulumi.azure.appinsights.InsightsArgs;
    import com.pulumi.azure.apimanagement.Service;
    import com.pulumi.azure.apimanagement.ServiceArgs;
    import com.pulumi.azure.apimanagement.Api;
    import com.pulumi.azure.apimanagement.ApiArgs;
    import com.pulumi.azure.apimanagement.inputs.ApiImportArgs;
    import com.pulumi.azure.apimanagement.Logger;
    import com.pulumi.azure.apimanagement.LoggerArgs;
    import com.pulumi.azure.apimanagement.inputs.LoggerApplicationInsightsArgs;
    import com.pulumi.azure.apimanagement.ApiDiagnostic;
    import com.pulumi.azure.apimanagement.ApiDiagnosticArgs;
    import com.pulumi.azure.apimanagement.inputs.ApiDiagnosticFrontendRequestArgs;
    import com.pulumi.azure.apimanagement.inputs.ApiDiagnosticFrontendResponseArgs;
    import com.pulumi.azure.apimanagement.inputs.ApiDiagnosticBackendRequestArgs;
    import com.pulumi.azure.apimanagement.inputs.ApiDiagnosticBackendResponseArgs;
    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 example = new ResourceGroup("example", ResourceGroupArgs.builder()        
                .name("example-resources")
                .location("West Europe")
                .build());
    
            var exampleInsights = new Insights("exampleInsights", InsightsArgs.builder()        
                .name("example-appinsights")
                .location(example.location())
                .resourceGroupName(example.name())
                .applicationType("web")
                .build());
    
            var exampleService = new Service("exampleService", ServiceArgs.builder()        
                .name("example-apim")
                .location(example.location())
                .resourceGroupName(example.name())
                .publisherName("My Company")
                .publisherEmail("company@mycompany.io")
                .skuName("Developer_1")
                .build());
    
            var exampleApi = new Api("exampleApi", ApiArgs.builder()        
                .name("example-api")
                .resourceGroupName(example.name())
                .apiManagementName(exampleService.name())
                .revision("1")
                .displayName("Example API")
                .path("example")
                .protocols("https")
                .import_(ApiImportArgs.builder()
                    .contentFormat("swagger-link-json")
                    .contentValue("http://conferenceapi.azurewebsites.net/?format=json")
                    .build())
                .build());
    
            var exampleLogger = new Logger("exampleLogger", LoggerArgs.builder()        
                .name("example-apimlogger")
                .apiManagementName(exampleService.name())
                .resourceGroupName(example.name())
                .applicationInsights(LoggerApplicationInsightsArgs.builder()
                    .instrumentationKey(exampleInsights.instrumentationKey())
                    .build())
                .build());
    
            var exampleApiDiagnostic = new ApiDiagnostic("exampleApiDiagnostic", ApiDiagnosticArgs.builder()        
                .identifier("applicationinsights")
                .resourceGroupName(example.name())
                .apiManagementName(exampleService.name())
                .apiName(exampleApi.name())
                .apiManagementLoggerId(exampleLogger.id())
                .samplingPercentage(5)
                .alwaysLogErrors(true)
                .logClientIp(true)
                .verbosity("verbose")
                .httpCorrelationProtocol("W3C")
                .frontendRequest(ApiDiagnosticFrontendRequestArgs.builder()
                    .bodyBytes(32)
                    .headersToLogs(                
                        "content-type",
                        "accept",
                        "origin")
                    .build())
                .frontendResponse(ApiDiagnosticFrontendResponseArgs.builder()
                    .bodyBytes(32)
                    .headersToLogs(                
                        "content-type",
                        "content-length",
                        "origin")
                    .build())
                .backendRequest(ApiDiagnosticBackendRequestArgs.builder()
                    .bodyBytes(32)
                    .headersToLogs(                
                        "content-type",
                        "accept",
                        "origin")
                    .build())
                .backendResponse(ApiDiagnosticBackendResponseArgs.builder()
                    .bodyBytes(32)
                    .headersToLogs(                
                        "content-type",
                        "content-length",
                        "origin")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: azure:core:ResourceGroup
        properties:
          name: example-resources
          location: West Europe
      exampleInsights:
        type: azure:appinsights:Insights
        name: example
        properties:
          name: example-appinsights
          location: ${example.location}
          resourceGroupName: ${example.name}
          applicationType: web
      exampleService:
        type: azure:apimanagement:Service
        name: example
        properties:
          name: example-apim
          location: ${example.location}
          resourceGroupName: ${example.name}
          publisherName: My Company
          publisherEmail: company@mycompany.io
          skuName: Developer_1
      exampleApi:
        type: azure:apimanagement:Api
        name: example
        properties:
          name: example-api
          resourceGroupName: ${example.name}
          apiManagementName: ${exampleService.name}
          revision: '1'
          displayName: Example API
          path: example
          protocols:
            - https
          import:
            contentFormat: swagger-link-json
            contentValue: http://conferenceapi.azurewebsites.net/?format=json
      exampleLogger:
        type: azure:apimanagement:Logger
        name: example
        properties:
          name: example-apimlogger
          apiManagementName: ${exampleService.name}
          resourceGroupName: ${example.name}
          applicationInsights:
            instrumentationKey: ${exampleInsights.instrumentationKey}
      exampleApiDiagnostic:
        type: azure:apimanagement:ApiDiagnostic
        name: example
        properties:
          identifier: applicationinsights
          resourceGroupName: ${example.name}
          apiManagementName: ${exampleService.name}
          apiName: ${exampleApi.name}
          apiManagementLoggerId: ${exampleLogger.id}
          samplingPercentage: 5
          alwaysLogErrors: true
          logClientIp: true
          verbosity: verbose
          httpCorrelationProtocol: W3C
          frontendRequest:
            bodyBytes: 32
            headersToLogs:
              - content-type
              - accept
              - origin
          frontendResponse:
            bodyBytes: 32
            headersToLogs:
              - content-type
              - content-length
              - origin
          backendRequest:
            bodyBytes: 32
            headersToLogs:
              - content-type
              - accept
              - origin
          backendResponse:
            bodyBytes: 32
            headersToLogs:
              - content-type
              - content-length
              - origin
    

    Create ApiDiagnostic Resource

    new ApiDiagnostic(name: string, args: ApiDiagnosticArgs, opts?: CustomResourceOptions);
    @overload
    def ApiDiagnostic(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      always_log_errors: Optional[bool] = None,
                      api_management_logger_id: Optional[str] = None,
                      api_management_name: Optional[str] = None,
                      api_name: Optional[str] = None,
                      backend_request: Optional[ApiDiagnosticBackendRequestArgs] = None,
                      backend_response: Optional[ApiDiagnosticBackendResponseArgs] = None,
                      frontend_request: Optional[ApiDiagnosticFrontendRequestArgs] = None,
                      frontend_response: Optional[ApiDiagnosticFrontendResponseArgs] = None,
                      http_correlation_protocol: Optional[str] = None,
                      identifier: Optional[str] = None,
                      log_client_ip: Optional[bool] = None,
                      operation_name_format: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      sampling_percentage: Optional[float] = None,
                      verbosity: Optional[str] = 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: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:

    ApiManagementLoggerId string
    The ID (name) of the Diagnostics Logger.
    ApiManagementName string
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    ApiName string
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    Identifier string
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    ResourceGroupName string
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    AlwaysLogErrors bool
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    BackendRequest ApiDiagnosticBackendRequest
    A backend_request block as defined below.
    BackendResponse ApiDiagnosticBackendResponse
    A backend_response block as defined below.
    FrontendRequest ApiDiagnosticFrontendRequest
    A frontend_request block as defined below.
    FrontendResponse ApiDiagnosticFrontendResponse
    A frontend_response block as defined below.
    HttpCorrelationProtocol string
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    LogClientIp bool
    Log client IP address.
    OperationNameFormat string
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    SamplingPercentage double
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    Verbosity string
    Logging verbosity. Possible values are verbose, information or error.
    ApiManagementLoggerId string
    The ID (name) of the Diagnostics Logger.
    ApiManagementName string
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    ApiName string
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    Identifier string
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    ResourceGroupName string
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    AlwaysLogErrors bool
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    BackendRequest ApiDiagnosticBackendRequestArgs
    A backend_request block as defined below.
    BackendResponse ApiDiagnosticBackendResponseArgs
    A backend_response block as defined below.
    FrontendRequest ApiDiagnosticFrontendRequestArgs
    A frontend_request block as defined below.
    FrontendResponse ApiDiagnosticFrontendResponseArgs
    A frontend_response block as defined below.
    HttpCorrelationProtocol string
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    LogClientIp bool
    Log client IP address.
    OperationNameFormat string
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    SamplingPercentage float64
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    Verbosity string
    Logging verbosity. Possible values are verbose, information or error.
    apiManagementLoggerId String
    The ID (name) of the Diagnostics Logger.
    apiManagementName String
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    apiName String
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    identifier String
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    resourceGroupName String
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    alwaysLogErrors Boolean
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    backendRequest ApiDiagnosticBackendRequest
    A backend_request block as defined below.
    backendResponse ApiDiagnosticBackendResponse
    A backend_response block as defined below.
    frontendRequest ApiDiagnosticFrontendRequest
    A frontend_request block as defined below.
    frontendResponse ApiDiagnosticFrontendResponse
    A frontend_response block as defined below.
    httpCorrelationProtocol String
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    logClientIp Boolean
    Log client IP address.
    operationNameFormat String
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    samplingPercentage Double
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity String
    Logging verbosity. Possible values are verbose, information or error.
    apiManagementLoggerId string
    The ID (name) of the Diagnostics Logger.
    apiManagementName string
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    apiName string
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    identifier string
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    resourceGroupName string
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    alwaysLogErrors boolean
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    backendRequest ApiDiagnosticBackendRequest
    A backend_request block as defined below.
    backendResponse ApiDiagnosticBackendResponse
    A backend_response block as defined below.
    frontendRequest ApiDiagnosticFrontendRequest
    A frontend_request block as defined below.
    frontendResponse ApiDiagnosticFrontendResponse
    A frontend_response block as defined below.
    httpCorrelationProtocol string
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    logClientIp boolean
    Log client IP address.
    operationNameFormat string
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    samplingPercentage number
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity string
    Logging verbosity. Possible values are verbose, information or error.
    api_management_logger_id str
    The ID (name) of the Diagnostics Logger.
    api_management_name str
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    api_name str
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    identifier str
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    resource_group_name str
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    always_log_errors bool
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    backend_request ApiDiagnosticBackendRequestArgs
    A backend_request block as defined below.
    backend_response ApiDiagnosticBackendResponseArgs
    A backend_response block as defined below.
    frontend_request ApiDiagnosticFrontendRequestArgs
    A frontend_request block as defined below.
    frontend_response ApiDiagnosticFrontendResponseArgs
    A frontend_response block as defined below.
    http_correlation_protocol str
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    log_client_ip bool
    Log client IP address.
    operation_name_format str
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    sampling_percentage float
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity str
    Logging verbosity. Possible values are verbose, information or error.
    apiManagementLoggerId String
    The ID (name) of the Diagnostics Logger.
    apiManagementName String
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    apiName String
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    identifier String
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    resourceGroupName String
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    alwaysLogErrors Boolean
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    backendRequest Property Map
    A backend_request block as defined below.
    backendResponse Property Map
    A backend_response block as defined below.
    frontendRequest Property Map
    A frontend_request block as defined below.
    frontendResponse Property Map
    A frontend_response block as defined below.
    httpCorrelationProtocol String
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    logClientIp Boolean
    Log client IP address.
    operationNameFormat String
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    samplingPercentage Number
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity String
    Logging verbosity. Possible values are verbose, information or error.

    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.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiDiagnostic Resource

    Get an existing ApiDiagnostic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiDiagnosticState, opts?: CustomResourceOptions): ApiDiagnostic
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            always_log_errors: Optional[bool] = None,
            api_management_logger_id: Optional[str] = None,
            api_management_name: Optional[str] = None,
            api_name: Optional[str] = None,
            backend_request: Optional[ApiDiagnosticBackendRequestArgs] = None,
            backend_response: Optional[ApiDiagnosticBackendResponseArgs] = None,
            frontend_request: Optional[ApiDiagnosticFrontendRequestArgs] = None,
            frontend_response: Optional[ApiDiagnosticFrontendResponseArgs] = None,
            http_correlation_protocol: Optional[str] = None,
            identifier: Optional[str] = None,
            log_client_ip: Optional[bool] = None,
            operation_name_format: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            sampling_percentage: Optional[float] = None,
            verbosity: Optional[str] = None) -> ApiDiagnostic
    func GetApiDiagnostic(ctx *Context, name string, id IDInput, state *ApiDiagnosticState, opts ...ResourceOption) (*ApiDiagnostic, error)
    public static ApiDiagnostic Get(string name, Input<string> id, ApiDiagnosticState? state, CustomResourceOptions? opts = null)
    public static ApiDiagnostic get(String name, Output<String> id, ApiDiagnosticState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlwaysLogErrors bool
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    ApiManagementLoggerId string
    The ID (name) of the Diagnostics Logger.
    ApiManagementName string
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    ApiName string
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    BackendRequest ApiDiagnosticBackendRequest
    A backend_request block as defined below.
    BackendResponse ApiDiagnosticBackendResponse
    A backend_response block as defined below.
    FrontendRequest ApiDiagnosticFrontendRequest
    A frontend_request block as defined below.
    FrontendResponse ApiDiagnosticFrontendResponse
    A frontend_response block as defined below.
    HttpCorrelationProtocol string
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    Identifier string
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    LogClientIp bool
    Log client IP address.
    OperationNameFormat string
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    ResourceGroupName string
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    SamplingPercentage double
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    Verbosity string
    Logging verbosity. Possible values are verbose, information or error.
    AlwaysLogErrors bool
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    ApiManagementLoggerId string
    The ID (name) of the Diagnostics Logger.
    ApiManagementName string
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    ApiName string
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    BackendRequest ApiDiagnosticBackendRequestArgs
    A backend_request block as defined below.
    BackendResponse ApiDiagnosticBackendResponseArgs
    A backend_response block as defined below.
    FrontendRequest ApiDiagnosticFrontendRequestArgs
    A frontend_request block as defined below.
    FrontendResponse ApiDiagnosticFrontendResponseArgs
    A frontend_response block as defined below.
    HttpCorrelationProtocol string
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    Identifier string
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    LogClientIp bool
    Log client IP address.
    OperationNameFormat string
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    ResourceGroupName string
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    SamplingPercentage float64
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    Verbosity string
    Logging verbosity. Possible values are verbose, information or error.
    alwaysLogErrors Boolean
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    apiManagementLoggerId String
    The ID (name) of the Diagnostics Logger.
    apiManagementName String
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    apiName String
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    backendRequest ApiDiagnosticBackendRequest
    A backend_request block as defined below.
    backendResponse ApiDiagnosticBackendResponse
    A backend_response block as defined below.
    frontendRequest ApiDiagnosticFrontendRequest
    A frontend_request block as defined below.
    frontendResponse ApiDiagnosticFrontendResponse
    A frontend_response block as defined below.
    httpCorrelationProtocol String
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    identifier String
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    logClientIp Boolean
    Log client IP address.
    operationNameFormat String
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    resourceGroupName String
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    samplingPercentage Double
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity String
    Logging verbosity. Possible values are verbose, information or error.
    alwaysLogErrors boolean
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    apiManagementLoggerId string
    The ID (name) of the Diagnostics Logger.
    apiManagementName string
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    apiName string
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    backendRequest ApiDiagnosticBackendRequest
    A backend_request block as defined below.
    backendResponse ApiDiagnosticBackendResponse
    A backend_response block as defined below.
    frontendRequest ApiDiagnosticFrontendRequest
    A frontend_request block as defined below.
    frontendResponse ApiDiagnosticFrontendResponse
    A frontend_response block as defined below.
    httpCorrelationProtocol string
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    identifier string
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    logClientIp boolean
    Log client IP address.
    operationNameFormat string
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    resourceGroupName string
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    samplingPercentage number
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity string
    Logging verbosity. Possible values are verbose, information or error.
    always_log_errors bool
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    api_management_logger_id str
    The ID (name) of the Diagnostics Logger.
    api_management_name str
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    api_name str
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    backend_request ApiDiagnosticBackendRequestArgs
    A backend_request block as defined below.
    backend_response ApiDiagnosticBackendResponseArgs
    A backend_response block as defined below.
    frontend_request ApiDiagnosticFrontendRequestArgs
    A frontend_request block as defined below.
    frontend_response ApiDiagnosticFrontendResponseArgs
    A frontend_response block as defined below.
    http_correlation_protocol str
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    identifier str
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    log_client_ip bool
    Log client IP address.
    operation_name_format str
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    resource_group_name str
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    sampling_percentage float
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity str
    Logging verbosity. Possible values are verbose, information or error.
    alwaysLogErrors Boolean
    Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
    apiManagementLoggerId String
    The ID (name) of the Diagnostics Logger.
    apiManagementName String
    The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    apiName String
    The name of the API on which to configure the Diagnostics Logs. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    backendRequest Property Map
    A backend_request block as defined below.
    backendResponse Property Map
    A backend_response block as defined below.
    frontendRequest Property Map
    A frontend_request block as defined below.
    frontendResponse Property Map
    A frontend_response block as defined below.
    httpCorrelationProtocol String
    The HTTP Correlation Protocol to use. Possible values are None, Legacy or W3C.
    identifier String
    Identifier of the Diagnostics Logs. Possible values are applicationinsights and azuremonitor. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    logClientIp Boolean
    Log client IP address.
    operationNameFormat String
    The format of the Operation Name for Application Insights telemetries. Possible values are Name, and Url. Defaults to Name.
    resourceGroupName String
    The name of the Resource Group where the API Management Service API Diagnostics Logs should exist. Changing this forces a new API Management Service API Diagnostics Logs to be created.
    samplingPercentage Number
    Sampling (%!)(MISSING). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between 0.0 and 100.0.
    verbosity String
    Logging verbosity. Possible values are verbose, information or error.

    Supporting Types

    ApiDiagnosticBackendRequest, ApiDiagnosticBackendRequestArgs

    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticBackendRequestDataMasking
    A data_masking block as defined below.
    HeadersToLogs List<string>
    Specifies a list of headers to log.
    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticBackendRequestDataMasking
    A data_masking block as defined below.
    HeadersToLogs []string
    Specifies a list of headers to log.
    bodyBytes Integer
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticBackendRequestDataMasking
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.
    bodyBytes number
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticBackendRequestDataMasking
    A data_masking block as defined below.
    headersToLogs string[]
    Specifies a list of headers to log.
    body_bytes int
    Number of payload bytes to log (up to 8192).
    data_masking ApiDiagnosticBackendRequestDataMasking
    A data_masking block as defined below.
    headers_to_logs Sequence[str]
    Specifies a list of headers to log.
    bodyBytes Number
    Number of payload bytes to log (up to 8192).
    dataMasking Property Map
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.

    ApiDiagnosticBackendRequestDataMasking, ApiDiagnosticBackendRequestDataMaskingArgs

    headers List<Property Map>
    A headers block as defined below.
    queryParams List<Property Map>
    A query_params block as defined below.

    ApiDiagnosticBackendRequestDataMaskingHeader, ApiDiagnosticBackendRequestDataMaskingHeaderArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticBackendRequestDataMaskingQueryParam, ApiDiagnosticBackendRequestDataMaskingQueryParamArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticBackendResponse, ApiDiagnosticBackendResponseArgs

    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticBackendResponseDataMasking
    A data_masking block as defined below.
    HeadersToLogs List<string>
    Specifies a list of headers to log.
    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticBackendResponseDataMasking
    A data_masking block as defined below.
    HeadersToLogs []string
    Specifies a list of headers to log.
    bodyBytes Integer
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticBackendResponseDataMasking
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.
    bodyBytes number
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticBackendResponseDataMasking
    A data_masking block as defined below.
    headersToLogs string[]
    Specifies a list of headers to log.
    body_bytes int
    Number of payload bytes to log (up to 8192).
    data_masking ApiDiagnosticBackendResponseDataMasking
    A data_masking block as defined below.
    headers_to_logs Sequence[str]
    Specifies a list of headers to log.
    bodyBytes Number
    Number of payload bytes to log (up to 8192).
    dataMasking Property Map
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.

    ApiDiagnosticBackendResponseDataMasking, ApiDiagnosticBackendResponseDataMaskingArgs

    headers List<Property Map>
    A headers block as defined below.
    queryParams List<Property Map>
    A query_params block as defined below.

    ApiDiagnosticBackendResponseDataMaskingHeader, ApiDiagnosticBackendResponseDataMaskingHeaderArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticBackendResponseDataMaskingQueryParam, ApiDiagnosticBackendResponseDataMaskingQueryParamArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticFrontendRequest, ApiDiagnosticFrontendRequestArgs

    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticFrontendRequestDataMasking
    A data_masking block as defined below.
    HeadersToLogs List<string>
    Specifies a list of headers to log.
    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticFrontendRequestDataMasking
    A data_masking block as defined below.
    HeadersToLogs []string
    Specifies a list of headers to log.
    bodyBytes Integer
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticFrontendRequestDataMasking
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.
    bodyBytes number
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticFrontendRequestDataMasking
    A data_masking block as defined below.
    headersToLogs string[]
    Specifies a list of headers to log.
    body_bytes int
    Number of payload bytes to log (up to 8192).
    data_masking ApiDiagnosticFrontendRequestDataMasking
    A data_masking block as defined below.
    headers_to_logs Sequence[str]
    Specifies a list of headers to log.
    bodyBytes Number
    Number of payload bytes to log (up to 8192).
    dataMasking Property Map
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.

    ApiDiagnosticFrontendRequestDataMasking, ApiDiagnosticFrontendRequestDataMaskingArgs

    headers List<Property Map>
    A headers block as defined below.
    queryParams List<Property Map>
    A query_params block as defined below.

    ApiDiagnosticFrontendRequestDataMaskingHeader, ApiDiagnosticFrontendRequestDataMaskingHeaderArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticFrontendRequestDataMaskingQueryParam, ApiDiagnosticFrontendRequestDataMaskingQueryParamArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticFrontendResponse, ApiDiagnosticFrontendResponseArgs

    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticFrontendResponseDataMasking
    A data_masking block as defined below.
    HeadersToLogs List<string>
    Specifies a list of headers to log.
    BodyBytes int
    Number of payload bytes to log (up to 8192).
    DataMasking ApiDiagnosticFrontendResponseDataMasking
    A data_masking block as defined below.
    HeadersToLogs []string
    Specifies a list of headers to log.
    bodyBytes Integer
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticFrontendResponseDataMasking
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.
    bodyBytes number
    Number of payload bytes to log (up to 8192).
    dataMasking ApiDiagnosticFrontendResponseDataMasking
    A data_masking block as defined below.
    headersToLogs string[]
    Specifies a list of headers to log.
    body_bytes int
    Number of payload bytes to log (up to 8192).
    data_masking ApiDiagnosticFrontendResponseDataMasking
    A data_masking block as defined below.
    headers_to_logs Sequence[str]
    Specifies a list of headers to log.
    bodyBytes Number
    Number of payload bytes to log (up to 8192).
    dataMasking Property Map
    A data_masking block as defined below.
    headersToLogs List<String>
    Specifies a list of headers to log.

    ApiDiagnosticFrontendResponseDataMasking, ApiDiagnosticFrontendResponseDataMaskingArgs

    headers List<Property Map>
    A headers block as defined below.
    queryParams List<Property Map>
    A query_params block as defined below.

    ApiDiagnosticFrontendResponseDataMaskingHeader, ApiDiagnosticFrontendResponseDataMaskingHeaderArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    ApiDiagnosticFrontendResponseDataMaskingQueryParam, ApiDiagnosticFrontendResponseDataMaskingQueryParamArgs

    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    Mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    Value string
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.
    mode string
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value string
    The name of the header or the query parameter to mask.
    mode str
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value str
    The name of the header or the query parameter to mask.
    mode String
    The data masking mode. Possible values are Mask and Hide for query_params. The only possible value is Mask for headers.
    value String
    The name of the header or the query parameter to mask.

    Import

    API Management Service API Diagnostics Logs can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/apiDiagnostic:ApiDiagnostic example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/instance1/apis/api1/diagnostics/diagnostic1
    

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.70.0 published on Wednesday, Mar 27, 2024 by Pulumi