DirectorySetPropertiesOptionalParams.yml

### YamlMime:TSType
name: DirectorySetPropertiesOptionalParams
uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams'
package: '@azure/storage-file'
summary: Optional Parameters.
fullName: DirectorySetPropertiesOptionalParams
remarks: ''
isPreview: false
isDeprecated: false
type: interface
properties:
  - name: abortSignal
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.abortSignal'
    package: '@azure/storage-file'
    summary: The signal which can be used to abort requests.
    fullName: abortSignal
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        type: AbortSignalLike
        description: ''
  - name: customHeaders
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.customHeaders'
    package: '@azure/storage-file'
    summary: |-
      {object} [customHeaders] User defined custom request headers that
      will be applied before the request is sent.
    fullName: customHeaders
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'customHeaders?: undefined | [key: string]: string'
      return:
        type: 'undefined | [key: string]: string'
        description: ''
  - name: filePermission
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.filePermission'
    package: '@azure/storage-file'
    summary: >-
      If specified the permission (security descriptor) shall be set for the
      directory/file. This

      header can be used if Permission size is <= 8KB, else
      x-ms-file-permission-key header shall be

      used. Default value: Inherit. If SDDL is specified as input, it must have
      owner, group and

      dacl. Note: Only one of the x-ms-file-permission or
      x-ms-file-permission-key should be

      specified.
    fullName: filePermission
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'filePermission?: undefined | string'
      return:
        type: undefined | string
        description: ''
  - name: filePermissionKey
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.filePermissionKey'
    package: '@azure/storage-file'
    summary: >-
      Key of the permission to be set for the directory/file. Note: Only one of
      the

      x-ms-file-permission or x-ms-file-permission-key should be specified.
    fullName: filePermissionKey
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'filePermissionKey?: undefined | string'
      return:
        type: undefined | string
        description: ''
  - name: onDownloadProgress
    uid: >-
      @azure/storage-file.DirectorySetPropertiesOptionalParams.onDownloadProgress
    package: '@azure/storage-file'
    summary: Callback which fires upon download progress.
    fullName: onDownloadProgress
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: >-
        onDownloadProgress?: undefined | (progress: TransferProgressEvent) =>
        void
      return:
        type: 'undefined | (progress: TransferProgressEvent) =&gt; void'
        description: ''
  - name: onUploadProgress
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.onUploadProgress'
    package: '@azure/storage-file'
    summary: Callback which fires upon upload progress.
    fullName: onUploadProgress
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'onUploadProgress?: undefined | (progress: TransferProgressEvent) => void'
      return:
        type: 'undefined | (progress: TransferProgressEvent) =&gt; void'
        description: ''
  - name: timeout
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.timeout'
    package: '@azure/storage-file'
    summary: >-
      The number of milliseconds a request can take before automatically being
      terminated.
    fullName: timeout
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'timeout?: undefined | number'
      return:
        type: undefined | number
        description: ''
  - name: timeoutParameter
    uid: '@azure/storage-file.DirectorySetPropertiesOptionalParams.timeoutParameter'
    package: '@azure/storage-file'
    summary: >-
      The timeout parameter is expressed in seconds. For more information, see
      <a

      href="https://docs.microsoft.com/en-us/rest/api/storageservices/Setting-Timeouts-for-File-Service-Operations?redirectedfrom=MSDN">Setting

      Timeouts for File Service Operations.</a>
    fullName: timeoutParameter
    remarks: ''
    isPreview: false
    isDeprecated: false
    syntax:
      content: 'timeoutParameter?: undefined | number'
      return:
        type: undefined | number
        description: ''
extends: RequestOptionsBase