Share via

NetworkGroupsOperations Class

  • Reference

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:network_groups> attribute.

Constructor

NetworkGroupsOperations(*args, **kwargs)

Methods

begin_delete

Deletes a network group.
create_or_update

Creates or updates a network group.
get

Gets the specified network group.
list

Lists the specified network group.

begin_delete

Deletes a network group.

begin_delete(resource_group_name: str, network_manager_name: str, network_group_name: str, *, force: bool | None = None, **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.
network_group_name
Required
str

The name of the network group. Required.

Keyword-Only Parameters

Name Description
force
bool

Deletes the resource even if it is part of a deployed configuration. If the configuration has been deployed, the service will do a cleanup deployment in the background, prior to the delete. Default value is None.

Default value: None

Returns

Type Description
LROPoller[None]

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

Exceptions

Type Description
HttpResponseError

create_or_update

Creates or updates a network group.

create_or_update(resource_group_name: str, network_manager_name: str, network_group_name: str, parameters: _models.NetworkGroup, *, if_match: str | None = None, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkGroup

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.
network_group_name
Required
str

The name of the network group. Required.
parameters
Required
NetworkGroup or IO[bytes]

Parameters supplied to the specify which network group need to create. Is either a NetworkGroup type or a IO[bytes] type. Required.

Keyword-Only Parameters

Name Description
if_match
str

The ETag of the transformation. Omit this value to always overwrite the current resource. Specify the last-seen ETag value to prevent accidentally overwriting concurrent changes. Default value is None.

Default value: None

Returns

Type Description
NetworkGroup

NetworkGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Gets the specified network group.

get(resource_group_name: str, network_manager_name: str, network_group_name: str, **kwargs: Any) -> NetworkGroup

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.
network_group_name
Required
str

The name of the network group. Required.

Returns

Type Description
NetworkGroup

NetworkGroup or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

Lists the specified network group.

list(resource_group_name: str, network_manager_name: str, *, top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> Iterable[NetworkGroup]

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
top
int

An optional query parameter which specifies the maximum number of records to be returned by the server. Default value is None.

Default value: None
skip_token
str

SkipToken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls. Default value is None.

Default value: None

Returns

Type Description
ItemPaged[NetworkGroup]

An iterator like instance of either NetworkGroup 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.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv169\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>