Interface ApiResourceLocation

Information about the location of a REST API resource

interface ApiResourceLocation {
    area?: string;
    id?: string;
    maxVersion?: string;
    minVersion?: string;
    releasedVersion?: string;
    resourceName?: string;
    resourceVersion?: number;
    routeTemplate?: string;
}

Properties

area? id? maxVersion? minVersion? releasedVersion? resourceName? resourceVersion? routeTemplate?

Properties

Optionalarea

area?: string

Area name for this resource

Optionalid

id?: string

Unique Identifier for this location

OptionalmaxVersion

maxVersion?: string

Maximum api version that this resource supports (current server version for this resource)

OptionalminVersion

minVersion?: string

Minimum api version that this resource supports

OptionalreleasedVersion

releasedVersion?: string

The latest version of this resource location that is in "Release" (non-preview) mode

OptionalresourceName

resourceName?: string

Resource name

OptionalresourceVersion

resourceVersion?: number

The current resource version supported by this resource location

OptionalrouteTemplate

routeTemplate?: string

This location's route template (templated relative path)

Settings

Member Visibility

On This Page

Properties