Get Azure entity
Retrieves entity information for the given Azure object ID. If related_entity_type parameter is not set, this endpoint will return information about a single entity. Using the counts boolean parameter will further modify the response. If related_entity_type parameter is set, this endpoint will return information about entities related to a single entity. The type parameter will morph the response data structure. The list value for the type parameter also accepts skip and limit parameters.
Query parameters
The object ID of the entity being operated on.
Returns related entity counts. Does not work with related_entity_type parameter.
Flags the query to return related entity information based on the type passed.
The type of return data expected. Only works with related_entity_type parameter.
The number of items to skip in a paginated response.
This query parameter is used for determining the number of objects to skip in pagination. Only compatible with related_entity_type and type=list
The limit of results requested by the client.
This query parameter is used for setting an upper limit of objects returned in paginated responses. Only compatible with related_entity_type and type=list
Response
This endpoint returns a polymorphic response dependent on the query parameters passed. Three different response schemas are possible:
- entity schema is used when related_entity_type is not set. Additional 'count' properties are dependent on the type of entity being queried.
- related-list schema is used when related_entity_type is set and type parameter is either list or not set (it is the default), and it supports pagination.
- related-graph schema is used when related_entity_type is set and type=graph.