SharedAccessSignatureOperations interface

Package:

@azure/planetarycomputer

Interface representing a SharedAccessSignature operations.

Properties

getToken	Generate a SAS Token for the given storage account and container. The storage account and container must be associated with a Planetary Computer dataset indexed by the STAC API.
getUrl	Signs a HREF (a link URL) by appending a SAS Token. If the HREF is not a Azure Blob Storage HREF, then pass back the HREF unsigned.
revokeToken	Revoke a SAS Token for managed storage account of this GeoCatalog.

Property Details

getToken

Generate a SAS Token for the given storage account and container. The storage account and container must be associated with a Planetary Computer dataset indexed by the STAC API.

getToken: (collectionId: string, options?: SharedAccessSignatureGetTokenOptionalParams) => Promise<SharedAccessSignatureToken>

Property Value

(collectionId: string, options?: SharedAccessSignatureGetTokenOptionalParams) => Promise<SharedAccessSignatureToken>

getUrl

Signs a HREF (a link URL) by appending a SAS Token. If the HREF is not a Azure Blob Storage HREF, then pass back the HREF unsigned.

getUrl: (href: string, options?: SharedAccessSignatureGetUrlOptionalParams) => Promise<SharedAccessSignatureSignedLink>

Property Value

(href: string, options?: SharedAccessSignatureGetUrlOptionalParams) => Promise<SharedAccessSignatureSignedLink>

revokeToken

Revoke a SAS Token for managed storage account of this GeoCatalog.

revokeToken: (options?: SharedAccessSignatureRevokeTokenOptionalParams) => Promise<void>

Property Value

(options?: SharedAccessSignatureRevokeTokenOptionalParams) => Promise<void>