BatchVmExtension Class

Definition

The configuration for virtual machine extensions.

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

Constructors

BatchVmExtension(String, String, String)

Initializes a new instance of BatchVmExtension.

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

The type of the extensions.

Name

The name of the virtual machine extension.

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

ProvisionAfterExtensions

Collection of extension names after which this extension needs to be provisioned.

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

TypeHandlerVersion

The version of script handler.

Explicit Interface Implementations

IJsonModel<BatchVmExtension>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<BatchVmExtension>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<BatchVmExtension>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<BatchVmExtension>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<BatchVmExtension>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to