GetFileSharedAccessSignature

Returns a shared access signature for a specified file.

Properties

Azure Storage Credential

  • Account Name - The name of your Azure storage account.
  • Access Key - Your Azure account access key.
  • EndpointSuffix - To create a connection string for a storage service in a specific region.
  • BlobStorageUri - The Uri to the location of the Blob storage you want to access.
    • PrimaryUri and SecondaryUri settings available
  • FileStorageUri - The Uri to the location of the File storage you want to access.
    • PrimaryUri and SecondaryUri settings available
  • TableStorageUri - The Uri to the location of the Table storage you want to access.
    • PrimaryUri and SecondaryUri settings available
  • QueueStorageUri - The Uri to the location of the Queue storage you want to access.
    • PrimaryUri and SecondaryUri settings available

Share name

Name of the file share.

Directory path

The name or path of the directory. For example, for subdirectory2 existing in subdirectory in maindirectory, the directory path is maindirectory/subdirectory/subdirectory2. If not specified, the root directory is accessed.

File name

Name of the file.

Shared access file policies

Specifies the access policy for the shared access signature.

Shared access file headers

Specifies optional header values to set for a file accessed with this SAS.

Group policy identifier

A string identifying a stored access policy.

Shared access protocol

The allowed protocols (https only, or http and https). Choose Unspecified if you don't want to restrict protocol.

IP address

The allowed IP address. Please specify either only IP Address or Minimum and Maximum IP Address or none if you don't want to restrict based on IP address.

Minimum IP address

The minimum allowed IP address of IP address range. Please specify either only IP Address or Minimum and Maximum IP Address or none if you don't want to restrict based on IP address.

Maximum IP address

The maximum allowed IP address of IP address range. Please specify either only IP Address or Minimum and Maximum IP Address or none if you don't want to restrict based on IP address.


Also See

Please refer to the following Azure API reference documentation:

Configure Azure Storage connection strings:

https://docs.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.auth.storagecredentials.-ctor?view=azure-dotnet#Microsoft_Azure_Storage_Auth_StorageCredentials__ctor_System_String_System_String_

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.cloudstorageaccount.-ctor?view=azure-dotnet#Microsoft_Azure_Storage_CloudStorageAccount__ctor_Microsoft_Azure_Storage_Auth_StorageCredentials_System_String_System_Boolean_

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.cloudstorageaccount.-ctor?view=azure-dotnet#Microsoft_Azure_Storage_CloudStorageAccount__ctor_Microsoft_Azure_Storage_Auth_StorageCredentials_Microsoft_Azure_Storage_StorageUri_Microsoft_Azure_Storage_StorageUri_Microsoft_Azure_Storage_StorageUri_Microsoft_Azure_Storage_StorageUri_

Documentation to assist in setting properties:

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.file.cloudfile.getsharedaccesssignature?view=azure-dotnet#Microsoft_Azure_Storage_File_CloudFile_GetSharedAccessSignature_Microsoft_Azure_Storage_File_SharedAccessFilePolicy_Microsoft_Azure_Storage_File_SharedAccessFileHeaders_System_String_System_Nullable_Microsoft_Azure_Storage_SharedAccessProtocol__Microsoft_Azure_Storage_IPAddressOrRange_

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.file.cloudfileclient.getsharereference?view=azure-dotnet

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.file.cloudfiledirectory.getdirectoryreference?view=azure-dotnet

https://docs.microsoft.com/en-us/dotnet/api/microsoft.azure.storage.file.cloudfiledirectory.getfilereference?view=azure-dotnet