StacClient.DeleteCollection Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

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
DeleteCollection(WaitUntil, String, RequestContext)	Delete a collection in the GeoCatalog instance.
DeleteCollection(WaitUntil, String, CancellationToken)	Delete a collection in the GeoCatalog instance.

DeleteCollection(WaitUntil, String, RequestContext)

Source:: StacClient.cs

Delete a collection in the GeoCatalog instance.

public virtual Azure.Operation DeleteCollection(Azure.WaitUntil waitUntil, string collectionId, Azure.RequestContext context);

abstract member DeleteCollection : Azure.WaitUntil * string * Azure.RequestContext -> Azure.Operation
override this.DeleteCollection : Azure.WaitUntil * string * Azure.RequestContext -> Azure.Operation

Public Overridable Function DeleteCollection (waitUntil As WaitUntil, collectionId As String, context As RequestContext) As 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.

context: RequestContext

The request options, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Operation

The response returned from the service.

Exceptions

ArgumentNullException

collectionId is null.

ArgumentException

collectionId is an empty string, and was expected to be non-empty.

Applies to

DeleteCollection(WaitUntil, String, CancellationToken)

Source:: StacClient.cs

Delete a collection in the GeoCatalog instance.

public virtual Azure.Operation DeleteCollection(Azure.WaitUntil waitUntil, string collectionId, System.Threading.CancellationToken cancellationToken = default);

abstract member DeleteCollection : Azure.WaitUntil * string * System.Threading.CancellationToken -> Azure.Operation
override this.DeleteCollection : Azure.WaitUntil * string * System.Threading.CancellationToken -> Azure.Operation

Public Overridable Function DeleteCollection (waitUntil As WaitUntil, collectionId As String, Optional cancellationToken As CancellationToken = Nothing) As Operation