public final class BlobServiceSasSignatureValues extends Object
Modifier and Type | Method and Description |
---|---|
BlobServiceSasQueryParameters |
generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
Deprecated.
Please use the generateSas(BlobServiceSasSignatureValues) method on the desired container/blob client
after initializing
BlobServiceSasSignatureValues . |
BlobServiceSasQueryParameters |
generateSasQueryParameters(UserDelegationKey delegationKey,
String accountName)
Deprecated.
Please use the generateUserDelegationSas(BlobServiceSasSignatureValues, UserDelegationKey) method on
the desired container/blob client after initializing
BlobServiceSasSignatureValues . |
String |
getBlobName()
Deprecated.
Blob name is now auto-populated by the SAS generation methods provided on the desired blob client.
|
String |
getCacheControl() |
String |
getContainerName()
Deprecated.
Container name is now auto-populated by the SAS generation methods provided on the desired
container/blob client.
|
String |
getContentDisposition() |
String |
getContentEncoding() |
String |
getContentLanguage() |
String |
getContentType() |
OffsetDateTime |
getExpiryTime() |
String |
getIdentifier() |
String |
getPermissions() |
SasProtocol |
getProtocol() |
SasIpRange |
getSasIpRange() |
String |
getSnapshotId()
Deprecated.
Snapshot id is now auto-populated by the SAS generation methods provided on the desired (snapshot)
blob client.
|
OffsetDateTime |
getStartTime() |
String |
getVersion() |
BlobServiceSasSignatureValues |
setBlobName(String blobName)
Deprecated.
Please use the SAS generation methods provided on the desired blob client that will auto-populate the
blob name.
|
BlobServiceSasSignatureValues |
setCacheControl(String cacheControl)
Sets the cache-control header for the SAS.
|
BlobServiceSasSignatureValues |
setContainerName(String containerName)
Deprecated.
Please use the SAS generation methods provided on the desired container/blob client that will
auto-populate the container name.
|
BlobServiceSasSignatureValues |
setContentDisposition(String contentDisposition)
Sets the content-disposition header for the SAS.
|
BlobServiceSasSignatureValues |
setContentEncoding(String contentEncoding)
Sets the content-encoding header for the SAS.
|
BlobServiceSasSignatureValues |
setContentLanguage(String contentLanguage)
Sets the content-language header for the SAS.
|
BlobServiceSasSignatureValues |
setContentType(String contentType)
Sets the content-type header for the SAS.
|
BlobServiceSasSignatureValues |
setExpiryTime(OffsetDateTime expiryTime)
Sets the time after which the SAS will no longer work.
|
BlobServiceSasSignatureValues |
setIdentifier(String identifier)
Sets the name of the access policy on the container this SAS references if any.
|
BlobServiceSasSignatureValues |
setPermissions(BlobContainerSasPermission permissions)
Sets the Container permissions allowed by the SAS.
|
BlobServiceSasSignatureValues |
setPermissions(BlobSasPermission permissions)
Sets the Blob permissions allowed by the SAS.
|
BlobServiceSasSignatureValues |
setProtocol(SasProtocol protocol)
Sets the
SasProtocol which determines the protocols allowed by the SAS. |
BlobServiceSasSignatureValues |
setSasIpRange(SasIpRange sasIpRange)
Sets the
SasIpRange which determines the IP ranges that are allowed to use the SAS. |
BlobServiceSasSignatureValues |
setSnapshotId(String snapshotId)
Deprecated.
Please use the SAS generation methods provided on the desired (snapshot) blob client that will
auto-populate the snapshot id.
|
BlobServiceSasSignatureValues |
setStartTime(OffsetDateTime startTime)
Sets when the SAS will take effect.
|
BlobServiceSasSignatureValues |
setVersion(String version)
Sets the version of the service this SAS will target.
|
@Deprecated public BlobServiceSasSignatureValues()
BlobServiceSasSignatureValues.BlobServiceSasSignatureValues(String)
,
BlobServiceSasSignatureValues.BlobServiceSasSignatureValues(OffsetDateTime, BlobSasPermission)
, or
BlobServiceSasSignatureValues.BlobServiceSasSignatureValues(OffsetDateTime, BlobContainerSasPermission)
public BlobServiceSasSignatureValues(OffsetDateTime expiryTime, BlobContainerSasPermission permissions)
expiryTime
- The time after which the SAS will no longer work.permissions
- BlobContainerSasPermission
allowed by the SAS.public BlobServiceSasSignatureValues(OffsetDateTime expiryTime, BlobSasPermission permissions)
expiryTime
- When the SAS will no longer workpermissions
- BlobSasPermission
allowed by the SASpublic BlobServiceSasSignatureValues(String identifier)
UserDelegationKey
SAS.identifier
- Name of the access policy@Deprecated public BlobServiceSasSignatureValues(String version, SasProtocol sasProtocol, OffsetDateTime startTime, OffsetDateTime expiryTime, String permission, SasIpRange sasIpRange, String identifier, String cacheControl, String contentDisposition, String contentEncoding, String contentLanguage, String contentType)
BlobServiceSasSignatureValues.BlobServiceSasSignatureValues(String)
,
BlobServiceSasSignatureValues.BlobServiceSasSignatureValues(OffsetDateTime, BlobSasPermission)
, or
BlobServiceSasSignatureValues.BlobServiceSasSignatureValues(OffsetDateTime, BlobContainerSasPermission)
followed by calls to the desired setters.version
- The version of the service this SAS will target. If not specified, it will default to the version
targeted by the library.sasProtocol
- The SasProtocol
which determines the protocols allowed by the SAS.startTime
- When the SAS will take effect.expiryTime
- The time after which the SAS will no longer work.permission
- The permissions string allowed by the SAS.sasIpRange
- The SasIpRange
which determines the IP ranges that are allowed to use the SAS.identifier
- The name of the access policy on the container this SAS references if any.cacheControl
- The cache-control header for the SAS.contentDisposition
- The content-disposition header for the SAS.contentEncoding
- The content-encoding header for the SAS.contentLanguage
- The content-language header for the SAS.contentType
- The content-type header for the SAS.public String getVersion()
public BlobServiceSasSignatureValues setVersion(String version)
version
- Version to targetpublic SasProtocol getProtocol()
SasProtocol
which determines the protocols allowed by the SAS.public BlobServiceSasSignatureValues setProtocol(SasProtocol protocol)
SasProtocol
which determines the protocols allowed by the SAS.protocol
- Protocol for the SASpublic OffsetDateTime getStartTime()
public BlobServiceSasSignatureValues setStartTime(OffsetDateTime startTime)
startTime
- When the SAS takes effectpublic OffsetDateTime getExpiryTime()
public BlobServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)
expiryTime
- When the SAS will no longer workpublic String getPermissions()
BlobContainerSasPermission
or
BlobSasPermission
depending on the resource being accessed for help determining the permissions allowed.public BlobServiceSasSignatureValues setPermissions(BlobSasPermission permissions)
permissions
- BlobSasPermission
NullPointerException
- if permissions
is null.public BlobServiceSasSignatureValues setPermissions(BlobContainerSasPermission permissions)
permissions
- BlobContainerSasPermission
NullPointerException
- if permissions
is null.public SasIpRange getSasIpRange()
SasIpRange
which determines the IP ranges that are allowed to use the SAS.public BlobServiceSasSignatureValues setSasIpRange(SasIpRange sasIpRange)
SasIpRange
which determines the IP ranges that are allowed to use the SAS.sasIpRange
- Allowed IP range to set@Deprecated public String getContainerName()
@Deprecated public BlobServiceSasSignatureValues setContainerName(String containerName)
containerName
- The name of the container.@Deprecated public String getBlobName()
null
or an empty string is returned when a
creating a container SAS.null
or an empty string is returned when a
creating a container SAS.@Deprecated public BlobServiceSasSignatureValues setBlobName(String blobName)
null
or an empty string to create a container SAS.blobName
- The name of the blob. Use null
or an empty string to create a container SAS.@Deprecated public String getSnapshotId()
@Deprecated public BlobServiceSasSignatureValues setSnapshotId(String snapshotId)
BlobServiceSasSignatureValues.resource
will be set to BlobServiceSasSignatureValues.SAS_BLOB_SNAPSHOT_CONSTANT
if the passed snapshotId
isn't
null
amd BlobServiceSasSignatureValues.resource
is set to BlobServiceSasSignatureValues.SAS_BLOB_CONSTANT
.
snapshotId
- Identifier of the snapshotpublic String getIdentifier()
public BlobServiceSasSignatureValues setIdentifier(String identifier)
identifier
- Name of the access policypublic String getCacheControl()
public BlobServiceSasSignatureValues setCacheControl(String cacheControl)
cacheControl
- Cache-Control header valuepublic String getContentDisposition()
public BlobServiceSasSignatureValues setContentDisposition(String contentDisposition)
contentDisposition
- Content-Disposition header valuepublic String getContentEncoding()
public BlobServiceSasSignatureValues setContentEncoding(String contentEncoding)
contentEncoding
- Content-Encoding header valuepublic String getContentLanguage()
public BlobServiceSasSignatureValues setContentLanguage(String contentLanguage)
contentLanguage
- Content-Language header valuepublic String getContentType()
public BlobServiceSasSignatureValues setContentType(String contentType)
contentType
- Content-Type header value@Deprecated public BlobServiceSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
BlobServiceSasSignatureValues
.Notes on SAS generation
version
is not set, the latest service
version
is used.identifier
is set, expiryTime
and
permissions should not be set. These values are inherited from the stored access policy.expiryTime
and permissions
must
be set.The type of SAS query parameters returned depends on the following:
BlobServiceSasSignatureValues.getBlobName()
is not set, container SAS query parameters are returned.BlobServiceSasSignatureValues.getBlobName()
and BlobServiceSasSignatureValues.getSnapshotId()
are set, blob snapshot SAS query parameters
are returned.BlobServiceSasSignatureValues.getBlobName()
is set, blob SAS query parameters are returned.storageSharedKeyCredentials
- A StorageSharedKeyCredential
object used to sign the SAS values.BlobServiceSasQueryParameters
IllegalStateException
- If the HMAC-SHA256 algorithm isn't supported, if the key isn't a valid Base64
encoded string, or the UTF-8 charset isn't supported.IllegalArgumentException
- if BlobServiceSasSignatureValues.getPermissions()
contains an invalid character for the SAS resource.NullPointerException
- if storageSharedKeyCredentials
is null.@Deprecated public BlobServiceSasQueryParameters generateSasQueryParameters(UserDelegationKey delegationKey, String accountName)
BlobServiceSasSignatureValues
.Notes on SAS generation
version
is not set, the latest service
version
is used.identifier
is set, expiryTime
and
permissions should not be set. These values are inherited from the stored access policy.expiryTime
and permissions
must
be set.The type of SAS query parameters returned depends on the following:
BlobServiceSasSignatureValues.getBlobName()
is not set, container SAS query parameters are returned.BlobServiceSasSignatureValues.getBlobName()
and BlobServiceSasSignatureValues.getSnapshotId()
are set, blob snapshot SAS query parameters
are returned.BlobServiceSasSignatureValues.getBlobName()
is set, blob SAS query parameters are returned.delegationKey
- A UserDelegationKey
object used to sign the SAS values.accountName
- Azure Storage account name to generate SAS for.BlobServiceSasQueryParameters
IllegalStateException
- If the HMAC-SHA256 algorithm isn't supported, if the key isn't a valid Base64
encoded string, or the UTF-8 charset isn't supported.IllegalArgumentException
- if BlobServiceSasSignatureValues.getPermissions()
contains an invalid character for the SAS resource.NullPointerException
- if delegationKey
or account
is null.Copyright © 2020 Microsoft Corporation. All rights reserved.