Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Mso Provider
  3. API Docs
  4. SchemaTemplateDeploy
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet
ciscodevnet/terraform-provider-mso

mso.SchemaTemplateDeploy

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet
ciscodevnet/terraform-provider-mso

    Manages deploy/undeploy operations for schema template on sites.

    This resource is deprecated for NDO v4.1 and later. Use resource mso.SchemaTemplateDeployNdo instead.

    Example Usage

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

const templateDeployer = new mso.SchemaTemplateDeploy("templateDeployer", {
    schemaId: mso_schema.schema1.id,
    templateName: "Template1",
    siteId: mso_site.site1.id,
    undeploy: true,
});

    import pulumi
import pulumi_mso as mso

template_deployer = mso.SchemaTemplateDeploy("templateDeployer",
    schema_id=mso_schema["schema1"]["id"],
    template_name="Template1",
    site_id=mso_site["site1"]["id"],
    undeploy=True)

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/mso/mso"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := mso.NewSchemaTemplateDeploy(ctx, "templateDeployer", &mso.SchemaTemplateDeployArgs{
			SchemaId:     pulumi.Any(mso_schema.Schema1.Id),
			TemplateName: pulumi.String("Template1"),
			SiteId:       pulumi.Any(mso_site.Site1.Id),
			Undeploy:     pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mso = Pulumi.Mso;

return await Deployment.RunAsync(() => 
{
    var templateDeployer = new Mso.SchemaTemplateDeploy("templateDeployer", new()
    {
        SchemaId = mso_schema.Schema1.Id,
        TemplateName = "Template1",
        SiteId = mso_site.Site1.Id,
        Undeploy = true,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.mso.SchemaTemplateDeploy;
import com.pulumi.mso.SchemaTemplateDeployArgs;
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 templateDeployer = new SchemaTemplateDeploy("templateDeployer", SchemaTemplateDeployArgs.builder()
            .schemaId(mso_schema.schema1().id())
            .templateName("Template1")
            .siteId(mso_site.site1().id())
            .undeploy(true)
            .build());

    }
}

    resources:
  templateDeployer:
    type: mso:SchemaTemplateDeploy
    properties:
      schemaId: ${mso_schema.schema1.id}
      templateName: Template1
      siteId: ${mso_site.site1.id}
      undeploy: true

    Argument Reference

    • schema_id - (Required) The schema-id of template.
    • template_name - (Required) name of the template to deploy/undeploy.
    • undeploy - (Optional) Boolean flag indicating whether to undeploy the template from a single site (see site_id) or not. Default is false.
    • site_id - (Optional) Site-id from where the template is to be undeployed. It is required if you set undeploy = true.

    NOTE: This resource is intentionally created non-idempotent so that it deploys the template in every run, it will not fail if there is no change and we deploy the template again. When destroying the resource, all sites will be undeployed.

    Attribute Reference

    No attributes are exported.

    Create SchemaTemplateDeploy Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SchemaTemplateDeploy(name: string, args: SchemaTemplateDeployArgs, opts?: CustomResourceOptions);
    @overload
def SchemaTemplateDeploy(resource_name: str,
                         args: SchemaTemplateDeployArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def SchemaTemplateDeploy(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         schema_id: Optional[str] = None,
                         template_name: Optional[str] = None,
                         force_apply: Optional[str] = None,
                         schema_template_deploy_id: Optional[str] = None,
                         site_id: Optional[str] = None,
                         undeploy: Optional[bool] = None)
    func NewSchemaTemplateDeploy(ctx *Context, name string, args SchemaTemplateDeployArgs, opts ...ResourceOption) (*SchemaTemplateDeploy, error)
    public SchemaTemplateDeploy(string name, SchemaTemplateDeployArgs args, CustomResourceOptions? opts = null)
    public SchemaTemplateDeploy(String name, SchemaTemplateDeployArgs args)
public SchemaTemplateDeploy(String name, SchemaTemplateDeployArgs args, CustomResourceOptions options)

    type: mso:SchemaTemplateDeploy
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 SchemaTemplateDeployArgs
    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 SchemaTemplateDeployArgs
    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 SchemaTemplateDeployArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchemaTemplateDeployArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchemaTemplateDeployArgs
    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 schemaTemplateDeployResource = new Mso.SchemaTemplateDeploy("schemaTemplateDeployResource", new()
{
    SchemaId = "string",
    TemplateName = "string",
    ForceApply = "string",
    SchemaTemplateDeployId = "string",
    SiteId = "string",
    Undeploy = false,
});

    example, err := mso.NewSchemaTemplateDeploy(ctx, "schemaTemplateDeployResource", &mso.SchemaTemplateDeployArgs{
	SchemaId:               pulumi.String("string"),
	TemplateName:           pulumi.String("string"),
	ForceApply:             pulumi.String("string"),
	SchemaTemplateDeployId: pulumi.String("string"),
	SiteId:                 pulumi.String("string"),
	Undeploy:               pulumi.Bool(false),
})

    var schemaTemplateDeployResource = new SchemaTemplateDeploy("schemaTemplateDeployResource", SchemaTemplateDeployArgs.builder()
    .schemaId("string")
    .templateName("string")
    .forceApply("string")
    .schemaTemplateDeployId("string")
    .siteId("string")
    .undeploy(false)
    .build());

    schema_template_deploy_resource = mso.SchemaTemplateDeploy("schemaTemplateDeployResource",
    schema_id="string",
    template_name="string",
    force_apply="string",
    schema_template_deploy_id="string",
    site_id="string",
    undeploy=False)

    const schemaTemplateDeployResource = new mso.SchemaTemplateDeploy("schemaTemplateDeployResource", {
    schemaId: "string",
    templateName: "string",
    forceApply: "string",
    schemaTemplateDeployId: "string",
    siteId: "string",
    undeploy: false,
});

    type: mso:SchemaTemplateDeploy
properties:
    forceApply: string
    schemaId: string
    schemaTemplateDeployId: string
    siteId: string
    templateName: string
    undeploy: false

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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing SchemaTemplateDeploy Resource

    Get an existing SchemaTemplateDeploy 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?: SchemaTemplateDeployState, opts?: CustomResourceOptions): SchemaTemplateDeploy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        force_apply: Optional[str] = None,
        schema_id: Optional[str] = None,
        schema_template_deploy_id: Optional[str] = None,
        site_id: Optional[str] = None,
        template_name: Optional[str] = None,
        undeploy: Optional[bool] = None) -> SchemaTemplateDeploy
    func GetSchemaTemplateDeploy(ctx *Context, name string, id IDInput, state *SchemaTemplateDeployState, opts ...ResourceOption) (*SchemaTemplateDeploy, error)
    public static SchemaTemplateDeploy Get(string name, Input<string> id, SchemaTemplateDeployState? state, CustomResourceOptions? opts = null)
    public static SchemaTemplateDeploy get(String name, Output<String> id, SchemaTemplateDeployState state, CustomResourceOptions options)
    resources:  _:    type: mso:SchemaTemplateDeploy    get:      id: ${id}
    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:

    Package Details

    Repository
    mso ciscodevnet/terraform-provider-mso
    License
    Notes
    This Pulumi package is based on the mso Terraform Provider.
    mso logo
    mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet
    ciscodevnet/terraform-provider-mso