VirtualNetworks | @azure/arm-network-profile-2019-03-01-hybrid

Class representing a VirtualNetworks.

Hierarchy

VirtualNetworks

Index

Constructors

constructor

Methods

Constructors

constructor

new VirtualNetworks(client: NetworkManagementClientContext): VirtualNetworks

- Defined in operations/virtualNetworks.ts:20
Create a VirtualNetworks.

Parameters
- client: NetworkManagementClientContext
  
  Reference to the service client.
Returns VirtualNetworks

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, virtualNetworkName: string, parameters: VirtualNetwork, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworks.ts:242
Creates or updates a virtual network in the specified resource group.

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
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginDeleteMethod

beginDeleteMethod(resourceGroupName: string, virtualNetworkName: string, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworks.ts:223
Deletes the specified virtual network.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

beginUpdateTags

beginUpdateTags(resourceGroupName: string, virtualNetworkName: string, parameters: TagsObject, options?: msRest.RequestOptionsBase): Promise<msRestAzure.LROPoller>

- Defined in operations/virtualNetworks.ts:262
Updates a virtual network tags.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRestAzure.LROPoller>

Promise<msRestAzure.LROPoller>

checkIPAddressAvailability

checkIPAddressAvailability(resourceGroupName: string, virtualNetworkName: string, options?: Models.VirtualNetworksCheckIPAddressAvailabilityOptionalParams): Promise<Models.VirtualNetworksCheckIPAddressAvailabilityResponse>
checkIPAddressAvailability(resourceGroupName: string, virtualNetworkName: string, callback: msRest.ServiceCallback<IPAddressAvailabilityResult>): void
checkIPAddressAvailability(resourceGroupName: string, virtualNetworkName: string, options: VirtualNetworksCheckIPAddressAvailabilityOptionalParams, callback: msRest.ServiceCallback<IPAddressAvailabilityResult>): void

- Defined in operations/virtualNetworks.ts:159
Checks whether a private IP address is available for use.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- Optional options: Models.VirtualNetworksCheckIPAddressAvailabilityOptionalParams
Returns Promise<Models.VirtualNetworksCheckIPAddressAvailabilityResponse>

Promise<Models.VirtualNetworksCheckIPAddressAvailabilityResponse>
- Defined in operations/virtualNetworks.ts:165
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- callback: msRest.ServiceCallback<IPAddressAvailabilityResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:172
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- options: VirtualNetworksCheckIPAddressAvailabilityOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<IPAddressAvailabilityResult>
  
  The callback
Returns void

createOrUpdate

createOrUpdate(resourceGroupName: string, virtualNetworkName: string, parameters: VirtualNetwork, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksCreateOrUpdateResponse>

- Defined in operations/virtualNetworks.ts:82
Creates or updates a virtual network in the specified resource group.

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
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksCreateOrUpdateResponse>

Promise<Models.VirtualNetworksCreateOrUpdateResponse>

deleteMethod

deleteMethod(resourceGroupName: string, virtualNetworkName: string, options?: msRest.RequestOptionsBase): Promise<msRest.RestResponse>

- Defined in operations/virtualNetworks.ts:37
Deletes the specified virtual network.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- Optional options: msRest.RequestOptionsBase
Returns Promise<msRest.RestResponse>

Promise<msRest.RestResponse>

get

get(resourceGroupName: string, virtualNetworkName: string, options?: Models.VirtualNetworksGetOptionalParams): Promise<Models.VirtualNetworksGetResponse>
get(resourceGroupName: string, virtualNetworkName: string, callback: msRest.ServiceCallback<VirtualNetwork>): void
get(resourceGroupName: string, virtualNetworkName: string, options: VirtualNetworksGetOptionalParams, callback: msRest.ServiceCallback<VirtualNetwork>): void

- Defined in operations/virtualNetworks.ts:49
Gets the specified virtual network by resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- Optional options: Models.VirtualNetworksGetOptionalParams
Returns Promise<Models.VirtualNetworksGetResponse>

Promise<Models.VirtualNetworksGetResponse>
- Defined in operations/virtualNetworks.ts:55
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- callback: msRest.ServiceCallback<VirtualNetwork>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:62
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- options: VirtualNetworksGetOptionalParams
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetwork>
  
  The callback
Returns void

list

list(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksListResponse>
list(resourceGroupName: string, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void
list(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void

- Defined in operations/virtualNetworks.ts:130
Gets all virtual networks in a resource group.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksListResponse>

Promise<Models.VirtualNetworksListResponse>
- Defined in operations/virtualNetworks.ts:135
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:141
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void

listAll

listAll(options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksListAllResponse>
listAll(callback: msRest.ServiceCallback<VirtualNetworkListResult>): void
listAll(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void

- Defined in operations/virtualNetworks.ts:105
Gets all virtual networks in a subscription.

Parameters
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksListAllResponse>

Promise<Models.VirtualNetworksListAllResponse>
- Defined in operations/virtualNetworks.ts:109
Parameters
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:114
Parameters
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void

listAllNext

listAllNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksListAllNextResponse>
listAllNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void
listAllNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void

- Defined in operations/virtualNetworks.ts:280
Gets all virtual networks in a subscription.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksListAllNextResponse>

Promise<Models.VirtualNetworksListAllNextResponse>
- Defined in operations/virtualNetworks.ts:285
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:291
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void

listNext

listNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksListNextResponse>
listNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void
listNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkListResult>): void

- Defined in operations/virtualNetworks.ts:308
Gets all virtual networks in a resource group.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksListNextResponse>

Promise<Models.VirtualNetworksListNextResponse>
- Defined in operations/virtualNetworks.ts:313
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:319
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkListResult>
  
  The callback
Returns void

listUsage

listUsage(resourceGroupName: string, virtualNetworkName: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksListUsageResponse>
listUsage(resourceGroupName: string, virtualNetworkName: string, callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>): void
listUsage(resourceGroupName: string, virtualNetworkName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>): void

- Defined in operations/virtualNetworks.ts:191
Lists usage stats.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksListUsageResponse>

Promise<Models.VirtualNetworksListUsageResponse>
- Defined in operations/virtualNetworks.ts:197
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:204
Parameters
- resourceGroupName: string
  
  The name of the resource group.
- virtualNetworkName: string
  
  The name of the virtual network.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>
  
  The callback
Returns void

listUsageNext

listUsageNext(nextPageLink: string, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksListUsageNextResponse>
listUsageNext(nextPageLink: string, callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>): void
listUsageNext(nextPageLink: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>): void

- Defined in operations/virtualNetworks.ts:336
Lists usage stats.

Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksListUsageNextResponse>

Promise<Models.VirtualNetworksListUsageNextResponse>
- Defined in operations/virtualNetworks.ts:341
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>
  
  The callback
Returns void
- Defined in operations/virtualNetworks.ts:347
Parameters
- nextPageLink: string
  
  The NextLink from the previous successful call to List operation.
- options: msRest.RequestOptionsBase
  
  The optional parameters
- callback: msRest.ServiceCallback<VirtualNetworkListUsageResult>
  
  The callback
Returns void

updateTags

updateTags(resourceGroupName: string, virtualNetworkName: string, parameters: TagsObject, options?: msRest.RequestOptionsBase): Promise<Models.VirtualNetworksUpdateTagsResponse>

- Defined in operations/virtualNetworks.ts:95
Updates a virtual network tags.

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.
- Optional options: msRest.RequestOptionsBase
Returns Promise<Models.VirtualNetworksUpdateTagsResponse>

Promise<Models.VirtualNetworksUpdateTagsResponse>

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

client: NetworkManagementClientContext

Returns VirtualNetworks

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

virtualNetworkName: string

parameters: VirtualNetwork

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginDeleteMethod

Parameters

resourceGroupName: string

virtualNetworkName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

beginUpdateTags

Parameters

resourceGroupName: string

virtualNetworkName: string

parameters: TagsObject

Optional options: msRest.RequestOptionsBase

Returns Promise<msRestAzure.LROPoller>

checkIPAddressAvailability

Parameters

resourceGroupName: string

virtualNetworkName: string

Optional options: Models.VirtualNetworksCheckIPAddressAvailabilityOptionalParams

Returns Promise<Models.VirtualNetworksCheckIPAddressAvailabilityResponse>

Parameters

resourceGroupName: string

virtualNetworkName: string

callback: msRest.ServiceCallback<IPAddressAvailabilityResult>

Returns void

Parameters

resourceGroupName: string

virtualNetworkName: string

options: VirtualNetworksCheckIPAddressAvailabilityOptionalParams

callback: msRest.ServiceCallback<IPAddressAvailabilityResult>

Returns void

createOrUpdate

Parameters

resourceGroupName: string

virtualNetworkName: string

parameters: VirtualNetwork

Optional options: msRest.RequestOptionsBase

Returns Promise<Models.VirtualNetworksCreateOrUpdateResponse>

deleteMethod

Parameters

resourceGroupName: string

virtualNetworkName: string

Optional options: msRest.RequestOptionsBase

Returns Promise<msRest.RestResponse>

get

Parameters

resourceGroupName: string

virtualNetworkName: string

Optional options: Models.VirtualNetworksGetOptionalParams

Returns Promise<Models.VirtualNetworksGetResponse>

Parameters

resourceGroupName: string

virtualNetworkName: string

callback: msRest.ServiceCallback<VirtualNetwork>

Returns void

Parameters

resourceGroupName: string

virtualNetworkName: string

options: VirtualNetworksGetOptionalParams

callback: msRest.ServiceCallback<VirtualNetwork>

Returns void

list

Parameters

resourceGroupName: string