CustomIPPrefixesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:custom_ip_prefixes> attribute.

Inheritance

builtins.object

CustomIPPrefixesOperations

Constructor

CustomIPPrefixesOperations(*args, **kwargs)

Methods

begin_create_or_update	Creates or updates a custom IP prefix.
begin_delete	Deletes the specified custom IP prefix.
get	Gets the specified custom IP prefix in a specified resource group.
list	Gets all custom IP prefixes in a resource group.
list_all	Gets all the custom IP prefixes in a subscription.
update_tags	Updates custom IP prefix tags.

begin_create_or_update

Creates or updates a custom IP prefix.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Deletes the specified custom IP prefix.

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

Parameters

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

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
custom_ip_prefix_name Required	str The name of the custom IP prefix. Required.

Keyword-Only Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets all custom IP prefixes in a resource group.

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

Parameters

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

Returns

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

Exceptions

Type	Description
HttpResponseError

list_all

Gets all the custom IP prefixes in a subscription.

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

Returns

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

Exceptions

Type	Description
HttpResponseError

update_tags

Updates custom IP prefix tags.

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

Parameters

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

Returns

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