Package version:

Interface VirtualNetworks

Interface representing a VirtualNetworks.

interface VirtualNetworks {
    beginCreateOrUpdate(resourceGroupName, virtualNetworkName, resource, options?): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>;
    beginCreateOrUpdateAndWait(resourceGroupName, virtualNetworkName, resource, options?): Promise<VirtualNetwork>;
    beginDelete(resourceGroupName, virtualNetworkName, options?): Promise<SimplePollerLike<OperationState<VirtualNetworksDeleteHeaders>, VirtualNetworksDeleteHeaders>>;
    beginDeleteAndWait(resourceGroupName, virtualNetworkName, options?): Promise<VirtualNetworksDeleteHeaders>;
    beginUpdate(resourceGroupName, virtualNetworkName, properties, options?): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>;
    beginUpdateAndWait(resourceGroupName, virtualNetworkName, properties, options?): Promise<VirtualNetwork>;
    get(resourceGroupName, virtualNetworkName, options?): Promise<VirtualNetwork>;
    listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<VirtualNetwork>;
    listBySubscription(options?): PagedAsyncIterableIterator<VirtualNetwork>;
}

Index

Methods

beginCreateOrUpdate beginCreateOrUpdateAndWait beginDelete beginDeleteAndWait beginUpdate beginUpdateAndWait get listByResourceGroup listBySubscription

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName, virtualNetworkName, resource, options?): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>
Onboards the ScVmm virtual network as an Azure virtual network resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- resource: VirtualNetwork
  Resource create parameters.
- Optional options: VirtualNetworksCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>
- Defined in operationsInterfaces/virtualNetworks.ts:63

beginCreateOrUpdateAndWait

beginCreateOrUpdateAndWait(resourceGroupName, virtualNetworkName, resource, options?): Promise<VirtualNetwork>
Onboards the ScVmm virtual network as an Azure virtual network resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- resource: VirtualNetwork
  Resource create parameters.
- Optional options: VirtualNetworksCreateOrUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualNetwork>
- Defined in operationsInterfaces/virtualNetworks.ts:81

beginDelete

beginDelete(resourceGroupName, virtualNetworkName, options?): Promise<SimplePollerLike<OperationState<VirtualNetworksDeleteHeaders>, VirtualNetworksDeleteHeaders>>
Deregisters the ScVmm virtual network from Azure.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- Optional options: VirtualNetworksDeleteOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualNetworksDeleteHeaders>, VirtualNetworksDeleteHeaders>>
- Defined in operationsInterfaces/virtualNetworks.ts:124

beginDeleteAndWait

beginDeleteAndWait(resourceGroupName, virtualNetworkName, options?): Promise<VirtualNetworksDeleteHeaders>
Deregisters the ScVmm virtual network from Azure.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- Optional options: VirtualNetworksDeleteOptionalParams
  The options parameters.
Returns Promise<VirtualNetworksDeleteHeaders>
- Defined in operationsInterfaces/virtualNetworks.ts:140

beginUpdate

beginUpdate(resourceGroupName, virtualNetworkName, properties, options?): Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>
Updates the VirtualNetworks resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- properties: VirtualNetworkTagsUpdate
  The resource properties to be updated.
- Optional options: VirtualNetworksUpdateOptionalParams
  The options parameters.
Returns Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>
- Defined in operationsInterfaces/virtualNetworks.ts:94

beginUpdateAndWait

beginUpdateAndWait(resourceGroupName, virtualNetworkName, properties, options?): Promise<VirtualNetwork>
Updates the VirtualNetworks resource.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- properties: VirtualNetworkTagsUpdate
  The resource properties to be updated.
- Optional options: VirtualNetworksUpdateOptionalParams
  The options parameters.
Returns Promise<VirtualNetwork>
- Defined in operationsInterfaces/virtualNetworks.ts:112

get

get(resourceGroupName, virtualNetworkName, options?): Promise<VirtualNetwork>
Implements VirtualNetwork GET method.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- virtualNetworkName: string
  Name of the VirtualNetwork.
- Optional options: VirtualNetworksGetOptionalParams
  The options parameters.
Returns Promise<VirtualNetwork>
- Defined in operationsInterfaces/virtualNetworks.ts:51

listByResourceGroup

listByResourceGroup(resourceGroupName, options?): PagedAsyncIterableIterator<VirtualNetwork>
List of VirtualNetworks in a resource group.
Parameters
- resourceGroupName: string
  The name of the resource group. The name is case insensitive.
- Optional options: VirtualNetworksListByResourceGroupOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualNetwork>
- Defined in operationsInterfaces/virtualNetworks.ts:41

listBySubscription

listBySubscription(options?): PagedAsyncIterableIterator<VirtualNetwork>
List of VirtualNetworks in a subscription.
Parameters
- Optional options: VirtualNetworksListBySubscriptionOptionalParams
  The options parameters.
Returns PagedAsyncIterableIterator<VirtualNetwork>
- Defined in operationsInterfaces/virtualNetworks.ts:33

Interface VirtualNetworks

Index

Methods

Methods

beginCreateOrUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

beginCreateOrUpdateAndWait

Parameters

Returns Promise<VirtualNetwork>

beginDelete

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualNetworksDeleteHeaders>, VirtualNetworksDeleteHeaders>>

beginDeleteAndWait

Parameters

Returns Promise<VirtualNetworksDeleteHeaders>

beginUpdate

Parameters

Returns Promise<SimplePollerLike<OperationState<VirtualNetwork>, VirtualNetwork>>

beginUpdateAndWait

Parameters

Returns Promise<VirtualNetwork>

get

Parameters

Returns Promise<VirtualNetwork>

listByResourceGroup

Parameters

Returns PagedAsyncIterableIterator<VirtualNetwork>

listBySubscription

Parameters

Returns PagedAsyncIterableIterator<VirtualNetwork>

Settings

Member Visibility

Theme