Skip to content

Data types

A URL that points to a resource.

scalar TypeSpec.Rest.ResourceLocation

Structure for a paging response using value and nextLink to represent pagination.

model TypeSpec.Rest.Resource.CollectionWithNextLink<Resource>
NameDescription
ResourceThe resource type of the collection.
NameTypeDescription
valueArray<Element>
nextLink?TypeSpec.Rest.ResourceLocation

Dynamically gathers keys of the model type Resource.

model TypeSpec.Rest.Resource.KeysOf<Resource>
NameDescription
ResourceThe target resource model.

None

Dynamically gathers parent keys of the model type Resource.

model TypeSpec.Rest.Resource.ParentKeysOf<Resource>
NameDescription
ResourceThe target resource model.

None

Represents collection operation parameters for the resource of type Resource.

model TypeSpec.Rest.Resource.ResourceCollectionParameters<Resource>
NameDescription
ResourceThe resource model.

None

Resource create operation completed successfully.

model TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource>
NameDescription
ResourceThe resource model that was created.
NameTypeDescription
statusCode201The status code.
bodyResource

Resource create operation model.

model TypeSpec.Rest.Resource.ResourceCreateModel<Resource>
NameDescription
ResourceThe resource model to create.

None

Resource create or update operation model.

model TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>
NameDescription
ResourceThe resource model to create or update.

None

Resource deleted successfully.

model TypeSpec.Rest.Resource.ResourceDeletedResponse
NameTypeDescription
_200The status code.

The default error response for resource operations.

model TypeSpec.Rest.Resource.ResourceError
NameTypeDescription
codeint32The error code.
messagestringThe error message.

Represents operation parameters for the resource of type Resource.

model TypeSpec.Rest.Resource.ResourceParameters<Resource>
NameDescription
ResourceThe resource model.

None