Please wait. This can take some minutes ...
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
com.pulumi.azurenative.resources.kotlin.Deployment.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.azurenative.resources.kotlin
import com.pulumi.azurenative.resources.kotlin.outputs.DeploymentPropertiesExtendedResponse
import com.pulumi.azurenative.resources.kotlin.outputs.DeploymentPropertiesExtendedResponse.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.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.Map
/**
* Builder for [Deployment].
*/
@PulumiTagMarker
public class DeploymentResourceBuilder internal constructor() {
public var name: String? = null
public var args: DeploymentArgs = DeploymentArgs()
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 DeploymentArgsBuilder.() -> Unit) {
val builder = DeploymentArgsBuilder()
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(): Deployment {
val builtJavaResource = com.pulumi.azurenative.resources.Deployment(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Deployment(builtJavaResource)
}
}
/**
* Deployment information.
* Azure REST API version: 2022-09-01. Prior API version in Azure Native 1.x: 2021-01-01.
* Other available API versions: 2016-07-01, 2023-07-01, 2024-03-01, 2024-07-01.
* ## Example Usage
* ### Create a deployment that will deploy a template with a uri and queryString
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var deployment = new AzureNative.Resources.Deployment("deployment", new()
* {
* DeploymentName = "my-deployment",
* Properties = new AzureNative.Resources.Inputs.DeploymentPropertiesArgs
* {
* Mode = AzureNative.Resources.DeploymentMode.Incremental,
* Parameters = null,
* TemplateLink = new AzureNative.Resources.Inputs.TemplateLinkArgs
* {
* QueryString = "sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d",
* Uri = "https://example.com/exampleTemplate.json",
* },
* },
* ResourceGroupName = "my-resource-group",
* });
* });
* ```
* ```go
* package main
* import (
* resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := resources.NewDeployment(ctx, "deployment", &resources.DeploymentArgs{
* DeploymentName: pulumi.String("my-deployment"),
* Properties: &resources.DeploymentPropertiesArgs{
* Mode: resources.DeploymentModeIncremental,
* Parameters: nil,
* TemplateLink: &resources.TemplateLinkArgs{
* QueryString: pulumi.String("sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d"),
* Uri: pulumi.String("https://example.com/exampleTemplate.json"),
* },
* },
* ResourceGroupName: pulumi.String("my-resource-group"),
* })
* 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.azurenative.resources.Deployment;
* import com.pulumi.azurenative.resources.DeploymentArgs;
* import com.pulumi.azurenative.resources.inputs.DeploymentPropertiesArgs;
* import com.pulumi.azurenative.resources.inputs.TemplateLinkArgs;
* 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 deployment = new Deployment("deployment", DeploymentArgs.builder()
* .deploymentName("my-deployment")
* .properties(DeploymentPropertiesArgs.builder()
* .mode("Incremental")
* .parameters()
* .templateLink(TemplateLinkArgs.builder()
* .queryString("sv=2019-02-02&st=2019-04-29T22%3A18%3A26Z&se=2019-04-30T02%3A23%3A26Z&sr=b&sp=rw&sip=168.1.5.60-168.1.5.70&spr=https&sig=xxxxxxxx0xxxxxxxxxxxxx%2bxxxxxxxxxxxxxxxxxxxx%3d")
* .uri("https://example.com/exampleTemplate.json")
* .build())
* .build())
* .resourceGroupName("my-resource-group")
* .build());
* }
* }
* ```
* ### Create a deployment that will deploy a templateSpec with the given resourceId
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var deployment = new AzureNative.Resources.Deployment("deployment", new()
* {
* DeploymentName = "my-deployment",
* Properties = new AzureNative.Resources.Inputs.DeploymentPropertiesArgs
* {
* Mode = AzureNative.Resources.DeploymentMode.Incremental,
* Parameters = null,
* TemplateLink = new AzureNative.Resources.Inputs.TemplateLinkArgs
* {
* Id = "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1",
* },
* },
* ResourceGroupName = "my-resource-group",
* });
* });
* ```
* ```go
* package main
* import (
* resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := resources.NewDeployment(ctx, "deployment", &resources.DeploymentArgs{
* DeploymentName: pulumi.String("my-deployment"),
* Properties: &resources.DeploymentPropertiesArgs{
* Mode: resources.DeploymentModeIncremental,
* Parameters: nil,
* TemplateLink: &resources.TemplateLinkArgs{
* Id: pulumi.String("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1"),
* },
* },
* ResourceGroupName: pulumi.String("my-resource-group"),
* })
* 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.azurenative.resources.Deployment;
* import com.pulumi.azurenative.resources.DeploymentArgs;
* import com.pulumi.azurenative.resources.inputs.DeploymentPropertiesArgs;
* import com.pulumi.azurenative.resources.inputs.TemplateLinkArgs;
* 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 deployment = new Deployment("deployment", DeploymentArgs.builder()
* .deploymentName("my-deployment")
* .properties(DeploymentPropertiesArgs.builder()
* .mode("Incremental")
* .parameters()
* .templateLink(TemplateLinkArgs.builder()
* .id("/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1")
* .build())
* .build())
* .resourceGroupName("my-resource-group")
* .build());
* }
* }
* ```
* ### Create a deployment that will redeploy another deployment on failure
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var deployment = new AzureNative.Resources.Deployment("deployment", new()
* {
* DeploymentName = "my-deployment",
* Properties = new AzureNative.Resources.Inputs.DeploymentPropertiesArgs
* {
* Mode = AzureNative.Resources.DeploymentMode.Complete,
* OnErrorDeployment = new AzureNative.Resources.Inputs.OnErrorDeploymentArgs
* {
* DeploymentName = "name-of-deployment-to-use",
* Type = AzureNative.Resources.OnErrorDeploymentType.SpecificDeployment,
* },
* Parameters = null,
* TemplateLink = new AzureNative.Resources.Inputs.TemplateLinkArgs
* {
* Uri = "https://example.com/exampleTemplate.json",
* },
* },
* ResourceGroupName = "my-resource-group",
* });
* });
* ```
* ```go
* package main
* import (
* resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := resources.NewDeployment(ctx, "deployment", &resources.DeploymentArgs{
* DeploymentName: pulumi.String("my-deployment"),
* Properties: &resources.DeploymentPropertiesArgs{
* Mode: resources.DeploymentModeComplete,
* OnErrorDeployment: &resources.OnErrorDeploymentArgs{
* DeploymentName: pulumi.String("name-of-deployment-to-use"),
* Type: resources.OnErrorDeploymentTypeSpecificDeployment,
* },
* Parameters: nil,
* TemplateLink: &resources.TemplateLinkArgs{
* Uri: pulumi.String("https://example.com/exampleTemplate.json"),
* },
* },
* ResourceGroupName: pulumi.String("my-resource-group"),
* })
* 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.azurenative.resources.Deployment;
* import com.pulumi.azurenative.resources.DeploymentArgs;
* import com.pulumi.azurenative.resources.inputs.DeploymentPropertiesArgs;
* import com.pulumi.azurenative.resources.inputs.OnErrorDeploymentArgs;
* import com.pulumi.azurenative.resources.inputs.TemplateLinkArgs;
* 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 deployment = new Deployment("deployment", DeploymentArgs.builder()
* .deploymentName("my-deployment")
* .properties(DeploymentPropertiesArgs.builder()
* .mode("Complete")
* .onErrorDeployment(OnErrorDeploymentArgs.builder()
* .deploymentName("name-of-deployment-to-use")
* .type("SpecificDeployment")
* .build())
* .parameters()
* .templateLink(TemplateLinkArgs.builder()
* .uri("https://example.com/exampleTemplate.json")
* .build())
* .build())
* .resourceGroupName("my-resource-group")
* .build());
* }
* }
* ```
* ### Create a deployment that will redeploy the last successful deployment on failure
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using AzureNative = Pulumi.AzureNative;
* return await Deployment.RunAsync(() =>
* {
* var deployment = new AzureNative.Resources.Deployment("deployment", new()
* {
* DeploymentName = "my-deployment",
* Properties = new AzureNative.Resources.Inputs.DeploymentPropertiesArgs
* {
* Mode = AzureNative.Resources.DeploymentMode.Complete,
* OnErrorDeployment = new AzureNative.Resources.Inputs.OnErrorDeploymentArgs
* {
* Type = AzureNative.Resources.OnErrorDeploymentType.LastSuccessful,
* },
* Parameters = null,
* TemplateLink = new AzureNative.Resources.Inputs.TemplateLinkArgs
* {
* Uri = "https://example.com/exampleTemplate.json",
* },
* },
* ResourceGroupName = "my-resource-group",
* });
* });
* ```
* ```go
* package main
* import (
* resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := resources.NewDeployment(ctx, "deployment", &resources.DeploymentArgs{
* DeploymentName: pulumi.String("my-deployment"),
* Properties: &resources.DeploymentPropertiesArgs{
* Mode: resources.DeploymentModeComplete,
* OnErrorDeployment: &resources.OnErrorDeploymentArgs{
* Type: resources.OnErrorDeploymentTypeLastSuccessful,
* },
* Parameters: nil,
* TemplateLink: &resources.TemplateLinkArgs{
* Uri: pulumi.String("https://example.com/exampleTemplate.json"),
* },
* },
* ResourceGroupName: pulumi.String("my-resource-group"),
* })
* 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.azurenative.resources.Deployment;
* import com.pulumi.azurenative.resources.DeploymentArgs;
* import com.pulumi.azurenative.resources.inputs.DeploymentPropertiesArgs;
* import com.pulumi.azurenative.resources.inputs.OnErrorDeploymentArgs;
* import com.pulumi.azurenative.resources.inputs.TemplateLinkArgs;
* 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 deployment = new Deployment("deployment", DeploymentArgs.builder()
* .deploymentName("my-deployment")
* .properties(DeploymentPropertiesArgs.builder()
* .mode("Complete")
* .onErrorDeployment(OnErrorDeploymentArgs.builder()
* .type("LastSuccessful")
* .build())
* .parameters()
* .templateLink(TemplateLinkArgs.builder()
* .uri("https://example.com/exampleTemplate.json")
* .build())
* .build())
* .resourceGroupName("my-resource-group")
* .build());
* }
* }
* ```
* ## Import
* An existing resource can be imported using its type token, name, and identifier, e.g.
* ```sh
* $ pulumi import azure-native:resources:Deployment my-deployment /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}
* ```
*/
public class Deployment internal constructor(
override val javaResource: com.pulumi.azurenative.resources.Deployment,
) : KotlinCustomResource(javaResource, DeploymentMapper) {
/**
* the location of the deployment.
*/
public val location: Output?
get() = javaResource.location().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })
/**
* The name of the deployment.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* Deployment properties.
*/
public val properties: Output
get() = javaResource.properties().applyValue({ args0 -> args0.let({ args0 -> toKotlin(args0) }) })
/**
* Deployment tags
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* The type of the deployment.
*/
public val type: Output
get() = javaResource.type().applyValue({ args0 -> args0 })
}
public object DeploymentMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.azurenative.resources.Deployment::class == javaResource::class
override fun map(javaResource: Resource): Deployment = Deployment(
javaResource as
com.pulumi.azurenative.resources.Deployment,
)
}
/**
* @see [Deployment].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Deployment].
*/
public suspend fun deployment(name: String, block: suspend DeploymentResourceBuilder.() -> Unit): Deployment {
val builder = DeploymentResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Deployment].
* @param name The _unique_ name of the resulting resource.
*/
public fun deployment(name: String): Deployment {
val builder = DeploymentResourceBuilder()
builder.name(name)
return builder.build()
}