CustomIPPrefixesOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:custom_ip_prefixes> attribute.

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.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
custom_ip_prefix_name
Required
str

The name of the custom IP prefix. Required.
parameters
Required
CustomIpPrefix or <xref:JSON> or IO[bytes]

Parameters supplied to the create or update custom IP prefix operation. Is one of the following types: CustomIpPrefix, JSON, IO[bytes] Required.

Returns

Type Description
AsyncLROPoller[CustomIpPrefix]

An instance of AsyncLROPoller that returns CustomIpPrefix. The CustomIpPrefix is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified custom IP prefix.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.
custom_ip_prefix_name
Required
str

The name of the custom IP prefix. Required.

Returns

Type Description
AsyncLROPoller[None]

An instance of AsyncLROPoller that returns None

Exceptions

Type Description
HttpResponseError

get

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

async 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. The name is case insensitive. 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.

Default value: None

Returns

Type Description
CustomIpPrefix

CustomIpPrefix. The CustomIpPrefix is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError

list

Gets all custom IP prefixes in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. The name is case insensitive. Required.

Returns

Type Description
AsyncItemPaged[CustomIpPrefix]

An iterator like instance of CustomIpPrefix

Exceptions

Type Description
HttpResponseError

list_all

Gets all the custom IP prefixes in a subscription.

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

Returns

Type Description
AsyncItemPaged[CustomIpPrefix]

An iterator like instance of CustomIpPrefix

Exceptions

Type Description
HttpResponseError

update_tags

Updates custom IP prefix tags.

async 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. The name is case insensitive. Required.
custom_ip_prefix_name
Required
str

The name of the custom IP prefix. Required.
parameters
Required
TagsObject or <xref:JSON> or IO[bytes]

Parameters supplied to update custom IP prefix tags. Is one of the following types: TagsObject, JSON, IO[bytes] Required.

Returns

Type Description
CustomIpPrefix

CustomIpPrefix. The CustomIpPrefix is compatible with MutableMapping

Exceptions

Type Description
HttpResponseError