1. Packages
  2. Mso Provider
  3. API Docs
  4. getSchemaTemplate
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

mso.getSchemaTemplate

Explore with Pulumi AI

mso logo
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet

    Data source for MSO schema Template.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as mso from "@pulumi/mso";
    
    const example = mso.getSchemaTemplate({
        schemaId: data.mso_schema.schema1.id,
        name: "template-name",
    });
    
    import pulumi
    import pulumi_mso as mso
    
    example = mso.get_schema_template(schema_id=data["mso_schema"]["schema1"]["id"],
        name="template-name")
    
    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.LookupSchemaTemplate(ctx, &mso.LookupSchemaTemplateArgs{
    			SchemaId: data.Mso_schema.Schema1.Id,
    			Name:     "template-name",
    		}, nil)
    		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 example = Mso.GetSchemaTemplate.Invoke(new()
        {
            SchemaId = data.Mso_schema.Schema1.Id,
            Name = "template-name",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.mso.MsoFunctions;
    import com.pulumi.mso.inputs.GetSchemaTemplateArgs;
    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 example = MsoFunctions.getSchemaTemplate(GetSchemaTemplateArgs.builder()
                .schemaId(data.mso_schema().schema1().id())
                .name("template-name")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: mso:getSchemaTemplate
          arguments:
            schemaId: ${data.mso_schema.schema1.id}
            name: template-name
    

    Argument Reference

    • schema_id - (Required) The schema ID of the Template.
    • name - (Required) The name of the Template.

    Attribute Reference

    • tenant_id - (Read-Only) The tenant ID to associate with the Template.
    • display_name - (Read-Only) The name of the Template as displayed on the MSO UI.
    • template_type - (Read-Only) The type of the Template.
    • description - (Read-Only) The description of the Template.

    Using getSchemaTemplate

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSchemaTemplate(args: GetSchemaTemplateArgs, opts?: InvokeOptions): Promise<GetSchemaTemplateResult>
    function getSchemaTemplateOutput(args: GetSchemaTemplateOutputArgs, opts?: InvokeOptions): Output<GetSchemaTemplateResult>
    def get_schema_template(id: Optional[str] = None,
                            name: Optional[str] = None,
                            schema_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSchemaTemplateResult
    def get_schema_template_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            schema_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSchemaTemplateResult]
    func LookupSchemaTemplate(ctx *Context, args *LookupSchemaTemplateArgs, opts ...InvokeOption) (*LookupSchemaTemplateResult, error)
    func LookupSchemaTemplateOutput(ctx *Context, args *LookupSchemaTemplateOutputArgs, opts ...InvokeOption) LookupSchemaTemplateResultOutput

    > Note: This function is named LookupSchemaTemplate in the Go SDK.

    public static class GetSchemaTemplate 
    {
        public static Task<GetSchemaTemplateResult> InvokeAsync(GetSchemaTemplateArgs args, InvokeOptions? opts = null)
        public static Output<GetSchemaTemplateResult> Invoke(GetSchemaTemplateInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSchemaTemplateResult> getSchemaTemplate(GetSchemaTemplateArgs args, InvokeOptions options)
    public static Output<GetSchemaTemplateResult> getSchemaTemplate(GetSchemaTemplateArgs args, InvokeOptions options)
    
    fn::invoke:
      function: mso:index/getSchemaTemplate:getSchemaTemplate
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    SchemaId string
    Id string
    Name string
    SchemaId string
    Id string
    name String
    schemaId String
    id String
    name string
    schemaId string
    id string
    name str
    schema_id str
    id str
    name String
    schemaId String
    id String

    getSchemaTemplate Result

    The following output properties are available:

    Description string
    DisplayName string
    Id string
    Name string
    SchemaId string
    TemplateType string
    TenantId string
    Description string
    DisplayName string
    Id string
    Name string
    SchemaId string
    TemplateType string
    TenantId string
    description String
    displayName String
    id String
    name String
    schemaId String
    templateType String
    tenantId String
    description string
    displayName string
    id string
    name string
    schemaId string
    templateType string
    tenantId string
    description String
    displayName String
    id String
    name String
    schemaId String
    templateType String
    tenantId String

    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