FaceModels.SnapshotUpdateOptionalParams.yml

### YamlMime:TSType
name: SnapshotUpdateOptionalParams
uid: '@azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams'
package: '@azure/cognitiveservices-face'
summary: Optional Parameters.
fullName: SnapshotUpdateOptionalParams
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: applyScope
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.applyScope
    package: '@azure/cognitiveservices-face'
    summary: >-
      Array of the target Face subscription ids for the snapshot, specified by
      the user who created

      the snapshot when calling Snapshot - Take. For each snapshot, only
      subscriptions included in

      the applyScope of Snapshot - Take can apply it.
    fullName: applyScope
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'applyScope?: string[]'
      return:
        description: ''
        type: string[]
  - name: userData
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.userData
    package: '@azure/cognitiveservices-face'
    summary: >-
      User specified data about the snapshot for any purpose. Length should not
      exceed 16KB.
    fullName: userData
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userData?: string'
      return:
        description: ''
        type: string
inheritedProperties:
  - name: abortSignal
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.abortSignal
    package: '@azure/cognitiveservices-face'
    summary: The signal which can be used to abort requests.
    fullName: abortSignal
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'abortSignal?: AbortSignalLike'
      return:
        description: ''
        type: <xref uid="@azure/ms-rest-js.AbortSignalLike" />
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.abortSignal
  - name: customHeaders
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.customHeaders
    package: '@azure/cognitiveservices-face'
    summary: |-
      User defined custom request headers that
      will be applied before the request is sent.
    fullName: customHeaders
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'customHeaders?: {[key: string]: string}'
      return:
        description: ''
        type: '{[key: string]: string}'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.customHeaders
  - name: onDownloadProgress
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.onDownloadProgress
    package: '@azure/cognitiveservices-face'
    summary: Callback which fires upon download progress.
    fullName: onDownloadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onDownloadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onDownloadProgress
  - name: onUploadProgress
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.onUploadProgress
    package: '@azure/cognitiveservices-face'
    summary: Callback which fires upon upload progress.
    fullName: onUploadProgress
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'onUploadProgress?: (progress: TransferProgressEvent) => void'
      return:
        description: ''
        type: '(progress: TransferProgressEvent) =&gt; void'
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.onUploadProgress
  - name: timeout
    uid: >-
      @azure/cognitiveservices-face.FaceModels.SnapshotUpdateOptionalParams.timeout
    package: '@azure/cognitiveservices-face'
    summary: >-
      The number of milliseconds a request can take before automatically being
      terminated.
    fullName: timeout
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'timeout?: number'
      return:
        description: ''
        type: number
    inheritanceDescription: <b>Inherited From</b> msRest.RequestOptionsBase.timeout
extends: <xref uid="@azure/ms-rest-js.RequestOptionsBase" />