We recommend using Azure Native.
azure.core.ResourceGroupTemplateDeployment
Explore with Pulumi AI
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 thedelete_nested_items_during_deletion
field tofalse
within thetemplate_deployment
block.
Create ResourceGroupTemplateDeployment Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ResourceGroupTemplateDeployment(name: string, args: ResourceGroupTemplateDeploymentArgs, opts?: CustomResourceOptions);
@overload
def ResourceGroupTemplateDeployment(resource_name: str,
args: ResourceGroupTemplateDeploymentArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ResourceGroupTemplateDeployment(resource_name: str,
opts: Optional[ResourceOptions] = None,
deployment_mode: Optional[str] = None,
resource_group_name: Optional[str] = None,
debug_level: Optional[str] = None,
name: Optional[str] = None,
parameters_content: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
template_content: Optional[str] = None,
template_spec_version_id: Optional[str] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var resourceGroupTemplateDeploymentResource = new Azure.Core.ResourceGroupTemplateDeployment("resourceGroupTemplateDeploymentResource", new()
{
DeploymentMode = "string",
ResourceGroupName = "string",
DebugLevel = "string",
Name = "string",
ParametersContent = "string",
Tags =
{
{ "string", "string" },
},
TemplateContent = "string",
TemplateSpecVersionId = "string",
});
example, err := core.NewResourceGroupTemplateDeployment(ctx, "resourceGroupTemplateDeploymentResource", &core.ResourceGroupTemplateDeploymentArgs{
DeploymentMode: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
DebugLevel: pulumi.String("string"),
Name: pulumi.String("string"),
ParametersContent: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TemplateContent: pulumi.String("string"),
TemplateSpecVersionId: pulumi.String("string"),
})
var resourceGroupTemplateDeploymentResource = new ResourceGroupTemplateDeployment("resourceGroupTemplateDeploymentResource", ResourceGroupTemplateDeploymentArgs.builder()
.deploymentMode("string")
.resourceGroupName("string")
.debugLevel("string")
.name("string")
.parametersContent("string")
.tags(Map.of("string", "string"))
.templateContent("string")
.templateSpecVersionId("string")
.build());
resource_group_template_deployment_resource = azure.core.ResourceGroupTemplateDeployment("resourceGroupTemplateDeploymentResource",
deployment_mode="string",
resource_group_name="string",
debug_level="string",
name="string",
parameters_content="string",
tags={
"string": "string",
},
template_content="string",
template_spec_version_id="string")
const resourceGroupTemplateDeploymentResource = new azure.core.ResourceGroupTemplateDeployment("resourceGroupTemplateDeploymentResource", {
deploymentMode: "string",
resourceGroupName: "string",
debugLevel: "string",
name: "string",
parametersContent: "string",
tags: {
string: "string",
},
templateContent: "string",
templateSpecVersionId: "string",
});
type: azure:core:ResourceGroupTemplateDeployment
properties:
debugLevel: string
deploymentMode: string
name: string
parametersContent: string
resourceGroupName: string
tags:
string: string
templateContent: string
templateSpecVersionId: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ResourceGroupTemplateDeployment resource accepts the following input properties:
- Deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- Resource
Group stringName - 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 string - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, 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.
- Parameters
Content string 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.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- Template
Content string - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - Template
Spec stringVersion Id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- Deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- Resource
Group stringName - 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 string - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, 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.
- Parameters
Content string 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.
- map[string]string
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- Template
Content string - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - Template
Spec stringVersion Id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- resource
Group StringName - 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 String - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, 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.
- parameters
Content String 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.
- Map<String,String>
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- template
Content String - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - template
Spec StringVersion Id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- resource
Group stringName - 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 string - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, 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.
- parameters
Content string 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.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- template
Content string - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - template
Spec stringVersion Id - 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- resource_
group_ strname - 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
andrequestContent, 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.
An example of how to pass variables into an ARM Template can be seen in the example.
- 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_ strversion_ id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- resource
Group StringName - 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 String - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, 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.
- parameters
Content String 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.
- Map<String>
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- template
Content String - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - template
Spec StringVersion Id - 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.
- Output
Content string - The JSON Content of the Outputs of the ARM Template Deployment.
- Id string
- The provider-assigned unique ID for this managed resource.
- Output
Content string - The JSON Content of the Outputs of the ARM Template Deployment.
- id String
- The provider-assigned unique ID for this managed resource.
- output
Content String - The JSON Content of the Outputs of the ARM Template Deployment.
- id string
- The provider-assigned unique ID for this managed resource.
- output
Content 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.
- output
Content 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.
- Debug
Level string - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, responseContent
. - Deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- 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.
- Output
Content string - The JSON Content of the Outputs of the ARM Template Deployment.
- Parameters
Content string 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.
- Resource
Group stringName - 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.
- Dictionary<string, string>
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- Template
Content string - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - Template
Spec stringVersion Id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- Debug
Level string - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, responseContent
. - Deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- 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.
- Output
Content string - The JSON Content of the Outputs of the ARM Template Deployment.
- Parameters
Content string 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.
- Resource
Group stringName - 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.
- map[string]string
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- Template
Content string - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - Template
Spec stringVersion Id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- debug
Level String - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, responseContent
. - deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- 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.
- output
Content String - The JSON Content of the Outputs of the ARM Template Deployment.
- parameters
Content String 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.
- resource
Group StringName - 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.
- Map<String,String>
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- template
Content String - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - template
Spec StringVersion Id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- debug
Level string - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, responseContent
. - deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- 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.
- output
Content string - The JSON Content of the Outputs of the ARM Template Deployment.
- parameters
Content string 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.
- resource
Group stringName - 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.
- {[key: string]: string}
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- template
Content string - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - template
Spec stringVersion Id - 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
andrequestContent, 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- 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.
An example of how to pass variables into an ARM Template can be seen in the example.
- resource_
group_ strname - 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.
- 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_ strversion_ id - The ID of the Template Spec Version to deploy. Cannot be specified with
template_content
.
- debug
Level String - The Debug Level which should be used for this Resource Group Template Deployment. Possible values are
none
,requestContent
,responseContent
andrequestContent, responseContent
. - deployment
Mode 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) andIncremental
(where resources are additive only).Note: If
deployment_mode
is set toComplete
then resources within this Resource Group which are not defined in the ARM Template will be deleted.- 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.
- output
Content String - The JSON Content of the Outputs of the ARM Template Deployment.
- parameters
Content String 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.
- resource
Group StringName - 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.
- Map<String>
- A mapping of tags which should be assigned to the Resource Group Template Deployment.
- template
Content String - The contents of the ARM Template which should be deployed into this Resource Group. Cannot be specified with
template_spec_version_id
. - template
Spec StringVersion Id - 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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Classic pulumi/pulumi-azure
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
azurerm
Terraform Provider.