com.pulumi.azure.dashboard.kotlin.DashboardFunctions.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
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 6.15.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.azure.dashboard.kotlin

import com.pulumi.azure.dashboard.DashboardFunctions.azurerm_portal_dashboardPlain
import com.pulumi.azure.dashboard.DashboardFunctions.getGrafanaPlain
import com.pulumi.azure.dashboard.kotlin.inputs.Azurerm_portal_dashboardPlainArgs
import com.pulumi.azure.dashboard.kotlin.inputs.Azurerm_portal_dashboardPlainArgsBuilder
import com.pulumi.azure.dashboard.kotlin.inputs.GetGrafanaIdentity
import com.pulumi.azure.dashboard.kotlin.inputs.GetGrafanaPlainArgs
import com.pulumi.azure.dashboard.kotlin.inputs.GetGrafanaPlainArgsBuilder
import com.pulumi.azure.dashboard.kotlin.outputs.Azurerm_portal_dashboardResult
import com.pulumi.azure.dashboard.kotlin.outputs.GetGrafanaResult
import kotlinx.coroutines.future.await
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import com.pulumi.azure.dashboard.kotlin.outputs.Azurerm_portal_dashboardResult.Companion.toKotlin as azurerm_portal_dashboardResultToKotlin
import com.pulumi.azure.dashboard.kotlin.outputs.GetGrafanaResult.Companion.toKotlin as getGrafanaResultToKotlin

public object DashboardFunctions {
    /**
     * Use this data source to access information about an existing shared dashboard in the Azure Portal. This is the data source of the `azure.portal.Dashboard` resource.
     * ## Example Usage
     * 
     * ```typescript
     * import * as pulumi from "@pulumi/pulumi";
     * import * as azure from "@pulumi/azure";
     * const example = azure.portal.getDashboard({
     *     name: "existing-dashboard",
     *     resourceGroupName: "dashboard-rg",
     * });
     * export const id = exampleAzurermDashboard.id;
     * ```
     * ```python
     * import pulumi
     * import pulumi_azure as azure
     * example = azure.portal.get_dashboard(name="existing-dashboard",
     *     resource_group_name="dashboard-rg")
     * pulumi.export("id", example_azurerm_dashboard["id"])
     * ```
     * ```csharp
     * using System.Collections.Generic;
     * using System.Linq;
     * using Pulumi;
     * using Azure = Pulumi.Azure;
     * return await Deployment.RunAsync(() =>
     * {
     *     var example = Azure.Portal.GetDashboard.Invoke(new()
     *     {
     *         Name = "existing-dashboard",
     *         ResourceGroupName = "dashboard-rg",
     *     });
     *     return new Dictionary
     *     {
     *         ["id"] = exampleAzurermDashboard.Id,
     *     };
     * });
     * ```
     * ```go
     * package main
     * import (
     * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/portal"
     * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
     * )
     * func main() {
     * 	pulumi.Run(func(ctx *pulumi.Context) error {
     * 		_, err := portal.LookupDashboard(ctx, &portal.LookupDashboardArgs{
     * 			Name:              pulumi.StringRef("existing-dashboard"),
     * 			ResourceGroupName: "dashboard-rg",
     * 		}, nil)
     * 		if err != nil {
     * 			return err
     * 		}
     * 		ctx.Export("id", exampleAzurermDashboard.Id)
     * 		return nil
     * 	})
     * }
     * ```
     * ```java
     * package generated_program;
     * import com.pulumi.Context;
     * import com.pulumi.Pulumi;
     * import com.pulumi.core.Output;
     * import com.pulumi.azure.portal.PortalFunctions;
     * import com.pulumi.azure.portal.inputs.GetDashboardArgs;
     * 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) {
     *         final var example = PortalFunctions.getDashboard(GetDashboardArgs.builder()
     *             .name("existing-dashboard")
     *             .resourceGroupName("dashboard-rg")
     *             .build());
     *         ctx.export("id", exampleAzurermDashboard.id());
     *     }
     * }
     * ```
     * ```yaml
     * variables:
     *   example:
     *     fn::invoke:
     *       Function: azure:portal:getDashboard
     *       Arguments:
     *         name: existing-dashboard
     *         resourceGroupName: dashboard-rg
     * outputs:
     *   id: ${exampleAzurermDashboard.id}
     * ```
     * 
     * @param argument A collection of arguments for invoking azurerm_portal_dashboard.
     * @return A collection of values returned by azurerm_portal_dashboard.
     */
    @Deprecated(
        message = """
  azure.dashboard.azurerm_portal_dashboard has been deprecated in favor of azure.portal.getDashboard
  """,
    )
    public suspend fun azurerm_portal_dashboard(argument: Azurerm_portal_dashboardPlainArgs): Azurerm_portal_dashboardResult =
        azurerm_portal_dashboardResultToKotlin(azurerm_portal_dashboardPlain(argument.toJava()).await())

    /**
     * @see [azurerm_portal_dashboard].
     * @param dashboardProperties JSON data representing dashboard body.
     * @param displayName Specifies the display name of the shared Azure Portal Dashboard.
     * @param name Specifies the name of the shared Azure Portal Dashboard.
     * @param resourceGroupName Specifies the name of the resource group the shared Azure Portal Dashboard is located in.
     * @return A collection of values returned by azurerm_portal_dashboard.
     */
    @Deprecated(
        message = """
  azure.dashboard.azurerm_portal_dashboard has been deprecated in favor of azure.portal.getDashboard
  """,
    )
    public suspend fun azurerm_portal_dashboard(
        dashboardProperties: String? = null,
        displayName: String? = null,
        name: String? = null,
        resourceGroupName: String,
    ): Azurerm_portal_dashboardResult {
        val argument = Azurerm_portal_dashboardPlainArgs(
            dashboardProperties = dashboardProperties,
            displayName = displayName,
            name = name,
            resourceGroupName = resourceGroupName,
        )
        return azurerm_portal_dashboardResultToKotlin(azurerm_portal_dashboardPlain(argument.toJava()).await())
    }

