Share via

IpAllocationsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:ip_allocations> attribute.

Constructor

IpAllocationsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates an IpAllocation in the specified resource group.
begin_delete

Deletes the specified IpAllocation.
get

Gets the specified IpAllocation by resource group.
list

Gets all IpAllocations in a subscription.
list_by_resource_group

Gets all IpAllocations in a resource group.
update_tags

Updates a IpAllocation tags.

begin_create_or_update

Creates or updates an IpAllocation in the specified resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ip_allocation_name
Required
str

The name of the IpAllocation. Required.
parameters
Required
IpAllocation or IO[bytes]

Parameters supplied to the create or update virtual network operation. Is either a IpAllocation type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[IpAllocation]

An instance of LROPoller that returns either IpAllocation or the result of cls(response)

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified IpAllocation.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ip_allocation_name
Required
str

The name of the IpAllocation. 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 IpAllocation by resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ip_allocation_name
Required
str

The name of the IpAllocation. Required.

Keyword-Only Parameters

Name Description
expand
str

Expands referenced resources. Default value is None.

Default value: None

Returns

Type Description
IpAllocation

IpAllocation or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all IpAllocations in a subscription.

list(**kwargs: Any) -> Iterable[IpAllocation]

Returns

Type Description
ItemPaged[IpAllocation]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Gets all IpAllocations in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs: Any) -> Iterable[IpAllocation]

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[IpAllocation]

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

Exceptions

Type Description
HttpResponseError

update_tags

Updates a IpAllocation tags.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.
ip_allocation_name
Required
str

The name of the IpAllocation. Required.
parameters
Required
TagsObject or IO[bytes]

Parameters supplied to update IpAllocation tags. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type Description
IpAllocation

IpAllocation or the result of cls(response)

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv177\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>