ProxyAgentSettings Class

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

Constructor

ProxyAgentSettings()

Name	Description
enabled	bool Specifies whether ProxyAgent feature should be enabled on the virtual machine or virtual machine scale set.
mode	Union[str, <xref:"Mode">] Specifies the mode that ProxyAgent will execute on. Warning: this property has been deprecated, please specify 'mode' under particular hostendpoint setting. Known values are: "Audit" and "Enforce".
key_incarnation_id	int Increase the value of this property allows users to reset the key used for securing communication channel between guest and host.
wire_server	<xref:<xref:"HostEndpointSettings">> Specifies the Wire Server endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
imds	<xref:<xref:"HostEndpointSettings">> Specifies the IMDS endpoint settings while creating the virtual machine or virtual machine scale set. Minimum api-version: 2024-03-01.
add_proxy_agent_extension	bool Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os.

Specify whether to implicitly install the ProxyAgent Extension. This option is currently applicable only for Linux Os.

addProxyAgentExtension: bool

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

enabled: bool

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

imds: HostEndpointSettings

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

keyIncarnationId: int

this property has been deprecated, please specify 'mode' under particular hostendpoint setting. Known values are: "Audit" and "Enforce".

mode: str | Mode

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

wireServer: HostEndpointSettings

Was this page helpful?