NSX-T Data Center REST API

Returns a list of Azure security groups corresponding to a VNet

Returns a list of Azure security groups corresponding to VNet with
information about each security group like inbound rules, outbound rules
and priority.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/azure/security-groups

Request Headers:

n/a

Query Parameters:

AzureResourcesListRequestParameters+

AzureResourcesListRequestParameters (schema)

Name	Description	Type	Notes
account_id	Account ID Optional identifier for account based on which resources are to be filtered.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
is_managed_by_nsx	Is Managed By NSX Filter parameter to obtain security groups which are managed by NSX.	boolean
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
region_id	Region ID Optional identifier for region based on which resources are to be filtered.	string
resource_group_id	Resource Group ID Optional identifier for resource group id based on which resources are to be filtered.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
vnet_id	Virtual Network ID Optional identifier for virtual network based on which resources are to be filtered.	string

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/azure/security-groups

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AzureSecurityGroupsListResult+

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Results Array of Azure security groups.	array of AzureSecurityGroup
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Required Permissions:

read

Feature:

cloud_resources