Share via


BlueprintData Class

Definition

A class representing the Blueprint data model. Represents a Blueprint definition.

public class BlueprintData : Azure.ResourceManager.Models.ResourceData
type BlueprintData = class
    inherit ResourceData
Public Class BlueprintData
Inherits ResourceData
Inheritance
BlueprintData

Constructors

BlueprintData()

Initializes a new instance of BlueprintData.

Properties

Description

Multi-line explain this resource.

DisplayName

One-liner string explain this resource.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Layout

Layout view of the blueprint definition for UI reference.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(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" }.

Name

The name of the resource.

(Inherited from ResourceData)
Parameters

Parameters required by this blueprint definition.

ResourceGroups

Resource group placeholders defined by this blueprint definition.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
Status

Status of the blueprint. This field is readonly.

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
TargetScope

The scope where this blueprint definition can be assigned.

Versions

Published versions of this blueprint definition.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(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" }.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ResourceData)

Applies to