We recommend using Azure Native.
azure.monitoring.LogProfile
Explore with Pulumi AI
Manages a Log Profile. A Log Profile configures how Activity Logs are exported.
NOTE: It’s only possible to configure one Log Profile per Subscription. If you are trying to create more than one Log Profile, an error with
StatusCode=409
will occur.
!> NOTE: Azure Log Profiles will be retired on 30th September 2026 and will be removed in v4.0 of the AzureRM Provider. More information on the deprecation can be found in the Azure documentation.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";
const example = new azure.core.ResourceGroup("example", {
name: "logprofiletest-rg",
location: "West Europe",
});
const exampleAccount = new azure.storage.Account("example", {
name: "afscsdfytw",
resourceGroupName: example.name,
location: example.location,
accountTier: "Standard",
accountReplicationType: "GRS",
});
const exampleEventHubNamespace = new azure.eventhub.EventHubNamespace("example", {
name: "logprofileeventhub",
location: example.location,
resourceGroupName: example.name,
sku: "Standard",
capacity: 2,
});
const exampleLogProfile = new azure.monitoring.LogProfile("example", {
name: "default",
categories: [
"Action",
"Delete",
"Write",
],
locations: [
"westus",
"global",
],
servicebusRuleId: pulumi.interpolate`${exampleEventHubNamespace.id}/authorizationrules/RootManageSharedAccessKey`,
storageAccountId: exampleAccount.id,
retentionPolicy: {
enabled: true,
days: 7,
},
});
import pulumi
import pulumi_azure as azure
example = azure.core.ResourceGroup("example",
name="logprofiletest-rg",
location="West Europe")
example_account = azure.storage.Account("example",
name="afscsdfytw",
resource_group_name=example.name,
location=example.location,
account_tier="Standard",
account_replication_type="GRS")
example_event_hub_namespace = azure.eventhub.EventHubNamespace("example",
name="logprofileeventhub",
location=example.location,
resource_group_name=example.name,
sku="Standard",
capacity=2)
example_log_profile = azure.monitoring.LogProfile("example",
name="default",
categories=[
"Action",
"Delete",
"Write",
],
locations=[
"westus",
"global",
],
servicebus_rule_id=example_event_hub_namespace.id.apply(lambda id: f"{id}/authorizationrules/RootManageSharedAccessKey"),
storage_account_id=example_account.id,
retention_policy=azure.monitoring.LogProfileRetentionPolicyArgs(
enabled=True,
days=7,
))
package main
import (
"fmt"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/eventhub"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/monitoring"
"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/storage"
"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("logprofiletest-rg"),
Location: pulumi.String("West Europe"),
})
if err != nil {
return err
}
exampleAccount, err := storage.NewAccount(ctx, "example", &storage.AccountArgs{
Name: pulumi.String("afscsdfytw"),
ResourceGroupName: example.Name,
Location: example.Location,
AccountTier: pulumi.String("Standard"),
AccountReplicationType: pulumi.String("GRS"),
})
if err != nil {
return err
}
exampleEventHubNamespace, err := eventhub.NewEventHubNamespace(ctx, "example", &eventhub.EventHubNamespaceArgs{
Name: pulumi.String("logprofileeventhub"),
Location: example.Location,
ResourceGroupName: example.Name,
Sku: pulumi.String("Standard"),
Capacity: pulumi.Int(2),
})
if err != nil {
return err
}
_, err = monitoring.NewLogProfile(ctx, "example", &monitoring.LogProfileArgs{
Name: pulumi.String("default"),
Categories: pulumi.StringArray{
pulumi.String("Action"),
pulumi.String("Delete"),
pulumi.String("Write"),
},
Locations: pulumi.StringArray{
pulumi.String("westus"),
pulumi.String("global"),
},
ServicebusRuleId: exampleEventHubNamespace.ID().ApplyT(func(id string) (string, error) {
return fmt.Sprintf("%v/authorizationrules/RootManageSharedAccessKey", id), nil
}).(pulumi.StringOutput),
StorageAccountId: exampleAccount.ID(),
RetentionPolicy: &monitoring.LogProfileRetentionPolicyArgs{
Enabled: pulumi.Bool(true),
Days: pulumi.Int(7),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;
return await Deployment.RunAsync(() =>
{
var example = new Azure.Core.ResourceGroup("example", new()
{
Name = "logprofiletest-rg",
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("example", new()
{
Name = "afscsdfytw",
ResourceGroupName = example.Name,
Location = example.Location,
AccountTier = "Standard",
AccountReplicationType = "GRS",
});
var exampleEventHubNamespace = new Azure.EventHub.EventHubNamespace("example", new()
{
Name = "logprofileeventhub",
Location = example.Location,
ResourceGroupName = example.Name,
Sku = "Standard",
Capacity = 2,
});
var exampleLogProfile = new Azure.Monitoring.LogProfile("example", new()
{
Name = "default",
Categories = new[]
{
"Action",
"Delete",
"Write",
},
Locations = new[]
{
"westus",
"global",
},
ServicebusRuleId = exampleEventHubNamespace.Id.Apply(id => $"{id}/authorizationrules/RootManageSharedAccessKey"),
StorageAccountId = exampleAccount.Id,
RetentionPolicy = new Azure.Monitoring.Inputs.LogProfileRetentionPolicyArgs
{
Enabled = true,
Days = 7,
},
});
});
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.storage.Account;
import com.pulumi.azure.storage.AccountArgs;
import com.pulumi.azure.eventhub.EventHubNamespace;
import com.pulumi.azure.eventhub.EventHubNamespaceArgs;
import com.pulumi.azure.monitoring.LogProfile;
import com.pulumi.azure.monitoring.LogProfileArgs;
import com.pulumi.azure.monitoring.inputs.LogProfileRetentionPolicyArgs;
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("logprofiletest-rg")
.location("West Europe")
.build());
var exampleAccount = new Account("exampleAccount", AccountArgs.builder()
.name("afscsdfytw")
.resourceGroupName(example.name())
.location(example.location())
.accountTier("Standard")
.accountReplicationType("GRS")
.build());
var exampleEventHubNamespace = new EventHubNamespace("exampleEventHubNamespace", EventHubNamespaceArgs.builder()
.name("logprofileeventhub")
.location(example.location())
.resourceGroupName(example.name())
.sku("Standard")
.capacity(2)
.build());
var exampleLogProfile = new LogProfile("exampleLogProfile", LogProfileArgs.builder()
.name("default")
.categories(
"Action",
"Delete",
"Write")
.locations(
"westus",
"global")
.servicebusRuleId(exampleEventHubNamespace.id().applyValue(id -> String.format("%s/authorizationrules/RootManageSharedAccessKey", id)))
.storageAccountId(exampleAccount.id())
.retentionPolicy(LogProfileRetentionPolicyArgs.builder()
.enabled(true)
.days(7)
.build())
.build());
}
}
resources:
example:
type: azure:core:ResourceGroup
properties:
name: logprofiletest-rg
location: West Europe
exampleAccount:
type: azure:storage:Account
name: example
properties:
name: afscsdfytw
resourceGroupName: ${example.name}
location: ${example.location}
accountTier: Standard
accountReplicationType: GRS
exampleEventHubNamespace:
type: azure:eventhub:EventHubNamespace
name: example
properties:
name: logprofileeventhub
location: ${example.location}
resourceGroupName: ${example.name}
sku: Standard
capacity: 2
exampleLogProfile:
type: azure:monitoring:LogProfile
name: example
properties:
name: default
categories:
- Action
- Delete
- Write
locations:
- westus
- global
servicebusRuleId: ${exampleEventHubNamespace.id}/authorizationrules/RootManageSharedAccessKey
storageAccountId: ${exampleAccount.id}
retentionPolicy:
enabled: true
days: 7
Create LogProfile Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new LogProfile(name: string, args: LogProfileArgs, opts?: CustomResourceOptions);
@overload
def LogProfile(resource_name: str,
args: LogProfileArgs,
opts: Optional[ResourceOptions] = None)
@overload
def LogProfile(resource_name: str,
opts: Optional[ResourceOptions] = None,
categories: Optional[Sequence[str]] = None,
locations: Optional[Sequence[str]] = None,
retention_policy: Optional[LogProfileRetentionPolicyArgs] = None,
name: Optional[str] = None,
servicebus_rule_id: Optional[str] = None,
storage_account_id: Optional[str] = None)
func NewLogProfile(ctx *Context, name string, args LogProfileArgs, opts ...ResourceOption) (*LogProfile, error)
public LogProfile(string name, LogProfileArgs args, CustomResourceOptions? opts = null)
public LogProfile(String name, LogProfileArgs args)
public LogProfile(String name, LogProfileArgs args, CustomResourceOptions options)
type: azure:monitoring:LogProfile
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args LogProfileArgs
- 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 LogProfileArgs
- 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 LogProfileArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LogProfileArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LogProfileArgs
- 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 logProfileResource = new Azure.Monitoring.LogProfile("logProfileResource", new()
{
Categories = new[]
{
"string",
},
Locations = new[]
{
"string",
},
RetentionPolicy = new Azure.Monitoring.Inputs.LogProfileRetentionPolicyArgs
{
Enabled = false,
Days = 0,
},
Name = "string",
ServicebusRuleId = "string",
StorageAccountId = "string",
});
example, err := monitoring.NewLogProfile(ctx, "logProfileResource", &monitoring.LogProfileArgs{
Categories: pulumi.StringArray{
pulumi.String("string"),
},
Locations: pulumi.StringArray{
pulumi.String("string"),
},
RetentionPolicy: &monitoring.LogProfileRetentionPolicyArgs{
Enabled: pulumi.Bool(false),
Days: pulumi.Int(0),
},
Name: pulumi.String("string"),
ServicebusRuleId: pulumi.String("string"),
StorageAccountId: pulumi.String("string"),
})
var logProfileResource = new LogProfile("logProfileResource", LogProfileArgs.builder()
.categories("string")
.locations("string")
.retentionPolicy(LogProfileRetentionPolicyArgs.builder()
.enabled(false)
.days(0)
.build())
.name("string")
.servicebusRuleId("string")
.storageAccountId("string")
.build());
log_profile_resource = azure.monitoring.LogProfile("logProfileResource",
categories=["string"],
locations=["string"],
retention_policy=azure.monitoring.LogProfileRetentionPolicyArgs(
enabled=False,
days=0,
),
name="string",
servicebus_rule_id="string",
storage_account_id="string")
const logProfileResource = new azure.monitoring.LogProfile("logProfileResource", {
categories: ["string"],
locations: ["string"],
retentionPolicy: {
enabled: false,
days: 0,
},
name: "string",
servicebusRuleId: "string",
storageAccountId: "string",
});
type: azure:monitoring:LogProfile
properties:
categories:
- string
locations:
- string
name: string
retentionPolicy:
days: 0
enabled: false
servicebusRuleId: string
storageAccountId: string
LogProfile 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 LogProfile resource accepts the following input properties:
- Categories List<string>
- List of categories of the logs.
- Locations List<string>
- List of regions for which Activity Log events are stored or streamed.
- Retention
Policy LogProfile Retention Policy - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - Name string
- The name of the Log Profile. Changing this forces a new resource to be created.
- Servicebus
Rule stringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - Storage
Account stringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- Categories []string
- List of categories of the logs.
- Locations []string
- List of regions for which Activity Log events are stored or streamed.
- Retention
Policy LogProfile Retention Policy Args - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - Name string
- The name of the Log Profile. Changing this forces a new resource to be created.
- Servicebus
Rule stringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - Storage
Account stringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories List<String>
- List of categories of the logs.
- locations List<String>
- List of regions for which Activity Log events are stored or streamed.
- retention
Policy LogProfile Retention Policy - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - name String
- The name of the Log Profile. Changing this forces a new resource to be created.
- servicebus
Rule StringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage
Account StringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories string[]
- List of categories of the logs.
- locations string[]
- List of regions for which Activity Log events are stored or streamed.
- retention
Policy LogProfile Retention Policy - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - name string
- The name of the Log Profile. Changing this forces a new resource to be created.
- servicebus
Rule stringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage
Account stringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories Sequence[str]
- List of categories of the logs.
- locations Sequence[str]
- List of regions for which Activity Log events are stored or streamed.
- retention_
policy LogProfile Retention Policy Args - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - name str
- The name of the Log Profile. Changing this forces a new resource to be created.
- servicebus_
rule_ strid - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage_
account_ strid - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories List<String>
- List of categories of the logs.
- locations List<String>
- List of regions for which Activity Log events are stored or streamed.
- retention
Policy Property Map - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - name String
- The name of the Log Profile. Changing this forces a new resource to be created.
- servicebus
Rule StringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage
Account StringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
Outputs
All input properties are implicitly available as output properties. Additionally, the LogProfile 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 LogProfile Resource
Get an existing LogProfile 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?: LogProfileState, opts?: CustomResourceOptions): LogProfile
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
categories: Optional[Sequence[str]] = None,
locations: Optional[Sequence[str]] = None,
name: Optional[str] = None,
retention_policy: Optional[LogProfileRetentionPolicyArgs] = None,
servicebus_rule_id: Optional[str] = None,
storage_account_id: Optional[str] = None) -> LogProfile
func GetLogProfile(ctx *Context, name string, id IDInput, state *LogProfileState, opts ...ResourceOption) (*LogProfile, error)
public static LogProfile Get(string name, Input<string> id, LogProfileState? state, CustomResourceOptions? opts = null)
public static LogProfile get(String name, Output<String> id, LogProfileState 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.
- Categories List<string>
- List of categories of the logs.
- Locations List<string>
- List of regions for which Activity Log events are stored or streamed.
- Name string
- The name of the Log Profile. Changing this forces a new resource to be created.
- Retention
Policy LogProfile Retention Policy - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - Servicebus
Rule stringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - Storage
Account stringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- Categories []string
- List of categories of the logs.
- Locations []string
- List of regions for which Activity Log events are stored or streamed.
- Name string
- The name of the Log Profile. Changing this forces a new resource to be created.
- Retention
Policy LogProfile Retention Policy Args - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - Servicebus
Rule stringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - Storage
Account stringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories List<String>
- List of categories of the logs.
- locations List<String>
- List of regions for which Activity Log events are stored or streamed.
- name String
- The name of the Log Profile. Changing this forces a new resource to be created.
- retention
Policy LogProfile Retention Policy - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - servicebus
Rule StringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage
Account StringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories string[]
- List of categories of the logs.
- locations string[]
- List of regions for which Activity Log events are stored or streamed.
- name string
- The name of the Log Profile. Changing this forces a new resource to be created.
- retention
Policy LogProfile Retention Policy - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - servicebus
Rule stringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage
Account stringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories Sequence[str]
- List of categories of the logs.
- locations Sequence[str]
- List of regions for which Activity Log events are stored or streamed.
- name str
- The name of the Log Profile. Changing this forces a new resource to be created.
- retention_
policy LogProfile Retention Policy Args - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - servicebus_
rule_ strid - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage_
account_ strid - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
- categories List<String>
- List of categories of the logs.
- locations List<String>
- List of regions for which Activity Log events are stored or streamed.
- name String
- The name of the Log Profile. Changing this forces a new resource to be created.
- retention
Policy Property Map - A
retention_policy
block as documented below. A retention policy for how long Activity Logs are retained in the storage account. - servicebus
Rule StringId - The service bus (or event hub) rule ID of the service bus (or event hub) namespace in which the Activity Log is streamed to. At least one of
storage_account_id
orservicebus_rule_id
must be set. - storage
Account StringId - The resource ID of the storage account in which the Activity Log is stored. At least one of
storage_account_id
orservicebus_rule_id
must be set.
Supporting Types
LogProfileRetentionPolicy, LogProfileRetentionPolicyArgs
Import
A Log Profile can be imported using the resource id
, e.g.
$ pulumi import azure:monitoring/logProfile:LogProfile example /subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Insights/logProfiles/test
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.