Package version:

Interface ProxyAgentSettings

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

interface ProxyAgentSettings {
    enabled?: boolean;
    imds?: HostEndpointSettings;
    keyIncarnationId?: number;
    mode?: string;
    wireServer?: HostEndpointSettings;
}

Properties

enabled? imds? keyIncarnationId? mode? wireServer?

Properties

Optionalenabled

enabled?: boolean

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

Optionalimds

imds?: HostEndpointSettings

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

OptionalkeyIncarnationId

keyIncarnationId?: number

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

Optionalmode

mode?: string

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

OptionalwireServer

wireServer?: HostEndpointSettings

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

Settings

Member Visibility