Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. Logger

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

azure.apimanagement.Logger

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure

Manages a Logger within an API Management Service.

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: "other",
});
const exampleService = new azure.apimanagement.Service("example", {
    name: "example-apim",
    location: example.location,
    resourceGroupName: example.name,
    publisherName: "My Company",
    publisherEmail: "company@exmaple.com",
    skuName: "Developer_1",
});
const exampleLogger = new azure.apimanagement.Logger("example", {
    name: "example-logger",
    apiManagementName: exampleService.name,
    resourceGroupName: example.name,
    resourceId: exampleInsights.id,
    applicationInsights: {
        instrumentationKey: exampleInsights.instrumentationKey,
    },
});
Copy
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="other")
example_service = azure.apimanagement.Service("example",
    name="example-apim",
    location=example.location,
    resource_group_name=example.name,
    publisher_name="My Company",
    publisher_email="company@exmaple.com",
    sku_name="Developer_1")
example_logger = azure.apimanagement.Logger("example",
    name="example-logger",
    api_management_name=example_service.name,
    resource_group_name=example.name,
    resource_id=example_insights.id,
    application_insights={
        "instrumentation_key": example_insights.instrumentation_key,
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/apimanagement"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/appinsights"
	"github.com/pulumi/pulumi-azure/sdk/v6/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("other"),
		})
		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@exmaple.com"),
			SkuName:           pulumi.String("Developer_1"),
		})
		if err != nil {
			return err
		}
		_, err = apimanagement.NewLogger(ctx, "example", &apimanagement.LoggerArgs{
			Name:              pulumi.String("example-logger"),
			ApiManagementName: exampleService.Name,
			ResourceGroupName: example.Name,
			ResourceId:        exampleInsights.ID(),
			ApplicationInsights: &apimanagement.LoggerApplicationInsightsArgs{
				InstrumentationKey: exampleInsights.InstrumentationKey,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
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 = "other",
    });

    var exampleService = new Azure.ApiManagement.Service("example", new()
    {
        Name = "example-apim",
        Location = example.Location,
        ResourceGroupName = example.Name,
        PublisherName = "My Company",
        PublisherEmail = "company@exmaple.com",
        SkuName = "Developer_1",
    });

    var exampleLogger = new Azure.ApiManagement.Logger("example", new()
    {
        Name = "example-logger",
        ApiManagementName = exampleService.Name,
        ResourceGroupName = example.Name,
        ResourceId = exampleInsights.Id,
        ApplicationInsights = new Azure.ApiManagement.Inputs.LoggerApplicationInsightsArgs
        {
            InstrumentationKey = exampleInsights.InstrumentationKey,
        },
    });

});
Copy
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.Logger;
import com.pulumi.azure.apimanagement.LoggerArgs;
import com.pulumi.azure.apimanagement.inputs.LoggerApplicationInsightsArgs;
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("other")
            .build());

        var exampleService = new Service("exampleService", ServiceArgs.builder()
            .name("example-apim")
            .location(example.location())
            .resourceGroupName(example.name())
            .publisherName("My Company")
            .publisherEmail("company@exmaple.com")
            .skuName("Developer_1")
            .build());

        var exampleLogger = new Logger("exampleLogger", LoggerArgs.builder()
            .name("example-logger")
            .apiManagementName(exampleService.name())
            .resourceGroupName(example.name())
            .resourceId(exampleInsights.id())
            .applicationInsights(LoggerApplicationInsightsArgs.builder()
                .instrumentationKey(exampleInsights.instrumentationKey())
                .build())
            .build());

    }
}
Copy
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: other
  exampleService:
    type: azure:apimanagement:Service
    name: example
    properties:
      name: example-apim
      location: ${example.location}
      resourceGroupName: ${example.name}
      publisherName: My Company
      publisherEmail: company@exmaple.com
      skuName: Developer_1
  exampleLogger:
    type: azure:apimanagement:Logger
    name: example
    properties:
      name: example-logger
      apiManagementName: ${exampleService.name}
      resourceGroupName: ${example.name}
      resourceId: ${exampleInsights.id}
      applicationInsights:
        instrumentationKey: ${exampleInsights.instrumentationKey}
Copy

Create Logger Resource

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

Constructor syntax

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

@overload
def Logger(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           api_management_name: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           application_insights: Optional[LoggerApplicationInsightsArgs] = None,
           buffered: Optional[bool] = None,
           description: Optional[str] = None,
           eventhub: Optional[LoggerEventhubArgs] = None,
           name: Optional[str] = None,
           resource_id: Optional[str] = None)
