IpGroupsOperations Class

IpGroupsOperations async operations.

You should not instantiate this class directly. Instead, you should create a Client instance that instantiates it for you and attaches it as an attribute.

Inheritance

builtins.object

IpGroupsOperations

Constructor

IpGroupsOperations(client, config, serializer, deserializer) -> None

Parameters

client

Client for service requests.

config

Configuration of service client.

serializer

An object model serializer.

deserializer

An object model deserializer.

Variables

models

Alias to model classes used in this operation group.

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: azure.mgmt.network.v2020_03_01.models._models_py3.IpGroup, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[_ForwardRef('models.IpGroup')]

Parameters

resource_group_name

str

Required

The name of the resource group.

ip_groups_name

str

Required

The name of the ipGroups.

parameters

IpGroup

Required

Parameters supplied to the create or update IpGroups operation.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

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

Return type

AsyncLROPoller[IpGroup]

Exceptions

~azure.core.exceptions.HttpResponseError

begin_delete

Deletes the specified ipGroups.

begin_delete(resource_group_name: str, ip_groups_name: str, **kwargs) -> azure.core.polling._async_poller.AsyncLROPoller[NoneType]

Parameters

resource_group_name

str

Required

The name of the resource group.

ip_groups_name

str

Required

The name of the ipGroups.

cls

callable

Required

A custom type or function that will be passed the direct response

continuation_token

str

Required

A continuation token to restart a poller from a saved state.

polling

bool or AsyncPollingMethod

Required

True for ARMPolling, False for no polling, or a polling object for personal polling strategy

polling_interval

int

Required

Default waiting time between two polls for LRO operations if no Retry-After header is present.

Returns

An instance of AsyncLROPoller that returns either None or the result of cls(response)

Return type

AsyncLROPoller[None]

Exceptions

~azure.core.exceptions.HttpResponseError

get

Gets the specified ipGroups.

get(resource_group_name: str, ip_groups_name: str, expand: typing.Union[str, NoneType] = None, **kwargs) -> azure.mgmt.network.v2020_03_01.models._models_py3.IpGroup

Parameters

resource_group_name

str

Required

The name of the resource group.

ip_groups_name

str

Required

The name of the ipGroups.

expand

str

Required

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

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

IpGroup, or the result of cls(response)

Return type

IpGroup

Exceptions

~azure.core.exceptions.HttpResponseError

list

Gets all IpGroups in a subscription.

list(**kwargs) -> typing.AsyncIterable[_ForwardRef('models.IpGroupListResult')]

Parameters

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[IpGroupListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

list_by_resource_group

Gets all IpGroups in a resource group.

list_by_resource_group(resource_group_name: str, **kwargs) -> typing.AsyncIterable[_ForwardRef('models.IpGroupListResult')]

Parameters

resource_group_name

str

Required

The name of the resource group.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

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

Return type

AsyncItemPaged[IpGroupListResult]

Exceptions

~azure.core.exceptions.HttpResponseError

update_groups

Updates tags of an IpGroups resource.

update_groups(resource_group_name: str, ip_groups_name: str, parameters: azure.mgmt.network.v2020_03_01.models._models_py3.TagsObject, **kwargs) -> azure.mgmt.network.v2020_03_01.models._models_py3.IpGroup

Parameters

resource_group_name

str

Required

The name of the resource group.

ip_groups_name

str

Required

The name of the ipGroups.

parameters

TagsObject

Required

Parameters supplied to the update ipGroups operation.

cls

callable

Required

A custom type or function that will be passed the direct response

Returns

IpGroup, or the result of cls(response)

Return type

IpGroup

Exceptions

~azure.core.exceptions.HttpResponseError

Attributes

models

models = <module 'azure.mgmt.network.v2020_03_01.models' from 'c:\\repo\\venv\\lib\\site-packages\\azure\\mgmt\\network\\v2020_03_01\\models\\__init__.py'>