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.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.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.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.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.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.get(): Extension | Error
ExtensionResourceInstanceOperations.update
Updates an existing instance of the extension resource.
op TypeSpec.Rest.Resource.ExtensionResourceInstanceOperations.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | Error
ExtensionResourceInstanceOperations.delete
Deletes an existing instance of the extension resource.
op TypeSpec.Rest.Resource.ExtensionResourceInstanceOperations.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.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.get(): Extension | Error
ExtensionResourceOperations.update
Updates an existing instance of the extension resource.
op TypeSpec.Rest.Resource.ExtensionResourceOperations.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | Error
ExtensionResourceOperations.delete
Deletes an existing instance of the extension resource.
op TypeSpec.Rest.Resource.ExtensionResourceOperations.delete(): TypeSpec.Rest.Resource.ResourceDeletedResponse | Error
ExtensionResourceOperations.create
Creates a new instance of the extension resource.
op TypeSpec.Rest.Resource.ExtensionResourceOperations.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.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.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.update(properties: TypeSpec.Rest.Resource.ResourceCreateOrUpdateModel<Resource>): Extension | Error