func NewLogger(ctx *Context, name string, args LoggerArgs, opts ...ResourceOption) (*Logger, error)
public Logger(string name, LoggerArgs args, CustomResourceOptions? opts = null)
public Logger(String name, LoggerArgs args)
public Logger(String name, LoggerArgs args, CustomResourceOptions options)

type: azure:apimanagement:Logger
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

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

Constructor example

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

var loggerResource = new Azure.ApiManagement.Logger("loggerResource", new()
{
    ApiManagementName = "string",
    ResourceGroupName = "string",
    ApplicationInsights = new Azure.ApiManagement.Inputs.LoggerApplicationInsightsArgs
    {
        ConnectionString = "string",
        InstrumentationKey = "string",
    },
    Buffered = false,
    Description = "string",
    Eventhub = new Azure.ApiManagement.Inputs.LoggerEventhubArgs
    {
        Name = "string",
        ConnectionString = "string",
        EndpointUri = "string",
        UserAssignedIdentityClientId = "string",
    },
    Name = "string",
    ResourceId = "string",
});
Copy
example, err := apimanagement.NewLogger(ctx, "loggerResource", &apimanagement.LoggerArgs{
	ApiManagementName: pulumi.String("string"),
	ResourceGroupName: pulumi.String("string"),
	ApplicationInsights: &apimanagement.LoggerApplicationInsightsArgs{
		ConnectionString:   pulumi.String("string"),
		InstrumentationKey: pulumi.String("string"),
	},
	Buffered:    pulumi.Bool(false),
	Description: pulumi.String("string"),
	Eventhub: &apimanagement.LoggerEventhubArgs{
		Name:                         pulumi.String("string"),
		ConnectionString:             pulumi.String("string"),
		EndpointUri:                  pulumi.String("string"),
		UserAssignedIdentityClientId: pulumi.String("string"),
	},
	Name:       pulumi.String("string"),
	ResourceId: pulumi.String("string"),
})
Copy
var loggerResource = new Logger("loggerResource", LoggerArgs.builder()
    .apiManagementName("string")
    .resourceGroupName("string")
    .applicationInsights(LoggerApplicationInsightsArgs.builder()
        .connectionString("string")
        .instrumentationKey("string")
        .build())
    .buffered(false)
    .description("string")
    .eventhub(LoggerEventhubArgs.builder()
        .name("string")
        .connectionString("string")
        .endpointUri("string")
        .userAssignedIdentityClientId("string")
        .build())
    .name("string")
    .resourceId("string")
    .build());
Copy
logger_resource = azure.apimanagement.Logger("loggerResource",
    api_management_name="string",
    resource_group_name="string",
    application_insights={
        "connection_string": "string",
        "instrumentation_key": "string",
    },
    buffered=False,
    description="string",
    eventhub={
        "name": "string",
        "connection_string": "string",
        "endpoint_uri": "string",
        "user_assigned_identity_client_id": "string",
    },
    name="string",
    resource_id="string")
Copy
const loggerResource = new azure.apimanagement.Logger("loggerResource", {
    apiManagementName: "string",
    resourceGroupName: "string",
    applicationInsights: {
        connectionString: "string",
        instrumentationKey: "string",
    },
    buffered: false,
    description: "string",
    eventhub: {
        name: "string",
        connectionString: "string",
        endpointUri: "string",
        userAssignedIdentityClientId: "string",
    },
    name: "string",
    resourceId: "string",
});
Copy
type: azure:apimanagement:Logger
properties:
    apiManagementName: string
    applicationInsights:
        connectionString: string
        instrumentationKey: string
    buffered: false
    description: string
    eventhub:
        connectionString: string
        endpointUri: string
        name: string
        userAssignedIdentityClientId: string
    name: string
    resourceGroupName: string
    resourceId: string
Copy

Logger Resource Properties

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

Inputs

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

The Logger resource accepts the following input properties:

