IpamPoolsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:ipam_pools> attribute.

Inheritance

builtins.object

IpamPoolsOperations

Constructor

IpamPoolsOperations(*args, **kwargs)

Methods

begin_create	Creates/Updates the Pool resource. Creates/Updates the Pool resource.
begin_delete	Delete the Pool resource. Delete the Pool resource.
get	Gets the specific Pool resource. Gets the specific Pool resource.
get_pool_usage	Get the Pool Usage. Get the Pool Usage.
list	Gets list of Pool resources at Network Manager level. Gets list of Pool resources at Network Manager level.
list_associated_resources	List Associated Resource in the Pool. List Associated Resource in the Pool.
update	Updates the specific Pool resource. Updates the specific Pool resource.

begin_create

Creates/Updates the Pool resource.

Creates/Updates the Pool resource.

begin_create(resource_group_name: str, network_manager_name: str, pool_name: str, body: _models.IpamPool, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.IpamPool]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_manager_name Required	str The name of the network manager. Required.
pool_name Required	str IP Address Manager Pool resource name. Required.
body Required	IpamPool or IO[bytes] Pool resource object to create/update. Is either a IpamPool type or a IO[bytes] type. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

begin_delete

Delete the Pool resource.

Delete the Pool resource.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_manager_name Required	str The name of the network manager. Required.
pool_name Required	str Pool resource name. 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 specific Pool resource.

Gets the specific Pool resource.

get(resource_group_name: str, network_manager_name: str, pool_name: str, **kwargs: Any) -> IpamPool

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_manager_name Required	str The name of the network manager. Required.
pool_name Required	str Pool resource name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

get_pool_usage

Get the Pool Usage.

Get the Pool Usage.

get_pool_usage(resource_group_name: str, network_manager_name: str, pool_name: str, **kwargs: Any) -> PoolUsage

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_manager_name Required	str The name of the network manager. Required.
pool_name Required	str Pool resource name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

list

Gets list of Pool resources at Network Manager level.

Gets list of Pool resources at Network Manager level.

list(resource_group_name: str, network_manager_name: str, *, skip_token: str | None = None, skip: int = 0, top: int = 50, sort_key: str | None = None, sort_value: str | None = None, **kwargs: Any) -> Iterable[IpamPool]

Parameters

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

Keyword-Only Parameters

Name	Description
skip_token	str Optional skip token. Default value is None.
skip	int Optional num entries to skip. Default value is 0.
top	int Optional num entries to show. Default value is 50.
sort_key	str Optional key by which to sort. Default value is None.
sort_value	str Optional sort value for pagination. Default value is None.

Returns

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

Exceptions

Type	Description
HttpResponseError

list_associated_resources

List Associated Resource in the Pool.

List Associated Resource in the Pool.

list_associated_resources(resource_group_name: str, network_manager_name: str, pool_name: str, **kwargs: Any) -> Iterable[PoolAssociation]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_manager_name Required	str The name of the network manager. Required.
pool_name Required	str Pool resource name. Required.

Returns

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

Exceptions

Type	Description
HttpResponseError

update

Updates the specific Pool resource.

Updates the specific Pool resource.

update(resource_group_name: str, network_manager_name: str, pool_name: str, body: _models.IpamPoolUpdate | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IpamPool

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. Required.
network_manager_name Required	str The name of the network manager. Required.
pool_name Required	str IP Address Manager Pool resource name. Required.
body Required	IpamPoolUpdate or IO[bytes] Pool resource object to update partially. Is either a IpamPoolUpdate type or a IO[bytes] type. Default value is None.

Returns

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