431 строка
39 KiB
YAML
431 строка
39 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues"
|
|
name: "ShareServiceSasSignatureValues"
|
|
nameWithType: "ShareServiceSasSignatureValues"
|
|
summary: "Used to initialize parameters for a Shared Access Signature (SAS) for an Azure File Storage service."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **ShareServiceSasSignatureValues**"
|
|
constructors:
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues()"
|
|
name: "ShareServiceSasSignatureValues()"
|
|
nameWithType: "ShareServiceSasSignatureValues.ShareServiceSasSignatureValues()"
|
|
summary: "Creates an object with empty values for all fields."
|
|
deprecatedTag: "Please use <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#ShareServiceSasSignatureValues(String)\"></xref>, <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(java.time.OffsetDateTime,com.azure.storage.file.share.sas.ShareSasPermission)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#ShareServiceSasSignatureValues(OffsetDateTime, ShareSasPermission)\"></xref>, or <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(java.time.OffsetDateTime,com.azure.storage.file.share.sas.ShareFileSasPermission)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#ShareServiceSasSignatureValues(OffsetDateTime, ShareFileSasPermission)\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareServiceSasSignatureValues()"
|
|
desc: "Creates an object with empty values for all fields."
|
|
hasDeprecatedTag: true
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(String identifier)"
|
|
name: "ShareServiceSasSignatureValues(String identifier)"
|
|
nameWithType: "ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(String identifier)"
|
|
summary: "Creates an object with the specified identifier."
|
|
parameters:
|
|
- description: "Name of the access policy."
|
|
name: "identifier"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues(String identifier)"
|
|
desc: "Creates an object with the specified identifier."
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(java.time.OffsetDateTime,com.azure.storage.file.share.sas.ShareFileSasPermission)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareFileSasPermission permissions)"
|
|
name: "ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareFileSasPermission permissions)"
|
|
nameWithType: "ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareFileSasPermission permissions)"
|
|
summary: "Creates an object with the specified expiry time and permissions"
|
|
parameters:
|
|
- description: "The time after which the SAS will no longer work."
|
|
name: "expiryTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "<xref uid=\"com.azure.storage.file.share.sas.ShareFileSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareFileSasPermission\"></xref> allowed by the SAS."
|
|
name: "permissions"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareFileSasPermission?alt=com.azure.storage.file.share.sas.ShareFileSasPermission&text=ShareFileSasPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareFileSasPermission permissions)"
|
|
desc: "Creates an object with the specified expiry time and permissions"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(java.time.OffsetDateTime,com.azure.storage.file.share.sas.ShareSasPermission)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareSasPermission permissions)"
|
|
name: "ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareSasPermission permissions)"
|
|
nameWithType: "ShareServiceSasSignatureValues.ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareSasPermission permissions)"
|
|
summary: "Creates an object with the specified expiry time and permissions"
|
|
parameters:
|
|
- description: "The time after which the SAS will no longer work."
|
|
name: "expiryTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- description: "<xref uid=\"com.azure.storage.file.share.sas.ShareSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareSasPermission\"></xref> allowed by the SAS."
|
|
name: "permissions"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareServiceSasSignatureValues(OffsetDateTime expiryTime, ShareSasPermission permissions)"
|
|
desc: "Creates an object with the specified expiry time and permissions"
|
|
methods:
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.generateSasQueryParameters(com.azure.storage.common.StorageSharedKeyCredential)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
name: "generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
nameWithType: "ShareServiceSasSignatureValues.generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
summary: "Uses an account's shared key credential to sign these signature values to produce the proper SAS query parameters."
|
|
deprecatedTag: "Please use the generate<wbr>Sas(Share<wbr>Service<wbr>Sas<wbr>Signature<wbr>Values) method on the desired share/file/directory client after initializing <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareServiceSasSignatureValues\"></xref>."
|
|
parameters:
|
|
- description: "A <xref uid=\"com.azure.storage.common.StorageSharedKeyCredential\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref> object used to sign the SAS values."
|
|
name: "storageSharedKeyCredentials"
|
|
type: "<xref href=\"com.azure.storage.common.StorageSharedKeyCredential?alt=com.azure.storage.common.StorageSharedKeyCredential&text=StorageSharedKeyCredential\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareServiceSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
desc: "Uses an account's shared key credential to sign these signature values to produce the proper SAS query parameters.\n\n**Notes on SAS generation**\n\n * If <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setIdentifier(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"identifier\"></xref> is set, <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setExpiryTime(java.time.OffsetDateTime)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"expiryTime\"></xref> and permissions should not be set. These values are inherited from the stored access policy.\n * Otherwise, <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setExpiryTime(java.time.OffsetDateTime)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"expiryTime\"></xref> and <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getPermissions()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"permissions\"></xref> must be set.\n\nThe type of SAS query parameters returned depends on the following:\n\n1. If <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getFilePath()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getFilePath()\"></xref> is not set, query parameters for a **share SAS** are returned.\n2. Otherwise, <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getShareName()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getShareName()\"></xref> and <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getFilePath()\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getFilePath()\"></xref> are used to create query parameters for a **file SAS**.\n\nSee class level JavaDocs for code snippets."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "<xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareServiceSasQueryParameters\"></xref>"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasQueryParameters?alt=com.azure.storage.file.share.sas.ShareServiceSasQueryParameters&text=ShareServiceSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getCacheControl()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getCacheControl()"
|
|
name: "getCacheControl()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getCacheControl()"
|
|
syntax: "public String getCacheControl()"
|
|
returns:
|
|
description: "the cache-control header for the SAS."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentDisposition()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentDisposition()"
|
|
name: "getContentDisposition()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getContentDisposition()"
|
|
syntax: "public String getContentDisposition()"
|
|
returns:
|
|
description: "the content-disposition header for the SAS."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentEncoding()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentEncoding()"
|
|
name: "getContentEncoding()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getContentEncoding()"
|
|
syntax: "public String getContentEncoding()"
|
|
returns:
|
|
description: "the content-encoding header for the SAS."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentLanguage()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentLanguage()"
|
|
name: "getContentLanguage()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getContentLanguage()"
|
|
syntax: "public String getContentLanguage()"
|
|
returns:
|
|
description: "the content-language header for the SAS."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentType()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getContentType()"
|
|
name: "getContentType()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getContentType()"
|
|
syntax: "public String getContentType()"
|
|
returns:
|
|
description: "the content-type header for the SAS."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getExpiryTime()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getExpiryTime()"
|
|
name: "getExpiryTime()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getExpiryTime()"
|
|
syntax: "public OffsetDateTime getExpiryTime()"
|
|
returns:
|
|
description: "the time after which the SAS will no longer work."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getFilePath()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getFilePath()"
|
|
name: "getFilePath()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getFilePath()"
|
|
summary: "Gets the path of the file or directory being made accessible."
|
|
deprecatedTag: "File path is now auto-populated by the SAS generation methods provided on the desired file/directory client."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getFilePath()"
|
|
desc: "Gets the path of the file or directory being made accessible. `null` or an empty string for a share SAS."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The path of the file or directory being made accessible. <code>null</code> or an empty string for a share SAS."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getIdentifier()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getIdentifier()"
|
|
name: "getIdentifier()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getIdentifier()"
|
|
syntax: "public String getIdentifier()"
|
|
returns:
|
|
description: "the name of the access policy on the share this SAS references if any. Please see\n <a href=\"https://docs.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy\">\n Establishing a stored access policy</a> for more information."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getPermissions()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getPermissions()"
|
|
name: "getPermissions()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getPermissions()"
|
|
syntax: "public String getPermissions()"
|
|
returns:
|
|
description: "the permissions string allowed by the SAS. Please refer to either <xref uid=\"com.azure.storage.file.share.sas.ShareSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareSasPermission\"></xref> or <xref uid=\"com.azure.storage.file.share.sas.ShareFileSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ShareFileSasPermission\"></xref> depending on the resource being accessed for help determining the permissions allowed."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getProtocol()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getProtocol()"
|
|
name: "getProtocol()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getProtocol()"
|
|
syntax: "public SasProtocol getProtocol()"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.storage.common.sas.SasProtocol\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasProtocol\"></xref> which determines the protocols allowed by the SAS."
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasProtocol?alt=com.azure.storage.common.sas.SasProtocol&text=SasProtocol\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getSasIpRange()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getSasIpRange()"
|
|
name: "getSasIpRange()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getSasIpRange()"
|
|
syntax: "public SasIpRange getSasIpRange()"
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.storage.common.sas.SasIpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasIpRange\"></xref> which determines the IP ranges that are allowed to use the SAS."
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasIpRange?alt=com.azure.storage.common.sas.SasIpRange&text=SasIpRange\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getShareName()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getShareName()"
|
|
name: "getShareName()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getShareName()"
|
|
summary: "Gets the name of the share being made accessible."
|
|
deprecatedTag: "Share name is now auto-populated by the SAS generation methods provided on the desired share/file/directory client."
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public String getShareName()"
|
|
desc: "Gets the name of the share being made accessible."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "The name of the share being made accessible."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getStartTime()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getStartTime()"
|
|
name: "getStartTime()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getStartTime()"
|
|
syntax: "public OffsetDateTime getStartTime()"
|
|
returns:
|
|
description: "when the SAS will take effect."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getVersion()"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.getVersion()"
|
|
name: "getVersion()"
|
|
nameWithType: "ShareServiceSasSignatureValues.getVersion()"
|
|
syntax: "public String getVersion()"
|
|
returns:
|
|
description: "the version of the service this SAS will target. If not specified, it will default to the version\n targeted by the library."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setCacheControl(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setCacheControl(String cacheControl)"
|
|
name: "setCacheControl(String cacheControl)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setCacheControl(String cacheControl)"
|
|
summary: "Sets the cache-control header for the SAS."
|
|
parameters:
|
|
- description: "Cache-Control header value"
|
|
name: "cacheControl"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setCacheControl(String cacheControl)"
|
|
desc: "Sets the cache-control header for the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentDisposition(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentDisposition(String contentDisposition)"
|
|
name: "setContentDisposition(String contentDisposition)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setContentDisposition(String contentDisposition)"
|
|
summary: "Sets the content-disposition header for the SAS."
|
|
parameters:
|
|
- description: "Content-Disposition header value"
|
|
name: "contentDisposition"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setContentDisposition(String contentDisposition)"
|
|
desc: "Sets the content-disposition header for the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentEncoding(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentEncoding(String contentEncoding)"
|
|
name: "setContentEncoding(String contentEncoding)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setContentEncoding(String contentEncoding)"
|
|
summary: "Sets the content-encoding header for the SAS."
|
|
parameters:
|
|
- description: "Content-Encoding header value"
|
|
name: "contentEncoding"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setContentEncoding(String contentEncoding)"
|
|
desc: "Sets the content-encoding header for the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentLanguage(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentLanguage(String contentLanguage)"
|
|
name: "setContentLanguage(String contentLanguage)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setContentLanguage(String contentLanguage)"
|
|
summary: "Sets the content-language header for the SAS."
|
|
parameters:
|
|
- description: "Content-Language header value"
|
|
name: "contentLanguage"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setContentLanguage(String contentLanguage)"
|
|
desc: "Sets the content-language header for the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentType(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setContentType(String contentType)"
|
|
name: "setContentType(String contentType)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setContentType(String contentType)"
|
|
summary: "Sets the content-type header for the SAS."
|
|
parameters:
|
|
- description: "Content-Type header value"
|
|
name: "contentType"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setContentType(String contentType)"
|
|
desc: "Sets the content-type header for the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setExpiryTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setExpiryTime(OffsetDateTime expiryTime)"
|
|
name: "setExpiryTime(OffsetDateTime expiryTime)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setExpiryTime(OffsetDateTime expiryTime)"
|
|
summary: "Sets the time after which the SAS will no longer work."
|
|
parameters:
|
|
- description: "When the SAS will no longer work"
|
|
name: "expiryTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)"
|
|
desc: "Sets the time after which the SAS will no longer work."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setFilePath(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setFilePath(String filePath)"
|
|
name: "setFilePath(String filePath)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setFilePath(String filePath)"
|
|
summary: "Sets the path of the file or directory being made accessible."
|
|
deprecatedTag: "Please use the generate<wbr>Sas methods provided on the desired file/directory client that will auto-populate the file path."
|
|
parameters:
|
|
- description: "The name of the share being made accessible."
|
|
name: "filePath"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareServiceSasSignatureValues setFilePath(String filePath)"
|
|
desc: "Sets the path of the file or directory being made accessible. Pass in `null` or an empty string for a share SAS."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setIdentifier(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setIdentifier(String identifier)"
|
|
name: "setIdentifier(String identifier)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setIdentifier(String identifier)"
|
|
summary: "Sets the name of the access policy on the share this SAS references if any."
|
|
parameters:
|
|
- description: "Name of the stored access policy"
|
|
name: "identifier"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setIdentifier(String identifier)"
|
|
desc: "Sets the name of the access policy on the share this SAS references if any. Please see [ Establishing a stored access policy][Establishing a stored access policy] for more information.\n\n\n[Establishing a stored access policy]: https://docs.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy"
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setPermissions(com.azure.storage.file.share.sas.ShareFileSasPermission)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setPermissions(ShareFileSasPermission permissions)"
|
|
name: "setPermissions(ShareFileSasPermission permissions)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setPermissions(ShareFileSasPermission permissions)"
|
|
summary: "Sets the permissions allowed by the SAS."
|
|
parameters:
|
|
- description: "Permissions for the SAS."
|
|
name: "permissions"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareFileSasPermission?alt=com.azure.storage.file.share.sas.ShareFileSasPermission&text=ShareFileSasPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareServiceSasSignatureValues setPermissions(ShareFileSasPermission permissions)"
|
|
desc: "Sets the permissions allowed by the SAS. Share file SASs are created when both a <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setShareName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"share name\"></xref> and <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setFilePath(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"file path\"></xref> are set on the builder."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setPermissions(com.azure.storage.file.share.sas.ShareSasPermission)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setPermissions(ShareSasPermission permissions)"
|
|
name: "setPermissions(ShareSasPermission permissions)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setPermissions(ShareSasPermission permissions)"
|
|
summary: "Sets the permissions allowed by the SAS."
|
|
parameters:
|
|
- description: "Permissions for the share SAS."
|
|
name: "permissions"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareSasPermission?alt=com.azure.storage.file.share.sas.ShareSasPermission&text=ShareSasPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareServiceSasSignatureValues setPermissions(ShareSasPermission permissions)"
|
|
desc: "Sets the permissions allowed by the SAS. Share SASs are created when **only** <xref uid=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setShareName(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"share name\"></xref> is set on the builder."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setProtocol(com.azure.storage.common.sas.SasProtocol)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setProtocol(SasProtocol protocol)"
|
|
name: "setProtocol(SasProtocol protocol)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setProtocol(SasProtocol protocol)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.common.sas.SasProtocol\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasProtocol\"></xref> which determines the protocols allowed by the SAS."
|
|
parameters:
|
|
- description: "Protocol for the SAS"
|
|
name: "protocol"
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasProtocol?alt=com.azure.storage.common.sas.SasProtocol&text=SasProtocol\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareServiceSasSignatureValues setProtocol(SasProtocol protocol)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.common.sas.SasProtocol\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasProtocol\"></xref> which determines the protocols allowed by the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setSasIpRange(com.azure.storage.common.sas.SasIpRange)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setSasIpRange(SasIpRange sasIpRange)"
|
|
name: "setSasIpRange(SasIpRange sasIpRange)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setSasIpRange(SasIpRange sasIpRange)"
|
|
summary: "Sets the <xref uid=\"com.azure.storage.common.sas.SasIpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasIpRange\"></xref> which determines the IP ranges that are allowed to use the SAS."
|
|
parameters:
|
|
- description: "Allowed IP range to set"
|
|
name: "sasIpRange"
|
|
type: "<xref href=\"com.azure.storage.common.sas.SasIpRange?alt=com.azure.storage.common.sas.SasIpRange&text=SasIpRange\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public ShareServiceSasSignatureValues setSasIpRange(SasIpRange sasIpRange)"
|
|
desc: "Sets the <xref uid=\"com.azure.storage.common.sas.SasIpRange\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasIpRange\"></xref> which determines the IP ranges that are allowed to use the SAS."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setShareName(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setShareName(String shareName)"
|
|
name: "setShareName(String shareName)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setShareName(String shareName)"
|
|
summary: "Sets the name of the share being made accessible."
|
|
deprecatedTag: "Please use the generate<wbr>Sas methods provided on the desired share/file/directory client that will auto-populate the share name."
|
|
parameters:
|
|
- description: "The name of the share being made accessible."
|
|
name: "shareName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareServiceSasSignatureValues setShareName(String shareName)"
|
|
desc: "Sets the name of the share being made accessible."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setStartTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setStartTime(OffsetDateTime startTime)"
|
|
name: "setStartTime(OffsetDateTime startTime)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setStartTime(OffsetDateTime startTime)"
|
|
summary: "Sets when the SAS will take effect."
|
|
parameters:
|
|
- description: "When the SAS takes effect"
|
|
name: "startTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public ShareServiceSasSignatureValues setStartTime(OffsetDateTime startTime)"
|
|
desc: "Sets when the SAS will take effect."
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setVersion(java.lang.String)"
|
|
fullName: "com.azure.storage.file.share.sas.ShareServiceSasSignatureValues.setVersion(String version)"
|
|
name: "setVersion(String version)"
|
|
nameWithType: "ShareServiceSasSignatureValues.setVersion(String version)"
|
|
summary: "Sets the version of the service this SAS will target."
|
|
deprecatedTag: "The version is set to the latest version of sas. Users should stop calling this API as it is now treated as a no-op."
|
|
parameters:
|
|
- description: "Version to target"
|
|
name: "version"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public ShareServiceSasSignatureValues setVersion(String version)"
|
|
desc: "Sets the version of the service this SAS will target. If not specified, it will default to the version targeted by the library."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated FileServiceSasSignatureValues object"
|
|
type: "<xref href=\"com.azure.storage.file.share.sas.ShareServiceSasSignatureValues?alt=com.azure.storage.file.share.sas.ShareServiceSasSignatureValues&text=ShareServiceSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Used to initialize parameters for a Shared Access Signature (SAS) for an Azure File Storage service. Once all the values here are set, use the appropriate SAS generation method on the desired share/file/directory client to obtain a representation of the SAS which can then be applied to a new client using the .sasToken(String) method on the desired client builder."
|
|
metadata: {}
|
|
package: "com.azure.storage.file.share.sas"
|
|
artifact: com.azure:azure-storage-file-share:12.24.0
|