Share via


ProxyAgentSettings Class

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

Constructor

ProxyAgentSettings(*, enabled: bool | None = None, mode: str | _models.Mode | None = None, key_incarnation_id: int | None = None, wire_server: _models.HostEndpointSettings | None = None, imds: _models.HostEndpointSettings | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
enabled

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

Default value: None
mode
str or 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".

Default value: None
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.

Default value: None
wire_server

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

Default value: None
imds

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

Default value: None

Variables

Name Description
enabled

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

mode
str or 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

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

imds

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