VirtualNetworksOperations Class
Warning
DO NOT instantiate this class directly.
Instead, you should access the following operations through
<xref:virtual_networks> attribute.
Constructor
VirtualNetworksOperations(*args, **kwargs)
Methods
| begin_create_or_update |
Create or replace an existing virtual network. This operation can take a while to complete. |
| begin_delete |
Delete virtual network. This operation can take a while to complete. |
| get |
Get virtual network. |
| list |
List virtual networks in a given lab. |
| update |
Allows modifying tags of virtual networks. All other properties will be ignored. |
begin_create_or_update
Create or replace an existing virtual network. This operation can take a while to complete.
begin_create_or_update(resource_group_name: str, lab_name: str, name: str, virtual_network: _models.VirtualNetwork, *, content_type: str = 'application/json', **kwargs: Any) -> LROPoller[_models.VirtualNetwork]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
name
Required
|
The name of the virtual network. Required. |
|
virtual_network
Required
|
A virtual network. Is either a VirtualNetwork type or a IO[bytes] type. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either VirtualNetwork or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
begin_delete
Delete virtual network. This operation can take a while to complete.
begin_delete(resource_group_name: str, lab_name: str, name: str, **kwargs: Any) -> LROPoller[None]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
name
Required
|
The name of the virtual network. Required. |
Returns
| Type | Description |
|---|---|
|
An instance of LROPoller that returns either None or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
get
Get virtual network.
get(resource_group_name: str, lab_name: str, name: str, expand: str | None = None, **kwargs: Any) -> VirtualNetwork
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
name
Required
|
The name of the virtual network. Required. |
|
expand
|
Specify the $expand query. Example: 'properties($expand=externalSubnets)'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
VirtualNetwork or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
list
List virtual networks in a given lab.
list(resource_group_name: str, lab_name: str, expand: str | None = None, filter: str | None = None, top: int | None = None, orderby: str | None = None, **kwargs: Any) -> ItemPaged[VirtualNetwork]
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
expand
|
Specify the $expand query. Example: 'properties($expand=externalSubnets)'. Default value is None. Default value: None
|
|
filter
|
The filter to apply to the operation. Example: '$filter=contains(name,'myName'). Default value is None. Default value: None
|
|
top
|
The maximum number of resources to return from the operation. Example: '$top=10'. Default value is None. Default value: None
|
|
orderby
|
The ordering expression for the results, using OData notation. Example: '$orderby=name desc'. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An iterator like instance of either VirtualNetwork or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
update
Allows modifying tags of virtual networks. All other properties will be ignored.
update(resource_group_name: str, lab_name: str, name: str, tags: dict[str, str] | None = None, **kwargs: Any) -> VirtualNetwork
Parameters
| Name | Description |
|---|---|
|
resource_group_name
Required
|
The name of the resource group. Required. |
|
lab_name
Required
|
The name of the lab. Required. |
|
name
Required
|
The name of the virtual network. Required. |
|
tags
|
The tags of the resource. Default value is None. Default value: None
|
Returns
| Type | Description |
|---|---|
|
VirtualNetwork or the result of cls(response) |
Exceptions
| Type | Description |
|---|---|
Attributes
models
models = <module 'azure.mgmt.devtestlabs.models' from 'C:\\ToolCache\\Python\\3.12.10\\x64\\Lib\\site-packages\\py2docfx\\venv\\venv125\\Lib\\site-packages\\azure\\mgmt\\devtestlabs\\models\\__init__.py'>