    /**
     * @see [azurerm_portal_dashboard].
     * @param argument Builder for [com.pulumi.azure.dashboard.kotlin.inputs.Azurerm_portal_dashboardPlainArgs].
     * @return A collection of values returned by azurerm_portal_dashboard.
     */
    @Deprecated(
        message = """
  azure.dashboard.azurerm_portal_dashboard has been deprecated in favor of azure.portal.getDashboard
  """,
    )
    public suspend fun azurerm_portal_dashboard(argument: suspend Azurerm_portal_dashboardPlainArgsBuilder.() -> Unit): Azurerm_portal_dashboardResult {
        val builder = Azurerm_portal_dashboardPlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return azurerm_portal_dashboardResultToKotlin(azurerm_portal_dashboardPlain(builtArgument.toJava()).await())
    }

    /**
     * Use this data source to access information about an existing Grafana Dashboard.
     * ## Example Usage
     * 
     * ```typescript
     * import * as pulumi from "@pulumi/pulumi";
     * import * as azure from "@pulumi/azure";
     * const example = azure.dashboard.getGrafana({
     *     name: "example-grafana-dashboard",
     *     resourceGroupName: "example-rg",
     * });
     * export const name = example.then(example => example.name);
     * ```
     * ```python
     * import pulumi
     * import pulumi_azure as azure
     * example = azure.dashboard.get_grafana(name="example-grafana-dashboard",
     *     resource_group_name="example-rg")
     * pulumi.export("name", example.name)
     * ```
     * ```csharp
     * using System.Collections.Generic;
     * using System.Linq;
     * using Pulumi;
     * using Azure = Pulumi.Azure;
     * return await Deployment.RunAsync(() =>
     * {
     *     var example = Azure.Dashboard.GetGrafana.Invoke(new()
     *     {
     *         Name = "example-grafana-dashboard",
     *         ResourceGroupName = "example-rg",
     *     });
     *     return new Dictionary
     *     {
     *         ["name"] = example.Apply(getGrafanaResult => getGrafanaResult.Name),
     *     };
     * });
     * ```
     * ```go
     * package main
     * import (
     * 	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/dashboard"
     * 	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
     * )
     * func main() {
     * 	pulumi.Run(func(ctx *pulumi.Context) error {
     * 		example, err := dashboard.LookupGrafana(ctx, &dashboard.LookupGrafanaArgs{
     * 			Name:              "example-grafana-dashboard",
     * 			ResourceGroupName: "example-rg",
     * 		}, nil)
     * 		if err != nil {
     * 			return err
     * 		}
     * 		ctx.Export("name", example.Name)
     * 		return nil
     * 	})
     * }
     * ```
     * ```java
     * package generated_program;
     * import com.pulumi.Context;
     * import com.pulumi.Pulumi;
     * import com.pulumi.core.Output;
     * import com.pulumi.azure.dashboard.DashboardFunctions;
     * import com.pulumi.azure.dashboard.inputs.GetGrafanaArgs;
     * 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) {
     *         final var example = DashboardFunctions.getGrafana(GetGrafanaArgs.builder()
     *             .name("example-grafana-dashboard")
     *             .resourceGroupName("example-rg")
     *             .build());
     *         ctx.export("name", example.applyValue(getGrafanaResult -> getGrafanaResult.name()));
     *     }
     * }
     * ```
     * ```yaml
     * variables:
     *   example:
     *     fn::invoke:
     *       Function: azure:dashboard:getGrafana
     *       Arguments:
     *         name: example-grafana-dashboard
     *         resourceGroupName: example-rg
     * outputs:
     *   name: ${example.name}
     * ```
     * 
     * @param argument A collection of arguments for invoking getGrafana.
     * @return A collection of values returned by getGrafana.
     */
    public suspend fun getGrafana(argument: GetGrafanaPlainArgs): GetGrafanaResult =
        getGrafanaResultToKotlin(getGrafanaPlain(argument.toJava()).await())

    /**
     * @see [getGrafana].
     * @param identity The managed identity of the grafana resource.
     * @param name Name of the grafana dashboard.
     * @param resourceGroupName Name of the resource group where resource belongs to.
     * @return A collection of values returned by getGrafana.
     */
    public suspend fun getGrafana(
        identity: GetGrafanaIdentity? = null,
        name: String,
        resourceGroupName: String,
    ): GetGrafanaResult {
        val argument = GetGrafanaPlainArgs(
            identity = identity,
            name = name,
            resourceGroupName = resourceGroupName,
        )
        return getGrafanaResultToKotlin(getGrafanaPlain(argument.toJava()).await())
    }

    /**
     * @see [getGrafana].
     * @param argument Builder for [com.pulumi.azure.dashboard.kotlin.inputs.GetGrafanaPlainArgs].
     * @return A collection of values returned by getGrafana.
     */
    public suspend fun getGrafana(argument: suspend GetGrafanaPlainArgsBuilder.() -> Unit): GetGrafanaResult {
        val builder = GetGrafanaPlainArgsBuilder()
        builder.argument()
        val builtArgument = builder.build()
        return getGrafanaResultToKotlin(getGrafanaPlain(builtArgument.toJava()).await())
    }
}