This is an archive version of the document. To get the most up-to-date information, see the current version.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/v3/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 |
| 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.
NetworkSecurityGroupv3
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. |
Example
The following request returns a full list of all available network security groups.
|