Class TemplateArtifact

Blueprint artifact that deploys a Resource Manager template.

Inheritance
Azure.ResourceManager.Models.ResourceData
ArtifactData
TemplateArtifact
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.ResourceManager.Blueprint.dll
Syntax
public class TemplateArtifact : Azure.ResourceManager.Blueprint.ArtifactData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Blueprint.Models.TemplateArtifact>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Blueprint.Models.TemplateArtifact>

Constructors

TemplateArtifact(BinaryData, IDictionary<String,ParameterValue>)

Initializes a new instance of TemplateArtifact.

Declaration
public TemplateArtifact (BinaryData template, System.Collections.Generic.IDictionary<string,Azure.ResourceManager.Blueprint.Models.ParameterValue> parameters);
Parameters
System.BinaryData template

The Resource Manager template blueprint artifact body.
System.Collections.Generic.IDictionary<System.String,ParameterValue> parameters

Resource Manager template blueprint artifact parameter values.
Exceptions
System.ArgumentNullException

template or parameters is null.

Properties

DependsOn

Artifacts which need to be deployed before the specified artifact.

Declaration
public System.Collections.Generic.IList<string> DependsOn { get; }
Property Value
System.Collections.Generic.IList<System.String>

Description

Multi-line explain this resource.

Declaration
public string Description { get; set; }
Property Value
System.String

DisplayName

One-liner string explain this resource.

Declaration
public string DisplayName { get; set; }
Property Value
System.String

Parameters

Resource Manager template blueprint artifact parameter values.

Declaration
public System.Collections.Generic.IDictionary<string,Azure.ResourceManager.Blueprint.Models.ParameterValue> Parameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String,ParameterValue>

ResourceGroup

If applicable, the name of the resource group placeholder to which the Resource Manager template blueprint artifact will be deployed.

Declaration
public string ResourceGroup { get; set; }
Property Value
System.String

Template

The Resource Manager template blueprint artifact body.

To assign an object to this property use System.BinaryData.FromObjectAsJson``1(``0,System.Text.Json.JsonSerializerOptions).

To assign an already formatted json string to this property use System.BinaryData.FromString(System.String).

Examples:

  • BinaryData.FromObjectAsJson("foo")Creates a payload of "foo".
  • BinaryData.FromString("\"foo\"")Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" })Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}")Creates a payload of { "key": "value" }.

Declaration
public BinaryData Template { get; set; }
Property Value
System.BinaryData

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Declaration
protected override void JsonModelWriteCore (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The JSON writer.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The client options for reading and writing models.

Explicit Interface Implementations

IJsonModel<TemplateArtifact>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

Declaration
Azure.ResourceManager.Blueprint.Models.TemplateArtifact IJsonModel<TemplateArtifact>.Create (ref System.Text.Json.Utf8JsonReader reader, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonReader reader

The System.Text.Json.Utf8JsonReader to read.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
TemplateArtifact

A T representation of the JSON value.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IJsonModel<TemplateArtifact>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided System.Text.Json.Utf8JsonWriter.

Declaration
void IJsonModel<TemplateArtifact>.Write (System.Text.Json.Utf8JsonWriter writer, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.Text.Json.Utf8JsonWriter writer

The System.Text.Json.Utf8JsonWriter to write into.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<TemplateArtifact>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided System.BinaryData into a model.

Declaration
Azure.ResourceManager.Blueprint.Models.TemplateArtifact IPersistableModel<TemplateArtifact>.Create (BinaryData data, System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.BinaryData data

The System.BinaryData to parse.
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
TemplateArtifact

A T representation of the data.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.

IPersistableModel<TemplateArtifact>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

Declaration
string IPersistableModel<TemplateArtifact>.GetFormatFromOptions (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to consider when serializing and deserializing the model.
Returns
System.String

The format that the model uses when communicating with the serivce.

IPersistableModel<TemplateArtifact>.Write(ModelReaderWriterOptions)

Writes the model into a System.BinaryData.

Declaration
BinaryData IPersistableModel<TemplateArtifact>.Write (System.ClientModel.Primitives.ModelReaderWriterOptions options);
Parameters
System.ClientModel.Primitives.ModelReaderWriterOptions options

The System.ClientModel.Primitives.ModelReaderWriterOptions to use.
Returns
System.BinaryData

A binary representation of the written model.
Exceptions
System.FormatException

If the model does not support the requested System.ClientModel.Primitives.ModelReaderWriterOptions.Format.