Share via


MachineExtensionProperties Class

Definition

Describes the properties of a Machine Extension.

public class MachineExtensionProperties : System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.HybridCompute.Models.MachineExtensionProperties>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.HybridCompute.Models.MachineExtensionProperties>
type MachineExtensionProperties = class
    interface IJsonModel<MachineExtensionProperties>
    interface IPersistableModel<MachineExtensionProperties>
Public Class MachineExtensionProperties
Implements IJsonModel(Of MachineExtensionProperties), IPersistableModel(Of MachineExtensionProperties)
Inheritance
MachineExtensionProperties
Implements

Constructors

MachineExtensionProperties()

Initializes a new instance of MachineExtensionProperties.

Properties

AutoUpgradeMinorVersion

Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true.

EnableAutomaticUpgrade

Indicates whether the extension should be automatically upgraded by the platform if there is a newer version available.

ForceUpdateTag

How the extension handler should be forced to update even if the extension configuration has not changed.

InstanceView

The machine extension instance view.

MachineExtensionPropertiesType

Specifies the type of the extension; an example is "CustomScriptExtension".

ProtectedSettings

The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all.

To assign an object to the value of 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" }.

ProvisioningState

The provisioning state, which only appears in the response.

Publisher

The name of the extension handler publisher.

Settings

Json formatted public settings for the extension.

To assign an object to the value of 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" }.

TypeHandlerVersion

Specifies the version of the script handler.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<MachineExtensionProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<MachineExtensionProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<MachineExtensionProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<MachineExtensionProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<MachineExtensionProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to