Share via


ComputeFleetVmssExtensionProperties Class

Definition

Describes the properties of a Virtual Machine Scale Set Extension.

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

Constructors

ComputeFleetVmssExtensionProperties()

Initializes a new instance of ComputeFleetVmssExtensionProperties.

Properties

ExtensionType

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

ForceUpdateTag

If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed.

IsAutomaticUpgradeEnabled

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

IsSuppressFailuresEnabled

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.

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

ShouldAutoUpgradeMinorVersion

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.

TypeHandlerVersion

Specifies the version of the script handler.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<ComputeFleetVmssExtensionProperties>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<ComputeFleetVmssExtensionProperties>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ComputeFleetVmssExtensionProperties>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<ComputeFleetVmssExtensionProperties>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<ComputeFleetVmssExtensionProperties>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to