Azure Networking Services VirtualNetworks API
The VirtualNetworks API from Azure Networking Services — 3 operation(s) for virtualnetworks.
OpenAPI Specification
swagger: '2.0'
info:
description: The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.
title: NetworkManagementClient LoadBalancers VirtualNetworks API
version: '2.0'
x-apisguru-categories:
- cloud
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_assets.onestore.ms_cdnfiles_onestorerolling-1606-01000_shell_v3_images_logo_microsoft.png
x-origin:
- format: swagger
url: https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/loadBalancer.json
x-preferred: true
x-providerName: azure.com
x-serviceName: network-loadBalancer
x-tags:
- Azure
- Microsoft
host: management.azure.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
security:
- azure_auth:
- user_impersonation
tags:
- name: VirtualNetworks
paths:
/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks:
get:
description: Gets all virtual networks in a subscription.
operationId: VirtualNetworks_ListAll
parameters:
- description: Client API version.
in: query
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
in: path
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Request successful. The operation returns a list of VirtualNetwork resources.
schema:
$ref: '#/definitions/VirtualNetworkListResult'
tags:
- VirtualNetworks
x-ms-examples:
List all virtual networks:
parameters:
api-version: '2019-08-01'
subscriptionId: subid
responses:
'200':
body:
value:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1
location: westus
name: vnet1
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/8
dhcpOptions:
dnsServers: []
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/24
provisioningState: Succeeded
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
- id: /subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2
location: westus
name: vnet2
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
dhcpOptions:
dnsServers:
- 8.8.8.8
provisioningState: Succeeded
subnets: []
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
x-ms-pageable:
nextLinkName: nextLink
summary: Azure Networking Services Virtual Networks_ List All
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks:
get:
description: Gets all virtual networks in a resource group.
operationId: VirtualNetworks_List
parameters:
- description: The name of the resource group.
in: path
name: resourceGroupName
required: true
type: string
example: my-resource-group
- description: Client API version.
in: query
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
in: path
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Request successful. The operation returns a list of VirtualNetwork resources.
schema:
$ref: '#/definitions/VirtualNetworkListResult'
tags:
- VirtualNetworks
x-ms-examples:
List virtual networks in resource group:
parameters:
api-version: '2019-08-01'
resourceGroupName: rg1
subscriptionId: subid
responses:
'200':
body:
value:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1
location: westus
name: vnet1
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/8
dhcpOptions:
dnsServers: []
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/24
provisioningState: Succeeded
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2
location: westus
name: vnet2
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
dhcpOptions:
dnsServers:
- 8.8.8.8
provisioningState: Succeeded
subnets: []
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
x-ms-pageable:
nextLinkName: nextLink
summary: Azure Networking Services Virtual Networks_ List
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}
: delete:
description: Deletes the specified virtual network.
operationId: VirtualNetworks_Delete
parameters:
- description: The name of the resource group.
in: path
name: resourceGroupName
required: true
type: string
example: my-resource-group
- description: The name of the virtual network.
in: path
name: virtualNetworkName
required: true
type: string
example: example-value
- description: Client API version.
in: query
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
in: path
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Delete successful.
'202':
description: Accepted and the operation will complete asynchronously.
'204':
description: Delete successful.
tags:
- VirtualNetworks
x-ms-examples:
Delete virtual network:
parameters:
api-version: '2019-08-01'
resourceGroupName: rg1
subscriptionId: subid
virtualNetworkName: test-vnet
responses:
'200': {}
'202': {}
'204': {}
x-ms-long-running-operation: true
x-ms-long-running-operation-options:
final-state-via: location
summary: Azure Networking Services Virtual Networks_ Delete
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
get:
description: Gets the specified virtual network by resource group.
operationId: VirtualNetworks_Get
parameters:
- description: The name of the resource group.
in: path
name: resourceGroupName
required: true
type: string
example: my-resource-group
- description: The name of the virtual network.
in: path
name: virtualNetworkName
required: true
type: string
example: example-value
- description: Client API version.
in: query
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
in: path
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
- description: Expands referenced resources.
in: query
name: $expand
required: false
type: string
example: example-value
responses:
'200':
description: Request successful. The operation returns the resulting VirtualNetwork resource.
schema:
$ref: '#/definitions/VirtualNetwork'
tags:
- VirtualNetworks
x-ms-examples:
Get virtual network:
parameters:
api-version: '2019-08-01'
resourceGroupName: rg1
subscriptionId: subid
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: westus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1
name: subnet1
properties:
addressPrefix: 10.0.1.0/24
ipConfigurations:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe
provisioningState: Succeeded
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
Get virtual network with a delegated subnet:
parameters:
api-version: '2019-08-01'
resourceGroupName: rg1
subscriptionId: subId
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: westus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1
name: subnet1
properties:
addressPrefix: 10.0.1.0/24
delegations:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation
name: myDelegation
properties:
actions: []
provisioningState: Succeeded
serviceName: Microsoft.Provider/resourceType
ipConfigurations:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe
provisioningState: Succeeded
purpose: ''
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
Get virtual network with service association links:
parameters:
api-version: '2019-08-01'
resourceGroupName: rg1
subscriptionId: subId
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: westus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- etag: W/"4d3e91b4-f67f-48be-880b-e4a8abdd019e"
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1
name: subnet1
properties:
addressPrefix: 10.0.214.0/24
delegations:
- etag: W/"4d3e91b4-f67f-48be-880b-e4a8abdd019e"
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/aciDelegation
name: aciDelegation
properties:
actions:
- Microsoft.Network/virtualNetworks/subnets/action
provisioningState: Succeeded
serviceName: Microsoft.Provider/resourceType
ipConfigurationProfiles:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1
provisioningState: Succeeded
serviceAssociationLinks:
- etag: W/"4d3e91b4-f67f-48be-880b-e4a8abdd019e"
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/serviceAssociationLinks/serviceAssociationLink1
name: serviceAssociationLink1
properties:
linkedResourceType: Microsoft.Provider/resourceType
provisioningState: Succeeded
serviceEndpoints: []
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
summary: Azure Networking Services Virtual Networks_ Get
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
patch:
description: Updates a virtual network tags.
operationId: VirtualNetworks_UpdateTags
parameters:
- description: The name of the resource group.
in: path
name: resourceGroupName
required: true
type: string
example: my-resource-group
- description: The name of the virtual network.
in: path
name: virtualNetworkName
required: true
type: string
example: example-value
- description: Parameters supplied to update virtual network tags.
in: body
name: parameters
required: true
schema:
description: Tags object for patch operations.
properties:
tags:
additionalProperties:
type: string
description: Resource tags.
type: object
example: example-value
- description: Client API version.
in: query
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
in: path
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Update successful. The operation returns the resulting VirtualNetwork resource.
schema:
$ref: '#/definitions/VirtualNetwork'
tags:
- VirtualNetworks
x-ms-examples:
Update virtual network tags:
parameters:
api-version: '2019-08-01'
location: westus
parameters:
tags:
tag1: value1
tag2: value2
resourceGroupName: rg1
subscriptionId: subid
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: westus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets: []
virtualNetworkPeerings: []
tags:
tag1: value1
tag2: value2
type: Microsoft.Network/virtualNetworks
x-ms-long-running-operation: true
summary: Azure Networking Services Virtual Networks_ Update Tags
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
put:
description: Creates or updates a virtual network in the specified resource group.
operationId: VirtualNetworks_CreateOrUpdate
parameters:
- description: The name of the resource group.
in: path
name: resourceGroupName
required: true
type: string
example: my-resource-group
- description: The name of the virtual network.
in: path
name: virtualNetworkName
required: true
type: string
example: example-value
- description: Parameters supplied to the create or update virtual network operation.
in: body
name: parameters
required: true
schema:
$ref: '#/definitions/VirtualNetwork'
example: example-value
- description: Client API version.
in: query
name: api-version
required: true
type: string
example: '2019-06-01'
- description: The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
in: path
name: subscriptionId
required: true
type: string
example: 00000000-0000-0000-0000-000000000000
responses:
'200':
description: Update successful. The operation returns the resulting VirtualNetwork resource.
schema:
$ref: '#/definitions/VirtualNetwork'
'201':
description: Create successful. The operation returns the resulting VirtualNetwork resource.
schema:
$ref: '#/definitions/VirtualNetwork'
tags:
- VirtualNetworks
x-ms-examples:
Create virtual network:
parameters:
api-version: '2019-08-01'
parameters:
location: eastus
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
resourceGroupName: rg1
subscriptionId: subid
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: eastus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets: []
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
'201':
body:
id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: eastus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets: []
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
Create virtual network with Bgp Communities:
parameters:
api-version: '2019-08-01'
parameters:
location: eastus
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
bgpCommunities:
virtualNetworkCommunity: 12076:60000
subnets:
- name: test-1
properties:
addressPrefix: 10.0.0.0/24
resourceGroupName: rg1
subscriptionId: subid
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: eastus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
bgpCommunities:
regionalCommunity: 12076:51004
virtualNetworkCommunity: 12076:60000
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/24
provisioningState: Succeeded
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
'201':
body:
id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: eastus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
bgpCommunities:
regionalCommunity: 12076:51004
virtualNetworkCommunity: 12076:60000
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/24
provisioningState: Succeeded
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
Create virtual network with delegated subnets:
parameters:
api-version: '2019-08-01'
parameters:
location: westcentralus
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
subnets:
- name: test-1
properties:
addressPrefix: 10.0.0.0/24
delegations:
- name: myDelegation
properties:
serviceName: Microsoft.Sql/managedInstances
resourceGroupName: rg1
subscriptionId: subId
virtualNetworkName: test-vnet
responses:
'200':
body:
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: westcentralus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/24
delegations:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation
name: myDelegation
properties:
actions: []
provisioningState: Succeeded
serviceName: Microsoft.Sql/managedInstances
provisioningState: Succeeded
purpose: ''
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
'201':
body:
id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet
location: westcentralus
name: test-vnet
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/24
delegations:
- id: /subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation
name: myDelegation
properties:
actions: []
provisioningState: Succeeded
serviceName: Microsoft.Sql/managedInstances
provisioningState: Succeeded
purpose: ''
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
Create virtual network with service endpoints:
parameters:
api-version: '2019-08-01'
parameters:
location: eastus
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
subnets:
- name: test-1
properties:
addressPrefix: 10.0.0.0/16
serviceEndpoints:
- service: Microsoft.Storage
resourceGroupName: vnetTest
subscriptionId: subid
virtualNetworkName: vnet1
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1
location: eastus
name: vnet1
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/16
ipConfigurations: []
provisioningState: Succeeded
resourceNavigationLinks: []
serviceEndpoints:
- locations:
- eastus2(stage)
- usnorth(stage)
provisioningState: Succeeded
service: Microsoft.Storage
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
'201':
body:
id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1
location: eastus
name: vnet1
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/16
ipConfigurations: []
provisioningState: Succeeded
resourceNavigationLinks: []
serviceEndpoints:
- locations:
- eastus2(stage)
- usnorth(stage)
provisioningState: Succeeded
service: Microsoft.Storage
virtualNetworkPeerings: []
type: Microsoft.Network/virtualNetworks
Create virtual network with service endpoints and service endpoint policy:
parameters:
api-version: '2019-08-01'
parameters:
location: eastus2euap
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
subnets:
- name: test-1
properties:
addressPrefix: 10.0.0.0/16
serviceEndpointPolicies:
- id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1
serviceEndpoints:
- service: Microsoft.Storage
resourceGroupName: vnetTest
subscriptionId: subid
virtualNetworkName: vnet1
responses:
'200':
body:
id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1
location: eastus2euap
name: vnet1
properties:
addressSpace:
addressPrefixes:
- 10.0.0.0/16
provisioningState: Succeeded
subnets:
- id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1
name: test-1
properties:
addressPrefix: 10.0.0.0/16
ipConfigurations: []
provisioningState: Succeeded
resourceNavigationLinks: []
serviceEndpointPolicies:
- id: /subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1
# --- truncated at 32 KB (55 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/azure-networking-services/refs/heads/main/openapi/azure-networking-services-virtualnetworks-api-openapi.yml