PublicIPPrefixesOperations Class

PublicIPPrefixesOperations 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

PublicIPPrefixesOperations

Constructor

PublicIPPrefixesOperations(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 prefix.
begin_delete	Deletes the specified public IP prefix.
begin_update_tags	Updates public IP prefix tags.
get	Gets the specified public IP prefix in a specified resource group.
list	Gets all public IP prefixes in a resource group.
list_all	Gets all the public IP prefixes in a subscription.

begin_create_or_update

Creates or updates a static or dynamic public IP prefix.

begin_create_or_update(resource_group_name: str, public_ip_prefix_name: str, parameters: azure.mgmt.network.v2018_08_01.models._models_py3.PublicIPPrefix, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.PublicIPPrefix')]

Parameters

resource_group_name

str

Required

The name of the resource group.

public_ip_prefix_name

str

Required

The name of the public IP prefix.

parameters

PublicIPPrefix

Required

Parameters supplied to the create or update public IP prefix 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 PublicIPPrefix or the result of cls(response)

Return type

AsyncLROPoller[PublicIPPrefix]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified public IP prefix.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

public_ip_prefix_name

str

Required

The name of the PublicIpPrefix.

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

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_update_tags

Updates public IP prefix tags.

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

Parameters

resource_group_name

str

Required

The name of the resource group.

public_ip_prefix_name

str

Required

The name of the public IP prefix.

parameters

TagsObject

Required

Parameters supplied to update public IP prefix 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 PublicIPPrefix or the result of cls(response)

Return type

AsyncLROPoller[PublicIPPrefix]

Exceptions

~azure.core.exceptions.HttpResponseError

get

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

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

Parameters

resource_group_name

str

Required

The name of the resource group.

public_ip_prefix_name

str

Required

The name of the Public IP Prefix.

expand

str

Required

Expands referenced resources.

cls

callable

Required

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

Returns

PublicIPPrefix, or the result of cls(response)

Return type

PublicIPPrefix

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all public IP prefixes in a resource group.

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

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 PublicIPPrefixListResult or the result of cls(response)

Return type

AsyncItemPaged[PublicIPPrefixListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_all

Gets all the public IP prefixes in a subscription.

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

Parameters

cls

callable

Required

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

Returns

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

Return type

AsyncItemPaged[PublicIPPrefixListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

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