SASQueryParametersOptions.yml

### YamlMime:TSType
name: SASQueryParametersOptions
uid: '@azure/storage-blob.SASQueryParametersOptions'
package: '@azure/storage-blob'
summary: >-
  Options to construct
  [SASQueryParameters](xref:@azure/storage-blob.SASQueryParameters).
fullName: SASQueryParametersOptions
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: cacheControl
    uid: '@azure/storage-blob.SASQueryParametersOptions.cacheControl'
    package: '@azure/storage-blob'
    summary: Value for cache-control header in Blob/File Service SAS.
    fullName: cacheControl
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'cacheControl?: string'
      return:
        description: ''
        type: string
  - name: contentDisposition
    uid: '@azure/storage-blob.SASQueryParametersOptions.contentDisposition'
    package: '@azure/storage-blob'
    summary: Value for content-disposition header in Blob/File Service SAS.
    fullName: contentDisposition
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentDisposition?: string'
      return:
        description: ''
        type: string
  - name: contentEncoding
    uid: '@azure/storage-blob.SASQueryParametersOptions.contentEncoding'
    package: '@azure/storage-blob'
    summary: Value for content-encoding header in Blob/File Service SAS.
    fullName: contentEncoding
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentEncoding?: string'
      return:
        description: ''
        type: string
  - name: contentLanguage
    uid: '@azure/storage-blob.SASQueryParametersOptions.contentLanguage'
    package: '@azure/storage-blob'
    summary: Value for content-length header in Blob/File Service SAS.
    fullName: contentLanguage
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentLanguage?: string'
      return:
        description: ''
        type: string
  - name: contentType
    uid: '@azure/storage-blob.SASQueryParametersOptions.contentType'
    package: '@azure/storage-blob'
    summary: Value for content-type header in Blob/File Service SAS.
    fullName: contentType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'contentType?: string'
      return:
        description: ''
        type: string
  - name: correlationId
    uid: '@azure/storage-blob.SASQueryParametersOptions.correlationId'
    package: '@azure/storage-blob'
    summary: >-
      A GUID value that will be logged in the storage diagnostic logs and can be
      used to correlate SAS generation with storage resource access.

      This is only used for User Delegation SAS.
    fullName: correlationId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'correlationId?: string'
      return:
        description: ''
        type: string
  - name: encryptionScope
    uid: '@azure/storage-blob.SASQueryParametersOptions.encryptionScope'
    package: '@azure/storage-blob'
    summary: >-
      Optional. Encryption scope to use when sending requests authorized with
      this SAS URI.
    fullName: encryptionScope
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'encryptionScope?: string'
      return:
        description: ''
        type: string
  - name: expiresOn
    uid: '@azure/storage-blob.SASQueryParametersOptions.expiresOn'
    package: '@azure/storage-blob'
    summary: >-
      Optional only when identifier is provided. The expiry time for this SAS
      token.
    fullName: expiresOn
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'expiresOn?: Date'
      return:
        description: ''
        type: Date
  - name: identifier
    uid: '@azure/storage-blob.SASQueryParametersOptions.identifier'
    package: '@azure/storage-blob'
    summary: >-
      Optional. The signed identifier (only for
      [BlobSASSignatureValues](xref:@azure/storage-blob.BlobSASSignatureValues)).


      See
      https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
    fullName: identifier
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'identifier?: string'
      return:
        description: ''
        type: string
  - name: ipRange
    uid: '@azure/storage-blob.SASQueryParametersOptions.ipRange'
    package: '@azure/storage-blob'
    summary: Optional. IP ranges allowed in this SAS.
    fullName: ipRange
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'ipRange?: SasIPRange'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.SasIPRange" />
  - name: permissions
    uid: '@azure/storage-blob.SASQueryParametersOptions.permissions'
    package: '@azure/storage-blob'
    summary: >-
      Optional only when identifier is provided.

      Please refer to
      [AccountSASPermissions](xref:@azure/storage-blob.AccountSASPermissions),
      [BlobSASPermissions](xref:@azure/storage-blob.BlobSASPermissions), or
      [ContainerSASPermissions](xref:@azure/storage-blob.ContainerSASPermissions)
      for

      more details.
    fullName: permissions
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'permissions?: string'
      return:
        description: ''
        type: string
  - name: preauthorizedAgentObjectId
    uid: '@azure/storage-blob.SASQueryParametersOptions.preauthorizedAgentObjectId'
    package: '@azure/storage-blob'
    summary: >-
      Authorized AAD Object ID in GUID format. The AAD Object ID of a user
      authorized by the owner of the User Delegation Key

      to perform the action granted by the SAS. The Azure Storage service will
      ensure that the owner of the user delegation key

      has the required permissions before granting access but no additional
      permission check for the user specified in

      this value will be performed. This cannot be used in conjuction with
      <xref:signedUnauthorizedUserObjectId>.

      This is only used for User Delegation SAS.
    fullName: preauthorizedAgentObjectId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'preauthorizedAgentObjectId?: string'
      return:
        description: ''
        type: string
  - name: protocol
    uid: '@azure/storage-blob.SASQueryParametersOptions.protocol'
    package: '@azure/storage-blob'
    summary: Optional. The allowed HTTP protocol(s).
    fullName: protocol
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'protocol?: SASProtocol'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.SASProtocol" />
  - name: resource
    uid: '@azure/storage-blob.SASQueryParametersOptions.resource'
    package: '@azure/storage-blob'
    summary: >-
      Optional. Specifies which resources are accessible via the SAS (only for
      [BlobSASSignatureValues](xref:@azure/storage-blob.BlobSASSignatureValues)).


      See
      https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
    fullName: resource
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'resource?: string'
      return:
        description: ''
        type: string
  - name: resourceTypes
    uid: '@azure/storage-blob.SASQueryParametersOptions.resourceTypes'
    package: '@azure/storage-blob'
    summary: >-
      Optional. The storage resource types being accessed (only for Account
      SAS). Please refer to

      [AccountSASResourceTypes](xref:@azure/storage-blob.AccountSASResourceTypes)
      for more details.
    fullName: resourceTypes
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'resourceTypes?: string'
      return:
        description: ''
        type: string
  - name: services
    uid: '@azure/storage-blob.SASQueryParametersOptions.services'
    package: '@azure/storage-blob'
    summary: >-
      Optional. The storage services being accessed (only for Account SAS).
      Please refer to
      [AccountSASServices](xref:@azure/storage-blob.AccountSASServices)

      for more details.
    fullName: services
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'services?: string'
      return:
        description: ''
        type: string
  - name: startsOn
    uid: '@azure/storage-blob.SASQueryParametersOptions.startsOn'
    package: '@azure/storage-blob'
    summary: Optional. The start time for this SAS token.
    fullName: startsOn
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'startsOn?: Date'
      return:
        description: ''
        type: Date
  - name: userDelegationKey
    uid: '@azure/storage-blob.SASQueryParametersOptions.userDelegationKey'
    package: '@azure/storage-blob'
    summary: User delegation key properties.
    fullName: userDelegationKey
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'userDelegationKey?: UserDelegationKey'
      return:
        description: ''
        type: <xref uid="@azure/storage-blob.UserDelegationKey" />