com.pulumi.azure.automation.kotlin.RunBookArgs.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.automation.kotlin
import com.pulumi.azure.automation.RunBookArgs.builder
import com.pulumi.azure.automation.kotlin.inputs.RunBookDraftArgs
import com.pulumi.azure.automation.kotlin.inputs.RunBookDraftArgsBuilder
import com.pulumi.azure.automation.kotlin.inputs.RunBookJobScheduleArgs
import com.pulumi.azure.automation.kotlin.inputs.RunBookJobScheduleArgsBuilder
import com.pulumi.azure.automation.kotlin.inputs.RunBookPublishContentLinkArgs
import com.pulumi.azure.automation.kotlin.inputs.RunBookPublishContentLinkArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Boolean
import kotlin.Int
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName
/**
* Manages a Automation Runbook.
* ## 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 exampleAccount = new azure.automation.Account("example", {
* name: "account1",
* location: example.location,
* resourceGroupName: example.name,
* skuName: "Basic",
* });
* const exampleRunBook = new azure.automation.RunBook("example", {
* name: "Get-AzureVMTutorial",
* location: example.location,
* resourceGroupName: example.name,
* automationAccountName: exampleAccount.name,
* logVerbose: true,
* logProgress: true,
* description: "This is an example runbook",
* runbookType: "PowerShellWorkflow",
* publishContentLink: {
* uri: "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_azure as azure
* example = azure.core.ResourceGroup("example",
* name="example-resources",
* location="West Europe")
* example_account = azure.automation.Account("example",
* name="account1",
* location=example.location,
* resource_group_name=example.name,
* sku_name="Basic")
* example_run_book = azure.automation.RunBook("example",
* name="Get-AzureVMTutorial",
* location=example.location,
* resource_group_name=example.name,
* automation_account_name=example_account.name,
* log_verbose=True,
* log_progress=True,
* description="This is an example runbook",
* runbook_type="PowerShellWorkflow",
* publish_content_link=azure.automation.RunBookPublishContentLinkArgs(
* uri="https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
* ))
* ```
* ```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 exampleAccount = new Azure.Automation.Account("example", new()
* {
* Name = "account1",
* Location = example.Location,
* ResourceGroupName = example.Name,
* SkuName = "Basic",
* });
* var exampleRunBook = new Azure.Automation.RunBook("example", new()
* {
* Name = "Get-AzureVMTutorial",
* Location = example.Location,
* ResourceGroupName = example.Name,
* AutomationAccountName = exampleAccount.Name,
* LogVerbose = true,
* LogProgress = true,
* Description = "This is an example runbook",
* RunbookType = "PowerShellWorkflow",
* PublishContentLink = new Azure.Automation.Inputs.RunBookPublishContentLinkArgs
* {
* Uri = "https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1",
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-azure/sdk/v5/go/azure/automation"
* "github.com/pulumi/pulumi-azure/sdk/v5/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
* }
* exampleAccount, err := automation.NewAccount(ctx, "example", &automation.AccountArgs{
* Name: pulumi.String("account1"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* SkuName: pulumi.String("Basic"),
* })
* if err != nil {
* return err
* }
* _, err = automation.NewRunBook(ctx, "example", &automation.RunBookArgs{
* Name: pulumi.String("Get-AzureVMTutorial"),
* Location: example.Location,
* ResourceGroupName: example.Name,
* AutomationAccountName: exampleAccount.Name,
* LogVerbose: pulumi.Bool(true),
* LogProgress: pulumi.Bool(true),
* Description: pulumi.String("This is an example runbook"),
* RunbookType: pulumi.String("PowerShellWorkflow"),
* PublishContentLink: &automation.RunBookPublishContentLinkArgs{
* Uri: pulumi.String("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1"),
* },
* })
* 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.automation.Account;
* import com.pulumi.azure.automation.AccountArgs;
* import com.pulumi.azure.automation.RunBook;
* import com.pulumi.azure.automation.RunBookArgs;
* import com.pulumi.azure.automation.inputs.RunBookPublishContentLinkArgs;
* 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 exampleAccount = new Account("exampleAccount", AccountArgs.builder()
* .name("account1")
* .location(example.location())
* .resourceGroupName(example.name())
* .skuName("Basic")
* .build());
* var exampleRunBook = new RunBook("exampleRunBook", RunBookArgs.builder()
* .name("Get-AzureVMTutorial")
* .location(example.location())
* .resourceGroupName(example.name())
* .automationAccountName(exampleAccount.name())
* .logVerbose("true")
* .logProgress("true")
* .description("This is an example runbook")
* .runbookType("PowerShellWorkflow")
* .publishContentLink(RunBookPublishContentLinkArgs.builder()
* .uri("https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: azure:core:ResourceGroup
* properties:
* name: example-resources
* location: West Europe
* exampleAccount:
* type: azure:automation:Account
* name: example
* properties:
* name: account1
* location: ${example.location}
* resourceGroupName: ${example.name}
* skuName: Basic
* exampleRunBook:
* type: azure:automation:RunBook
* name: example
* properties:
* name: Get-AzureVMTutorial
* location: ${example.location}
* resourceGroupName: ${example.name}
* automationAccountName: ${exampleAccount.name}
* logVerbose: 'true'
* logProgress: 'true'
* description: This is an example runbook
* runbookType: PowerShellWorkflow
* publishContentLink:
* uri: https://raw.githubusercontent.com/Azure/azure-quickstart-templates/c4935ffb69246a6058eb24f54640f53f69d3ac9f/101-automation-runbook-getvms/Runbooks/Get-AzureVMTutorial.ps1
* ```
*
* ## Import
* Automation Runbooks can be imported using the `resource id`, e.g.
* ```sh
* $ pulumi import azure:automation/runBook:RunBook Get-AzureVMTutorial /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Automation/automationAccounts/account1/runbooks/Get-AzureVMTutorial
* ```
* @property automationAccountName The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
* @property content The desired content of the runbook.
* > **NOTE** The Azure API requires a `publish_content_link` to be supplied even when specifying your own `content`.
* @property description A description for this credential.
* @property draft A `draft` block as defined below .
* @property jobSchedules
* @property location Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
* @property logActivityTraceLevel Specifies the activity-level tracing options of the runbook, available only for Graphical runbooks. Possible values are `0` for None, `9` for Basic, and `15` for Detailed. Must turn on Verbose logging in order to see the tracing.
* @property logProgress Progress log option.
* @property logVerbose Verbose log option.
* @property name Specifies the name of the Runbook. Changing this forces a new resource to be created.
* @property publishContentLink One `publish_content_link` block as defined below.
* @property resourceGroupName The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
* @property runbookType The type of the runbook - can be either `Graph`, `GraphPowerShell`, `GraphPowerShellWorkflow`, `PowerShellWorkflow`, `PowerShell`, `PowerShell72`, `Python3`, `Python2` or `Script`. Changing this forces a new resource to be created.
* @property tags A mapping of tags to assign to the resource.
*/
public data class RunBookArgs(
public val automationAccountName: Output? = null,
public val content: Output? = null,
public val description: Output? = null,
public val draft: Output? = null,
public val jobSchedules: Output>? = null,
public val location: Output? = null,
public val logActivityTraceLevel: Output? = null,
public val logProgress: Output? = null,
public val logVerbose: Output? = null,
public val name: Output? = null,
public val publishContentLink: Output? = null,
public val resourceGroupName: Output? = null,
public val runbookType: Output? = null,
public val tags: Output>? = null,
) : ConvertibleToJava {
override fun toJava(): com.pulumi.azure.automation.RunBookArgs =
com.pulumi.azure.automation.RunBookArgs.builder()
.automationAccountName(automationAccountName?.applyValue({ args0 -> args0 }))
.content(content?.applyValue({ args0 -> args0 }))
.description(description?.applyValue({ args0 -> args0 }))
.draft(draft?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
.jobSchedules(
jobSchedules?.applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
})
}),
)
.location(location?.applyValue({ args0 -> args0 }))
.logActivityTraceLevel(logActivityTraceLevel?.applyValue({ args0 -> args0 }))
.logProgress(logProgress?.applyValue({ args0 -> args0 }))
.logVerbose(logVerbose?.applyValue({ args0 -> args0 }))
.name(name?.applyValue({ args0 -> args0 }))
.publishContentLink(
publishContentLink?.applyValue({ args0 ->
args0.let({ args0 ->
args0.toJava()
})
}),
)
.resourceGroupName(resourceGroupName?.applyValue({ args0 -> args0 }))
.runbookType(runbookType?.applyValue({ args0 -> args0 }))
.tags(
tags?.applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}),
).build()
}
/**
* Builder for [RunBookArgs].
*/
@PulumiTagMarker
public class RunBookArgsBuilder internal constructor() {
private var automationAccountName: Output? = null
private var content: Output? = null
private var description: Output? = null
private var draft: Output? = null
private var jobSchedules: Output>? = null
private var location: Output? = null
private var logActivityTraceLevel: Output? = null
private var logProgress: Output? = null
private var logVerbose: Output? = null
private var name: Output? = null
private var publishContentLink: Output? = null
private var resourceGroupName: Output? = null
private var runbookType: Output? = null
private var tags: Output>? = null
/**
* @param value The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
*/
@JvmName("ecyewfmlppeekatg")
public suspend fun automationAccountName(`value`: Output) {
this.automationAccountName = value
}
/**
* @param value The desired content of the runbook.
* > **NOTE** The Azure API requires a `publish_content_link` to be supplied even when specifying your own `content`.
*/
@JvmName("yjsapelhepvknovg")
public suspend fun content(`value`: Output) {
this.content = value
}
/**
* @param value A description for this credential.
*/
@JvmName("vefsqfvlecqsgthv")
public suspend fun description(`value`: Output) {
this.description = value
}
/**
* @param value A `draft` block as defined below .
*/
@JvmName("sewrlhomtdnxsswh")
public suspend fun draft(`value`: Output) {
this.draft = value
}
/**
* @param value
*/
@JvmName("igjewpqpgxmcwkas")
public suspend fun jobSchedules(`value`: Output>) {
this.jobSchedules = value
}
@JvmName("mquhuakbjixrbbdm")
public suspend fun jobSchedules(vararg values: Output) {
this.jobSchedules = Output.all(values.asList())
}
/**
* @param values
*/
@JvmName("vifofjmexecdfoww")
public suspend fun jobSchedules(values: List>) {
this.jobSchedules = Output.all(values)
}
/**
* @param value Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
@JvmName("acdgwsjevphdlpbk")
public suspend fun location(`value`: Output) {
this.location = value
}
/**
* @param value Specifies the activity-level tracing options of the runbook, available only for Graphical runbooks. Possible values are `0` for None, `9` for Basic, and `15` for Detailed. Must turn on Verbose logging in order to see the tracing.
*/
@JvmName("lxxxbsewmvprjoxb")
public suspend fun logActivityTraceLevel(`value`: Output) {
this.logActivityTraceLevel = value
}
/**
* @param value Progress log option.
*/
@JvmName("lbwssyymyquqpkyy")
public suspend fun logProgress(`value`: Output) {
this.logProgress = value
}
/**
* @param value Verbose log option.
*/
@JvmName("eqxlatgghqqepxqf")
public suspend fun logVerbose(`value`: Output) {
this.logVerbose = value
}
/**
* @param value Specifies the name of the Runbook. Changing this forces a new resource to be created.
*/
@JvmName("hhnewljabpomgkhd")
public suspend fun name(`value`: Output) {
this.name = value
}
/**
* @param value One `publish_content_link` block as defined below.
*/
@JvmName("fqxjjlheebgxlmno")
public suspend fun publishContentLink(`value`: Output) {
this.publishContentLink = value
}
/**
* @param value The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
*/
@JvmName("rdtrsooilikebuoe")
public suspend fun resourceGroupName(`value`: Output) {
this.resourceGroupName = value
}
/**
* @param value The type of the runbook - can be either `Graph`, `GraphPowerShell`, `GraphPowerShellWorkflow`, `PowerShellWorkflow`, `PowerShell`, `PowerShell72`, `Python3`, `Python2` or `Script`. Changing this forces a new resource to be created.
*/
@JvmName("duxxaogpjsfjunky")
public suspend fun runbookType(`value`: Output) {
this.runbookType = value
}
/**
* @param value A mapping of tags to assign to the resource.
*/
@JvmName("rdqhlyrhxtonirxb")
public suspend fun tags(`value`: Output>) {
this.tags = value
}
/**
* @param value The name of the automation account in which the Runbook is created. Changing this forces a new resource to be created.
*/
@JvmName("dvacejscfmkbmhlm")
public suspend fun automationAccountName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.automationAccountName = mapped
}
/**
* @param value The desired content of the runbook.
* > **NOTE** The Azure API requires a `publish_content_link` to be supplied even when specifying your own `content`.
*/
@JvmName("ywqoodeuffpkucwx")
public suspend fun content(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.content = mapped
}
/**
* @param value A description for this credential.
*/
@JvmName("jbgtynbuptslhmjc")
public suspend fun description(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.description = mapped
}
/**
* @param value A `draft` block as defined below .
*/
@JvmName("nvmtvfmhbjdbfhvm")
public suspend fun draft(`value`: RunBookDraftArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.draft = mapped
}
/**
* @param argument A `draft` block as defined below .
*/
@JvmName("flcxskdssqgxvpdl")
public suspend fun draft(argument: suspend RunBookDraftArgsBuilder.() -> Unit) {
val toBeMapped = RunBookDraftArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.draft = mapped
}
/**
* @param value
*/
@JvmName("kdncycrxclqquogb")
public suspend fun jobSchedules(`value`: List?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.jobSchedules = mapped
}
/**
* @param argument
*/
@JvmName("yuxvdiyisofweqbb")
public suspend
fun jobSchedules(argument: List Unit>) {
val toBeMapped = argument.toList().map {
RunBookJobScheduleArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.jobSchedules = mapped
}
/**
* @param argument
*/
@JvmName("rvpcnwqvumqplaom")
public suspend fun jobSchedules(
vararg
argument: suspend RunBookJobScheduleArgsBuilder.() -> Unit,
) {
val toBeMapped = argument.toList().map {
RunBookJobScheduleArgsBuilder().applySuspend {
it()
}.build()
}
val mapped = of(toBeMapped)
this.jobSchedules = mapped
}
/**
* @param argument
*/
@JvmName("xgacjkdfmfgexurv")
public suspend fun jobSchedules(argument: suspend RunBookJobScheduleArgsBuilder.() -> Unit) {
val toBeMapped = listOf(RunBookJobScheduleArgsBuilder().applySuspend { argument() }.build())
val mapped = of(toBeMapped)
this.jobSchedules = mapped
}
/**
* @param values
*/
@JvmName("ypsetmohncdtmygy")
public suspend fun jobSchedules(vararg values: RunBookJobScheduleArgs) {
val toBeMapped = values.toList()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.jobSchedules = mapped
}
/**
* @param value Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
*/
@JvmName("caqufddlbikkvdjy")
public suspend fun location(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.location = mapped
}
/**
* @param value Specifies the activity-level tracing options of the runbook, available only for Graphical runbooks. Possible values are `0` for None, `9` for Basic, and `15` for Detailed. Must turn on Verbose logging in order to see the tracing.
*/
@JvmName("stavvwfejprabubk")
public suspend fun logActivityTraceLevel(`value`: Int?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.logActivityTraceLevel = mapped
}
/**
* @param value Progress log option.
*/
@JvmName("wxomrukhmhvjybpv")
public suspend fun logProgress(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.logProgress = mapped
}
/**
* @param value Verbose log option.
*/
@JvmName("tlyxflpbobldnjqn")
public suspend fun logVerbose(`value`: Boolean?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.logVerbose = mapped
}
/**
* @param value Specifies the name of the Runbook. Changing this forces a new resource to be created.
*/
@JvmName("dxkmqdsxnxnyhjef")
public suspend fun name(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.name = mapped
}
/**
* @param value One `publish_content_link` block as defined below.
*/
@JvmName("koqnhxaxctjnfrxu")
public suspend fun publishContentLink(`value`: RunBookPublishContentLinkArgs?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.publishContentLink = mapped
}
/**
* @param argument One `publish_content_link` block as defined below.
*/
@JvmName("uvcbqeefdeckcxwp")
public suspend
fun publishContentLink(argument: suspend RunBookPublishContentLinkArgsBuilder.() -> Unit) {
val toBeMapped = RunBookPublishContentLinkArgsBuilder().applySuspend { argument() }.build()
val mapped = of(toBeMapped)
this.publishContentLink = mapped
}
/**
* @param value The name of the resource group in which the Runbook is created. Changing this forces a new resource to be created.
*/
@JvmName("vadfhfaslbfxmory")
public suspend fun resourceGroupName(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.resourceGroupName = mapped
}
/**
* @param value The type of the runbook - can be either `Graph`, `GraphPowerShell`, `GraphPowerShellWorkflow`, `PowerShellWorkflow`, `PowerShell`, `PowerShell72`, `Python3`, `Python2` or `Script`. Changing this forces a new resource to be created.
*/
@JvmName("enhtynsakptqnkkp")
public suspend fun runbookType(`value`: String?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.runbookType = mapped
}
/**
* @param value A mapping of tags to assign to the resource.
*/
@JvmName("hefjscatfbvolfpa")
public suspend fun tags(`value`: Map?) {
val toBeMapped = value
val mapped = toBeMapped?.let({ args0 -> of(args0) })
this.tags = mapped
}
/**
* @param values A mapping of tags to assign to the resource.
*/
@JvmName("lcaemjckgqdbwulp")
public fun tags(vararg values: Pair) {
val toBeMapped = values.toMap()
val mapped = toBeMapped.let({ args0 -> of(args0) })
this.tags = mapped
}
internal fun build(): RunBookArgs = RunBookArgs(
automationAccountName = automationAccountName,
content = content,
description = description,
draft = draft,
jobSchedules = jobSchedules,
location = location,
logActivityTraceLevel = logActivityTraceLevel,
logProgress = logProgress,
logVerbose = logVerbose,
name = name,
publishContentLink = publishContentLink,
resourceGroupName = resourceGroupName,
runbookType = runbookType,
tags = tags,
)
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy