NSX-T Data Center REST API

Returns IP allocations for all Azure Vnets. This operation is only supported for containers.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/azure/gateways/ip-mappings

Request Headers:

n/a

Query Parameters:

AzureIpMappingsListRequestParameters+

AzureIpMappingsListRequestParameters (schema)

Name	Description	Type	Notes
cloud_account_id	Cloud Account ID ID of the Cloud Account in which the IPs are allocated.	string
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
display_name	Name of IP Mappings Name of IP Mappings.	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
ip_allocation_type	IP allocation type Based on the type, IP allocation will be done accordingly. Legal values are PAS and NAT.	string	Enum: PAS, NAT Default: "PAS"
mapping_id	Mapping ID ID of the mapping returned in IP allocation request.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string
vnet_id	Vnet ID ID of the Azure Vnet in which the IPs are allocated.	string

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AzureIpMappingsListResult+

AzureIpMappingsListResult (schema)

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	Cloud IP mappings Results Array of Cloud public/link local IP to secondary IP mappings.	array of AzureIpAllocationMappings
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

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable