StacClient.DeleteItemAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| DeleteItemAsync(WaitUntil, String, String, CancellationToken) |
Delete a STAC item from a collection. |
| DeleteItemAsync(WaitUntil, String, String, RequestContext) |
Delete a STAC item from a collection. |
DeleteItemAsync(WaitUntil, String, String, CancellationToken)
- Source:
- StacClient.cs
Delete a STAC item from a collection.
public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteItemAsync(Azure.WaitUntil waitUntil, string collectionId, string itemId, System.Threading.CancellationToken cancellationToken = default);abstract member DeleteItemAsync : Azure.WaitUntil * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteItemAsync : Azure.WaitUntil * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Operation>Public Overridable Function DeleteItemAsync (waitUntil As WaitUntil, collectionId As String, itemId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Operation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- collectionId
- String
Catalog collection id.
- itemId
- String
STAC Item id.
- cancellationToken
- CancellationToken
The cancellation token that can be used to cancel the operation.
Returns
Exceptions
collectionId or itemId is null.
collectionId or itemId is an empty string, and was expected to be non-empty.
Applies to
DeleteItemAsync(WaitUntil, String, String, RequestContext)
- Source:
- StacClient.cs
Delete a STAC item from a collection.
public virtual System.Threading.Tasks.Task<Azure.Operation> DeleteItemAsync(Azure.WaitUntil waitUntil, string collectionId, string itemId, Azure.RequestContext context);abstract member DeleteItemAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>
override this.DeleteItemAsync : Azure.WaitUntil * string * string * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Operation>Public Overridable Function DeleteItemAsync (waitUntil As WaitUntil, collectionId As String, itemId As String, context As RequestContext) As Task(Of Operation)Parameters
- waitUntil
- WaitUntil
Completed if the method should wait to return until the long-running operation has completed on the service; Started if it should return after starting the operation. For more information on long-running operations, please see Azure.Core Long-Running Operation samples.
- collectionId
- String
Catalog collection id.
- itemId
- String
STAC Item id.
- context
- RequestContext
The request options, which can override default behaviors of the client pipeline on a per-call basis.
Returns
The response returned from the service.
Exceptions
collectionId or itemId is null.
collectionId or itemId is an empty string, and was expected to be non-empty.
