We recommend using Azure Native.
azure.apimanagement.ApiDiagnostic
Explore with Pulumi AI
Manages a API Management Service API Diagnostics Logs.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new()
{
Location = "West Europe",
});
var exampleInsights = new Azure.AppInsights.Insights("exampleInsights", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
ApplicationType = "web",
});
var exampleService = new Azure.ApiManagement.Service("exampleService", new()
{
Location = exampleResourceGroup.Location,
ResourceGroupName = exampleResourceGroup.Name,
PublisherName = "My Company",
PublisherEmail = "company@mycompany.io",
SkuName = "Developer_1",
});
var exampleApi = new Azure.ApiManagement.Api("exampleApi", new()
{
ResourceGroupName = exampleResourceGroup.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("exampleLogger", new()
{
ApiManagementName = exampleService.Name,
ResourceGroupName = exampleResourceGroup.Name,
ApplicationInsights = new Azure.ApiManagement.Inputs.LoggerApplicationInsightsArgs
{
InstrumentationKey = exampleInsights.InstrumentationKey,
},
});
var exampleApiDiagnostic = new Azure.ApiManagement.ApiDiagnostic("exampleApiDiagnostic", new()
{
Identifier = "applicationinsights",
ResourceGroupName = exampleResourceGroup.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 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 {
exampleResourceGroup, err := core.NewResourceGroup(ctx, "exampleResourceGroup", &core.ResourceGroupArgs{
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleInsights, err := appinsights.NewInsights(ctx, "exampleInsights", &appinsights.InsightsArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.Name,
ApplicationType: pulumi.String("web"),
})
if err != nil {
return err
}
exampleService, err := apimanagement.NewService(ctx, "exampleService", &apimanagement.ServiceArgs{
Location: exampleResourceGroup.Location,
ResourceGroupName: exampleResourceGroup.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, "exampleApi", &apimanagement.ApiArgs{
ResourceGroupName: exampleResourceGroup.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, "exampleLogger", &apimanagement.LoggerArgs{
ApiManagementName: exampleService.Name,
ResourceGroupName: exampleResourceGroup.Name,
ApplicationInsights: &apimanagement.LoggerApplicationInsightsArgs{
InstrumentationKey: exampleInsights.InstrumentationKey,
},
})
if err != nil {
return err
}
_, err = apimanagement.NewApiDiagnostic(ctx, "exampleApiDiagnostic", &apimanagement.ApiDiagnosticArgs{
Identifier: pulumi.String("applicationinsights"),
ResourceGroupName: exampleResourceGroup.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
})
}
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 exampleResourceGroup = new ResourceGroup("exampleResourceGroup", ResourceGroupArgs.builder()
.location("West Europe")
.build());
var exampleInsights = new Insights("exampleInsights", InsightsArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.applicationType("web")
.build());
var exampleService = new Service("exampleService", ServiceArgs.builder()
.location(exampleResourceGroup.location())
.resourceGroupName(exampleResourceGroup.name())
.publisherName("My Company")
.publisherEmail("company@mycompany.io")
.skuName("Developer_1")
.build());
var exampleApi = new Api("exampleApi", ApiArgs.builder()
.resourceGroupName(exampleResourceGroup.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()
.apiManagementName(exampleService.name())
.resourceGroupName(exampleResourceGroup.name())
.applicationInsights(LoggerApplicationInsightsArgs.builder()
.instrumentationKey(exampleInsights.instrumentationKey())
.build())
.build());
var exampleApiDiagnostic = new ApiDiagnostic("exampleApiDiagnostic", ApiDiagnosticArgs.builder()
.identifier("applicationinsights")
.resourceGroupName(exampleResourceGroup.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());
}
}
import pulumi
import pulumi_azure as azure
example_resource_group = azure.core.ResourceGroup("exampleResourceGroup", location="West Europe")
example_insights = azure.appinsights.Insights("exampleInsights",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
application_type="web")
example_service = azure.apimanagement.Service("exampleService",
location=example_resource_group.location,
resource_group_name=example_resource_group.name,
publisher_name="My Company",
publisher_email="company@mycompany.io",
sku_name="Developer_1")
example_api = azure.apimanagement.Api("exampleApi",
resource_group_name=example_resource_group.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("exampleLogger",
api_management_name=example_service.name,
resource_group_name=example_resource_group.name,
application_insights=azure.apimanagement.LoggerApplicationInsightsArgs(
instrumentation_key=example_insights.instrumentation_key,
))
example_api_diagnostic = azure.apimanagement.ApiDiagnostic("exampleApiDiagnostic",
identifier="applicationinsights",
resource_group_name=example_resource_group.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",
],
))
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleInsights = new azure.appinsights.Insights("exampleInsights", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
applicationType: "web",
});
const exampleService = new azure.apimanagement.Service("exampleService", {
location: exampleResourceGroup.location,
resourceGroupName: exampleResourceGroup.name,
publisherName: "My Company",
publisherEmail: "company@mycompany.io",
skuName: "Developer_1",
});
const exampleApi = new azure.apimanagement.Api("exampleApi", {
resourceGroupName: exampleResourceGroup.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("exampleLogger", {
apiManagementName: exampleService.name,
resourceGroupName: exampleResourceGroup.name,
applicationInsights: {
instrumentationKey: exampleInsights.instrumentationKey,
},
});
const exampleApiDiagnostic = new azure.apimanagement.ApiDiagnostic("exampleApiDiagnostic", {
identifier: "applicationinsights",
resourceGroupName: exampleResourceGroup.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",
],
},
});
resources:
exampleResourceGroup:
type: azure:core:ResourceGroup
properties:
location: West Europe
exampleInsights:
type: azure:appinsights:Insights
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
applicationType: web
exampleService:
type: azure:apimanagement:Service
properties:
location: ${exampleResourceGroup.location}
resourceGroupName: ${exampleResourceGroup.name}
publisherName: My Company
publisherEmail: company@mycompany.io
skuName: Developer_1
exampleApi:
type: azure:apimanagement:Api
properties:
resourceGroupName: ${exampleResourceGroup.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
properties:
apiManagementName: ${exampleService.name}
resourceGroupName: ${exampleResourceGroup.name}
applicationInsights:
instrumentationKey: ${exampleInsights.instrumentationKey}
exampleApiDiagnostic:
type: azure:apimanagement:ApiDiagnostic
properties:
identifier: applicationinsights
resourceGroupName: ${exampleResourceGroup.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:
- Api
Management stringLogger Id The ID (name) of the Diagnostics Logger.
- Api
Management stringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- Api
Name 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
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- Resource
Group stringName 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 boolErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- Backend
Request ApiDiagnostic Backend Request A
backend_request
block as defined below.- Backend
Response ApiDiagnostic Backend Response A
backend_response
block as defined below.- Frontend
Request ApiDiagnostic Frontend Request A
frontend_request
block as defined below.- Frontend
Response ApiDiagnostic Frontend Response A
frontend_response
block as defined below.- Http
Correlation stringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- Log
Client boolIp Log client IP address.
- Operation
Name stringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- Sampling
Percentage double Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- Verbosity string
Logging verbosity. Possible values are
verbose
,information
orerror
.
- Api
Management stringLogger Id The ID (name) of the Diagnostics Logger.
- Api
Management stringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- Api
Name 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
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- Resource
Group stringName 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 boolErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- Backend
Request ApiDiagnostic Backend Request Args A
backend_request
block as defined below.- Backend
Response ApiDiagnostic Backend Response Args A
backend_response
block as defined below.- Frontend
Request ApiDiagnostic Frontend Request Args A
frontend_request
block as defined below.- Frontend
Response ApiDiagnostic Frontend Response Args A
frontend_response
block as defined below.- Http
Correlation stringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- Log
Client boolIp Log client IP address.
- Operation
Name stringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- Sampling
Percentage float64 Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- Verbosity string
Logging verbosity. Possible values are
verbose
,information
orerror
.
- api
Management StringLogger Id The ID (name) of the Diagnostics Logger.
- api
Management StringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- api
Name 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
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- resource
Group StringName 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 BooleanErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- backend
Request ApiDiagnostic Backend Request A
backend_request
block as defined below.- backend
Response ApiDiagnostic Backend Response A
backend_response
block as defined below.- frontend
Request ApiDiagnostic Frontend Request A
frontend_request
block as defined below.- frontend
Response ApiDiagnostic Frontend Response A
frontend_response
block as defined below.- http
Correlation StringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- log
Client BooleanIp Log client IP address.
- operation
Name StringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- sampling
Percentage Double Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity String
Logging verbosity. Possible values are
verbose
,information
orerror
.
- api
Management stringLogger Id The ID (name) of the Diagnostics Logger.
- api
Management stringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- api
Name 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
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- resource
Group stringName 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 booleanErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- backend
Request ApiDiagnostic Backend Request A
backend_request
block as defined below.- backend
Response ApiDiagnostic Backend Response A
backend_response
block as defined below.- frontend
Request ApiDiagnostic Frontend Request A
frontend_request
block as defined below.- frontend
Response ApiDiagnostic Frontend Response A
frontend_response
block as defined below.- http
Correlation stringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- log
Client booleanIp Log client IP address.
- operation
Name stringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- sampling
Percentage number Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity string
Logging verbosity. Possible values are
verbose
,information
orerror
.
- api_
management_ strlogger_ id The ID (name) of the Diagnostics Logger.
- api_
management_ strname 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
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- resource_
group_ strname 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_ boolerrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- backend_
request ApiDiagnostic Backend Request Args A
backend_request
block as defined below.- backend_
response ApiDiagnostic Backend Response Args A
backend_response
block as defined below.- frontend_
request ApiDiagnostic Frontend Request Args A
frontend_request
block as defined below.- frontend_
response ApiDiagnostic Frontend Response Args A
frontend_response
block as defined below.- http_
correlation_ strprotocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- log_
client_ boolip Log client IP address.
- operation_
name_ strformat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- sampling_
percentage float Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity str
Logging verbosity. Possible values are
verbose
,information
orerror
.
- api
Management StringLogger Id The ID (name) of the Diagnostics Logger.
- api
Management StringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- api
Name 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
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- resource
Group StringName 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 BooleanErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- backend
Request Property Map A
backend_request
block as defined below.- backend
Response Property Map A
backend_response
block as defined below.- frontend
Request Property Map A
frontend_request
block as defined below.- frontend
Response Property Map A
frontend_response
block as defined below.- http
Correlation StringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- log
Client BooleanIp Log client IP address.
- operation
Name StringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- sampling
Percentage Number Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity String
Logging verbosity. Possible values are
verbose
,information
orerror
.
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.
- Always
Log boolErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- Api
Management stringLogger Id The ID (name) of the Diagnostics Logger.
- Api
Management stringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- Api
Name 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.
- Backend
Request ApiDiagnostic Backend Request A
backend_request
block as defined below.- Backend
Response ApiDiagnostic Backend Response A
backend_response
block as defined below.- Frontend
Request ApiDiagnostic Frontend Request A
frontend_request
block as defined below.- Frontend
Response ApiDiagnostic Frontend Response A
frontend_response
block as defined below.- Http
Correlation stringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- Identifier string
Identifier of the Diagnostics Logs. Possible values are
applicationinsights
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- Log
Client boolIp Log client IP address.
- Operation
Name stringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- Resource
Group stringName 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 double Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- Verbosity string
Logging verbosity. Possible values are
verbose
,information
orerror
.
- Always
Log boolErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- Api
Management stringLogger Id The ID (name) of the Diagnostics Logger.
- Api
Management stringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- Api
Name 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.
- Backend
Request ApiDiagnostic Backend Request Args A
backend_request
block as defined below.- Backend
Response ApiDiagnostic Backend Response Args A
backend_response
block as defined below.- Frontend
Request ApiDiagnostic Frontend Request Args A
frontend_request
block as defined below.- Frontend
Response ApiDiagnostic Frontend Response Args A
frontend_response
block as defined below.- Http
Correlation stringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- Identifier string
Identifier of the Diagnostics Logs. Possible values are
applicationinsights
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- Log
Client boolIp Log client IP address.
- Operation
Name stringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- Resource
Group stringName 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 float64 Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- Verbosity string
Logging verbosity. Possible values are
verbose
,information
orerror
.
- always
Log BooleanErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- api
Management StringLogger Id The ID (name) of the Diagnostics Logger.
- api
Management StringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- api
Name 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.
- backend
Request ApiDiagnostic Backend Request A
backend_request
block as defined below.- backend
Response ApiDiagnostic Backend Response A
backend_response
block as defined below.- frontend
Request ApiDiagnostic Frontend Request A
frontend_request
block as defined below.- frontend
Response ApiDiagnostic Frontend Response A
frontend_response
block as defined below.- http
Correlation StringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- identifier String
Identifier of the Diagnostics Logs. Possible values are
applicationinsights
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- log
Client BooleanIp Log client IP address.
- operation
Name StringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- resource
Group StringName 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 Double Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity String
Logging verbosity. Possible values are
verbose
,information
orerror
.
- always
Log booleanErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- api
Management stringLogger Id The ID (name) of the Diagnostics Logger.
- api
Management stringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- api
Name 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.
- backend
Request ApiDiagnostic Backend Request A
backend_request
block as defined below.- backend
Response ApiDiagnostic Backend Response A
backend_response
block as defined below.- frontend
Request ApiDiagnostic Frontend Request A
frontend_request
block as defined below.- frontend
Response ApiDiagnostic Frontend Response A
frontend_response
block as defined below.- http
Correlation stringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- identifier string
Identifier of the Diagnostics Logs. Possible values are
applicationinsights
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- log
Client booleanIp Log client IP address.
- operation
Name stringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- resource
Group stringName 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 number Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity string
Logging verbosity. Possible values are
verbose
,information
orerror
.
- always_
log_ boolerrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- api_
management_ strlogger_ id The ID (name) of the Diagnostics Logger.
- api_
management_ strname 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 ApiDiagnostic Backend Request Args A
backend_request
block as defined below.- backend_
response ApiDiagnostic Backend Response Args A
backend_response
block as defined below.- frontend_
request ApiDiagnostic Frontend Request Args A
frontend_request
block as defined below.- frontend_
response ApiDiagnostic Frontend Response Args A
frontend_response
block as defined below.- http_
correlation_ strprotocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- identifier str
Identifier of the Diagnostics Logs. Possible values are
applicationinsights
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- log_
client_ boolip Log client IP address.
- operation_
name_ strformat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- resource_
group_ strname 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 (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity str
Logging verbosity. Possible values are
verbose
,information
orerror
.
- always
Log BooleanErrors Always log errors. Send telemetry if there is an erroneous condition, regardless of sampling settings.
- api
Management StringLogger Id The ID (name) of the Diagnostics Logger.
- api
Management StringName The name of the API Management Service instance. Changing this forces a new API Management Service API Diagnostics Logs to be created.
- api
Name 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.
- backend
Request Property Map A
backend_request
block as defined below.- backend
Response Property Map A
backend_response
block as defined below.- frontend
Request Property Map A
frontend_request
block as defined below.- frontend
Response Property Map A
frontend_response
block as defined below.- http
Correlation StringProtocol The HTTP Correlation Protocol to use. Possible values are
None
,Legacy
orW3C
.- identifier String
Identifier of the Diagnostics Logs. Possible values are
applicationinsights
andazuremonitor
. Changing this forces a new API Management Service API Diagnostics Logs to be created.- log
Client BooleanIp Log client IP address.
- operation
Name StringFormat The format of the Operation Name for Application Insights telemetries. Possible values are
Name
, andUrl
. Defaults toName
.- resource
Group StringName 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 Number Sampling (%). For high traffic APIs, please read this documentation to understand performance implications and log sampling. Valid values are between
0.0
and100.0
.- verbosity String
Logging verbosity. Possible values are
verbose
,information
orerror
.
Supporting Types
ApiDiagnosticBackendRequest, ApiDiagnosticBackendRequestArgs
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Backend Request Data Masking A
data_masking
block as defined below.- Headers
To List<string>Logs Specifies a list of headers to log.
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Backend Request Data Masking A
data_masking
block as defined below.- Headers
To []stringLogs Specifies a list of headers to log.
- body
Bytes Integer Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Backend Request Data Masking A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
- body
Bytes number Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Backend Request Data Masking A
data_masking
block as defined below.- headers
To string[]Logs Specifies a list of headers to log.
- body_
bytes int Number of payload bytes to log (up to 8192).
- data_
masking ApiDiagnostic Backend Request Data Masking A
data_masking
block as defined below.- headers_
to_ Sequence[str]logs Specifies a list of headers to log.
- body
Bytes Number Number of payload bytes to log (up to 8192).
- data
Masking Property Map A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
ApiDiagnosticBackendRequestDataMasking, ApiDiagnosticBackendRequestDataMaskingArgs
- Headers
List<Api
Diagnostic Backend Request Data Masking Header> A
headers
block as defined below.- Query
Params List<ApiDiagnostic Backend Request Data Masking Query Param> A
query_params
block as defined below.
- Headers
[]Api
Diagnostic Backend Request Data Masking Header A
headers
block as defined below.- Query
Params []ApiDiagnostic Backend Request Data Masking Query Param A
query_params
block as defined below.
- headers
List<Api
Diagnostic Backend Request Data Masking Header> A
headers
block as defined below.- query
Params List<ApiDiagnostic Backend Request Data Masking Query Param> A
query_params
block as defined below.
- headers
Api
Diagnostic Backend Request Data Masking Header[] A
headers
block as defined below.- query
Params ApiDiagnostic Backend Request Data Masking Query Param[] A
query_params
block as defined below.
- headers
Sequence[Api
Diagnostic Backend Request Data Masking Header] A
headers
block as defined below.- query_
params Sequence[ApiDiagnostic Backend Request Data Masking Query Param] A
query_params
block as defined below.
- headers List<Property Map>
A
headers
block as defined below.- query
Params List<Property Map> A
query_params
block as defined below.
ApiDiagnosticBackendRequestDataMaskingHeader, ApiDiagnosticBackendRequestDataMaskingHeaderArgs
ApiDiagnosticBackendRequestDataMaskingQueryParam, ApiDiagnosticBackendRequestDataMaskingQueryParamArgs
ApiDiagnosticBackendResponse, ApiDiagnosticBackendResponseArgs
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Backend Response Data Masking A
data_masking
block as defined below.- Headers
To List<string>Logs Specifies a list of headers to log.
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Backend Response Data Masking A
data_masking
block as defined below.- Headers
To []stringLogs Specifies a list of headers to log.
- body
Bytes Integer Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Backend Response Data Masking A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
- body
Bytes number Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Backend Response Data Masking A
data_masking
block as defined below.- headers
To string[]Logs Specifies a list of headers to log.
- body_
bytes int Number of payload bytes to log (up to 8192).
- data_
masking ApiDiagnostic Backend Response Data Masking A
data_masking
block as defined below.- headers_
to_ Sequence[str]logs Specifies a list of headers to log.
- body
Bytes Number Number of payload bytes to log (up to 8192).
- data
Masking Property Map A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
ApiDiagnosticBackendResponseDataMasking, ApiDiagnosticBackendResponseDataMaskingArgs
- Headers
List<Api
Diagnostic Backend Response Data Masking Header> A
headers
block as defined below.- Query
Params List<ApiDiagnostic Backend Response Data Masking Query Param> A
query_params
block as defined below.
- Headers
[]Api
Diagnostic Backend Response Data Masking Header A
headers
block as defined below.- Query
Params []ApiDiagnostic Backend Response Data Masking Query Param A
query_params
block as defined below.
- headers
List<Api
Diagnostic Backend Response Data Masking Header> A
headers
block as defined below.- query
Params List<ApiDiagnostic Backend Response Data Masking Query Param> A
query_params
block as defined below.
- headers
Api
Diagnostic Backend Response Data Masking Header[] A
headers
block as defined below.- query
Params ApiDiagnostic Backend Response Data Masking Query Param[] A
query_params
block as defined below.
- headers
Sequence[Api
Diagnostic Backend Response Data Masking Header] A
headers
block as defined below.- query_
params Sequence[ApiDiagnostic Backend Response Data Masking Query Param] A
query_params
block as defined below.
- headers List<Property Map>
A
headers
block as defined below.- query
Params List<Property Map> A
query_params
block as defined below.
ApiDiagnosticBackendResponseDataMaskingHeader, ApiDiagnosticBackendResponseDataMaskingHeaderArgs
ApiDiagnosticBackendResponseDataMaskingQueryParam, ApiDiagnosticBackendResponseDataMaskingQueryParamArgs
ApiDiagnosticFrontendRequest, ApiDiagnosticFrontendRequestArgs
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Frontend Request Data Masking A
data_masking
block as defined below.- Headers
To List<string>Logs Specifies a list of headers to log.
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Frontend Request Data Masking A
data_masking
block as defined below.- Headers
To []stringLogs Specifies a list of headers to log.
- body
Bytes Integer Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Frontend Request Data Masking A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
- body
Bytes number Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Frontend Request Data Masking A
data_masking
block as defined below.- headers
To string[]Logs Specifies a list of headers to log.
- body_
bytes int Number of payload bytes to log (up to 8192).
- data_
masking ApiDiagnostic Frontend Request Data Masking A
data_masking
block as defined below.- headers_
to_ Sequence[str]logs Specifies a list of headers to log.
- body
Bytes Number Number of payload bytes to log (up to 8192).
- data
Masking Property Map A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
ApiDiagnosticFrontendRequestDataMasking, ApiDiagnosticFrontendRequestDataMaskingArgs
- Headers
List<Api
Diagnostic Frontend Request Data Masking Header> A
headers
block as defined below.- Query
Params List<ApiDiagnostic Frontend Request Data Masking Query Param> A
query_params
block as defined below.
- Headers
[]Api
Diagnostic Frontend Request Data Masking Header A
headers
block as defined below.- Query
Params []ApiDiagnostic Frontend Request Data Masking Query Param A
query_params
block as defined below.
- headers
List<Api
Diagnostic Frontend Request Data Masking Header> A
headers
block as defined below.- query
Params List<ApiDiagnostic Frontend Request Data Masking Query Param> A
query_params
block as defined below.
- headers
Api
Diagnostic Frontend Request Data Masking Header[] A
headers
block as defined below.- query
Params ApiDiagnostic Frontend Request Data Masking Query Param[] A
query_params
block as defined below.
- headers
Sequence[Api
Diagnostic Frontend Request Data Masking Header] A
headers
block as defined below.- query_
params Sequence[ApiDiagnostic Frontend Request Data Masking Query Param] A
query_params
block as defined below.
- headers List<Property Map>
A
headers
block as defined below.- query
Params List<Property Map> A
query_params
block as defined below.
ApiDiagnosticFrontendRequestDataMaskingHeader, ApiDiagnosticFrontendRequestDataMaskingHeaderArgs
ApiDiagnosticFrontendRequestDataMaskingQueryParam, ApiDiagnosticFrontendRequestDataMaskingQueryParamArgs
ApiDiagnosticFrontendResponse, ApiDiagnosticFrontendResponseArgs
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Frontend Response Data Masking A
data_masking
block as defined below.- Headers
To List<string>Logs Specifies a list of headers to log.
- Body
Bytes int Number of payload bytes to log (up to 8192).
- Data
Masking ApiDiagnostic Frontend Response Data Masking A
data_masking
block as defined below.- Headers
To []stringLogs Specifies a list of headers to log.
- body
Bytes Integer Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Frontend Response Data Masking A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
- body
Bytes number Number of payload bytes to log (up to 8192).
- data
Masking ApiDiagnostic Frontend Response Data Masking A
data_masking
block as defined below.- headers
To string[]Logs Specifies a list of headers to log.
- body_
bytes int Number of payload bytes to log (up to 8192).
- data_
masking ApiDiagnostic Frontend Response Data Masking A
data_masking
block as defined below.- headers_
to_ Sequence[str]logs Specifies a list of headers to log.
- body
Bytes Number Number of payload bytes to log (up to 8192).
- data
Masking Property Map A
data_masking
block as defined below.- headers
To List<String>Logs Specifies a list of headers to log.
ApiDiagnosticFrontendResponseDataMasking, ApiDiagnosticFrontendResponseDataMaskingArgs
- Headers
List<Api
Diagnostic Frontend Response Data Masking Header> A
headers
block as defined below.- Query
Params List<ApiDiagnostic Frontend Response Data Masking Query Param> A
query_params
block as defined below.
- Headers
[]Api
Diagnostic Frontend Response Data Masking Header A
headers
block as defined below.- Query
Params []ApiDiagnostic Frontend Response Data Masking Query Param A
query_params
block as defined below.
- headers
List<Api
Diagnostic Frontend Response Data Masking Header> A
headers
block as defined below.- query
Params List<ApiDiagnostic Frontend Response Data Masking Query Param> A
query_params
block as defined below.
- headers
Api
Diagnostic Frontend Response Data Masking Header[] A
headers
block as defined below.- query
Params ApiDiagnostic Frontend Response Data Masking Query Param[] A
query_params
block as defined below.
- headers
Sequence[Api
Diagnostic Frontend Response Data Masking Header] A
headers
block as defined below.- query_
params Sequence[ApiDiagnostic Frontend Response Data Masking Query Param] A
query_params
block as defined below.
- headers List<Property Map>
A
headers
block as defined below.- query
Params List<Property Map> A
query_params
block as defined below.
ApiDiagnosticFrontendResponseDataMaskingHeader, ApiDiagnosticFrontendResponseDataMaskingHeaderArgs
ApiDiagnosticFrontendResponseDataMaskingQueryParam, ApiDiagnosticFrontendResponseDataMaskingQueryParamArgs
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.