com.pulumi.azure.core.ResourceGroupTemplateDeployment Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of azure Show documentation
Show all versions of azure Show documentation
A Pulumi package for creating and managing Microsoft Azure cloud resources, based on the Terraform azurerm provider. We recommend using the [Azure Native provider](https://github.com/pulumi/pulumi-azure-native) to provision Azure infrastructure. Azure Native provides complete coverage of Azure resources and same-day access to new resources and resource updates.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.azure.core;
import com.pulumi.azure.Utilities;
import com.pulumi.azure.core.ResourceGroupTemplateDeploymentArgs;
import com.pulumi.azure.core.inputs.ResourceGroupTemplateDeploymentState;
import com.pulumi.core.Alias;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Manages a Resource Group Template Deployment.
*
* > **Note:** This resource will automatically attempt to delete resources deployed by the ARM Template when it is deleted. This behavior can be disabled in the provider `features` block by setting the `delete_nested_items_during_deletion` field to `false` within the `template_deployment` block.
*
* ## Import
*
* Resource Group Template Deployments can be imported using the `resource id`, e.g.
*
* ```sh
* $ pulumi import azure:core/resourceGroupTemplateDeployment:ResourceGroupTemplateDeployment example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Resources/deployments/template1
* ```
*
*/
@ResourceType(type="azure:core/resourceGroupTemplateDeployment:ResourceGroupTemplateDeployment")
public class ResourceGroupTemplateDeployment extends com.pulumi.resources.CustomResource {
/**
* The Debug Level which should be used for this Resource Group Template Deployment. Possible values are `none`, `requestContent`, `responseContent` and `requestContent, responseContent`.
*
*/
@Export(name="debugLevel", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> debugLevel;
/**
* @return The Debug Level which should be used for this Resource Group Template Deployment. Possible values are `none`, `requestContent`, `responseContent` and `requestContent, responseContent`.
*
*/
public Output> debugLevel() {
return Codegen.optional(this.debugLevel);
}
/**
* The Deployment Mode for this Resource Group Template Deployment. Possible values are `Complete` (where resources in the Resource Group not specified in the ARM Template will be destroyed) and `Incremental` (where resources are additive only).
*
* > **Note:** If `deployment_mode` is set to `Complete` then resources within this Resource Group which are not defined in the ARM Template will be deleted.
*
*/
@Export(name="deploymentMode", refs={String.class}, tree="[0]")
private Output deploymentMode;
/**
* @return The Deployment Mode for this Resource Group Template Deployment. Possible values are `Complete` (where resources in the Resource Group not specified in the ARM Template will be destroyed) and `Incremental` (where resources are additive only).
*
* > **Note:** If `deployment_mode` is set to `Complete` then resources within this Resource Group which are not defined in the ARM Template will be deleted.
*
*/
public Output deploymentMode() {
return this.deploymentMode;
}
/**
* The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
*
*/
public Output name() {
return this.name;
}
/**
* The JSON Content of the Outputs of the ARM Template Deployment.
*
*/
@Export(name="outputContent", refs={String.class}, tree="[0]")
private Output outputContent;
/**
* @return The JSON Content of the Outputs of the ARM Template Deployment.
*
*/
public Output outputContent() {
return this.outputContent;
}
/**
* The contents of the ARM Template parameters file - containing a JSON list of parameters.
*
* > An example of how to pass variables into an ARM Template can be seen in the example.
*
*/
@Export(name="parametersContent", refs={String.class}, tree="[0]")
private Output parametersContent;
/**
* @return The contents of the ARM Template parameters file - containing a JSON list of parameters.
*
* > An example of how to pass variables into an ARM Template can be seen in the example.
*
*/
public Output parametersContent() {
return this.parametersContent;
}
/**
* The name of the Resource Group where the Resource Group Template Deployment should exist. Changing this forces a new Resource Group Template Deployment to be created.
*
*/
@Export(name="resourceGroupName", refs={String.class}, tree="[0]")
private Output resourceGroupName;
/**
* @return The name of the Resource Group where the Resource Group Template Deployment should exist. Changing this forces a new Resource Group Template Deployment to be created.
*
*/
public Output resourceGroupName() {
return this.resourceGroupName;
}
/**
* A mapping of tags which should be assigned to the Resource Group Template Deployment.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output* @Nullable */ Map> tags;
/**
* @return A mapping of tags which should be assigned to the Resource Group Template Deployment.
*
*/
public Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with `template_spec_version_id`.
*
*/
@Export(name="templateContent", refs={String.class}, tree="[0]")
private Output templateContent;
/**
* @return The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with `template_spec_version_id`.
*
*/
public Output templateContent() {
return this.templateContent;
}
/**
* The ID of the Template Spec Version to deploy. Cannot be specified with `template_content`.
*
*/
@Export(name="templateSpecVersionId", refs={String.class}, tree="[0]")
private Output* @Nullable */ String> templateSpecVersionId;
/**
* @return The ID of the Template Spec Version to deploy. Cannot be specified with `template_content`.
*
*/
public Output> templateSpecVersionId() {
return Codegen.optional(this.templateSpecVersionId);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public ResourceGroupTemplateDeployment(java.lang.String name) {
this(name, ResourceGroupTemplateDeploymentArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public ResourceGroupTemplateDeployment(java.lang.String name, ResourceGroupTemplateDeploymentArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public ResourceGroupTemplateDeployment(java.lang.String name, ResourceGroupTemplateDeploymentArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:core/resourceGroupTemplateDeployment:ResourceGroupTemplateDeployment", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private ResourceGroupTemplateDeployment(java.lang.String name, Output id, @Nullable ResourceGroupTemplateDeploymentState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("azure:core/resourceGroupTemplateDeployment:ResourceGroupTemplateDeployment", name, state, makeResourceOptions(options, id), false);
}
private static ResourceGroupTemplateDeploymentArgs makeArgs(ResourceGroupTemplateDeploymentArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? ResourceGroupTemplateDeploymentArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.aliases(List.of(
Output.of(Alias.builder().type("azure:core/templateDeployment:TemplateDeployment").build())
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static ResourceGroupTemplateDeployment get(java.lang.String name, Output id, @Nullable ResourceGroupTemplateDeploymentState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new ResourceGroupTemplateDeployment(name, id, state, options);
}
}