Language

BulkActionVMExtensionProperties Class

Definition

Describes the properties of a Virtual Machine Extension.

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

Constructors

Name Description
BulkActionVMExtensionProperties()

Initializes a new instance of BulkActionVMExtensionProperties.

Properties

Name Description
EnableAutomaticUpgrade

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

ForceUpdateTag

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

IsAutoUpgradeMinorVersion

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.

IsSuppressFailures

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.

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

ProtectedSettingsFromKeyVault

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

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

Type

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

TypeHandlerVersion

Specifies the version of the script handler.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BulkActionVMExtensionProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<BulkActionVMExtensionProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<BulkActionVMExtensionProperties>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<BulkActionVMExtensionProperties>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<BulkActionVMExtensionProperties>.Write(ModelReaderWriterOptions)

Applies to