Azure Classic v5.38.0, Mar 21 23

azure.core.ResourceGroupTemplateDeployment

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.

Create ResourceGroupTemplateDeployment Resource

new ResourceGroupTemplateDeployment(name: string, args: ResourceGroupTemplateDeploymentArgs, opts?: CustomResourceOptions);

@overload
def ResourceGroupTemplateDeployment(resource_name: str,
                                    opts: Optional[ResourceOptions] = None,
                                    debug_level: Optional[str] = None,
                                    deployment_mode: Optional[str] = None,
                                    name: Optional[str] = None,
                                    parameters_content: Optional[str] = None,
                                    resource_group_name: Optional[str] = None,
                                    tags: Optional[Mapping[str, str]] = None,
                                    template_content: Optional[str] = None,
                                    template_spec_version_id: Optional[str] = None)
@overload
def ResourceGroupTemplateDeployment(resource_name: str,
                                    args: ResourceGroupTemplateDeploymentArgs,
                                    opts: Optional[ResourceOptions] = None)

func NewResourceGroupTemplateDeployment(ctx *Context, name string, args ResourceGroupTemplateDeploymentArgs, opts ...ResourceOption) (*ResourceGroupTemplateDeployment, error)

public ResourceGroupTemplateDeployment(string name, ResourceGroupTemplateDeploymentArgs args, CustomResourceOptions? opts = null)

public ResourceGroupTemplateDeployment(String name, ResourceGroupTemplateDeploymentArgs args)
public ResourceGroupTemplateDeployment(String name, ResourceGroupTemplateDeploymentArgs args, CustomResourceOptions options)

type: azure:core:ResourceGroupTemplateDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ResourceGroupTemplateDeploymentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ResourceGroupTemplateDeploymentArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ResourceGroupTemplateDeploymentArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ResourceGroupTemplateDeploymentArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ResourceGroupTemplateDeploymentArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ResourceGroupTemplateDeployment Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ResourceGroupTemplateDeployment resource accepts the following input properties:

DeploymentMode string: 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).
ResourceGroupName string: 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.
DebugLevel string: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
Name string: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
ParametersContent string: The contents of the ARM Template parameters file - containing a JSON list of parameters.
Tags Dictionary<string, string>: A mapping of tags which should be assigned to the Resource Group Template Deployment.
TemplateContent string: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
TemplateSpecVersionId string: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

DeploymentMode string: 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).
ResourceGroupName string: 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.
DebugLevel string: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
Name string: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
ParametersContent string: The contents of the ARM Template parameters file - containing a JSON list of parameters.
Tags map[string]string: A mapping of tags which should be assigned to the Resource Group Template Deployment.
TemplateContent string: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
TemplateSpecVersionId string: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

deploymentMode String: 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).
resourceGroupName String: 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.
debugLevel String: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
name String: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
parametersContent String: The contents of the ARM Template parameters file - containing a JSON list of parameters.
tags Map<String,String>: A mapping of tags which should be assigned to the Resource Group Template Deployment.
templateContent String: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
templateSpecVersionId String: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

deploymentMode string: 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).
resourceGroupName string: 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.
debugLevel string: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
name string: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
parametersContent string: The contents of the ARM Template parameters file - containing a JSON list of parameters.
tags {[key: string]: string}: A mapping of tags which should be assigned to the Resource Group Template Deployment.
templateContent string: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
templateSpecVersionId string: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

deployment_mode str: 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).
resource_group_name str: 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.
debug_level str: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
name str: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
parameters_content str: The contents of the ARM Template parameters file - containing a JSON list of parameters.
tags Mapping[str, str]: A mapping of tags which should be assigned to the Resource Group Template Deployment.
template_content str: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
template_spec_version_id str: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

deploymentMode String: 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).
resourceGroupName String: 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.
debugLevel String: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
name String: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
parametersContent String: The contents of the ARM Template parameters file - containing a JSON list of parameters.
tags Map<String>: A mapping of tags which should be assigned to the Resource Group Template Deployment.
templateContent String: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
templateSpecVersionId String: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

Outputs

All input properties are implicitly available as output properties. Additionally, the ResourceGroupTemplateDeployment resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
OutputContent string: The JSON Content of the Outputs of the ARM Template Deployment.

Id string: The provider-assigned unique ID for this managed resource.
OutputContent string: The JSON Content of the Outputs of the ARM Template Deployment.

id String: The provider-assigned unique ID for this managed resource.
outputContent String: The JSON Content of the Outputs of the ARM Template Deployment.

