Get Collection of Network Security Groups

You can get a list of all network security groups.

Request

To retrieve a representation of a collection of network security groups, send the HTTP GET request to the /cloudInfrastructure/networkSecurityGroups endpoint.

HTTP Request

GET https://<hostname>/api/v2/cloudInfrastructure/networkSecurityGroups

Query Parameters

To control the amount and order of data in the response, you can use Offset, Limit and the following query parameters:

Query Parameter

Value

Description

RegionId

string

Returns network security groups that reside in the specified region.

SubscriptionId

string

Returns network security groups that belong to the specified subscription.

Request Headers

The request contains the following headers.

Header

Required

Value

Description

Authorization

Required

Bearer <Access-Token>

Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format.

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 HTTP headers.

Header

Value

Description

Content-length

integer

Identifies the length of the response body message, in bytes.

Content-type

  • application/json
  • application/problem+json

Identifies the media type of the response body message.

Response Body

In the response body, Veeam Backup for Microsoft Azure returns a representation of the /cloudInfrastructure/networkSecurityGroups collection.

NetworkSecurityGroupV2

Property

Type

Description

id

string

Azure ID assigned to a network security group.

name

string

Name of the network security group.

regionId

string

Azure ID assigned to the Azure region where the network security group resides.

resourceGroupName

string

Name of the resource group.

subscriptionId

string

Azure ID of the subscription to which the network security group belongs.

Get Collection of Network Security GroupsExample

The following request returns a full list of all available network security groups.

Request:

GET https://51.11.247.127/api/v2/cloudInfrastructure/networkSecurityGroups

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200

 

Response Body:

{

 "offset": 0,

 "limit": 2,

 "totalCount": 168,

 "results": [

   {

     "id": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/mamayrg2/providers/microsoft.network/networksecuritygroups/mamay2-nsg",

     "name": "mamay2-Nsg",

     "regionId": "westus",

     "resourceGroupName": "mamayRG2",

     "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803"

   },

   {

     "id": "/subscriptions/3a9a4930-7bbc-4b83-9c68-15d674fbc803/resourcegroups/mirekvanicky/providers/microsoft.network/networksecuritygroups/mirekvanickycontroller-nsg",

     "name": "MirekVanickyController-nsg",

     "regionId": "westus",

     "resourceGroupName": "MirekVanicky",

     "subscriptionId": "3a9a4930-7bbc-4b83-9c68-15d674fbc803"

   }

 ],

 "_links": {

   "self": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/networkSecurityGroups?offset=0&limit=2"

   },

   "next": {

     "href": "https://51.11.247.127/api/v2/cloudInfrastructure/networkSecurityGroups?offset=2&limit=2"

   }

 }

}

I want to report a typo

There is a misspelling right here:

 

I want to let the Veeam Documentation Team know about that.