Getting Virtual Networks

In this article

    You can get a list of available virtual networks to which the Azure archiver appliance will be connected.

    Request

    GET https://<hostname>:4443/v6/AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks

    Request Headers

    The request header must contain an authorization token of the current session.

    Request Parameters

    The following parameters must be specified in the URL of the request:

    Parameter

    Type

    Description

    serviceAccountId

    string

    Specifies the identification number of Microsoft Azure service account. For more information on how to get this parameter, see Getting Azure Service Accounts.

    subscriptionId

    string

    Specifies the Microsoft Azure subscription ID. For more information on how to get this parameter, see Getting Subscriptions.

    resourceGroupName

    string

    Specifies the resource group name. For more information on how to get this parameter, see Getting Resource Groups.

    The following optional parameter can be specified in the URL of the request:

    Parameter

    Type

    Description

    locationName

    string

    Specifies the Microsoft Azure region name. For more information on how to get this parameter, see Getting Locations.

    Request Body

    None.

    Response

    The server returns the following response to the client.

    Response Codes

    A successfully completed operation returns a response code 200 OK.

    Response Headers

    The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

    Header

    Description

    Content-length

    The length of the response body.

    Content-type

    The media type and syntax of the response body message: application/json; charset=utf-8

    Response Body

    In the response body, the server returns a resource representation of the /AzureServiceAccounts/{serviceAccountId}/Subscriptions/{subscriptionId}/ResourceGroups/{resourceGroupName}/VirtualNetworks resource. The response body contains the following properties:

    Property

    Type

    Description

    id

    string

    Specifies the virtual network ID.

    name

    string

    Specifies a name of the virtual network.

    type

    string

    Specifies the virtual network type.

    location

    string

    Specifies the Microsoft Azure region name.

    addressSpaces

    string[]

    Specifies an array of ranges of IPv4 addresses.

    Example

    The example returns a resource representation of available virtual networks within the specified resource group.

    Request:

    GET https://abc.tech.local:4443/v6/AzureServiceAccounts/576705c3-a1af-49bd-878f-9067865bfcf9/Subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/ResourceGroups/ResourceGroup10/VirtualNetworks

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    [

    {

    "id": "/subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/resourceGroups/ResourceGroup10/providers/Microsoft.Network/virtualNetworks/groupvnet775",

    "name": "groupvnet775",

    "type": "Microsoft.Network/virtualNetworks",

    "location": "eastus",

    "addressSpaces": [

    "10.5.0.0/16"

    ]

    },

    {

    "id": "/subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/resourceGroups/ResourceGroup10/providers/Microsoft.Network/virtualNetworks/groupvnet597",

    "name": "groupvnet597",

    "type": "Microsoft.Network/virtualNetworks",

    "location": "westeurope",

    "addressSpaces": [

    "10.4.0.0/16"

    ]

    },

    {

    "id": "/subscriptions/be7051ea-8fa4-4605-c607-89f3dd09fffd/resourceGroups/ResourceGroup10/providers/Microsoft.Network/virtualNetworks/Network-westeurope-33b6f07bc3684d6f99b6eae91f0d5bd1",

    "name": "Network-westeurope-33b6f07bc3684d6f99b6eae91f0d5bd1",

    "type": "Microsoft.Network/virtualNetworks",

    "location": "westeurope",

    "addressSpaces": [

    "10.0.0.0/16"

    ]

    },

    ...

    ]