1. Pulumi Registry
  2. Azure Classic
  3. API Docs
  4. core
  5. TenantTemplateDeployment
azure logo
Azure Classic v5.38.0, Mar 21 23

azure.core.TenantTemplateDeployment

Import

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

 $ pulumi import azure:core/tenantTemplateDeployment:TenantTemplateDeployment example /providers/Microsoft.Resources/deployments/deploy1

Example Usage

using System.Collections.Generic;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var exampleTemplateSpecVersion = Azure.Core.GetTemplateSpecVersion.Invoke(new()
    {
        Name = "myTemplateForTenant",
        ResourceGroupName = "myResourceGroup",
        Version = "v0.1",
    });

    var exampleTenantTemplateDeployment = new Azure.Core.TenantTemplateDeployment("exampleTenantTemplateDeployment", new()
    {
        Location = "West Europe",
        TemplateSpecVersionId = exampleTemplateSpecVersion.Apply(getTemplateSpecVersionResult => getTemplateSpecVersionResult.Id),
    });

});

package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/core"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleTemplateSpecVersion, err := core.GetTemplateSpecVersion(ctx, &core.GetTemplateSpecVersionArgs{
			Name:              "myTemplateForTenant",
			ResourceGroupName: "myResourceGroup",
			Version:           "v0.1",
		}, nil)
		if err != nil {
			return err
		}
		_, err = core.NewTenantTemplateDeployment(ctx, "exampleTenantTemplateDeployment", &core.TenantTemplateDeploymentArgs{
			Location:              pulumi.String("West Europe"),
			TemplateSpecVersionId: *pulumi.String(exampleTemplateSpecVersion.Id),
		})
		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.azure.core.CoreFunctions;
import com.pulumi.azure.core.inputs.GetTemplateSpecVersionArgs;
import com.pulumi.azure.core.TenantTemplateDeployment;
import com.pulumi.azure.core.TenantTemplateDeploymentArgs;
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) {
        final var exampleTemplateSpecVersion = CoreFunctions.getTemplateSpecVersion(GetTemplateSpecVersionArgs.builder()
            .name("myTemplateForTenant")
            .resourceGroupName("myResourceGroup")
            .version("v0.1")
            .build());

        var exampleTenantTemplateDeployment = new TenantTemplateDeployment("exampleTenantTemplateDeployment", TenantTemplateDeploymentArgs.builder()        
            .location("West Europe")
            .templateSpecVersionId(exampleTemplateSpecVersion.applyValue(getTemplateSpecVersionResult -> getTemplateSpecVersionResult.id()))
            .build());

    }
}

import pulumi
import pulumi_azure as azure

example_template_spec_version = azure.core.get_template_spec_version(name="myTemplateForTenant",
    resource_group_name="myResourceGroup",
    version="v0.1")
example_tenant_template_deployment = azure.core.TenantTemplateDeployment("exampleTenantTemplateDeployment",
    location="West Europe",
    template_spec_version_id=example_template_spec_version.id)

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const exampleTemplateSpecVersion = azure.core.getTemplateSpecVersion({
    name: "myTemplateForTenant",
    resourceGroupName: "myResourceGroup",
    version: "v0.1",
});
const exampleTenantTemplateDeployment = new azure.core.TenantTemplateDeployment("exampleTenantTemplateDeployment", {
    location: "West Europe",
    templateSpecVersionId: exampleTemplateSpecVersion.then(exampleTemplateSpecVersion => exampleTemplateSpecVersion.id),
});

resources:
  exampleTenantTemplateDeployment:
    type: azure:core:TenantTemplateDeployment
    properties:
      location: West Europe
      templateSpecVersionId: ${exampleTemplateSpecVersion.id}
variables:
  exampleTemplateSpecVersion:
    fn::invoke:
      Function: azure:core:getTemplateSpecVersion
      Arguments:
        name: myTemplateForTenant
        resourceGroupName: myResourceGroup
        version: v0.1

Create TenantTemplateDeployment Resource

