SecurityProfile Class

  • java.lang.Object
    • com.azure.resourcemanager.compute.models.SecurityProfile

Implements

public final class SecurityProfile
implements JsonSerializable<SecurityProfile>

Specifies the Security profile settings for the virtual machine or virtual machine scale set.

Constructor Summary

Constructor Description
SecurityProfile()

Creates an instance of SecurityProfile class.

Method Summary

Modifier and Type Method and Description
Boolean encryptionAtHost()

Get the encryptionAtHost property: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set.

EncryptionIdentity encryptionIdentity()

Get the encryptionIdentity property: Specifies the Managed Identity used by ADE to get access token for keyvault operations.

static SecurityProfile fromJson(JsonReader jsonReader)

Reads an instance of SecurityProfile from the JsonReader.

ProxyAgentSettings proxyAgentSettings()

Get the proxyAgentSettings property: Specifies ProxyAgent settings while creating the virtual machine.

SecurityTypes securityType()

Get the securityType property: Specifies the SecurityType of the virtual machine.

JsonWriter toJson(JsonWriter jsonWriter)
UefiSettings uefiSettings()

Get the uefiSettings property: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

void validate()

Validates the instance.

SecurityProfile withEncryptionAtHost(Boolean encryptionAtHost)

Set the encryptionAtHost property: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set.

SecurityProfile withEncryptionIdentity(EncryptionIdentity encryptionIdentity)

Set the encryptionIdentity property: Specifies the Managed Identity used by ADE to get access token for keyvault operations.

SecurityProfile withProxyAgentSettings(ProxyAgentSettings proxyAgentSettings)

Set the proxyAgentSettings property: Specifies ProxyAgent settings while creating the virtual machine.

SecurityProfile withSecurityType(SecurityTypes securityType)

Set the securityType property: Specifies the SecurityType of the virtual machine.

SecurityProfile withUefiSettings(UefiSettings uefiSettings)

Set the uefiSettings property: Specifies the security settings like secure boot and vTPM used while creating the virtual machine.

Methods inherited from java.lang.Object

Constructor Details

SecurityProfile

public SecurityProfile()

Creates an instance of SecurityProfile class.

Method Details

encryptionAtHost

public Boolean encryptionAtHost()

Get the encryptionAtHost property: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.

Returns:

the encryptionAtHost value.

encryptionIdentity

public EncryptionIdentity encryptionIdentity()

Get the encryptionIdentity property: Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Returns:

the encryptionIdentity value.

fromJson

public static SecurityProfile fromJson(JsonReader jsonReader)

Reads an instance of SecurityProfile from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SecurityProfile if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If an error occurs while reading the SecurityProfile.

proxyAgentSettings

public ProxyAgentSettings proxyAgentSettings()

Get the proxyAgentSettings property: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Returns:

the proxyAgentSettings value.

securityType

public SecurityTypes securityType()

Get the securityType property: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.

Returns:

the securityType value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

uefiSettings

public UefiSettings uefiSettings()

Get the uefiSettings property: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

Returns:

the uefiSettings value.

validate

public void validate()

Validates the instance.

withEncryptionAtHost

public SecurityProfile withEncryptionAtHost(Boolean encryptionAtHost)

Set the encryptionAtHost property: This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself. The default behavior is: The Encryption at host will be disabled unless this property is set to true for the resource.

Parameters:

encryptionAtHost - the encryptionAtHost value to set.

Returns:

the SecurityProfile object itself.

withEncryptionIdentity

public SecurityProfile withEncryptionIdentity(EncryptionIdentity encryptionIdentity)

Set the encryptionIdentity property: Specifies the Managed Identity used by ADE to get access token for keyvault operations.

Parameters:

encryptionIdentity - the encryptionIdentity value to set.

Returns:

the SecurityProfile object itself.

withProxyAgentSettings

public SecurityProfile withProxyAgentSettings(ProxyAgentSettings proxyAgentSettings)

Set the proxyAgentSettings property: Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01.

Parameters:

proxyAgentSettings - the proxyAgentSettings value to set.

Returns:

the SecurityProfile object itself.

withSecurityType

public SecurityProfile withSecurityType(SecurityTypes securityType)

Set the securityType property: Specifies the SecurityType of the virtual machine. It has to be set to any specified value to enable UefiSettings. The default behavior is: UefiSettings will not be enabled unless this property is set.

Parameters:

securityType - the securityType value to set.

Returns:

the SecurityProfile object itself.

withUefiSettings

public SecurityProfile withUefiSettings(UefiSettings uefiSettings)

Set the uefiSettings property: Specifies the security settings like secure boot and vTPM used while creating the virtual machine. Minimum api-version: 2020-12-01.

Parameters:

uefiSettings - the uefiSettings value to set.

Returns:

the SecurityProfile object itself.

Applies to