Blob class
Class representing a Blob.
Constructors
| Blob(Storage |
Create a Blob. |
Methods
| abort |
|
| abort |
The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata. |
| abort |
|
| acquire |
|
| acquire |
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations |
| acquire |
|
| break |
|
| break |
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations |
| break |
|
| change |
|
| change |
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations |
| change |
|
| copy |
|
| copy |
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. |
| copy |
|
| create |
|
| create |
The Create Snapshot operation creates a read-only snapshot of a blob |
| create |
|
| delete |
|
| 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). |
| delete |
|
| download(Blob |
|
| download(Models. |
The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot. |
| download(Service |
|
| get |
|
| get |
Get the owner, group, permissions, or access control list for a blob. |
| get |
|
| get |
Returns the sku name and account kind |
| get |
|
| get |
|
| get |
|
| get |
The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob. |
| get |
|
| release |
|
| release |
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations |
| release |
|
| rename(string, Blob |
|
| rename(string, Models. |
Rename a blob/file. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations. To fail if the destination already exists, use a conditional request with If-None-Match: "*". |
| rename(string, Service |
|
| renew |
|
| renew |
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations |
| renew |
|
| set |
|
| set |
Set the owner, group, permissions, or access control list for a blob. |
| set |
|
| set |
|
| set |
The Set HTTP Headers operation sets system properties on the blob |
| set |
|
| set |
|
| set |
The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs |
| set |
|
| set |
|
| set |
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. |
| set |
|
| start |
|
| start |
The Start Copy From URL operation copies a blob or an internet resource to a new blob. |
| start |
|
| undelete(Blob |
|
| undelete(Models. |
Undelete a blob that was previously soft deleted |
| undelete(Service |
Constructor Details
Blob(StorageClientContext)
Create a Blob.
new Blob(client: StorageClientContext)Parameters
- client
- StorageClientContext
Reference to the service client.
Method Details
abortCopyFromURL(string, BlobAbortCopyFromURLOptionalParams, ServiceCallback<void>)
function abortCopyFromURL(copyId: string, options: BlobAbortCopyFromURLOptionalParams, callback: ServiceCallback<void>)Parameters
- copyId
-
string
The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
abortCopyFromURL(string, Models.BlobAbortCopyFromURLOptionalParams)
The Abort Copy From URL operation aborts a pending Copy From URL operation, and leaves a destination blob with zero length and full metadata.
function abortCopyFromURL(copyId: string, options?: Models.BlobAbortCopyFromURLOptionalParams)Parameters
- copyId
-
string
The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation.
- options
- Models.BlobAbortCopyFromURLOptionalParams
Returns
Promise<Models.BlobAbortCopyFromURLResponse>
Promise<Models.BlobAbortCopyFromURLResponse>
abortCopyFromURL(string, ServiceCallback<void>)
function abortCopyFromURL(copyId: string, callback: ServiceCallback<void>)Parameters
- copyId
-
string
The copy identifier provided in the x-ms-copy-id header of the original Copy Blob operation.
- callback
-
ServiceCallback<void>
The callback
acquireLease(BlobAcquireLeaseOptionalParams, ServiceCallback<void>)
function acquireLease(options: BlobAcquireLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobAcquireLeaseOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
acquireLease(Models.BlobAcquireLeaseOptionalParams)
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
function acquireLease(options?: Models.BlobAcquireLeaseOptionalParams)Parameters
- options
- Models.BlobAcquireLeaseOptionalParams
Returns
Promise<Models.BlobAcquireLeaseResponse>
Promise<Models.BlobAcquireLeaseResponse>
acquireLease(ServiceCallback<void>)
function acquireLease(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
breakLease(BlobBreakLeaseOptionalParams, ServiceCallback<void>)
function breakLease(options: BlobBreakLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobBreakLeaseOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
breakLease(Models.BlobBreakLeaseOptionalParams)
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
function breakLease(options?: Models.BlobBreakLeaseOptionalParams)Parameters
- options
- Models.BlobBreakLeaseOptionalParams
Returns
Promise<Models.BlobBreakLeaseResponse>
Promise<Models.BlobBreakLeaseResponse>
breakLease(ServiceCallback<void>)
function breakLease(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
changeLease(string, string, BlobChangeLeaseOptionalParams, ServiceCallback<void>)
function changeLease(leaseId: string, proposedLeaseId: string, options: BlobChangeLeaseOptionalParams, callback: ServiceCallback<void>)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.
- options
- BlobChangeLeaseOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
changeLease(string, string, Models.BlobChangeLeaseOptionalParams)
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
function changeLease(leaseId: string, proposedLeaseId: string, options?: Models.BlobChangeLeaseOptionalParams)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.
- options
- Models.BlobChangeLeaseOptionalParams
Returns
Promise<Models.BlobChangeLeaseResponse>
Promise<Models.BlobChangeLeaseResponse>
changeLease(string, string, ServiceCallback<void>)
function changeLease(leaseId: string, proposedLeaseId: string, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
copyFromURL(string, BlobCopyFromURLOptionalParams, ServiceCallback<void>)
function copyFromURL(copySource: string, options: BlobCopyFromURLOptionalParams, callback: ServiceCallback<void>)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.
- options
- BlobCopyFromURLOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
copyFromURL(string, Models.BlobCopyFromURLOptionalParams)
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.
function copyFromURL(copySource: string, options?: Models.BlobCopyFromURLOptionalParams)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.
- options
- Models.BlobCopyFromURLOptionalParams
Returns
Promise<Models.BlobCopyFromURLResponse>
Promise<Models.BlobCopyFromURLResponse>
copyFromURL(string, ServiceCallback<void>)
function copyFromURL(copySource: string, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
createSnapshot(BlobCreateSnapshotOptionalParams, ServiceCallback<void>)
function createSnapshot(options: BlobCreateSnapshotOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobCreateSnapshotOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
createSnapshot(Models.BlobCreateSnapshotOptionalParams)
The Create Snapshot operation creates a read-only snapshot of a blob
function createSnapshot(options?: Models.BlobCreateSnapshotOptionalParams)Parameters
- options
- Models.BlobCreateSnapshotOptionalParams
Returns
Promise<Models.BlobCreateSnapshotResponse>
Promise<Models.BlobCreateSnapshotResponse>
createSnapshot(ServiceCallback<void>)
function createSnapshot(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(BlobDeleteMethodOptionalParams, ServiceCallback<void>)
function deleteMethod(options: BlobDeleteMethodOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobDeleteMethodOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
deleteMethod(Models.BlobDeleteMethodOptionalParams)
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).
function deleteMethod(options?: Models.BlobDeleteMethodOptionalParams)Parameters
- options
- Models.BlobDeleteMethodOptionalParams
Returns
Promise<Models.BlobDeleteResponse>
Promise<Models.BlobDeleteResponse>
deleteMethod(ServiceCallback<void>)
function deleteMethod(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
download(BlobDownloadOptionalParams, ServiceCallback<void>)
function download(options: BlobDownloadOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobDownloadOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
download(Models.BlobDownloadOptionalParams)
The Download operation reads or downloads a blob from the system, including its metadata and properties. You can also call Download to read a snapshot.
function download(options?: Models.BlobDownloadOptionalParams)Parameters
- options
- Models.BlobDownloadOptionalParams
Returns
Promise<Models.BlobDownloadResponse>
Promise<Models.BlobDownloadResponse>
download(ServiceCallback<void>)
function download(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
getAccessControl(BlobGetAccessControlOptionalParams, ServiceCallback<void>)
function getAccessControl(options: BlobGetAccessControlOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getAccessControl(Models.BlobGetAccessControlOptionalParams)
Get the owner, group, permissions, or access control list for a blob.
function getAccessControl(options?: Models.BlobGetAccessControlOptionalParams)Parameters
- options
- Models.BlobGetAccessControlOptionalParams
Returns
Promise<Models.BlobGetAccessControlResponse>
Promise<Models.BlobGetAccessControlResponse>
getAccessControl(ServiceCallback<void>)
function getAccessControl(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
getAccountInfo(msRest.RequestOptionsBase)
Returns the sku name and account kind
function getAccountInfo(options?: msRest.RequestOptionsBase)Parameters
- options
- msRest.RequestOptionsBase
Returns
Promise<Models.BlobGetAccountInfoResponse>
Promise<Models.BlobGetAccountInfoResponse>
getAccountInfo(RequestOptionsBase, ServiceCallback<void>)
function getAccountInfo(options: RequestOptionsBase, callback: ServiceCallback<void>)Parameters
- options
-
RequestOptionsBase
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getAccountInfo(ServiceCallback<void>)
function getAccountInfo(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
getProperties(BlobGetPropertiesOptionalParams, ServiceCallback<void>)
function getProperties(options: BlobGetPropertiesOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobGetPropertiesOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
getProperties(Models.BlobGetPropertiesOptionalParams)
The Get Properties operation returns all user-defined metadata, standard HTTP properties, and system properties for the blob. It does not return the content of the blob.
function getProperties(options?: Models.BlobGetPropertiesOptionalParams)Parameters
- options
- Models.BlobGetPropertiesOptionalParams
Returns
Promise<Models.BlobGetPropertiesResponse>
Promise<Models.BlobGetPropertiesResponse>
getProperties(ServiceCallback<void>)
function getProperties(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
releaseLease(string, BlobReleaseLeaseOptionalParams, ServiceCallback<void>)
function releaseLease(leaseId: string, options: BlobReleaseLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- options
- BlobReleaseLeaseOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
releaseLease(string, Models.BlobReleaseLeaseOptionalParams)
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
function releaseLease(leaseId: string, options?: Models.BlobReleaseLeaseOptionalParams)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- options
- Models.BlobReleaseLeaseOptionalParams
Returns
Promise<Models.BlobReleaseLeaseResponse>
Promise<Models.BlobReleaseLeaseResponse>
releaseLease(string, ServiceCallback<void>)
function releaseLease(leaseId: string, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- callback
-
ServiceCallback<void>
The callback
rename(string, BlobRenameOptionalParams, ServiceCallback<void>)
function rename(renameSource: string, options: BlobRenameOptionalParams, callback: ServiceCallback<void>)Parameters
- renameSource
-
string
The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.
- options
- BlobRenameOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
rename(string, Models.BlobRenameOptionalParams)
Rename a blob/file. By default, the destination is overwritten and if the destination already exists and has a lease the lease is broken. This operation supports conditional HTTP requests. For more information, see Specifying Conditional Headers for Blob Service Operations. To fail if the destination already exists, use a conditional request with If-None-Match: "*".
function rename(renameSource: string, options?: Models.BlobRenameOptionalParams)Parameters
- renameSource
-
string
The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.
- options
- Models.BlobRenameOptionalParams
Returns
Promise<Models.BlobRenameResponse>
Promise<Models.BlobRenameResponse>
rename(string, ServiceCallback<void>)
function rename(renameSource: string, callback: ServiceCallback<void>)Parameters
- renameSource
-
string
The file or directory to be renamed. The value must have the following format: "/{filesysystem}/{path}". If "x-ms-properties" is specified, the properties will overwrite the existing properties; otherwise, the existing properties will be preserved.
- callback
-
ServiceCallback<void>
The callback
renewLease(string, BlobRenewLeaseOptionalParams, ServiceCallback<void>)
function renewLease(leaseId: string, options: BlobRenewLeaseOptionalParams, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- options
- BlobRenewLeaseOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
renewLease(string, Models.BlobRenewLeaseOptionalParams)
[Update] The Lease Blob operation establishes and manages a lock on a blob for write and delete operations
function renewLease(leaseId: string, options?: Models.BlobRenewLeaseOptionalParams)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- options
- Models.BlobRenewLeaseOptionalParams
Returns
Promise<Models.BlobRenewLeaseResponse>
Promise<Models.BlobRenewLeaseResponse>
renewLease(string, ServiceCallback<void>)
function renewLease(leaseId: string, callback: ServiceCallback<void>)Parameters
- leaseId
-
string
Specifies the current lease ID on the resource.
- callback
-
ServiceCallback<void>
The callback
setAccessControl(BlobSetAccessControlOptionalParams, ServiceCallback<void>)
function setAccessControl(options: BlobSetAccessControlOptionalParams, callback: ServiceCallback<void>)Parameters
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setAccessControl(Models.BlobSetAccessControlOptionalParams)
Set the owner, group, permissions, or access control list for a blob.
function setAccessControl(options?: Models.BlobSetAccessControlOptionalParams)Parameters
- options
- Models.BlobSetAccessControlOptionalParams
Returns
Promise<Models.BlobSetAccessControlResponse>
Promise<Models.BlobSetAccessControlResponse>
setAccessControl(ServiceCallback<void>)
function setAccessControl(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
setHTTPHeaders(BlobSetHTTPHeadersOptionalParams, ServiceCallback<void>)
function setHTTPHeaders(options: BlobSetHTTPHeadersOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobSetHTTPHeadersOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setHTTPHeaders(Models.BlobSetHTTPHeadersOptionalParams)
The Set HTTP Headers operation sets system properties on the blob
function setHTTPHeaders(options?: Models.BlobSetHTTPHeadersOptionalParams)Parameters
- options
- Models.BlobSetHTTPHeadersOptionalParams
Returns
Promise<Models.BlobSetHTTPHeadersResponse>
Promise<Models.BlobSetHTTPHeadersResponse>
setHTTPHeaders(ServiceCallback<void>)
function setHTTPHeaders(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
setMetadata(BlobSetMetadataOptionalParams, ServiceCallback<void>)
function setMetadata(options: BlobSetMetadataOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobSetMetadataOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setMetadata(Models.BlobSetMetadataOptionalParams)
The Set Blob Metadata operation sets user-defined metadata for the specified blob as one or more name-value pairs
function setMetadata(options?: Models.BlobSetMetadataOptionalParams)Parameters
- options
- Models.BlobSetMetadataOptionalParams
Returns
Promise<Models.BlobSetMetadataResponse>
Promise<Models.BlobSetMetadataResponse>
setMetadata(ServiceCallback<void>)
function setMetadata(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
setTier(Models.AccessTier, BlobSetTierOptionalParams, ServiceCallback<void>)
function setTier(tier: Models.AccessTier, options: BlobSetTierOptionalParams, callback: ServiceCallback<void>)Parameters
- tier
- Models.AccessTier
Indicates the tier to be set on the blob. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'
- options
- BlobSetTierOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
setTier(Models.AccessTier, Models.BlobSetTierOptionalParams)
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.
function setTier(tier: Models.AccessTier, options?: Models.BlobSetTierOptionalParams)Parameters
- tier
- Models.AccessTier
Indicates the tier to be set on the blob. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'
- options
- Models.BlobSetTierOptionalParams
Returns
Promise<Models.BlobSetTierResponse>
Promise<Models.BlobSetTierResponse>
setTier(Models.AccessTier, ServiceCallback<void>)
function setTier(tier: Models.AccessTier, callback: ServiceCallback<void>)Parameters
- tier
- Models.AccessTier
Indicates the tier to be set on the blob. Possible values include: 'P4', 'P6', 'P10', 'P15', 'P20', 'P30', 'P40', 'P50', 'P60', 'P70', 'P80', 'Hot', 'Cool', 'Archive'
- callback
-
ServiceCallback<void>
The callback
startCopyFromURL(string, BlobStartCopyFromURLOptionalParams, ServiceCallback<void>)
function startCopyFromURL(copySource: string, options: BlobStartCopyFromURLOptionalParams, callback: ServiceCallback<void>)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.
The optional parameters
- callback
-
ServiceCallback<void>
The callback
startCopyFromURL(string, Models.BlobStartCopyFromURLOptionalParams)
The Start Copy From URL operation copies a blob or an internet resource to a new blob.
function startCopyFromURL(copySource: string, options?: Models.BlobStartCopyFromURLOptionalParams)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.
- options
- Models.BlobStartCopyFromURLOptionalParams
Returns
Promise<Models.BlobStartCopyFromURLResponse>
Promise<Models.BlobStartCopyFromURLResponse>
startCopyFromURL(string, ServiceCallback<void>)
function startCopyFromURL(copySource: string, callback: ServiceCallback<void>)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.
- callback
-
ServiceCallback<void>
The callback
undelete(BlobUndeleteOptionalParams, ServiceCallback<void>)
function undelete(options: BlobUndeleteOptionalParams, callback: ServiceCallback<void>)Parameters
- options
- BlobUndeleteOptionalParams
The optional parameters
- callback
-
ServiceCallback<void>
The callback
undelete(Models.BlobUndeleteOptionalParams)
Undelete a blob that was previously soft deleted
function undelete(options?: Models.BlobUndeleteOptionalParams)Parameters
- options
- Models.BlobUndeleteOptionalParams
Returns
Promise<Models.BlobUndeleteResponse>
Promise<Models.BlobUndeleteResponse>
undelete(ServiceCallback<void>)
function undelete(callback: ServiceCallback<void>)Parameters
- callback
-
ServiceCallback<void>
The callback
