Veeam Backup for Microsoft Azure 8
REST API Reference
Related documents

Azure Virtual Networks

The /cloudInfrastructure/virtualNetworks resource collection represents Azure virtual networks configured in the Microsoft Azure environment.

Create Virtual Networks

The HTTP POST request to the /cloudInfrastructure/virtualNetworks endpoint creates a new virtual network in the Microsoft Azure environment.

SecurityBearer
Request
Request Body schema: application/json
required
networkAddressSpace
required
string

Specifies an IP address range for the virtual network.

networkName
required
string

Specifies a name for the new virtual network.

region
required
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to an Azure region in which the virtual network will be created.

subnetAddressSpace
required
string

Specifies an IP address range for the subnet.

subnetName
required
string

Specifies a name for a subnet that will be created in the virtual network.

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

415

Client Error

post/api/v8/cloudInfrastructure/virtualNetworks
Request samples
application/json
{
  • "networkName": "string",
  • "region": "string",
  • "networkAddressSpace": "string",
  • "subnetName": "string",
  • "subnetAddressSpace": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startTime": "2019-08-24T14:15:22Z",
  • "status": "Canceled",
  • "error": {
    },
  • "_links": {},
  • "result": {
    }
}

Get Collection of Virtual Networks

The HTTP GET request to the /cloudInfrastructure/virtualNetworks endpoint retrieves a list of all virtual networks created in the Microsoft Azure environment.

SecurityBearer
Request
query Parameters
Offset
integer <int32> >= 0

Specifies the first N items of a resource collection that will be excluded from the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
Limit
integer <int32> >= -1

Specifies the maximum number of items of a resource collection that will be returned in the response.

x-veeam-parameter-group: Veeam.Azure.REST.RequestQuery.V2.PageProperties
RegionId
string or null

Returns virtual networks that reside in an Azure region with the specified ID.

x-veeam-parameter-group: Veeam.Azure.REST.Latest.RequestQuery.VirtualNetworkOptions
SubscriptionId
string or null <uuid>

Returns only virtual networks that belong to an Azure subscription with the specified ID.

x-veeam-parameter-group: Veeam.Azure.REST.Latest.RequestQuery.VirtualNetworkOptions
ServiceAccountId
string

Returns only virtual networks to which a service account with the specified system ID has permissions.

x-veeam-parameter-group: Veeam.Azure.REST.Latest.RequestQuery.VirtualNetworkOptions
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

get/api/v8/cloudInfrastructure/virtualNetworks
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/virtualNetworks?Offset=0&Limit=-1&RegionId=string&SubscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08&ServiceAccountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{}

Get First Free Address RangeDeprecated

The HTTP GET request to the /cloudInfrastructure/virtualNetworks/firstFreeAddressSpace endpoint retrieves free adress range that can be used to create a new virtual network.

SecurityBearer
Request
query Parameters
subnetMask
required
integer <int32>

Specifies a subnet mask.

subscriptionId
string or null <uuid>

Specifies a subscription to retrieve the address range from.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/virtualNetworks/firstFreeAddressSpace
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/virtualNetworks/firstFreeAddressSpace?subnetMask=0&subscriptionId=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Get Virtual Network Data

The HTTP GET request to the /cloudInfrastructure/virtualNetworks/{networkId} endpoint retrieves information on a virtual network with the specified ID.

SecurityBearer
Request
path Parameters
networkId
required
string or null

Specifies the system ID assigned to a virtual network in the Veeam Backup for Microsoft Azure REST API.

query Parameters
accountId
string

Specifies the system ID assigned in the Veeam Backup for Microsoft Azure REST API to a service account whose permissions are used to protect virtual network configurations.

Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

get/api/v8/cloudInfrastructure/virtualNetworks/{networkId}
Request samples 
curl -i -X GET \
  'https://123.123.123.123/api/v8/cloudInfrastructure/virtualNetworks/{networkId}?accountId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "regionName": "string",
  • "addressSpaces": [
    ],
  • "_links": {}
}