2.2.3 Common URI Parameters

Every resource that supports CRUD operations uses common JSON elements in any request or response. The following table summarizes the set of common URI parameters defined by this specification.

URI parameter

Section

Description

<url>

2.2.3.5

The URL of the Network Controller.

grandParentResourceId

2.2.3.1

The user-defined resource ID of the network resource that is the ancestor of the resource that is the ancestor of the descendant resource.

operationId

2.2.3.2

The value of the x-ms-request-id header returned by the resource provider.

parentResourceId

2.2.3.3

The user-defined resource ID of the network resource that is the ancestor of the descendant resource. Depending on the type of resource, it can be:

  • User-defined, system-defined, or both

  • Unique across all resources of the same type

  • Unique across all resources of the same type in the context of the specific grandparent resource.

resourceId

2.2.3.4

The resource ID of the network resource to create, retrieve, update or delete. Depending on the type of resource, it can be:

  • User-defined, system-defined, or both

  • Unique across all resources of the same type

  • Unique across all resources of the same type in the context of the specific ancestor resource.

When the resourceId is optional for an ancestor resource, it is required for the descendant resources. 

instanceId

3.1.5.24

The globally unique Id generated and used internally by the Network Controller. The mapping resource that enables the client to map between the instanceId and the resourceId.