PublicIPAddressesOperations Class

Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

<xref:public_ip_addresses> attribute.

Inheritance: builtins.object

PublicIPAddressesOperations

Constructor

PublicIPAddressesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a static or dynamic public IP address.
begin_ddos_protection_status	Gets the Ddos Protection Status of a Public IP Address.
begin_delete	Deletes the specified public IP address.
get	Gets the specified public IP address in a specified resource group.
get_cloud_service_public_ip_address	Get the specified public IP address in a cloud service.
get_virtual_machine_scale_set_public_ip_address	Get the specified public IP address in a virtual machine scale set.
list	Gets all public IP addresses in a resource group.
list_all	Gets all the public IP addresses in a subscription.
list_cloud_service_public_ip_addresses	Gets information about all public IP addresses on a cloud service level.
list_cloud_service_role_instance_public_ip_addresses	Gets information about all public IP addresses in a role instance IP configuration in a cloud service.
list_virtual_machine_scale_set_public_ip_addresses	Gets information about all public IP addresses on a virtual machine scale set level.
list_virtual_machine_scale_set_vm_public_ip_addresses	Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.
update_tags	Updates public IP address tags.

begin_create_or_update

Creates or updates a static or dynamic public IP address.

begin_create_or_update(resource_group_name: str, public_ip_address_name: str, parameters: _models.PublicIPAddress, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PublicIPAddress]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_address_name Required	str The name of the public IP address. Required.
parameters Required	PublicIPAddress or IO[bytes] Parameters supplied to the create or update public IP address operation. Is either a PublicIPAddress type or a IO[bytes] type. Required.

Returns

Type	Description
LROPoller[PublicIPAddress]	An instance of LROPoller that returns either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_ddos_protection_status

Gets the Ddos Protection Status of a Public IP Address.

begin_ddos_protection_status(resource_group_name: str, public_ip_address_name: str, **kwargs: Any) -> LROPoller[PublicIpDdosProtectionStatusResult]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_address_name Required	str The name of the public IP address. Required.

Returns

Type	Description
LROPoller[PublicIpDdosProtectionStatusResult]	An instance of LROPoller that returns either PublicIpDdosProtectionStatusResult or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified public IP address.

