Interfaces and Operations

TypeSpec.Rest.Resource

ExtensionResourceCollectionOperations

Extension resource operation templates for extension resource collections.

interface TypeSpec.Rest.Resource.ExtensionResourceCollectionOperations<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceCollectionOperations.create

Creates a new instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceCollectionOperations<Extension, Resource, Error>.create(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Extension | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ExtensionResourceCollectionOperations.list

Lists all instances of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceCollectionOperations<Extension, Resource, Error>.list(): TypeSpec.Rest.Resource.CollectionWithNextLink<Resource> | Error

ExtensionResourceCreate

Extension resource create operation template.

interface TypeSpec.Rest.Resource.ExtensionResourceCreate<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceCreate.create

Creates a new instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceCreate<Extension, Resource, Error>.create(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Extension | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ExtensionResourceCreateOrUpdate

Extension resource create or update operation template.

interface TypeSpec.Rest.Resource.ExtensionResourceCreateOrUpdate<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceCreateOrUpdate.createOrUpdate

Creates or update an instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceCreateOrUpdate<Extension, Resource, Error>.createOrUpdate(resource: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ExtensionResourceDelete

Extension resource delete operation template.

interface TypeSpec.Rest.Resource.ExtensionResourceDelete<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceDelete.delete

Deletes an existing instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceDelete<Extension, Resource, Error>.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error

ExtensionResourceInstanceOperations

Extension resource operation templates for extension resource instances.

interface TypeSpec.Rest.Resource.ExtensionResourceInstanceOperations<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceInstanceOperations.get

Gets an instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceInstanceOperations<Extension, Resource, Error>.get(): Extension | Error

ExtensionResourceInstanceOperations.update

Updates an existing instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceInstanceOperations<Extension, Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | Error

ExtensionResourceInstanceOperations.delete

Deletes an existing instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceInstanceOperations<Extension, Resource, Error>.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error

ExtensionResourceList

Extension resource list operation template.

interface TypeSpec.Rest.Resource.ExtensionResourceList<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceList.list

Lists all instances of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceList<Extension, Resource, Error>.list(): TypeSpec.Rest.Resource.CollectionWithNextLink<Resource> | Error

ExtensionResourceOperations

Extension resource operation templates for extension resource instances and collections.

interface TypeSpec.Rest.Resource.ExtensionResourceOperations<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceOperations.get

Gets an instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceOperations<Extension, Resource, Error>.get(): Extension | Error

ExtensionResourceOperations.update

Updates an existing instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceOperations<Extension, Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | Error

ExtensionResourceOperations.delete

Deletes an existing instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceOperations<Extension, Resource, Error>.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error

ExtensionResourceOperations.create

Creates a new instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceOperations<Extension, Resource, Error>.create(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Extension | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ExtensionResourceOperations.list

Lists all instances of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceOperations<Extension, Resource, Error>.list(): TypeSpec.Rest.Resource.CollectionWithNextLink<Resource> | Error

ExtensionResourceRead

Extension resource read operation template.

interface TypeSpec.Rest.Resource.ExtensionResourceRead<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceRead.get

Gets an instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceRead<Extension, Resource, Error>.get(): Extension | Error

ExtensionResourceUpdate

Extension resource update operation template.

interface TypeSpec.Rest.Resource.ExtensionResourceUpdate<Extension, Resource, Error>

Template Parameters

Name	Description
Extension	The extension resource model.
Resource	The resource model.
Error	The error response.

ExtensionResourceUpdate.update

Updates an existing instance of the extension resource.

op TypeSpec.Rest.Resource.ExtensionResourceUpdate<Extension, Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | Error

ResourceCollectionOperations

Resource operation templates for resource collections.

interface TypeSpec.Rest.Resource.ResourceCollectionOperations<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model.
Error	The error response.

ResourceCollectionOperations.create

Creates a new instance of the resource.

op TypeSpec.Rest.Resource.ResourceCollectionOperations<Resource, Error>.create(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Resource | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ResourceCollectionOperations.list

Lists all instances of the resource.

op TypeSpec.Rest.Resource.ResourceCollectionOperations<Resource, Error>.list(): TypeSpec.Rest.Resource.CollectionWithNextLink<Resource> | Error

ResourceCreate

Resource create operation template.

interface TypeSpec.Rest.Resource.ResourceCreate<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model to create.
Error	The error response.

ResourceCreate.create

Creates a new instance of the resource.

op TypeSpec.Rest.Resource.ResourceCreate<Resource, Error>.create(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Resource | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ResourceCreateOrReplace

Resource create or replace operation template.

interface TypeSpec.Rest.Resource.ResourceCreateOrReplace<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model to create or replace.
Error	The error response.

ResourceCreateOrReplace.createOrReplace

Creates or replaces a instance of the resource.

op TypeSpec.Rest.Resource.ResourceCreateOrReplace<Resource, Error>.createOrReplace(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Resource | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ResourceCreateOrUpdate

Resource create or update operation template.

interface TypeSpec.Rest.Resource.ResourceCreateOrUpdate<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model to create or update.
Error	The error response.

ResourceCreateOrUpdate.createOrUpdate

Creates or update an instance of the resource.

op TypeSpec.Rest.Resource.ResourceCreateOrUpdate<Resource, Error>.createOrUpdate(resource: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Resource | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ResourceDelete

Resource delete operation template.

interface TypeSpec.Rest.Resource.ResourceDelete<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model to delete.
Error	The error response.

ResourceDelete.delete

Deletes an existing instance of the resource.

op TypeSpec.Rest.Resource.ResourceDelete<Resource, Error>.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error

ResourceInstanceOperations

Resource operation templates for resource instances.

interface TypeSpec.Rest.Resource.ResourceInstanceOperations<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model.
Error	The error response.

ResourceInstanceOperations.get

Gets an instance of the resource.

op TypeSpec.Rest.Resource.ResourceInstanceOperations<Resource, Error>.get(): Resource | Error

ResourceInstanceOperations.update

Updates an existing instance of the resource.

op TypeSpec.Rest.Resource.ResourceInstanceOperations<Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Resource | Error

ResourceInstanceOperations.delete

Deletes an existing instance of the resource.

op TypeSpec.Rest.Resource.ResourceInstanceOperations<Resource, Error>.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error

ResourceList

Resource list operation template.

interface TypeSpec.Rest.Resource.ResourceList<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model to list.
Error	The error response.

ResourceList.list

Lists all instances of the resource.

op TypeSpec.Rest.Resource.ResourceList<Resource, Error>.list(): TypeSpec.Rest.Resource.CollectionWithNextLink<Resource> | Error

ResourceOperations

Resource operation templates for resources.

interface TypeSpec.Rest.Resource.ResourceOperations<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model.
Error	The error response.

ResourceOperations.get

Gets an instance of the resource.

op TypeSpec.Rest.Resource.ResourceOperations<Resource, Error>.get(): Resource | Error

ResourceOperations.update

Updates an existing instance of the resource.

op TypeSpec.Rest.Resource.ResourceOperations<Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Resource | Error

ResourceOperations.delete

Deletes an existing instance of the resource.

op TypeSpec.Rest.Resource.ResourceOperations<Resource, Error>.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error

ResourceOperations.create

Creates a new instance of the resource.

op TypeSpec.Rest.Resource.ResourceOperations<Resource, Error>.create(resource: TypeSpec.Rest.Resource.ResourceCreateModel<Resource>): Resource | TypeSpec.Rest.Resource.ResourceCreatedResponse<Resource> | Error

ResourceOperations.list

Lists all instances of the resource.

op TypeSpec.Rest.Resource.ResourceOperations<Resource, Error>.list(): TypeSpec.Rest.Resource.CollectionWithNextLink<Resource> | Error

ResourceRead

Represents the resource GET operation.

interface TypeSpec.Rest.Resource.ResourceRead<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model.
Error	The error response.

ResourceRead.get

Gets an instance of the resource.

op TypeSpec.Rest.Resource.ResourceRead<Resource, Error>.get(): Resource | Error

ResourceUpdate

Resource update operation template.

interface TypeSpec.Rest.Resource.ResourceUpdate<Resource, Error>

Template Parameters

Name	Description
Resource	The resource model to update.
Error	The error response.

ResourceUpdate.update

Updates an existing instance of the resource.

op TypeSpec.Rest.Resource.ResourceUpdate<Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Resource | Error

SingletonResourceOperations

Singleton resource operation templates for singleton resource instances.

interface TypeSpec.Rest.Resource.SingletonResourceOperations<Singleton, Resource, Error>

Template Parameters

Name	Description
Singleton	The singleton resource model.
Resource	The resource model.
Error	The error response.

SingletonResourceOperations.get

Gets the singleton resource.

op TypeSpec.Rest.Resource.SingletonResourceOperations<Singleton, Resource, Error>.get(): Singleton | Error

SingletonResourceOperations.update

Updates the singleton resource.

op TypeSpec.Rest.Resource.SingletonResourceOperations<Singleton, Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Singleton | Error

SingletonResourceRead

Singleton resource read operation template.

interface TypeSpec.Rest.Resource.SingletonResourceRead<Singleton, Resource, Error>

Template Parameters

Name	Description
Singleton	The singleton resource model.
Resource	The resource model.
Error	The error response.

SingletonResourceRead.get

Gets the singleton resource.

op TypeSpec.Rest.Resource.SingletonResourceRead<Singleton, Resource, Error>.get(): Singleton | Error

SingletonResourceUpdate

Singleton resource update operation template.

interface TypeSpec.Rest.Resource.SingletonResourceUpdate<Singleton, Resource, Error>

Template Parameters

Name	Description
Singleton	The singleton resource model.
Resource	The resource model.
Error	The error response.

SingletonResourceUpdate.update

Updates the singleton resource.

op TypeSpec.Rest.Resource.SingletonResourceUpdate<Singleton, Resource, Error>.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Singleton | Error