Share via

ProxyAgentSettings interface

  • Reference
Package:
@azure/arm-compute

Specifies ProxyAgent settings for the virtual machine or virtual machine scale set. Minimum api-version: 2023-09-01.

Properties

enabled

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

Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
keyIncarnationId

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

Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting.
wireServer

Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.

Property Details

enabled

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

enabled?: boolean

Property Value

boolean

imds

Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.

imds?: HostEndpointSettings

Property Value

HostEndpointSettings

keyIncarnationId

Increase the value of this property allows users 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. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting.

mode?: string

Property Value

string

wireServer

Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.

wireServer?: HostEndpointSettings

Property Value

HostEndpointSettings