Docs Home
mso 1.4.0 published on Monday, Apr 14, 2025 by ciscodevnet
mso.Schema
Explore with Pulumi AI
Create Schema Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Schema(name: string, args?: SchemaArgs, opts?: CustomResourceOptions);@overload
def Schema(resource_name: str,
args: Optional[SchemaArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Schema(resource_name: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
schema_id: Optional[str] = None,
template_name: Optional[str] = None,
templates: Optional[Sequence[SchemaTemplateArgs]] = None,
tenant_id: Optional[str] = None)func NewSchema(ctx *Context, name string, args *SchemaArgs, opts ...ResourceOption) (*Schema, error)public Schema(string name, SchemaArgs? args = null, CustomResourceOptions? opts = null)
public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)
type: mso:Schema
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 SchemaArgs
- 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 SchemaArgs
- 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 SchemaArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args SchemaArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args SchemaArgs
- 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 schemaResource = new Mso.Schema("schemaResource", new()
{
Description = "string",
Name = "string",
SchemaId = "string",
Templates = new[]
{
new Mso.Inputs.SchemaTemplateArgs
{
DisplayName = "string",
Name = "string",
TenantId = "string",
Description = "string",
TemplateType = "string",
},
},
});
example, err := mso.NewSchema(ctx, "schemaResource", &mso.SchemaArgs{
Description: pulumi.String("string"),
Name: pulumi.String("string"),
SchemaId: pulumi.String("string"),
Templates: mso.SchemaTemplateTypeArray{
&mso.SchemaTemplateTypeArgs{
DisplayName: pulumi.String("string"),
Name: pulumi.String("string"),
TenantId: pulumi.String("string"),
Description: pulumi.String("string"),
TemplateType: pulumi.String("string"),
},
},
})
var schemaResource = new Schema("schemaResource", SchemaArgs.builder()
.description("string")
.name("string")
.schemaId("string")
.templates(SchemaTemplateArgs.builder()
.displayName("string")
.name("string")
.tenantId("string")
.description("string")
.templateType("string")
.build())
.build());
schema_resource = mso.Schema("schemaResource",
description="string",
name="string",
schema_id="string",
templates=[{
"display_name": "string",
"name": "string",
"tenant_id": "string",
"description": "string",
"template_type": "string",
}])
const schemaResource = new mso.Schema("schemaResource", {
description: "string",
name: "string",
schemaId: "string",
templates: [{
displayName: "string",
name: "string",
tenantId: "string",
description: "string",
templateType: "string",
}],
});
type: mso:Schema
properties:
description: string
name: string
schemaId: string
templates:
- description: string
displayName: string
name: string
templateType: string
tenantId: string
Schema 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 Schema resource accepts the following input properties:
- Description string
- Name string
- Schema
Id string - Template
Name string - Templates
List<Schema
Template> - Tenant
Id string
- Description string
- Name string
- Schema
Id string - Template
Name string - Templates
[]Schema
Template Type Args - Tenant
Id string
- description String
- name String
- schema
Id String - template
Name String - templates
List<Schema
Template> - tenant
Id String
- description string
- name string
- schema
Id string - template
Name string - templates
Schema
Template[] - tenant
Id string
- description str
- name str
- schema_
id str - template_
name str - templates
Sequence[Schema
Template Args] - tenant_
id str
- description String
- name String
- schema
Id String - template
Name String - templates List<Property Map>
- tenant
Id String
Outputs
All input properties are implicitly available as output properties. Additionally, the Schema 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 Schema Resource
Get an existing Schema 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?: SchemaState, opts?: CustomResourceOptions): Schema@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
description: Optional[str] = None,
name: Optional[str] = None,
schema_id: Optional[str] = None,
template_name: Optional[str] = None,
templates: Optional[Sequence[SchemaTemplateArgs]] = None,
tenant_id: Optional[str] = None) -> Schemafunc GetSchema(ctx *Context, name string, id IDInput, state *SchemaState, opts ...ResourceOption) (*Schema, error)public static Schema Get(string name, Input<string> id, SchemaState? state, CustomResourceOptions? opts = null)public static Schema get(String name, Output<String> id, SchemaState state, CustomResourceOptions options)resources: _: type: mso:Schema 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.
- Description string
- Name string
- Schema
Id string - Template
Name string - Templates
List<Schema
Template> - Tenant
Id string
- Description string
- Name string
- Schema
Id string - Template
Name string - Templates
[]Schema
Template Type Args - Tenant
Id string
- description String
- name String
- schema
Id String - template
Name String - templates
List<Schema
Template> - tenant
Id String
- description string
- name string
- schema
Id string - template
Name string - templates
Schema
Template[] - tenant
Id string
- description str
- name str
- schema_
id str - template_
name str - templates
Sequence[Schema
Template Args] - tenant_
id str
- description String
- name String
- schema
Id String - template
Name String - templates List<Property Map>
- tenant
Id String
Supporting Types
SchemaTemplate, SchemaTemplateArgs
- Display
Name string - Name string
- Tenant
Id string - Description string
- Template
Type string
- Display
Name string - Name string
- Tenant
Id string - Description string
- Template
Type string
- display
Name String - name String
- tenant
Id String - description String
- template
Type String
- display
Name string - name string
- tenant
Id string - description string
- template
Type string
- display_
name str - name str
- tenant_
id str - description str
- template_
type str
- display
Name String - name String
- tenant
Id String - description String
- template
Type String
Package Details
- Repository
- mso ciscodevnet/terraform-provider-mso
- License
- Notes
- This Pulumi package is based on the
msoTerraform Provider.