VirtualNetworks interface
Interface representing a VirtualNetworks.
Methods
Method Details
beginCreateOrUpdate(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)
Creates or updates a virtual network in the specified resource group.
function beginCreateOrUpdate(resourceGroupName: string, virtualNetworkName: string, parameters: VirtualNetwork, options?: VirtualNetworksCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetwork>, VirtualNetwork>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
- parameters
- VirtualNetwork
Parameters supplied to the create or update virtual network operation
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetwork>, VirtualNetwork>>
beginCreateOrUpdateAndWait(string, string, VirtualNetwork, VirtualNetworksCreateOrUpdateOptionalParams)
Creates or updates a virtual network in the specified resource group.
function beginCreateOrUpdateAndWait(resourceGroupName: string, virtualNetworkName: string, parameters: VirtualNetwork, options?: VirtualNetworksCreateOrUpdateOptionalParams): Promise<VirtualNetwork>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
- parameters
- VirtualNetwork
Parameters supplied to the create or update virtual network operation
The options parameters.
Returns
Promise<VirtualNetwork>
beginDelete(string, string, VirtualNetworksDeleteOptionalParams)
Deletes the specified virtual network.
function beginDelete(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksDeleteOptionalParams): Promise<PollerLike<PollOperationState<void>, void>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<void>, void>>
beginDeleteAndWait(string, string, VirtualNetworksDeleteOptionalParams)
Deletes the specified virtual network.
function beginDeleteAndWait(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
The options parameters.
Returns
Promise<void>
beginUpdateTags(string, string, TagsObject, VirtualNetworksUpdateTagsOptionalParams)
Updates a virtual network tags.
function beginUpdateTags(resourceGroupName: string, virtualNetworkName: string, parameters: TagsObject, options?: VirtualNetworksUpdateTagsOptionalParams): Promise<PollerLike<PollOperationState<VirtualNetwork>, VirtualNetwork>>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
- parameters
- TagsObject
Parameters supplied to update virtual network tags.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<VirtualNetwork>, VirtualNetwork>>
beginUpdateTagsAndWait(string, string, TagsObject, VirtualNetworksUpdateTagsOptionalParams)
Updates a virtual network tags.
function beginUpdateTagsAndWait(resourceGroupName: string, virtualNetworkName: string, parameters: TagsObject, options?: VirtualNetworksUpdateTagsOptionalParams): Promise<VirtualNetwork>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
- parameters
- TagsObject
Parameters supplied to update virtual network tags.
The options parameters.
Returns
Promise<VirtualNetwork>
checkIPAddressAvailability(string, string, string, VirtualNetworksCheckIPAddressAvailabilityOptionalParams)
Checks whether a private IP address is available for use.
function checkIPAddressAvailability(resourceGroupName: string, virtualNetworkName: string, ipAddress: string, options?: VirtualNetworksCheckIPAddressAvailabilityOptionalParams): Promise<IPAddressAvailabilityResult>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
- ipAddress
-
string
The private IP address to be verified.
The options parameters.
Returns
Promise<IPAddressAvailabilityResult>
get(string, string, VirtualNetworksGetOptionalParams)
Gets the specified virtual network by resource group.
function get(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksGetOptionalParams): Promise<VirtualNetwork>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
- options
- VirtualNetworksGetOptionalParams
The options parameters.
Returns
Promise<VirtualNetwork>
list(string, VirtualNetworksListOptionalParams)
Gets all virtual networks in a resource group.
function list(resourceGroupName: string, options?: VirtualNetworksListOptionalParams): PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
The options parameters.
Returns
listAll(VirtualNetworksListAllOptionalParams)
Gets all virtual networks in a subscription.
function listAll(options?: VirtualNetworksListAllOptionalParams): PagedAsyncIterableIterator<VirtualNetwork, VirtualNetwork[], PageSettings>Parameters
The options parameters.
Returns
listUsage(string, string, VirtualNetworksListUsageOptionalParams)
Lists usage stats.
function listUsage(resourceGroupName: string, virtualNetworkName: string, options?: VirtualNetworksListUsageOptionalParams): PagedAsyncIterableIterator<VirtualNetworkUsage, VirtualNetworkUsage[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group.
- virtualNetworkName
-
string
The name of the virtual network.
The options parameters.