begin_delete(resource_group_name: str, public_ip_address_name: str, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_address_name Required	str The name of the public IP address. Required.

Returns

Type	Description
LROPoller[None]	An instance of LROPoller that returns either None or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get

Gets the specified public IP address in a specified resource group.

get(resource_group_name: str, public_ip_address_name: str, *, expand: str | None = None, **kwargs: Any) -> PublicIPAddress

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_address_name Required	str The name of the public IP address. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

Type	Description
PublicIPAddress	PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_cloud_service_public_ip_address

Get the specified public IP address in a cloud service.

get_cloud_service_public_ip_address(resource_group_name: str, cloud_service_name: str, role_instance_name: str, network_interface_name: str, ip_configuration_name: str, public_ip_address_name: str, *, expand: str | None = None, **kwargs: Any) -> PublicIPAddress

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cloud_service_name Required	str The name of the cloud service. Required.
role_instance_name Required	str The role instance name. Required.
network_interface_name Required	str The name of the network interface. Required.
ip_configuration_name Required	str The name of the IP configuration. Required.
public_ip_address_name Required	str The name of the public IP Address. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

Type	Description
PublicIPAddress	PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

get_virtual_machine_scale_set_public_ip_address

Get the specified public IP address in a virtual machine scale set.

get_virtual_machine_scale_set_public_ip_address(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, ip_configuration_name: str, public_ip_address_name: str, *, expand: str | None = None, **kwargs: Any) -> PublicIPAddress

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.
virtualmachine_index Required	str The virtual machine index. Required.
network_interface_name Required	str The name of the network interface. Required.
ip_configuration_name Required	str The name of the IP configuration. Required.
public_ip_address_name Required	str The name of the public IP Address. Required.

Keyword-Only Parameters

Name	Description
expand	str Expands referenced resources. Default value is None.

Returns

Type	Description
PublicIPAddress	PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list

Gets all public IP addresses in a resource group.

list(resource_group_name: str, **kwargs: Any) -> Iterable[PublicIPAddress]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.

Returns

Type	Description
ItemPaged[PublicIPAddress]	An iterator like instance of either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the public IP addresses in a subscription.

list_all(**kwargs: Any) -> Iterable[PublicIPAddress]

Returns

Type	Description
ItemPaged[PublicIPAddress]	An iterator like instance of either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_cloud_service_public_ip_addresses

Gets information about all public IP addresses on a cloud service level.

list_cloud_service_public_ip_addresses(resource_group_name: str, cloud_service_name: str, **kwargs: Any) -> Iterable[PublicIPAddress]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cloud_service_name Required	str The name of the cloud service. Required.

Returns

Type	Description
ItemPaged[PublicIPAddress]	An iterator like instance of either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_cloud_service_role_instance_public_ip_addresses

Gets information about all public IP addresses in a role instance IP configuration in a cloud service.

list_cloud_service_role_instance_public_ip_addresses(resource_group_name: str, cloud_service_name: str, role_instance_name: str, network_interface_name: str, ip_configuration_name: str, **kwargs: Any) -> Iterable[PublicIPAddress]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
cloud_service_name Required	str The name of the cloud service. Required.
role_instance_name Required	str The name of role instance. Required.
network_interface_name Required	str The network interface name. Required.
ip_configuration_name Required	str The IP configuration name. Required.

Returns

Type	Description
ItemPaged[PublicIPAddress]	An iterator like instance of either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_virtual_machine_scale_set_public_ip_addresses

Gets information about all public IP addresses on a virtual machine scale set level.

list_virtual_machine_scale_set_public_ip_addresses(resource_group_name: str, virtual_machine_scale_set_name: str, **kwargs: Any) -> Iterable[PublicIPAddress]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.

Returns

Type	Description
ItemPaged[PublicIPAddress]	An iterator like instance of either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

list_virtual_machine_scale_set_vm_public_ip_addresses

Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.

list_virtual_machine_scale_set_vm_public_ip_addresses(resource_group_name: str, virtual_machine_scale_set_name: str, virtualmachine_index: str, network_interface_name: str, ip_configuration_name: str, **kwargs: Any) -> Iterable[PublicIPAddress]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
virtual_machine_scale_set_name Required	str The name of the virtual machine scale set. Required.
virtualmachine_index Required	str The virtual machine index. Required.
network_interface_name Required	str The network interface name. Required.
ip_configuration_name Required	str The IP configuration name. Required.

Returns

Type	Description
ItemPaged[PublicIPAddress]	An iterator like instance of either PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

update_tags

Updates public IP address tags.

update_tags(resource_group_name: str, public_ip_address_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.PublicIPAddress

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_address_name Required	str The name of the public IP address. Required.
parameters Required	TagsObject or IO[bytes] Parameters supplied to update public IP address tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type	Description
PublicIPAddress	PublicIPAddress or the result of cls(response)

Exceptions

Type	Description
HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>

Share via

PublicIPAddressesOperations Class

Constructor

Methods

begin_create_or_update

Parameters

Returns

Exceptions

begin_ddos_protection_status

Parameters

Returns

Exceptions

begin_delete

Parameters

Returns

Exceptions

get

Parameters

Keyword-Only Parameters

Returns

Exceptions

get_cloud_service_public_ip_address

Parameters

Keyword-Only Parameters

Returns

Exceptions

get_virtual_machine_scale_set_public_ip_address

Parameters

Keyword-Only Parameters

Returns

Exceptions

list

Parameters

Returns

Exceptions

list_all

Returns

Exceptions

list_cloud_service_public_ip_addresses

Parameters

Returns

Exceptions

list_cloud_service_role_instance_public_ip_addresses

Parameters

Returns

Exceptions

list_virtual_machine_scale_set_public_ip_addresses

Parameters

Returns

Exceptions

list_virtual_machine_scale_set_vm_public_ip_addresses

Parameters

Returns

Exceptions

update_tags

Parameters

Returns

Exceptions

Attributes

models

Additional resources