com.pulumi.azure.operationalinsights.kotlin.AnalyticsWorkspace.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-azure-kotlin Show documentation
Show all versions of pulumi-azure-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.operationalinsights.kotlin
import com.pulumi.azure.operationalinsights.kotlin.outputs.AnalyticsWorkspaceIdentity
import com.pulumi.azure.operationalinsights.kotlin.outputs.AnalyticsWorkspaceIdentity.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Double
import kotlin.Int
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [AnalyticsWorkspace].
*/
@PulumiTagMarker
public class AnalyticsWorkspaceResourceBuilder internal constructor() {
public var name: String? = null
public var args: AnalyticsWorkspaceArgs = AnalyticsWorkspaceArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend AnalyticsWorkspaceArgsBuilder.() -> Unit) {
val builder = AnalyticsWorkspaceArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): AnalyticsWorkspace {
val builtJavaResource =
com.pulumi.azure.operationalinsights.AnalyticsWorkspace(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return AnalyticsWorkspace(builtJavaResource)
}
}
/**
* Manages a Log Analytics (formally Operational Insights) Workspace.
* ## Example Usage
*
* ```typescript
* 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 exampleAnalyticsWorkspace = new azure.operationalinsights.AnalyticsWorkspace("example", {
* name: "acctest-01",
* location: example.location,
* resourceGroupName: example.name,
* sku: "PerGB2018",
* retentionInDays: 30,
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_analytics_workspace = azure.operationalinsights.AnalyticsWorkspace("example",
* name="acctest-01",
* location=example.location,
* resource_group_name=example.name,
* sku="PerGB2018",
* retention_in_days=30)
* ```
* ```csharp
* 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 exampleAnalyticsWorkspace = new Azure.OperationalInsights.AnalyticsWorkspace("example", new()
* {
* Name = "acctest-01",
* Location = example.Location,
* ResourceGroupName = example.Name,
* Sku = "PerGB2018",
* RetentionInDays = 30,
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/operationalinsights"
* "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
* }
* _, err = operationalinsights.NewAnalyticsWorkspace(ctx, "example", &operationalinsights.AnalyticsWorkspaceArgs{
* Name: pulumi.String("acctest-01"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* Sku: pulumi.String("PerGB2018"),
* RetentionInDays: pulumi.Int(30),
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* 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.operationalinsights.AnalyticsWorkspace;
* import com.pulumi.azure.operationalinsights.AnalyticsWorkspaceArgs;
* 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 exampleAnalyticsWorkspace = new AnalyticsWorkspace("exampleAnalyticsWorkspace", AnalyticsWorkspaceArgs.builder()
* .name("acctest-01")
* .location(example.location())
* .resourceGroupName(example.name())
* .sku("PerGB2018")
* .retentionInDays(30)
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleAnalyticsWorkspace:
* type: azure:operationalinsights:AnalyticsWorkspace
* name: example
* properties:
* name: acctest-01
* location: ${example.location}
* resourceGroupName: ${example.name}
* sku: PerGB2018
* retentionInDays: 30
* ```
*
* ## Import
* Log Analytics Workspaces can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:operationalinsights/analyticsWorkspace:AnalyticsWorkspace workspace1 /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mygroup1/providers/Microsoft.OperationalInsights/workspaces/workspace1
* ```
*/
public class AnalyticsWorkspace internal constructor(
override val javaResource: com.pulumi.azure.operationalinsights.AnalyticsWorkspace,
) : KotlinCustomResource(javaResource, AnalyticsWorkspaceMapper) {
/**
* Specifies if the log Analytics Workspace allow users accessing to data associated with resources they have permission to view, without permission to workspace. Defaults to `true`.
*/
public val allowResourceOnlyPermissions: Output?
get() = javaResource.allowResourceOnlyPermissions().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Is Customer Managed Storage mandatory for query management?
*/
public val cmkForQueryForced: Output?
get() = javaResource.cmkForQueryForced().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The workspace daily quota for ingestion in GB. Defaults to -1 (unlimited) if omitted.
* > **NOTE:** When `sku` is set to `Free` this field should not be set and has a default value of `0.5`.
*/
public val dailyQuotaGb: Output?
get() = javaResource.dailyQuotaGb().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The ID of the Data Collection Rule to use for this workspace.
*/
public val dataCollectionRuleId: Output?
get() = javaResource.dataCollectionRuleId().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* An `identity` block as defined below.
*/
public val identity: Output?
get() = javaResource.identity().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
}).orElse(null)
})
/**
* Whether to remove the data in the Log Analytics Workspace immediately after 30 days.
*/
public val immediateDataPurgeOn30DaysEnabled: Output?
get() = javaResource.immediateDataPurgeOn30DaysEnabled().applyValue({ args0 ->
args0.map({ args0 -> args0 }).orElse(null)
})
/**
* Should the Log Analytics Workspace support ingestion over the Public Internet? Defaults to `true`.
*/
public val internetIngestionEnabled: Output?
get() = javaResource.internetIngestionEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Should the Log Analytics Workspace support querying over the Public Internet? Defaults to `true`.
*/
public val internetQueryEnabled: Output?
get() = javaResource.internetQueryEnabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies if the log Analytics workspace should enforce authentication using Azure AD. Defaults to `false`.
*/
public val localAuthenticationDisabled: Output?
get() = javaResource.localAuthenticationDisabled().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
public val location: Output
get() = javaResource.location().applyValue({ args0 -> args0 })
/**
* Specifies the name of the Log Analytics Workspace. Workspace name should include 4-63 letters, digits or '-'. The '-' shouldn't be the first or the last symbol. Changing this forces a new resource to be created.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The Primary shared key for the Log Analytics Workspace.
*/
public val primarySharedKey: Output
get() = javaResource.primarySharedKey().applyValue({ args0 -> args0 })
/**
* The capacity reservation level in GB for this workspace. Possible values are `100`, `200`, `300`, `400`, `500`, `1000`, `2000` and `5000`.
* > **NOTE:** `reservation_capacity_in_gb_per_day` can only be used when the `sku` is set to `CapacityReservation`.
*/
public val reservationCapacityInGbPerDay: Output?
get() = javaResource.reservationCapacityInGbPerDay().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* The name of the resource group in which the Log Analytics workspace is created. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* The workspace data retention in days. Possible values are either 7 (Free Tier only) or range between 30 and 730.
*/
public val retentionInDays: Output
get() = javaResource.retentionInDays().applyValue({ args0 -> args0 })
/**
* The Secondary shared key for the Log Analytics Workspace.
*/
public val secondarySharedKey: Output
get() = javaResource.secondarySharedKey().applyValue({ args0 -> args0 })
/**
* Specifies the SKU of the Log Analytics Workspace. Possible values are `Free`, `PerNode`, `Premium`, `Standard`, `Standalone`, `Unlimited`, `CapacityReservation`, and `PerGB2018` (new SKU as of `2018-04-03`). Defaults to `PerGB2018`.
* > **NOTE:** A new pricing model took effect on `2018-04-03`, which requires the SKU `PerGB2018`. If you're provisioned resources before this date you have the option of remaining with the previous Pricing SKU and using the other SKUs defined above. More information about [the Pricing SKUs is available at the following URI](https://aka.ms/PricingTierWarning).
* > **NOTE:** Changing `sku` forces a new Log Analytics Workspace to be created, except when changing between `PerGB2018` and `CapacityReservation`. However, changing `sku` to `CapacityReservation` or changing `reservation_capacity_in_gb_per_day` to a higher tier will lead to a 31-days commitment period, during which the SKU cannot be changed to a lower one. Please refer to [official documentation](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/cost-logs#commitment-tiers) for further information.
* > **NOTE:** The `Free` SKU has a default `daily_quota_gb` value of `0.5` (GB).
*/
public val sku: Output
get() = javaResource.sku().applyValue({ args0 -> args0 })
/**
* A mapping of tags to assign to the resource.
* > **NOTE:** If a `azure.operationalinsights.AnalyticsWorkspace` is connected to a `azure.loganalytics.Cluster` via a `azure.loganalytics.LinkedService` you will not be able to modify the workspaces `sku` field until the link between the workspace and the cluster has been broken by deleting the `azure.loganalytics.LinkedService` resource. All other fields are modifiable while the workspace is linked to a cluster.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The Workspace (or Customer) ID for the Log Analytics Workspace.
*/
public val workspaceId: Output
get() = javaResource.workspaceId().applyValue({ args0 -> args0 })
}
public object AnalyticsWorkspaceMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.operationalinsights.AnalyticsWorkspace::class == javaResource::class
override fun map(javaResource: Resource): AnalyticsWorkspace = AnalyticsWorkspace(
javaResource as
com.pulumi.azure.operationalinsights.AnalyticsWorkspace,
)
}
/**
* @see [AnalyticsWorkspace].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [AnalyticsWorkspace].
*/
public suspend fun analyticsWorkspace(
name: String,
block: suspend AnalyticsWorkspaceResourceBuilder.() -> Unit,
): AnalyticsWorkspace {
val builder = AnalyticsWorkspaceResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [AnalyticsWorkspace].
* @param name The _unique_ name of the resulting resource.
*/
public fun analyticsWorkspace(name: String): AnalyticsWorkspace {
val builder = AnalyticsWorkspaceResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy