VirtualMachineExtensionPatch Class

Definition

Describes a Virtual Machine Extension.

public class VirtualMachineExtensionPatch : Azure.ResourceManager.Compute.Models.ComputeResourcePatch, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Compute.Models.VirtualMachineExtensionPatch>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Compute.Models.VirtualMachineExtensionPatch>
type VirtualMachineExtensionPatch = class
    inherit ComputeResourcePatch
    interface IJsonModel<VirtualMachineExtensionPatch>
    interface IPersistableModel<VirtualMachineExtensionPatch>
Public Class VirtualMachineExtensionPatch
Inherits ComputeResourcePatch
Implements IJsonModel(Of VirtualMachineExtensionPatch), IPersistableModel(Of VirtualMachineExtensionPatch)
Inheritance
VirtualMachineExtensionPatch
Implements

Constructors

VirtualMachineExtensionPatch()

Initializes a new instance of VirtualMachineExtensionPatch.

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 of the extension available.

ExtensionType

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

ForceUpdateTag

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

KeyVaultProtectedSettings

The extensions protected settings that are passed by reference, and consumed from key vault.

ProtectedSettings

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

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" }.

Publisher

The name of the extension handler publisher.

Settings

Json formatted public settings for the extension.

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" }.

SuppressFailures

Indicates whether failures stemming from the extension will be suppressed (Operational failures such as not connecting to the VM will not be suppressed regardless of this value). The default is false.

Tags

Resource tags.

(Inherited from ComputeResourcePatch)
TypeHandlerVersion

Specifies the version of the script handler.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ComputeResourcePatch)

Explicit Interface Implementations

IJsonModel<ComputeResourcePatch>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

(Inherited from ComputeResourcePatch)
IJsonModel<ComputeResourcePatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ComputeResourcePatch)
IJsonModel<VirtualMachineExtensionPatch>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<VirtualMachineExtensionPatch>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ComputeResourcePatch>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ComputeResourcePatch)
IPersistableModel<ComputeResourcePatch>.GetFormatFromOptions(ModelReaderWriterOptions)

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

(Inherited from ComputeResourcePatch)
IPersistableModel<ComputeResourcePatch>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ComputeResourcePatch)
IPersistableModel<VirtualMachineExtensionPatch>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<VirtualMachineExtensionPatch>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<VirtualMachineExtensionPatch>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to