com.pulumi.azure.portal.kotlin.PortalDashboard.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azure.portal.kotlin
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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [PortalDashboard].
*/
@PulumiTagMarker
public class PortalDashboardResourceBuilder internal constructor() {
public var name: String? = null
public var args: PortalDashboardArgs = PortalDashboardArgs()
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 PortalDashboardArgsBuilder.() -> Unit) {
val builder = PortalDashboardArgsBuilder()
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(): PortalDashboard {
val builtJavaResource = com.pulumi.azure.portal.PortalDashboard(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return PortalDashboard(builtJavaResource)
}
}
/**
*
* ## Import
* Dashboards can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:portal/portalDashboard:PortalDashboard my-board /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.Portal/dashboards/00000000-0000-0000-0000-000000000000
* ```
* Note the URI in the above sample can be found using the Resource Explorer tool in the Azure Portal.
*/
public class PortalDashboard internal constructor(
override val javaResource: com.pulumi.azure.portal.PortalDashboard,
) : KotlinCustomResource(javaResource, PortalDashboardMapper) {
/**
* JSON data representing dashboard body. See above for details on how to obtain this from the Portal.
*/
public val dashboardProperties: Output
get() = javaResource.dashboardProperties().applyValue({ args0 -> args0 })
/**
* 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 Shared Dashboard. Changing this forces a new resource to be created.
* > **Note**: You can specify a tag with the key `hidden-title` to set a more user-friendly title for this Dashboard.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The name of the resource group in which to create the dashboard. Changing this forces a new resource to be created.
*/
public val resourceGroupName: Output
get() = javaResource.resourceGroupName().applyValue({ args0 -> args0 })
/**
* A mapping of tags to assign to the resource.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
}
public object PortalDashboardMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azure.portal.PortalDashboard::class == javaResource::class
override fun map(javaResource: Resource): PortalDashboard = PortalDashboard(
javaResource as
com.pulumi.azure.portal.PortalDashboard,
)
}
/**
* @see [PortalDashboard].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [PortalDashboard].
*/
public suspend fun portalDashboard(
name: String,
block: suspend PortalDashboardResourceBuilder.() -> Unit,
): PortalDashboard {
val builder = PortalDashboardResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [PortalDashboard].
* @param name The _unique_ name of the resulting resource.
*/
public fun portalDashboard(name: String): PortalDashboard {
val builder = PortalDashboardResourceBuilder()
builder.name(name)
return builder.build()
}