ArmComputeModelFactory.CloudServiceExtension Method

  • Reference

Definition

Namespace:
Azure.ResourceManager.Compute.Models
Assembly:
Azure.ResourceManager.Compute.dll
Package:
Azure.ResourceManager.Compute v1.6.0
Package:
Azure.ResourceManager.Compute v1.7.0-beta.1
Source:
ArmComputeModelFactory.cs
Source:
ArmComputeModelFactory.cs

Initializes a new instance of CloudServiceExtension.

public static Azure.ResourceManager.Compute.Models.CloudServiceExtension CloudServiceExtension (string name = default, string publisher = default, string cloudServiceExtensionPropertiesType = default, string typeHandlerVersion = default, bool? autoUpgradeMinorVersion = default, BinaryData settings = default, BinaryData protectedSettings = default, Azure.ResourceManager.Compute.Models.CloudServiceVaultAndSecretReference protectedSettingsFromKeyVault = default, string forceUpdateTag = default, string provisioningState = default, System.Collections.Generic.IEnumerable<string> rolesAppliedTo = default);
static member CloudServiceExtension : string * string * string * string * Nullable<bool> * BinaryData * BinaryData * Azure.ResourceManager.Compute.Models.CloudServiceVaultAndSecretReference * string * string * seq<string> -> Azure.ResourceManager.Compute.Models.CloudServiceExtension
Public Shared Function CloudServiceExtension (Optional name As String = Nothing, Optional publisher As String = Nothing, Optional cloudServiceExtensionPropertiesType As String = Nothing, Optional typeHandlerVersion As String = Nothing, Optional autoUpgradeMinorVersion As Nullable(Of Boolean) = Nothing, Optional settings As BinaryData = Nothing, Optional protectedSettings As BinaryData = Nothing, Optional protectedSettingsFromKeyVault As CloudServiceVaultAndSecretReference = Nothing, Optional forceUpdateTag As String = Nothing, Optional provisioningState As String = Nothing, Optional rolesAppliedTo As IEnumerable(Of String) = Nothing) As CloudServiceExtension

Parameters

name
String

The name of the extension.

publisher
String

The name of the extension handler publisher.

cloudServiceExtensionPropertiesType
String

Specifies the type of the extension.

typeHandlerVersion
String

Specifies the version of the extension. Specifies the version of the extension. If this element is not specified or an asterisk (*) is used as the value, the latest version of the extension is used. If the value is specified with a major version number and an asterisk as the minor version number (X.), the latest minor version of the specified major version is selected. If a major version number and a minor version number are specified (X.Y), the specific extension version is selected. If a version is specified, an auto-upgrade is performed on the role instance.

autoUpgradeMinorVersion
Nullable<Boolean>

Explicitly specify whether platform can automatically upgrade typeHandlerVersion to higher minor versions when they become available.

settings
BinaryData

Public settings for the extension. For JSON extensions, this is the JSON settings for the extension. For XML Extension (like RDP), this is the XML setting for the extension.

protectedSettings
BinaryData

Protected settings for the extension which are encrypted before sent to the role instance.

protectedSettingsFromKeyVault
CloudServiceVaultAndSecretReference

Protected settings for the extension, referenced using KeyVault which are encrypted before sent to the role instance.

forceUpdateTag
String

Tag to force apply the provided public and protected settings. Changing the tag value allows for re-running the extension without changing any of the public or protected settings. If forceUpdateTag is not changed, updates to public or protected settings would still be applied by the handler. If neither forceUpdateTag nor any of public or protected settings change, extension would flow to the role instance with the same sequence-number, and it is up to handler implementation whether to re-run it or not

provisioningState
String

The provisioning state, which only appears in the response.

rolesAppliedTo
IEnumerable<String>

Optional list of roles to apply this extension. If property is not specified or '*' is specified, extension is applied to all roles in the cloud service.

Returns

CloudServiceExtension

A new CloudServiceExtension instance for mocking.

Applies to