NSGGroup

A logical group of NSG and NSG-BR instances that can be used to assign NSG-UBRs to all NSGs in the group, to provide connectivity to NSGs in disjoint underlays.

Overview

description string filterable   orderable  
embeddedMetadata list read only   autogenerated  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string filterable   orderable  
nsgGroupId integer read only   autogenerated   filterable   orderable   locally unique  

API Resource

/nsggroups/id
delete get put

Parents

/enterprises/id/nsggroups
get post
/nsggroups
get post

Children

/nsggroups/id/metadatas
get post
/nsggroups/id/globalmetadatas
get post put
/nsggroups/id/ducgroupbindings
get post

Members

/nsggroups/id/nsgateways
get put

Attributes documentation

description string filterable   orderable  
Discussion

Description of the NSG Group


Charateristics

Format: free
Max length: 255
SDK attribute: description

embeddedMetadata list read only   autogenerated  
Discussion

Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.


Charateristics

SDK attribute: embeddedMetadata

entityScope enum autogenerated  
Discussion

Specify if scope of entity is Data center or Enterprise level


Charateristics

Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems


Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.


Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string filterable   orderable  
Discussion

Name of the NSG Group


Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

nsgGroupId integer read only   autogenerated   filterable   orderable   locally unique  
Discussion

The NSG Group 12 bit identifier.


Charateristics

SDK attribute: nsgGroupId