ApiManagementName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management Service. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
ApplicationInsights Changes to this property will trigger replacement. LoggerApplicationInsights
An application_insights block as documented below. Changing this forces a new resource to be created.
Buffered bool
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
Description string
A description of this Logger.
Eventhub Changes to this property will trigger replacement. LoggerEventhub
An eventhub block as documented below. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
ResourceId Changes to this property will trigger replacement. string
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
ApiManagementName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management Service. Changing this forces a new resource to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
ApplicationInsights Changes to this property will trigger replacement. LoggerApplicationInsightsArgs
An application_insights block as documented below. Changing this forces a new resource to be created.
Buffered bool
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
Description string
A description of this Logger.
Eventhub Changes to this property will trigger replacement. LoggerEventhubArgs
An eventhub block as documented below. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
ResourceId Changes to this property will trigger replacement. string
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
apiManagementName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management Service. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
applicationInsights Changes to this property will trigger replacement. LoggerApplicationInsights
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered Boolean
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description String
A description of this Logger.
eventhub Changes to this property will trigger replacement. LoggerEventhub
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resourceId Changes to this property will trigger replacement. String
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
apiManagementName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management Service. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
applicationInsights Changes to this property will trigger replacement. LoggerApplicationInsights
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered boolean
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description string
A description of this Logger.
eventhub Changes to this property will trigger replacement. LoggerEventhub
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resourceId Changes to this property will trigger replacement. string
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
api_management_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management Service. Changing this forces a new resource to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
application_insights Changes to this property will trigger replacement. LoggerApplicationInsightsArgs
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered bool
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description str
A description of this Logger.
eventhub Changes to this property will trigger replacement. LoggerEventhubArgs
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resource_id Changes to this property will trigger replacement. str
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
apiManagementName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management Service. Changing this forces a new resource to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
applicationInsights Changes to this property will trigger replacement. Property Map
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered Boolean
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description String
A description of this Logger.
eventhub Changes to this property will trigger replacement. Property Map
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resourceId Changes to this property will trigger replacement. String
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.

Outputs

All input properties are implicitly available as output properties. Additionally, the Logger 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 Logger Resource

Get an existing Logger 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?: LoggerState, opts?: CustomResourceOptions): Logger
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_management_name: Optional[str] = None,
        application_insights: Optional[LoggerApplicationInsightsArgs] = None,
        buffered: Optional[bool] = None,
        description: Optional[str] = None,
        eventhub: Optional[LoggerEventhubArgs] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        resource_id: Optional[str] = None) -> Logger
func GetLogger(ctx *Context, name string, id IDInput, state *LoggerState, opts ...ResourceOption) (*Logger, error)
public static Logger Get(string name, Input<string> id, LoggerState? state, CustomResourceOptions? opts = null)
public static Logger get(String name, Output<String> id, LoggerState state, CustomResourceOptions options)
resources:  _:    type: azure:apimanagement:Logger    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
ApiManagementName Changes to this property will trigger replacement. string
The name of the API Management Service. Changing this forces a new resource to be created.
ApplicationInsights Changes to this property will trigger replacement. LoggerApplicationInsights
An application_insights block as documented below. Changing this forces a new resource to be created.
Buffered bool
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
Description string
A description of this Logger.
Eventhub Changes to this property will trigger replacement. LoggerEventhub
An eventhub block as documented below. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
ResourceId Changes to this property will trigger replacement. string
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
ApiManagementName Changes to this property will trigger replacement. string
The name of the API Management Service. Changing this forces a new resource to be created.
ApplicationInsights Changes to this property will trigger replacement. LoggerApplicationInsightsArgs
An application_insights block as documented below. Changing this forces a new resource to be created.
Buffered bool
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
Description string
A description of this Logger.
Eventhub Changes to this property will trigger replacement. LoggerEventhubArgs
An eventhub block as documented below. Changing this forces a new resource to be created.
Name Changes to this property will trigger replacement. string
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
ResourceId Changes to this property will trigger replacement. string
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
apiManagementName Changes to this property will trigger replacement. String
The name of the API Management Service. Changing this forces a new resource to be created.
applicationInsights Changes to this property will trigger replacement. LoggerApplicationInsights
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered Boolean
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description String
A description of this Logger.
eventhub Changes to this property will trigger replacement. LoggerEventhub
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
resourceId Changes to this property will trigger replacement. String
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
apiManagementName Changes to this property will trigger replacement. string
The name of the API Management Service. Changing this forces a new resource to be created.
applicationInsights Changes to this property will trigger replacement. LoggerApplicationInsights
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered boolean
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description string
A description of this Logger.
eventhub Changes to this property will trigger replacement. LoggerEventhub
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. string
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
resourceId Changes to this property will trigger replacement. string
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
api_management_name Changes to this property will trigger replacement. str
The name of the API Management Service. Changing this forces a new resource to be created.
application_insights Changes to this property will trigger replacement. LoggerApplicationInsightsArgs
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered bool
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description str
A description of this Logger.
eventhub Changes to this property will trigger replacement. LoggerEventhubArgs
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. str
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
resource_id Changes to this property will trigger replacement. str
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.
apiManagementName Changes to this property will trigger replacement. String
The name of the API Management Service. Changing this forces a new resource to be created.
applicationInsights Changes to this property will trigger replacement. Property Map
An application_insights block as documented below. Changing this forces a new resource to be created.
buffered Boolean
Specifies whether records should be buffered in the Logger prior to publishing. Defaults to true.
description String
A description of this Logger.
eventhub Changes to this property will trigger replacement. Property Map
An eventhub block as documented below. Changing this forces a new resource to be created.
name Changes to this property will trigger replacement. String
The name of this Logger, which must be unique within the API Management Service. Changing this forces a new resource to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
resourceId Changes to this property will trigger replacement. String
The target resource id which will be linked in the API-Management portal page. Changing this forces a new resource to be created.

Supporting Types

LoggerApplicationInsights
, LoggerApplicationInsightsArgs

ConnectionString string
The connection string of Application Insights.
InstrumentationKey string

The instrumentation key used to push data to Application Insights.

Note: Either connection_string or instrumentation_key have to be specified.

ConnectionString string
The connection string of Application Insights.
InstrumentationKey string

The instrumentation key used to push data to Application Insights.

Note: Either connection_string or instrumentation_key have to be specified.

connectionString String
The connection string of Application Insights.
instrumentationKey String

The instrumentation key used to push data to Application Insights.

Note: Either connection_string or instrumentation_key have to be specified.

connectionString string
The connection string of Application Insights.
instrumentationKey string

The instrumentation key used to push data to Application Insights.

Note: Either connection_string or instrumentation_key have to be specified.

connection_string str
The connection string of Application Insights.
instrumentation_key str

The instrumentation key used to push data to Application Insights.

Note: Either connection_string or instrumentation_key have to be specified.

connectionString String
The connection string of Application Insights.
instrumentationKey String

The instrumentation key used to push data to Application Insights.

Note: Either connection_string or instrumentation_key have to be specified.

LoggerEventhub
, LoggerEventhubArgs

Name This property is required. string
The name of an EventHub.
ConnectionString string

The connection string of an EventHub Namespace.

Note: At least one of connection_string or endpoint_uri must be specified

EndpointUri string
The endpoint address of an EventHub Namespace. Required when client_id is set.
UserAssignedIdentityClientId string
The Client Id of the User Assigned Identity with the "Azure Event Hubs Data Sender" role to the target EventHub Namespace. Required when endpoint_uri is set. If not specified the System Assigned Identity will be used.
Name This property is required. string
The name of an EventHub.
ConnectionString string

The connection string of an EventHub Namespace.

Note: At least one of connection_string or endpoint_uri must be specified

EndpointUri string
The endpoint address of an EventHub Namespace. Required when client_id is set.
UserAssignedIdentityClientId string
The Client Id of the User Assigned Identity with the "Azure Event Hubs Data Sender" role to the target EventHub Namespace. Required when endpoint_uri is set. If not specified the System Assigned Identity will be used.
name This property is required. String
The name of an EventHub.
connectionString String

The connection string of an EventHub Namespace.

Note: At least one of connection_string or endpoint_uri must be specified

endpointUri String
The endpoint address of an EventHub Namespace. Required when client_id is set.
userAssignedIdentityClientId String
The Client Id of the User Assigned Identity with the "Azure Event Hubs Data Sender" role to the target EventHub Namespace. Required when endpoint_uri is set. If not specified the System Assigned Identity will be used.
name This property is required. string
The name of an EventHub.
connectionString string

The connection string of an EventHub Namespace.

Note: At least one of connection_string or endpoint_uri must be specified

endpointUri string
The endpoint address of an EventHub Namespace. Required when client_id is set.
userAssignedIdentityClientId string
The Client Id of the User Assigned Identity with the "Azure Event Hubs Data Sender" role to the target EventHub Namespace. Required when endpoint_uri is set. If not specified the System Assigned Identity will be used.
name This property is required. str
The name of an EventHub.
connection_string str

The connection string of an EventHub Namespace.

Note: At least one of connection_string or endpoint_uri must be specified

endpoint_uri str
The endpoint address of an EventHub Namespace. Required when client_id is set.
user_assigned_identity_client_id str
The Client Id of the User Assigned Identity with the "Azure Event Hubs Data Sender" role to the target EventHub Namespace. Required when endpoint_uri is set. If not specified the System Assigned Identity will be used.
name This property is required. String
The name of an EventHub.
connectionString String

The connection string of an EventHub Namespace.

Note: At least one of connection_string or endpoint_uri must be specified

endpointUri String
The endpoint address of an EventHub Namespace. Required when client_id is set.
userAssignedIdentityClientId String
The Client Id of the User Assigned Identity with the "Azure Event Hubs Data Sender" role to the target EventHub Namespace. Required when endpoint_uri is set. If not specified the System Assigned Identity will be used.

Import

API Management Loggers can be imported using the resource id, e.g.

$ pulumi import azure:apimanagement/logger:Logger example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/example-rg/providers/Microsoft.ApiManagement/service/example-apim/loggers/example-logger
Copy

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

Package Details

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

We recommend using Azure Native.

Azure v6.22.0 published on Tuesday, Apr 1, 2025 by Pulumi
pulumi/pulumi-azure