Share via

ScopeConnectionsOperations Class

Warning

DO NOT instantiate this class directly.

Instead, you should access the following operations through

NetworkManagementClient's

<xref:scope_connections> attribute.

Constructor

ScopeConnectionsOperations(*args, **kwargs)

Methods

create_or_update

Creates or updates scope connection from Network Manager.
delete

Delete the pending scope connection created by this network manager.
get

Get specified scope connection created by this Network Manager.
list

List all scope connections created by this network manager.

create_or_update

Creates or updates scope connection from Network Manager.

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

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

Name for the cross-tenant connection. Required.
parameters
Required
ScopeConnection or IO[bytes]

Scope connection to be created/updated. Is either a ScopeConnection type or a IO[bytes] type. Required.

Returns

Type Description
ScopeConnection

ScopeConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

delete

Delete the pending scope connection created by this network manager.

delete(resource_group_name: str, network_manager_name: str, scope_connection_name: str, **kwargs: Any) -> 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.
scope_connection_name
Required
str

Name for the cross-tenant connection. Required.

Returns

Type Description
None

None or the result of cls(response)

Exceptions

Type Description
HttpResponseError

get

Get specified scope connection created by this Network Manager.

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

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

Name for the cross-tenant connection. Required.

Returns

Type Description
ScopeConnection

ScopeConnection or the result of cls(response)

Exceptions

Type Description
HttpResponseError

list

List all scope connections created by this network manager.

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

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[ScopeConnection]

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

Exceptions

Type Description
HttpResponseError

Attributes

models 

models = <module 'azure.mgmt.network.models' from 'C:\\ToolCache\\Python\\3.11.9\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv177\\Lib\\site-packages\\azure\\mgmt\\network\\models\\__init__.py'>