ProxyAgentSettings interface

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

Properties

enabled

Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.

keyIncarnationId

Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.

mode

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.

Property Details

enabled

Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.

enabled?: boolean

Property Value

boolean

keyIncarnationId

Increase the value of this property allows user to reset the key used for securing communication channel between guest and host.

keyIncarnationId?: number

Property Value

number

mode

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.

mode?: string

Property Value

string