Share via

VirtualMachineScaleSetPublicIPAddressConfiguration Class

Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration.

All required parameters must be populated in order to send to server.

Constructor

VirtualMachineScaleSetPublicIPAddressConfiguration(*, name: str, sku: _models.PublicIPAddressSku | None = None, tags: dict[str, str] | None = None, idle_timeout_in_minutes: int | None = None, dns_settings: _models.VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings | None = None, ip_tags: list['_models.VirtualMachineScaleSetIpTag'] | None = None, public_ip_prefix: _models.SubResource | None = None, public_ip_address_version: str | _models.IPVersion | None = None, delete_option: str | _models.DeleteOptions | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
name
str

The publicIP address configuration name. Required.
sku
PublicIPAddressSku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.

Default value: None
tags
dict[str, str]

Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration.

Default value: None
idle_timeout_in_minutes
int

The idle timeout of the public IP address.

Default value: None
dns_settings
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

The dns settings to be applied on the publicIP addresses .

Default value: None
ip_tags
list[VirtualMachineScaleSetIpTag]

The list of IP tags associated with the public IP address.

Default value: None
public_ip_prefix
SubResource

The PublicIPPrefix from which to allocate publicIP addresses.

Default value: None
public_ip_address_version
str or IPVersion

Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Known values are: "IPv4" and "IPv6".

Default value: None
delete_option
str or DeleteOptions

Specify what happens to the public IP when the VM is deleted. Known values are: "Delete" and "Detach".

Default value: None

Variables

Name Description
name
str

The publicIP address configuration name. Required.
sku
PublicIPAddressSku

Describes the public IP Sku. It can only be set with OrchestrationMode as Flexible.
tags
dict[str, str]

Resource tags applied to the publicIP address created by this PublicIPAddressConfiguration.
idle_timeout_in_minutes
int

The idle timeout of the public IP address.
dns_settings
VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

The dns settings to be applied on the publicIP addresses .
ip_tags
list[VirtualMachineScaleSetIpTag]

The list of IP tags associated with the public IP address.
public_ip_prefix
SubResource

The PublicIPPrefix from which to allocate publicIP addresses.
public_ip_address_version
str or IPVersion

Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'. Known values are: "IPv4" and "IPv6".
delete_option
str or DeleteOptions

Specify what happens to the public IP when the VM is deleted. Known values are: "Delete" and "Detach".