azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.compute.models.ProxyAgentSettings.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings"
fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings"
name: "ProxyAgentSettings"
nameWithType: "ProxyAgentSettings"
summary: "Specifies Proxy<wbr>Agent settings while creating the virtual machine."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **ProxyAgentSettings**</br> implements <xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.models.ProxyAgentSettings?alt=com.azure.resourcemanager.compute.models.ProxyAgentSettings&text=ProxyAgentSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
constructors:
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.ProxyAgentSettings()"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.ProxyAgentSettings()"
  name: "ProxyAgentSettings()"
  nameWithType: "ProxyAgentSettings.ProxyAgentSettings()"
  summary: "Creates an instance of Proxy<wbr>Agent<wbr>Settings class."
  syntax: "public ProxyAgentSettings()"
  desc: "Creates an instance of ProxyAgentSettings class."
methods:
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.enabled()"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.enabled()"
  name: "enabled()"
  nameWithType: "ProxyAgentSettings.enabled()"
  summary: "Get the enabled property: Specifies whether Proxy<wbr>Agent feature should be enabled on the virtual machine or virtual machine scale set."
  syntax: "public Boolean enabled()"
  desc: "Get the enabled property: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set."
  returns:
    description: "the enabled value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.fromJson(com.azure.json.JsonReader)"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.fromJson(JsonReader jsonReader)"
  name: "fromJson(JsonReader jsonReader)"
  nameWithType: "ProxyAgentSettings.fromJson(JsonReader jsonReader)"
  summary: "Reads an instance of Proxy<wbr>Agent<wbr>Settings from the Json<wbr>Reader."
  modifiers:
  - "static"
  parameters:
  - description: "The JsonReader being read."
    name: "jsonReader"
    type: "<xref href=\"com.azure.json.JsonReader?alt=com.azure.json.JsonReader&text=JsonReader\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public static ProxyAgentSettings fromJson(JsonReader jsonReader)"
  exceptions:
  - description: "If an error occurs while reading the ProxyAgentSettings."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  desc: "Reads an instance of ProxyAgentSettings from the JsonReader."
  returns:
    description: "An instance of ProxyAgentSettings if the JsonReader was pointing to an instance of it, or null if it was\n pointing to JSON null."
    type: "<xref href=\"com.azure.resourcemanager.compute.models.ProxyAgentSettings?alt=com.azure.resourcemanager.compute.models.ProxyAgentSettings&text=ProxyAgentSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.keyIncarnationId()"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.keyIncarnationId()"
  name: "keyIncarnationId()"
  nameWithType: "ProxyAgentSettings.keyIncarnationId()"
  summary: "Get the key<wbr>Incarnation<wbr>Id property: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host."
  syntax: "public Integer keyIncarnationId()"
  desc: "Get the keyIncarnationId property: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host."
  returns:
    description: "the keyIncarnationId value."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.mode()"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.mode()"
  name: "mode()"
  nameWithType: "ProxyAgentSettings.mode()"
  summary: "Get the mode property: Specifies the mode that Proxy<wbr>Agent will execute on if the feature is enabled."
  syntax: "public Mode mode()"
  desc: "Get the mode property: Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode."
  returns:
    description: "the mode value."
    type: "<xref href=\"com.azure.resourcemanager.compute.models.Mode?alt=com.azure.resourcemanager.compute.models.Mode&text=Mode\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.toJson(com.azure.json.JsonWriter)"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.toJson(JsonWriter jsonWriter)"
  name: "toJson(JsonWriter jsonWriter)"
  nameWithType: "ProxyAgentSettings.toJson(JsonWriter jsonWriter)"
  parameters:
  - name: "jsonWriter"
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public JsonWriter toJson(JsonWriter jsonWriter)"
  exceptions:
  - type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/io/IOException.html\">IOException</a>"
  returns:
    type: "<xref href=\"com.azure.json.JsonWriter?alt=com.azure.json.JsonWriter&text=JsonWriter\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.validate()"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.validate()"
  name: "validate()"
  nameWithType: "ProxyAgentSettings.validate()"
  summary: "Validates the instance."
  syntax: "public void validate()"
  desc: "Validates the instance."
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.withEnabled(java.lang.Boolean)"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.withEnabled(Boolean enabled)"
  name: "withEnabled(Boolean enabled)"
  nameWithType: "ProxyAgentSettings.withEnabled(Boolean enabled)"
  summary: "Set the enabled property: Specifies whether Proxy<wbr>Agent feature should be enabled on the virtual machine or virtual machine scale set."
  parameters:
  - description: "the enabled value to set."
    name: "enabled"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
  syntax: "public ProxyAgentSettings withEnabled(Boolean enabled)"
  desc: "Set the enabled property: Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set."
  returns:
    description: "the ProxyAgentSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.compute.models.ProxyAgentSettings?alt=com.azure.resourcemanager.compute.models.ProxyAgentSettings&text=ProxyAgentSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.withKeyIncarnationId(java.lang.Integer)"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.withKeyIncarnationId(Integer keyIncarnationId)"
  name: "withKeyIncarnationId(Integer keyIncarnationId)"
  nameWithType: "ProxyAgentSettings.withKeyIncarnationId(Integer keyIncarnationId)"
  summary: "Set the key<wbr>Incarnation<wbr>Id property: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host."
  parameters:
  - description: "the keyIncarnationId value to set."
    name: "keyIncarnationId"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  syntax: "public ProxyAgentSettings withKeyIncarnationId(Integer keyIncarnationId)"
  desc: "Set the keyIncarnationId property: Increase the value of this property allows user to reset the key used for securing communication channel between guest and host."
  returns:
    description: "the ProxyAgentSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.compute.models.ProxyAgentSettings?alt=com.azure.resourcemanager.compute.models.ProxyAgentSettings&text=ProxyAgentSettings\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.withMode(com.azure.resourcemanager.compute.models.Mode)"
  fullName: "com.azure.resourcemanager.compute.models.ProxyAgentSettings.withMode(Mode mode)"
  name: "withMode(Mode mode)"
  nameWithType: "ProxyAgentSettings.withMode(Mode mode)"
  summary: "Set the mode property: Specifies the mode that Proxy<wbr>Agent will execute on if the feature is enabled."
  parameters:
  - description: "the mode value to set."
    name: "mode"
    type: "<xref href=\"com.azure.resourcemanager.compute.models.Mode?alt=com.azure.resourcemanager.compute.models.Mode&text=Mode\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public ProxyAgentSettings withMode(Mode mode)"
  desc: "Set the mode property: Specifies the mode that ProxyAgent will execute on if the feature is enabled. ProxyAgent will start to audit or monitor but not enforce access control over requests to host endpoints in Audit mode, while in Enforce mode it will enforce access control. The default value is Enforce mode."
  returns:
    description: "the ProxyAgentSettings object itself."
    type: "<xref href=\"com.azure.resourcemanager.compute.models.ProxyAgentSettings?alt=com.azure.resourcemanager.compute.models.ProxyAgentSettings&text=ProxyAgentSettings\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Specifies ProxyAgent settings while creating the virtual machine. Minimum api-version: 2023-09-01."
implements:
- "<xref href=\"com.azure.json.JsonSerializable?alt=com.azure.json.JsonSerializable&text=JsonSerializable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.compute.models.ProxyAgentSettings?alt=com.azure.resourcemanager.compute.models.ProxyAgentSettings&text=ProxyAgentSettings\" data-throw-if-not-resolved=\"False\" />&gt;"
metadata: {}
package: "com.azure.resourcemanager.compute.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-compute:2.42.0