CloudBlockBlob.StartCopy 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
StartCopy(CloudBlockBlob, Nullable<StandardBlobTier>, Nullable<RehydratePriority>, AccessCondition, AccessCondition, BlobRequestOptions, OperationContext) |
Begins an operation to start copying another block blob's contents, properties, and metadata to this block blob. |
StartCopy(CloudBlockBlob, Checksum, Boolean, Nullable<StandardBlobTier>, Nullable<RehydratePriority>, AccessCondition, AccessCondition, BlobRequestOptions, OperationContext) |
Begins an operation to start copying another block blob's contents, properties, and metadata to this block blob. |
StartCopy(CloudBlockBlob, Nullable<StandardBlobTier>, Nullable<RehydratePriority>, AccessCondition, AccessCondition, BlobRequestOptions, OperationContext)
Begins an operation to start copying another block blob's contents, properties, and metadata to this block blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string StartCopy (Microsoft.Azure.Storage.Blob.CloudBlockBlob source, Microsoft.Azure.Storage.Blob.StandardBlobTier? standardBlockBlobTier = default, Microsoft.Azure.Storage.Blob.RehydratePriority? rehydratePriority = default, Microsoft.Azure.Storage.AccessCondition sourceAccessCondition = default, Microsoft.Azure.Storage.AccessCondition destAccessCondition = default, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
override this.StartCopy : Microsoft.Azure.Storage.Blob.CloudBlockBlob * Nullable<Microsoft.Azure.Storage.Blob.StandardBlobTier> * Nullable<Microsoft.Azure.Storage.Blob.RehydratePriority> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
Public Overridable Function StartCopy (source As CloudBlockBlob, Optional standardBlockBlobTier As Nullable(Of StandardBlobTier) = Nothing, Optional rehydratePriority As Nullable(Of RehydratePriority) = Nothing, Optional sourceAccessCondition As AccessCondition = Nothing, Optional destAccessCondition As AccessCondition = Nothing, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As String
Parameters
- source
- CloudBlockBlob
A CloudBlockBlob object.
- standardBlockBlobTier
- Nullable<StandardBlobTier>
A StandardBlobTier representing the tier to set.
- rehydratePriority
- Nullable<RehydratePriority>
The priority with which to rehydrate an archived blob.
- sourceAccessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the source blob. If null
, no condition is used.
- destAccessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the destination blob. If null
, no condition is used.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request. If null
, default options are applied to the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
The copy ID associated with the copy operation.
- Attributes
Remarks
This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.
Applies to
StartCopy(CloudBlockBlob, Checksum, Boolean, Nullable<StandardBlobTier>, Nullable<RehydratePriority>, AccessCondition, AccessCondition, BlobRequestOptions, OperationContext)
Begins an operation to start copying another block blob's contents, properties, and metadata to this block blob.
[Microsoft.Azure.Storage.DoesServiceRequest]
public string StartCopy (Microsoft.Azure.Storage.Blob.CloudBlockBlob source, Microsoft.Azure.Storage.Shared.Protocol.Checksum contentChecksum, bool syncCopy, Microsoft.Azure.Storage.Blob.StandardBlobTier? standardBlockBlobTier, Microsoft.Azure.Storage.Blob.RehydratePriority? rehydratePriority, Microsoft.Azure.Storage.AccessCondition sourceAccessCondition = default, Microsoft.Azure.Storage.AccessCondition destAccessCondition = default, Microsoft.Azure.Storage.Blob.BlobRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
override this.StartCopy : Microsoft.Azure.Storage.Blob.CloudBlockBlob * Microsoft.Azure.Storage.Shared.Protocol.Checksum * bool * Nullable<Microsoft.Azure.Storage.Blob.StandardBlobTier> * Nullable<Microsoft.Azure.Storage.Blob.RehydratePriority> * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
Public Function StartCopy (source As CloudBlockBlob, contentChecksum As Checksum, syncCopy As Boolean, standardBlockBlobTier As Nullable(Of StandardBlobTier), rehydratePriority As Nullable(Of RehydratePriority), Optional sourceAccessCondition As AccessCondition = Nothing, Optional destAccessCondition As AccessCondition = Nothing, Optional options As BlobRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As String
Parameters
- source
- CloudBlockBlob
A CloudBlockBlob object.
- contentChecksum
- Checksum
An hash value used to ensure transactional integrity. May be null
or Checksum.None
- syncCopy
- Boolean
A boolean to enable synchronous server copy of blobs.
- standardBlockBlobTier
- Nullable<StandardBlobTier>
A StandardBlobTier representing the tier to set.
- rehydratePriority
- Nullable<RehydratePriority>
The priority with which to rehydrate an archived blob.
- sourceAccessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the source blob. If null
, no condition is used.
- destAccessCondition
- AccessCondition
An AccessCondition object that represents the access conditions for the destination blob. If null
, no condition is used.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request. If null
, default options are applied to the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
The copy ID associated with the copy operation.
- Attributes
Remarks
This method fetches the blob's ETag, last-modified time, and part of the copy state. The copy ID and copy status fields are fetched, and the rest of the copy state is cleared.