NetworkManagersOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:network_managers> attribute.

Constructor

NetworkManagersOperations(*args, **kwargs)

Methods

begin_delete	Deletes a network manager.
create_or_update	Creates or updates a Network Manager.
get	Gets the specified Network Manager.
list	List network managers in a resource group.
list_by_subscription	List all network managers in a subscription.
patch	Patch NetworkManager.

begin_delete

Deletes a network manager.

begin_delete(resource_group_name: str, network_manager_name: str, *, force: bool | None = None, **kwargs: Any) -> LROPoller[None]

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. 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 None

Exceptions

Type	Description
HttpResponseError

create_or_update

Creates or updates a Network Manager.

create_or_update(resource_group_name: str, network_manager_name: str, parameters: _models.NetworkManager, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkManager

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. Required.
parameters Required	NetworkManager or <xref:JSON> or IO[bytes] Parameters supplied to specify which network manager is. Is one of the following types: NetworkManager, JSON, IO[bytes] Required.

Returns

Type	Description
NetworkManager	NetworkManager. The NetworkManager is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

get

Gets the specified Network Manager.

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

Parameters

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

Returns

Type	Description
NetworkManager	NetworkManager. The NetworkManager is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError

list

List network managers in a resource group.

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

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. 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[NetworkManager]	An iterator like instance of NetworkManager

Exceptions

Type	Description
HttpResponseError

list_by_subscription

List all network managers in a subscription.

list_by_subscription(*, top: int | None = None, skip_token: str | None = None, **kwargs: Any) -> ItemPaged[NetworkManager]

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[NetworkManager]	An iterator like instance of NetworkManager

Exceptions

Type	Description
HttpResponseError

patch

Patch NetworkManager.

patch(resource_group_name: str, network_manager_name: str, parameters: _models.PatchObject, *, content_type: str = 'application/json', **kwargs: Any) -> _models.NetworkManager

Parameters

Name	Description
resource_group_name Required	str The name of the resource group. The name is case insensitive. Required.
network_manager_name Required	str The name of the network manager. Required.
parameters Required	PatchObject or <xref:JSON> or IO[bytes] Parameters supplied to specify which network manager is. Is one of the following types: PatchObject, JSON, IO[bytes] Required.

Returns

Type	Description
NetworkManager	NetworkManager. The NetworkManager is compatible with MutableMapping

Exceptions

Type	Description
HttpResponseError