id string: The provider-assigned unique ID for this managed resource.
outputContent string: The JSON Content of the Outputs of the ARM Template Deployment.

id str: The provider-assigned unique ID for this managed resource.
output_content str: The JSON Content of the Outputs of the ARM Template Deployment.

id String: The provider-assigned unique ID for this managed resource.
outputContent String: The JSON Content of the Outputs of the ARM Template Deployment.

Look up Existing ResourceGroupTemplateDeployment Resource

Get an existing ResourceGroupTemplateDeployment resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ResourceGroupTemplateDeploymentState, opts?: CustomResourceOptions): ResourceGroupTemplateDeployment

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        debug_level: Optional[str] = None,
        deployment_mode: Optional[str] = None,
        name: Optional[str] = None,
        output_content: Optional[str] = None,
        parameters_content: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        template_content: Optional[str] = None,
        template_spec_version_id: Optional[str] = None) -> ResourceGroupTemplateDeployment

func GetResourceGroupTemplateDeployment(ctx *Context, name string, id IDInput, state *ResourceGroupTemplateDeploymentState, opts ...ResourceOption) (*ResourceGroupTemplateDeployment, error)

public static ResourceGroupTemplateDeployment Get(string name, Input<string> id, ResourceGroupTemplateDeploymentState? state, CustomResourceOptions? opts = null)

public static ResourceGroupTemplateDeployment get(String name, Output<String> id, ResourceGroupTemplateDeploymentState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DebugLevel string: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
DeploymentMode string: 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).
Name string: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
OutputContent string: The JSON Content of the Outputs of the ARM Template Deployment.
ParametersContent string: The contents of the ARM Template parameters file - containing a JSON list of parameters.
ResourceGroupName string: 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.
Tags Dictionary<string, string>: A mapping of tags which should be assigned to the Resource Group Template Deployment.
TemplateContent string: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
TemplateSpecVersionId string: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

DebugLevel string: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
DeploymentMode string: 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).
Name string: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
OutputContent string: The JSON Content of the Outputs of the ARM Template Deployment.
ParametersContent string: The contents of the ARM Template parameters file - containing a JSON list of parameters.
ResourceGroupName string: 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.
Tags map[string]string: A mapping of tags which should be assigned to the Resource Group Template Deployment.
TemplateContent string: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
TemplateSpecVersionId string: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

debugLevel String: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
deploymentMode String: 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).
name String: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
outputContent String: The JSON Content of the Outputs of the ARM Template Deployment.
parametersContent String: The contents of the ARM Template parameters file - containing a JSON list of parameters.
resourceGroupName String: 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.
tags Map<String,String>: A mapping of tags which should be assigned to the Resource Group Template Deployment.
templateContent String: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
templateSpecVersionId String: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

debugLevel string: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
deploymentMode string: 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).
name string: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
outputContent string: The JSON Content of the Outputs of the ARM Template Deployment.
parametersContent string: The contents of the ARM Template parameters file - containing a JSON list of parameters.
resourceGroupName string: 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.
tags {[key: string]: string}: A mapping of tags which should be assigned to the Resource Group Template Deployment.
templateContent string: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
templateSpecVersionId string: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

debug_level str: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
deployment_mode str: 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).
name str: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
output_content str: The JSON Content of the Outputs of the ARM Template Deployment.
parameters_content str: The contents of the ARM Template parameters file - containing a JSON list of parameters.
resource_group_name str: 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.
tags Mapping[str, str]: A mapping of tags which should be assigned to the Resource Group Template Deployment.
template_content str: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
template_spec_version_id str: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

debugLevel String: The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.
deploymentMode String: 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).
name String: The name which should be used for this Resource Group Template Deployment. Changing this forces a new Resource Group Template Deployment to be created.
outputContent String: The JSON Content of the Outputs of the ARM Template Deployment.
parametersContent String: The contents of the ARM Template parameters file - containing a JSON list of parameters.
resourceGroupName String: 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.
tags Map<String>: A mapping of tags which should be assigned to the Resource Group Template Deployment.
templateContent String: The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with template_spec_version_id.
templateSpecVersionId String: The ID of the Template Spec Version to deploy. Cannot be specified with template_content.

Import

Resource Group Template Deployments can be imported using the resource id, e.g.

 $ pulumi import azure:core/resourceGroupTemplateDeployment:ResourceGroupTemplateDeployment example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Resources/deployments/template1

Package Details

Repository: Azure Classic pulumi/pulumi-azure
License: Apache-2.0
Notes: This Pulumi package is based on the azurerm Terraform Provider.