PublicIPAddressesOperations Class

PublicIPAddressesOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance
builtins.object
PublicIPAddressesOperations

Constructor

PublicIPAddressesOperations(client, config, serializer, deserializer) -> None

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

Methods

begin_create_or_update

Creates or updates a static or dynamic public IP address.

begin_delete

Deletes the specified public IP address.

begin_update_tags

Updates public IP address tags.

get

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

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_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.

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: azure.mgmt.network.v2018_07_01.models._models_py3.PublicIPAddress, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.PublicIPAddress')]

Parameters

resource_group_name
str
Required

The name of the resource group.

public_ip_address_name
str
Required

The name of the public IP address.

parameters
PublicIPAddress
Required

Parameters supplied to the create or update public IP address operation.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either PublicIPAddress or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified public IP address.

begin_delete(resource_group_name: str, public_ip_address_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name
str
Required

The name of the resource group.

public_ip_address_name
str
Required

The name of the subnet.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates public IP address tags.

begin_update_tags(resource_group_name: str, public_ip_address_name: str, parameters: azure.mgmt.network.v2018_07_01.models._models_py3.TagsObject, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.PublicIPAddress')]

Parameters

resource_group_name
str
Required

The name of the resource group.

public_ip_address_name
str
Required

The name of the public IP address.

parameters
TagsObject
Required

Parameters supplied to update public IP address tags.

cls
callable
Required

A custom type or function that will be passed the direct response

continuation_token
str
Required

A continuation token to restart a poller from a saved state.

polling
bool or AsyncPollingMethod
Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval
int
Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either PublicIPAddress or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

get

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

get(resource_group_name: str, public_ip_address_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2018_07_01.models._models_py3.PublicIPAddress

Parameters

resource_group_name
str
Required

The name of the resource group.

public_ip_address_name
str
Required

The name of the subnet.

expand
str
Required

Expands referenced resources.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

PublicIPAddress, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2018_07_01.models._models_py3.PublicIPAddress

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_machine_scale_set_name
str
Required

The name of the virtual machine scale set.

virtualmachine_index
str
Required

The virtual machine index.

network_interface_name
str
Required

The name of the network interface.

ip_configuration_name
str
Required

The name of the IP configuration.

public_ip_address_name
str
Required

The name of the public IP Address.

expand
str
Required

Expands referenced resources.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

PublicIPAddress, or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all public IP addresses in a resource group.

list(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.PublicIPAddressListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicIPAddressListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all the public IP addresses in a subscription.

list_all(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.PublicIPAddressListResult')]

Parameters

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicIPAddressListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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) -> typing.AsyncIterable[_ForwardRef('models.PublicIPAddressListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_machine_scale_set_name
str
Required

The name of the virtual machine scale set.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicIPAddressListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.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) -> typing.AsyncIterable[_ForwardRef('models.PublicIPAddressListResult')]

Parameters

resource_group_name
str
Required

The name of the resource group.

virtual_machine_scale_set_name
str
Required

The name of the virtual machine scale set.

virtualmachine_index
str
Required

The virtual machine index.

network_interface_name
str
Required

The network interface name.

ip_configuration_name
str
Required

The IP configuration name.

cls
callable
Required

A custom type or function that will be passed the direct response

Returns

An iterator like instance of either PublicIPAddressListResult or the result of cls(response)

Return type

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2018_07_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2018_07_01\\models\\__init__.py'>