public final class QueueServiceSasSignatureValues extends Object
Constructor and Description |
---|
QueueServiceSasSignatureValues()
|
QueueServiceSasSignatureValues(OffsetDateTime expiryTime,
QueueSasPermission permissions)
Creates an object with the specified expiry time and permissions
|
QueueServiceSasSignatureValues(String identifier)
Creates an object with the specified identifier.
|
Modifier and Type | Method and Description |
---|---|
QueueServiceSasQueryParameters |
generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
Deprecated.
Please use the generateSas(QueueServiceSasSignatureValues) method on the desired queue client
after initializing
QueueServiceSasSignatureValues . |
OffsetDateTime |
getExpiryTime() |
String |
getId()
Deprecated.
|
String |
getIdentifier() |
String |
getPermissions() |
SasProtocol |
getProtocol() |
String |
getQueueName()
Deprecated.
Queue name is now auto-populated by the SAS generation methods provided on the desired queue client.
|
SasIpRange |
getSasIpRange() |
OffsetDateTime |
getStartTime() |
String |
getVersion() |
QueueServiceSasSignatureValues |
setExpiryTime(OffsetDateTime expiryTime)
Sets the time after which the SAS will no longer work.
|
QueueServiceSasSignatureValues |
setIdentifier(String identifier)
Sets the name of the access policy on the queue this SAS references if any.
|
QueueServiceSasSignatureValues |
setPermissions(QueueSasPermission permissions)
Sets the permissions string allowed by the SAS.
|
QueueServiceSasSignatureValues |
setProtocol(SasProtocol protocol)
Sets the
SasProtocol which determines the protocols allowed by the SAS. |
QueueServiceSasSignatureValues |
setQueueName(String queueName)
Deprecated.
Please use the generateSas methods provided on the desired queue client that will
auto-populate the queue name.
|
QueueServiceSasSignatureValues |
setSasIpRange(SasIpRange sasIpRange)
Sets the
SasIpRange which determines the IP ranges that are allowed to use the SAS. |
QueueServiceSasSignatureValues |
setStartTime(OffsetDateTime startTime)
Sets when the SAS will take effect.
|
QueueServiceSasSignatureValues |
setVersion(String version)
Sets the version of the service this SAS will target.
|
@Deprecated public QueueServiceSasSignatureValues()
QueueServiceSasSignatureValues.QueueServiceSasSignatureValues(String)
, or
QueueServiceSasSignatureValues.QueueServiceSasSignatureValues(OffsetDateTime, QueueSasPermission)
public QueueServiceSasSignatureValues(OffsetDateTime expiryTime, QueueSasPermission permissions)
expiryTime
- The time after which the SAS will no longer work.permissions
- QueueSasPermission
allowed by the SAS.public QueueServiceSasSignatureValues(String identifier)
identifier
- Name of the access policy.public String getVersion()
public QueueServiceSasSignatureValues setVersion(String version)
version
- Version to targetpublic SasProtocol getProtocol()
SasProtocol
which determines the protocols allowed by the SAS.public QueueServiceSasSignatureValues setProtocol(SasProtocol protocol)
SasProtocol
which determines the protocols allowed by the SAS.protocol
- Protocol for the SASpublic OffsetDateTime getStartTime()
public QueueServiceSasSignatureValues setStartTime(OffsetDateTime startTime)
startTime
- When the SAS takes effectpublic OffsetDateTime getExpiryTime()
public QueueServiceSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)
expiryTime
- When the SAS will no longer workpublic String getPermissions()
QueueSasPermission
for help
determining the permissions allowed.public QueueServiceSasSignatureValues setPermissions(QueueSasPermission permissions)
QueueSasPermission
for help constructing
the permissions string.permissions
- Permissions for the SASNullPointerException
- if permissions
is null.public SasIpRange getSasIpRange()
SasIpRange
which determines the IP ranges that are allowed to use the SAS.public QueueServiceSasSignatureValues 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 getQueueName()
@Deprecated public QueueServiceSasSignatureValues setQueueName(String queueName)
queueName
- Canonical name of the object the SAS grants access@Deprecated public String getId()
QueueServiceSasSignatureValues.getIdentifier()
public String getIdentifier()
public QueueServiceSasSignatureValues setIdentifier(String identifier)
identifier
- Name of the access policy@Deprecated public QueueServiceSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)
QueueServiceSasSignatureValues
.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.For samples, see class level JavaDocs.
storageSharedKeyCredentials
- A StorageSharedKeyCredential
object used to sign the SAS values.QueueServiceSasQueryParameters
represented by the current builder.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.NullPointerException
- If storageSharedKeyCredentials
is null.Copyright © 2021 Microsoft Corporation. All rights reserved.