DeploymentAtScopeArgs

data class DeploymentAtScopeArgs(val deploymentName: Output<String>? = null, val location: Output<String>? = null, val properties: Output<DeploymentPropertiesArgs>? = null, val scope: Output<String>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<DeploymentAtScopeArgs>

Deployment information. Uses Azure REST API version 2024-03-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01. Other available API versions: 2020-10-01, 2021-01-01, 2021-04-01, 2022-09-01, 2023-07-01, 2024-07-01, 2024-11-01, 2025-03-01, 2025-04-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native resources [ApiVersion]. See the ../../../version-guide/#accessing-any-api-version-via-local-packages for details.

Example Usage

Create deployment at a given scope.

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var deploymentAtScope = new AzureNative.Resources.DeploymentAtScope("deploymentAtScope", new()
{
DeploymentName = "my-deployment",
Location = "eastus",
Properties = new AzureNative.Resources.Inputs.DeploymentPropertiesArgs
{
Mode = AzureNative.Resources.DeploymentMode.Incremental,
Parameters = null,
TemplateLink = new AzureNative.Resources.Inputs.TemplateLinkArgs
{
Uri = "https://example.com/exampleTemplate.json",
},
},
Scope = "providers/Microsoft.Management/managementGroups/my-management-group-id",
Tags =
{
{ "tagKey1", "tag-value-1" },
{ "tagKey2", "tag-value-2" },
},
});
});
package main
import (
resources "github.com/pulumi/pulumi-azure-native-sdk/resources/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := resources.NewDeploymentAtScope(ctx, "deploymentAtScope", &resources.DeploymentAtScopeArgs{
DeploymentName: pulumi.String("my-deployment"),
Location: pulumi.String("eastus"),
Properties: &resources.DeploymentPropertiesArgs{
Mode: resources.DeploymentModeIncremental,
Parameters: resources.DeploymentParameterMap{},
TemplateLink: &resources.TemplateLinkArgs{
Uri: pulumi.String("https://example.com/exampleTemplate.json"),
},
},
Scope: pulumi.String("providers/Microsoft.Management/managementGroups/my-management-group-id"),
Tags: pulumi.StringMap{
"tagKey1": pulumi.String("tag-value-1"),
"tagKey2": pulumi.String("tag-value-2"),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.resources.DeploymentAtScope;
import com.pulumi.azurenative.resources.DeploymentAtScopeArgs;
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 deploymentAtScope = new DeploymentAtScope("deploymentAtScope", DeploymentAtScopeArgs.builder()
.deploymentName("my-deployment")
.location("eastus")
.properties(DeploymentPropertiesArgs.builder()
.mode("Incremental")
.parameters(Map.ofEntries(
))
.templateLink(TemplateLinkArgs.builder()
.uri("https://example.com/exampleTemplate.json")
.build())
.build())
.scope("providers/Microsoft.Management/managementGroups/my-management-group-id")
.tags(Map.ofEntries(
Map.entry("tagKey1", "tag-value-1"),
Map.entry("tagKey2", "tag-value-2")
))
.build());
}
}

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:resources:DeploymentAtScope my-deployment /{scope}/providers/Microsoft.Resources/deployments/{deploymentName}

Constructors

Link copied to clipboard
constructor(deploymentName: Output<String>? = null, location: Output<String>? = null, properties: Output<DeploymentPropertiesArgs>? = null, scope: Output<String>? = null, tags: Output<Map<String, String>>? = null)

Properties

Link copied to clipboard
val deploymentName: Output<String>? = null

The name of the deployment.

Link copied to clipboard
val location: Output<String>? = null

The location to store the deployment data.

Link copied to clipboard

The deployment properties.

Link copied to clipboard
val scope: Output<String>? = null

The resource scope.

Link copied to clipboard
val tags: Output<Map<String, String>>? = null

Deployment tags

Functions

Link copied to clipboard
open override fun toJava(): DeploymentAtScopeArgs