new TenantTemplateDeployment(name: string, args?: TenantTemplateDeploymentArgs, opts?: CustomResourceOptions);
@overload
def TenantTemplateDeployment(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             debug_level: Optional[str] = None,
                             location: 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)
@overload
def TenantTemplateDeployment(resource_name: str,
                             args: Optional[TenantTemplateDeploymentArgs] = None,
                             opts: Optional[ResourceOptions] = None)
func NewTenantTemplateDeployment(ctx *Context, name string, args *TenantTemplateDeploymentArgs, opts ...ResourceOption) (*TenantTemplateDeployment, error)
public TenantTemplateDeployment(string name, TenantTemplateDeploymentArgs? args = null, CustomResourceOptions? opts = null)
public TenantTemplateDeployment(String name, TenantTemplateDeploymentArgs args)
public TenantTemplateDeployment(String name, TenantTemplateDeploymentArgs args, CustomResourceOptions options)

type: azure:core:TenantTemplateDeployment
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TenantTemplateDeploymentArgs
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 TenantTemplateDeploymentArgs
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 TenantTemplateDeploymentArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args TenantTemplateDeploymentArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args TenantTemplateDeploymentArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

TenantTemplateDeployment 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 TenantTemplateDeployment resource accepts the following input properties:

DebugLevel string

The Debug Level which should be used for this Resource Group Template Deployment. Possible values are none, requestContent, responseContent and requestContent, responseContent.

Location string

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

Name string

The name which should be used for this Template. Changing this forces a new Template 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 Template.

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.

Location string

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

Name string

The name which should be used for this Template. Changing this forces a new Template 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 Template.

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.

location String

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name String

The name which should be used for this Template. Changing this forces a new Template 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 Template.

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.

location string

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name string

The name which should be used for this Template. Changing this forces a new Template 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 Template.

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.

location str

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name str

The name which should be used for this Template. Changing this forces a new Template 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 Template.

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.

location String

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name String

The name which should be used for this Template. Changing this forces a new Template 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 Template.

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 TenantTemplateDeployment 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 TenantTemplateDeployment Resource

Get an existing TenantTemplateDeployment 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?: TenantTemplateDeploymentState, opts?: CustomResourceOptions): TenantTemplateDeployment
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        debug_level: Optional[str] = None,
        location: Optional[str] = None,
        name: Optional[str] = None,
        output_content: 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) -> TenantTemplateDeployment
func GetTenantTemplateDeployment(ctx *Context, name string, id IDInput, state *TenantTemplateDeploymentState, opts ...ResourceOption) (*TenantTemplateDeployment, error)
public static TenantTemplateDeployment Get(string name, Input<string> id, TenantTemplateDeploymentState? state, CustomResourceOptions? opts = null)
public static TenantTemplateDeployment get(String name, Output<String> id, TenantTemplateDeploymentState 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.

Location string

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

Name string

The name which should be used for this Template. Changing this forces a new Template 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.

Tags Dictionary<string, string>

A mapping of tags which should be assigned to the Template.

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.

Location string

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

Name string

The name which should be used for this Template. Changing this forces a new Template 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.

Tags map[string]string

A mapping of tags which should be assigned to the Template.

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.

location String

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name String

The name which should be used for this Template. Changing this forces a new Template 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.

tags Map<String,String>

A mapping of tags which should be assigned to the Template.

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.

location string

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name string

The name which should be used for this Template. Changing this forces a new Template 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.

tags {[key: string]: string}

A mapping of tags which should be assigned to the Template.

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.

location str

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name str

The name which should be used for this Template. Changing this forces a new Template 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.

tags Mapping[str, str]

A mapping of tags which should be assigned to the Template.

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.

location String

The Azure Region where the Template should exist. Changing this forces a new Template to be created.

name String

The name which should be used for this Template. Changing this forces a new Template 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.

tags Map<String>

A mapping of tags which should be assigned to the Template.

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.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes

This Pulumi package is based on the azurerm Terraform Provider.