Share via


ShareFileStorageResourceOptions Class

Definition

Optional parameters for all File Share Storage resource types.

public class ShareFileStorageResourceOptions
type ShareFileStorageResourceOptions = class
Public Class ShareFileStorageResourceOptions
Inheritance
ShareFileStorageResourceOptions

Constructors

ShareFileStorageResourceOptions()

Constructor for ShareFileStorageResourceOptions.

Properties

CacheControl

Optional. Sets the Cache Control header which specifies directives for caching mechanisms.

By default preserves the Cache Control from the source. If explicitly set to null, the Cache Control will not be preserved and set to null.

Applies to upload and copy transfers.

ContentDisposition

Optional. Sets the Content Disposition header which conveys additional information about how to process the response payload, and also can be used to attach additional metadata. For example, if set to attachment, it indicates that the user-agent should not display the response, but instead show a Save As dialog with a filename other than the blob name specified.

By default preserves the Content Disposition from the source. If explicitly set to null, the Content Disposition will not be preserved and set to null.

Applies to upload and copy transfers.

ContentEncoding

Optional. Sets the Content Encoding header which specifies which content encodings have been applied to the blob. This value is returned to the client when the Get Blob operation is performed on the blob resource. The client can use this value when returned to decode the blob content.

By default preserves the Content Encoding from the source. If explicitly set to null, the Content Encoding will not be preserved and set to null.

Applies to upload and copy transfers.

ContentLanguage

Optional. Sets the Content Language header which specifies the natural languages used by this resource.

By default preserves the Content Language from the source. If explicitly set to null, the Content Language will not be preserved and set to null.

Applies to upload and copy transfers.

ContentType

Optional. Sets the Content Type header which specifies the MIME content type of the blob.

By default preserves the Content Type from the source. If explicitly set to null, the Content Type will not be preserved and set to null.

Applies to upload and copy transfers.

DestinationConditions

Optional. See ShareFileRequestConditions. Access conditions on the copying of data to this share file.

Applies to copy and upload transfers.

DirectoryMetadata

Optional. Defines custom metadata to set on the destination resource.

Applies to upload and copy transfers.

Preserves Metadata from the source by default. If explicitly set to null, the Metadata will not be preserved and set to null.

FileAttributes

The file system attributes for this file.

By default preserves the File Attributes from the source. If explicitly set to null, the File Attributes will not be preserved and set to null.

FileChangedOn

The change time of the file.

By default preserves the File Changed On Time from the source. If explicitly set to null, the File Changed On Time will not be preserved and set to now.

FileCreatedOn

The creation time of the file.

By default preserves the File Created On Time from the source. If explicitly set to null, the File Created On Time will not be preserved and set to now.

FileLastWrittenOn

The last write time of the file.

By default preserves the File Last Written On Time from the source. If explicitly set to null, the File Last Written On Time will not be preserved and set to now.

FileMetadata

Optional. Defines custom metadata to set on the destination resource.

Applies to upload and copy transfers.

Preserves Metadata from the source by default. If explicitly set to null, the Metadata will not be preserved and set to null.

FilePermissions

To preserve the key of the file permission. If set to true, the permission key will be preserved from the source Share to the destination Share. This requires a Create Share Permissions operation, which is a operation called on the Destination Share, which requires Share level permissions.

By default the permission key will not be preserved from the source Share to the destination Share. If explicitly set to null, the File Permissions will not be preserved. Applies only to copy transfers.

SourceConditions

Optional. See ShareFileRequestConditions. Access conditions on the copying of data from this source storage resource share file.

Applies to copy and download transfers.

Applies to