Class ProxyAgentSettings

java.lang.Object
com.azure.resourcemanager.compute.models.ProxyAgentSettings
All Implemented Interfaces:
com.azure.json.JsonSerializable<ProxyAgentSettings>
public final class ProxyAgentSettings extends Object implements com.azure.json.JsonSerializable<ProxyAgentSettings>
Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ProxyAgentSettings()
    Creates an instance of ProxyAgentSettings class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    addProxyAgentExtension()
    Get the addProxyAgentExtension property: Specify whether to implicitly install the ProxyAgent Extension.
    Boolean
    enabled()
    Get the enabled property: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
    static ProxyAgentSettings
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ProxyAgentSettings from the JsonReader.
    HostEndpointSettings
    imds()
    Get the imds property: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set.
    Integer
    keyIncarnationId()
    Get the keyIncarnationId property: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host.
    Mode
    mode()
    Get the mode property: Specifies the mode that ProxyAgent will execute on.
    com.azure.json.JsonWriter
    toJson(com.azure.json.JsonWriter jsonWriter)
    void
    validate()
    Validates the instance.
    HostEndpointSettings
    wireServer()
    Get the wireServer property: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set.
    ProxyAgentSettings
    withAddProxyAgentExtension(Boolean addProxyAgentExtension)
    Set the addProxyAgentExtension property: Specify whether to implicitly install the ProxyAgent Extension.
    ProxyAgentSettings
    withEnabled(Boolean enabled)
    Set the enabled property: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
    ProxyAgentSettings
    withImds(HostEndpointSettings imds)
    Set the imds property: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set.
    ProxyAgentSettings
    withKeyIncarnationId(Integer keyIncarnationId)
    Set the keyIncarnationId property: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host.
    ProxyAgentSettings
    withMode(Mode mode)
    Set the mode property: Specifies the mode that ProxyAgent will execute on.
    ProxyAgentSettings
    withWireServer(HostEndpointSettings wireServer)
    Set the wireServer property: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set.

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ProxyAgentSettings

      public ProxyAgentSettings()
      Creates an instance of ProxyAgentSettings class.

  • Method Details

    • enabled

      public Boolean enabled()
      Get the enabled property: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
      Returns:
      the enabled value.

    • withEnabled

      public ProxyAgentSettings withEnabled(Boolean enabled)
      Set the enabled property: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
      Parameters:
      enabled - the enabled value to set.
      Returns:
      the ProxyAgentSettings object itself.

    • mode

      public Mode mode()
      Get the mode property: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting.
      Returns:
      the mode value.

    • withMode

      public ProxyAgentSettings withMode(Mode mode)
      Set the mode property: Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting.
      Parameters:
      mode - the mode value to set.
      Returns:
      the ProxyAgentSettings object itself.

    • keyIncarnationId

      public Integer keyIncarnationId()
      Get the keyIncarnationId property: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host.
      Returns:
      the keyIncarnationId value.

    • withKeyIncarnationId

      public ProxyAgentSettings withKeyIncarnationId(Integer keyIncarnationId)
      Set the keyIncarnationId property: Increase the value of this property allows users to reset the key used for securing communication channel between guest and host.
      Parameters:
      keyIncarnationId - the keyIncarnationId value to set.
      Returns:
      the ProxyAgentSettings object itself.

    • wireServer

      public HostEndpointSettings wireServer()
      Get the wireServer property: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
      Returns:
      the wireServer value.

    • withWireServer

      public ProxyAgentSettings withWireServer(HostEndpointSettings wireServer)
      Set the wireServer property: Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
      Parameters:
      wireServer - the wireServer value to set.
      Returns:
      the ProxyAgentSettings object itself.

    • imds

      public HostEndpointSettings imds()
      Get the imds property: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
      Returns:
      the imds value.

    • withImds

      public ProxyAgentSettings withImds(HostEndpointSettings imds)
      Set the imds property: Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
      Parameters:
      imds - the imds value to set.
      Returns:
      the ProxyAgentSettings object itself.

    • addProxyAgentExtension

      public Boolean addProxyAgentExtension()
      Get the addProxyAgentExtension property: Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os.
      Returns:
      the addProxyAgentExtension value.

    • withAddProxyAgentExtension

      public ProxyAgentSettings withAddProxyAgentExtension(Boolean addProxyAgentExtension)
      Set the addProxyAgentExtension property: Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os.
      Parameters:
      addProxyAgentExtension - the addProxyAgentExtension value to set.
      Returns:
      the ProxyAgentSettings object itself.

    • validate

      public void validate()
      Validates the instance.
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ProxyAgentSettings>
      Throws:
      IOException

    • fromJson

      public static ProxyAgentSettings fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ProxyAgentSettings from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ProxyAgentSettings 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 ProxyAgentSettings.