Share via

IpGroupsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:ip_groups> attribute.

Inheritance
builtins.object
IpGroupsOperations

Constructor

IpGroupsOperations(*args, **kwargs)

Methods

begin_create_or_update

Creates or updates an ipGroups in a specified resource group.
begin_delete

Deletes the specified ipGroups.
get

Gets the specified ipGroups.
list

Gets all IpGroups in a subscription.
list_by_resource_group

Gets all IpGroups in a resource group.
update_groups

Updates tags of an IpGroups resource.

begin_create_or_update

Creates or updates an ipGroups in a specified resource group.

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

Parameters

Name Description
resource_group_name
Required
str

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

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

Parameters supplied to the create or update IpGroups operation. Is either a IpGroup type or a IO[bytes] type. Required.

Returns

Type Description
LROPoller[IpGroup]

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

Exceptions

Type Description
HttpResponseError

begin_delete

Deletes the specified ipGroups.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the ipGroups. 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 ipGroups.

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

Parameters

Name Description
resource_group_name
Required
str

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

The name of the ipGroups. Required.

Keyword-Only Parameters

Name Description
expand
str

Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource. Default value is None.

Returns

Type Description
IpGroup

IpGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Gets all IpGroups in a subscription.

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

Returns

Type Description
ItemPaged[IpGroup]

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

Exceptions

Type Description
HttpResponseError

list_by_resource_group

Gets all IpGroups in a resource group.

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

Parameters

Name Description
resource_group_name
Required
str

The name of the resource group. Required.

Returns

Type Description
ItemPaged[IpGroup]

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

Exceptions

Type Description
HttpResponseError

update_groups

Updates tags of an IpGroups resource.

update_groups(resource_group_name: str, ip_groups_name: str, parameters: _models.TagsObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.IpGroup

Parameters

Name Description
resource_group_name
Required
str

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

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

Parameters supplied to the update ipGroups operation. Is either a TagsObject type or a IO[bytes] type. Required.

Returns

Type Description
IpGroup

IpGroup 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'>