PublicIPPrefixesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:public_ip_prefixes> attribute.

Inheritance

builtins.object

PublicIPPrefixesOperations

Constructor

PublicIPPrefixesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a static or dynamic public IP prefix.
begin_delete	Deletes the specified public IP prefix.
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.
update_tags	Updates public IP prefix tags.

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: _models.PublicIPPrefix, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.PublicIPPrefix]

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified public IP prefix.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_prefix_name Required	str The name of the PublicIpPrefix. 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 prefix in a specified resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
public_ip_prefix_name Required	str The name of the public IP prefix. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets all public IP prefixes in a resource group.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the public IP prefixes in a subscription.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

update_tags

Updates public IP prefix tags.

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

Parameters

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

Returns

Type	Description
PublicIPPrefix	PublicIPPrefix 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'>