Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Blob

Package version

Class representing a Blob.

Hierarchy

  • Blob

Index

Constructors

constructor

Methods

abortCopyFromURL

acquireLease

breakLease

changeLease

  • [Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations

    Parameters

    • leaseId: string

      Specifies the current lease ID on the resource.

    • proposedLeaseId: string

      Proposed lease ID, in a GUID string format. The Blob service returns 400 (Invalid request) if the proposed lease ID is not in the correct format. See Guid Constructor (String) for a list of valid GUID string formats.

    • Optional options: BlobChangeLeaseOptionalParams

      The options parameters.

    Returns Promise<BlobChangeLeaseResponse>

copyFromURL

  • The Copy From URL operation copies a blob or an internet resource to a new blob. It will not return a response until the copy is complete.

    Parameters

    • copySource: string

      Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature.

    • Optional options: BlobCopyFromURLOptionalParams

      The options parameters.

    Returns Promise<BlobCopyFromURLResponse>

createSnapshot

delete

  • If the storage account's soft delete feature is disabled then, when a blob is deleted, it is permanently removed from the storage account. If the storage account's soft delete feature is enabled, then, when a blob is deleted, it is marked for deletion and becomes inaccessible immediately. However, the blob service retains the blob or snapshot for the number of days specified by the DeleteRetentionPolicy section of [Storage service properties] (Set-Blob-Service-Properties.md). After the specified number of days has passed, the blob's data is permanently removed from the storage account. Note that you continue to be charged for the soft-deleted blob's storage until it is permanently removed. Use the List Blobs API and specify the "include=deleted" query parameter to discover which blobs and snapshots have been soft deleted. You can then use the Undelete Blob API to restore a soft-deleted blob. All other operations on a soft-deleted blob or snapshot causes the service to return an HTTP status code of 404 (ResourceNotFound).

    Parameters

    Returns Promise<BlobDeleteResponse>

deleteImmutabilityPolicy

download

getAccountInfo

getProperties

getTags

query

releaseLease

renewLease

setExpiry

setHttpHeaders

setImmutabilityPolicy

setLegalHold

setMetadata

setTags

setTier

  • The Set Tier operation sets the tier on a blob. The operation is allowed on a page blob in a premium storage account and on a block blob in a blob storage account (locally redundant storage only). A premium page blob's tier determines the allowed size, IOPS, and bandwidth of the blob. A block blob's tier determines Hot/Cool/Archive storage type. This operation does not update the blob's ETag.

    Parameters

    Returns Promise<BlobSetTierResponse>

startCopyFromURL

  • The Start Copy From URL operation copies a blob or an internet resource to a new blob.

    Parameters

    • copySource: string

      Specifies the name of the source page blob snapshot. This value is a URL of up to 2 KB in length that specifies a page blob snapshot. The value should be URL-encoded as it would appear in a request URI. The source blob must either be public or must be authenticated via a shared access signature.

    • Optional options: BlobStartCopyFromURLOptionalParams

      The options parameters.

    Returns Promise<BlobStartCopyFromURLResponse>

undelete

Generated using TypeDoc