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

mso.getSchema

Explore with Pulumi AI

Data source for MSO schema.

Example Usage

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

const example = mso.getSchema({
    name: "demo_schema",
});
Copy
import pulumi
import pulumi_mso as mso

example = mso.get_schema(name="demo_schema")
Copy
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.LookupSchema(ctx, &mso.LookupSchemaArgs{
			Name: "demo_schema",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Mso = Pulumi.Mso;

return await Deployment.RunAsync(() => 
{
    var example = Mso.GetSchema.Invoke(new()
    {
        Name = "demo_schema",
    });

});
Copy
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.GetSchemaArgs;
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.getSchema(GetSchemaArgs.builder()
            .name("demo_schema")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: mso:getSchema
      arguments:
        name: demo_schema
Copy

Argument Reference

  • name - (Required) The name of the Schema.

Attribute Reference

  • template_name - (Read-Only) Deprecated. The template name of the Schema.
  • tenant_id - (Read-Only) Deprecated. The tenant ID of the Schema.
  • description - (Read-Only) The description of the Schema.
  • template - (Read-Only) A list of templates for the Schema.
    • name - (Read-Only) The name of the Template.
    • display_name - (Read-Only) The name of the Template as displayed on the MSO UI.
    • description - (Read-Only) The description of the Template.
    • tenant_id - (Read-Only) The tenant ID of the Template.
    • template_type - (Read-Only) The type of the Template.

Using getSchema

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 getSchema(args: GetSchemaArgs, opts?: InvokeOptions): Promise<GetSchemaResult>
function getSchemaOutput(args: GetSchemaOutputArgs, opts?: InvokeOptions): Output<GetSchemaResult>
Copy
def get_schema(id: Optional[str] = None,
               name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetSchemaResult
def get_schema_output(id: Optional[pulumi.Input[str]] = None,
               name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetSchemaResult]
Copy
func LookupSchema(ctx *Context, args *LookupSchemaArgs, opts ...InvokeOption) (*LookupSchemaResult, error)
func LookupSchemaOutput(ctx *Context, args *LookupSchemaOutputArgs, opts ...InvokeOption) LookupSchemaResultOutput
Copy

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

public static class GetSchema 
{
    public static Task<GetSchemaResult> InvokeAsync(GetSchemaArgs args, InvokeOptions? opts = null)
    public static Output<GetSchemaResult> Invoke(GetSchemaInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
public static Output<GetSchemaResult> getSchema(GetSchemaArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: mso:index/getSchema:getSchema
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name This property is required. string
Id string
Name This property is required. string
Id string
name This property is required. String
id String
name This property is required. string
id string
name This property is required. str
id str
name This property is required. String
id String

getSchema Result

The following output properties are available:

Description string
Id string
Name string
TemplateName string

Deprecated: Deprecated

Templates List<GetSchemaTemplate>
TenantId string

Deprecated: Deprecated

Description string
Id string
Name string
TemplateName string

Deprecated: Deprecated

Templates []GetSchemaTemplateType
TenantId string

Deprecated: Deprecated

description String
id String
name String
templateName String

Deprecated: Deprecated

templates List<GetSchemaTemplate>
tenantId String

Deprecated: Deprecated

description string
id string
name string
templateName string

Deprecated: Deprecated

templates GetSchemaTemplate[]
tenantId string

Deprecated: Deprecated

description str
id str
name str
template_name str

Deprecated: Deprecated

templates Sequence[GetSchemaTemplate]
tenant_id str

Deprecated: Deprecated

description String
id String
name String
templateName String

Deprecated: Deprecated

templates List<Property Map>
tenantId String

Deprecated: Deprecated

Supporting Types

GetSchemaTemplate

Description This property is required. string
DisplayName This property is required. string
Name This property is required. string
TemplateType This property is required. string
TenantId This property is required. string
Description This property is required. string
DisplayName This property is required. string
Name This property is required. string
TemplateType This property is required. string
TenantId This property is required. string
description This property is required. String
displayName This property is required. String
name This property is required. String
templateType This property is required. String
tenantId This property is required. String
description This property is required. string
displayName This property is required. string
name This property is required. string
templateType This property is required. string
tenantId This property is required. string
description This property is required. str
display_name This property is required. str
name This property is required. str
template_type This property is required. str
tenant_id This property is required. str
description This property is required. String
displayName This property is required. String
name This property is required. String
templateType This property is required. String
tenantId This property is required. String

Package Details

Repository
mso ciscodevnet/terraform-provider-mso
License
Notes
This Pulumi package is based on the mso Terraform Provider.