### YamlMime:JavaType
uid: "com.azure.storage.common.sas.CommonSasQueryParameters"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters"
name: "CommonSasQueryParameters"
nameWithType: "CommonSasQueryParameters"
summary: "Represents the components that make up an Azure Storage SAS' query parameters."
inheritances:
- ""
inheritedClassMethods:
- classRef: "java.lang.Object"
methodsRef:
- "clone"
- "equals"
- "finalize"
- "getClass"
- "hashCode"
- "notify"
- "notifyAll"
- "toString"
- "wait"
- "wait"
- "wait"
syntax: "public class **CommonSasQueryParameters**"
constructors:
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.CommonSasQueryParameters(java.util.Map,boolean)"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.CommonSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)"
name: "CommonSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)"
nameWithType: "CommonSasQueryParameters.CommonSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)"
summary: "Creates a new object."
parameters:
- description: "All query parameters for the request as key-value pairs"
name: "queryParamsMap"
type: "Map<String,String[]>"
- description: "When true
, the SAS query parameters will be removed from\n queryParamsMap"
name: "removeSasParametersFromMap"
type: ""
syntax: "public CommonSasQueryParameters(Map queryParamsMap, boolean removeSasParametersFromMap)"
desc: "Creates a new object."
methods:
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.encode()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.encode()"
name: "encode()"
nameWithType: "CommonSasQueryParameters.encode()"
summary: "Encodes all SAS query parameters into a string that can be appended to a URL."
syntax: "public String encode()"
desc: "Encodes all SAS query parameters into a string that can be appended to a URL."
returns:
description: "A String
representing the SAS query parameters."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getAgentObjectId()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getAgentObjectId()"
name: "getAgentObjectId()"
nameWithType: "CommonSasQueryParameters.getAgentObjectId()"
summary: "Gets the AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to perform the action granted by the SAS token."
syntax: "public String getAgentObjectId()"
desc: "Gets the AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the user delegation key has the required permissions before granting access and the service will perform an additional POSIX ACL check to determine if this user is authorized to perform the requested operation."
returns:
description: "The AAD object ID of a user assumed to be unauthorized by the owner of the user delegation key to\n perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner\n of the user delegation key has the required permissions before granting access and the service will perform an\n additional POSIX ACL check to determine if this user is authorized to perform the requested operation."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getCacheControl()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getCacheControl()"
name: "getCacheControl()"
nameWithType: "CommonSasQueryParameters.getCacheControl()"
summary: "Gets the Cache-Control header value when a client accesses the resource with this sas token."
syntax: "public String getCacheControl()"
desc: "Gets the Cache-Control header value when a client accesses the resource with this sas token."
returns:
description: "The Cache-Control header value when a client accesses the resource with this sas token."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentDisposition()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentDisposition()"
name: "getContentDisposition()"
nameWithType: "CommonSasQueryParameters.getContentDisposition()"
summary: "Gets the Content-Disposition header value when a client accesses the resource with this sas token."
syntax: "public String getContentDisposition()"
desc: "Gets the Content-Disposition header value when a client accesses the resource with this sas token."
returns:
description: "The Content-Disposition header value when a client accesses the resource with this sas token."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentEncoding()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentEncoding()"
name: "getContentEncoding()"
nameWithType: "CommonSasQueryParameters.getContentEncoding()"
summary: "Gets the Content-Encoding header value when a client accesses the resource with this sas token."
syntax: "public String getContentEncoding()"
desc: "Gets the Content-Encoding header value when a client accesses the resource with this sas token."
returns:
description: "The Content-Encoding header value when a client accesses the resource with this sas token."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentLanguage()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentLanguage()"
name: "getContentLanguage()"
nameWithType: "CommonSasQueryParameters.getContentLanguage()"
summary: "Gets the Content-Language header value when a client accesses the resource with this sas token."
syntax: "public String getContentLanguage()"
desc: "Gets the Content-Language header value when a client accesses the resource with this sas token."
returns:
description: "The Content-Language header value when a client accesses the resource with this sas token."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentType()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getContentType()"
name: "getContentType()"
nameWithType: "CommonSasQueryParameters.getContentType()"
summary: "Gets the Content-Type header value when a client accesses the resource with this sas token."
syntax: "public String getContentType()"
desc: "Gets the Content-Type header value when a client accesses the resource with this sas token."
returns:
description: "The Content-Type header value when a client accesses the resource with this sas token."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getCorrelationId()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getCorrelationId()"
name: "getCorrelationId()"
nameWithType: "CommonSasQueryParameters.getCorrelationId()"
summary: "Gets the correlation id to correlate the storage audit logs with the audit logs used by the principal generating and distributing the SAS."
syntax: "public String getCorrelationId()"
desc: "Gets the correlation id to correlate the storage audit logs with the audit logs used by the principal generating and distributing the SAS."
returns:
description: "The correlation id to correlate the storage audit logs with the audit logs used by the principal\n generating and distributing the SAS."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getDirectoryDepth()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getDirectoryDepth()"
name: "getDirectoryDepth()"
nameWithType: "CommonSasQueryParameters.getDirectoryDepth()"
summary: "Gets the directory depth of the resource this SAS token authorizes."
syntax: "public Integer getDirectoryDepth()"
desc: "Gets the directory depth of the resource this SAS token authorizes."
returns:
description: "The directory depth of the resource this SAS token authorizes."
type: "Integer"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getEncryptionScope()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getEncryptionScope()"
name: "getEncryptionScope()"
nameWithType: "CommonSasQueryParameters.getEncryptionScope()"
summary: "Gets the encryption scope that will be applied to any write operations performed with the sas."
syntax: "public String getEncryptionScope()"
desc: "Gets the encryption scope that will be applied to any write operations performed with the sas."
returns:
description: "An encryption scope that will be applied to any write operations performed with the sas."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getExpiryTime()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getExpiryTime()"
name: "getExpiryTime()"
nameWithType: "CommonSasQueryParameters.getExpiryTime()"
summary: "Gets the expiry time for this SAS token."
syntax: "public OffsetDateTime getExpiryTime()"
desc: "Gets the expiry time for this SAS token."
returns:
description: "The expiry time for this SAS token."
type: "OffsetDateTime"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getIdentifier()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getIdentifier()"
name: "getIdentifier()"
nameWithType: "CommonSasQueryParameters.getIdentifier()"
summary: "Gets the signed identifier."
syntax: "public String getIdentifier()"
desc: "Gets the signed identifier.\n\nPlease see [here][] for more information.\n\n\n[here]: https://docs.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy"
returns:
description: "The signed identifier."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyExpiry()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyExpiry()"
name: "getKeyExpiry()"
nameWithType: "CommonSasQueryParameters.getKeyExpiry()"
summary: "Gets the datetime when the key expires."
syntax: "public OffsetDateTime getKeyExpiry()"
desc: "Gets the datetime when the key expires."
returns:
description: "the datetime when the key expires."
type: "OffsetDateTime"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyObjectId()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyObjectId()"
name: "getKeyObjectId()"
nameWithType: "CommonSasQueryParameters.getKeyObjectId()"
summary: "Gets the object ID of the key."
syntax: "public String getKeyObjectId()"
desc: "Gets the object ID of the key."
returns:
description: "the object ID of the key."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyService()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyService()"
name: "getKeyService()"
nameWithType: "CommonSasQueryParameters.getKeyService()"
summary: "Gets the services that are permitted by the key."
syntax: "public String getKeyService()"
desc: "Gets the services that are permitted by the key."
returns:
description: "the services that are permitted by the key."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyStart()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyStart()"
name: "getKeyStart()"
nameWithType: "CommonSasQueryParameters.getKeyStart()"
summary: "Gets the datetime when the key becomes active."
syntax: "public OffsetDateTime getKeyStart()"
desc: "Gets the datetime when the key becomes active."
returns:
description: "the datetime when the key becomes active."
type: "OffsetDateTime"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyTenantId()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyTenantId()"
name: "getKeyTenantId()"
nameWithType: "CommonSasQueryParameters.getKeyTenantId()"
summary: "Gets the tenant ID of the key."
syntax: "public String getKeyTenantId()"
desc: "Gets the tenant ID of the key."
returns:
description: "the tenant ID of the key."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyVersion()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getKeyVersion()"
name: "getKeyVersion()"
nameWithType: "CommonSasQueryParameters.getKeyVersion()"
summary: "Gets the service version that created the key."
syntax: "public String getKeyVersion()"
desc: "Gets the service version that created the key."
returns:
description: "the service version that created the key."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getPermissions()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getPermissions()"
name: "getPermissions()"
nameWithType: "CommonSasQueryParameters.getPermissions()"
summary: "Gets the SAS permissions in a raw format."
syntax: "public String getPermissions()"
desc: "Gets the SAS permissions in a raw format.\n\nPlease refer to \\*SASPermission classes for more details."
returns:
description: "The SAS permissions in a raw format."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getPreauthorizedAgentObjectId()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getPreauthorizedAgentObjectId()"
name: "getPreauthorizedAgentObjectId()"
nameWithType: "CommonSasQueryParameters.getPreauthorizedAgentObjectId()"
summary: "Gets the AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the action granted by the SAS token."
syntax: "public String getPreauthorizedAgentObjectId()"
desc: "Gets the AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the user delegation key has the required permissions before granting access but no additional permission check for the agent object id will be performed."
returns:
description: "The AAD object ID of a user assumed to be authorized by the owner of the user delegation key to perform\n the action granted by the SAS token. The service will validate the SAS token and ensure that the owner of the\n user delegation key has the required permissions before granting access but no additional permission check for\n the agent object id will be performed."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getProtocol()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getProtocol()"
name: "getProtocol()"
nameWithType: "CommonSasQueryParameters.getProtocol()"
summary: "Gets the allowed HTTP protocol(s)."
syntax: "public SasProtocol getProtocol()"
desc: "Gets the allowed HTTP protocol(s).\n\nPlease refer to for more details."
returns:
description: "The allowed HTTP protocol(s) or null
."
type: ""
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getResource()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getResource()"
name: "getResource()"
nameWithType: "CommonSasQueryParameters.getResource()"
summary: "Gets the storage resource."
syntax: "public String getResource()"
desc: "Gets the storage resource."
returns:
description: "The storage resource."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getResourceTypes()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getResourceTypes()"
name: "getResourceTypes()"
nameWithType: "CommonSasQueryParameters.getResourceTypes()"
summary: "Gets the storage resource types being accessed (only for Account SAS)."
syntax: "public String getResourceTypes()"
desc: "Gets the storage resource types being accessed (only for Account SAS).\n\nPlease refer to for more details."
returns:
description: "The storage resource types being accessed (only for Account SAS)."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getSasIpRange()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getSasIpRange()"
name: "getSasIpRange()"
nameWithType: "CommonSasQueryParameters.getSasIpRange()"
summary: "Gets the ."
syntax: "public SasIpRange getSasIpRange()"
desc: "Gets the ."
returns:
description: ""
type: ""
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getServices()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getServices()"
name: "getServices()"
nameWithType: "CommonSasQueryParameters.getServices()"
summary: "Gets the storage services being accessed (only for Account SAS)."
syntax: "public String getServices()"
desc: "Gets the storage services being accessed (only for Account SAS).\n\nPlease refer to for more details."
returns:
description: "The storage services being accessed (only for Account SAS)."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getSignature()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getSignature()"
name: "getSignature()"
nameWithType: "CommonSasQueryParameters.getSignature()"
summary: "Gets the signature for the SAS token."
syntax: "public String getSignature()"
desc: "Gets the signature for the SAS token."
returns:
description: "The signature for the SAS token."
type: "String"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getStartTime()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getStartTime()"
name: "getStartTime()"
nameWithType: "CommonSasQueryParameters.getStartTime()"
summary: "Gets the start time for this SAS token."
syntax: "public OffsetDateTime getStartTime()"
desc: "Gets the start time for this SAS token."
returns:
description: "The start time for this SAS token or null
."
type: "OffsetDateTime"
- uid: "com.azure.storage.common.sas.CommonSasQueryParameters.getVersion()"
fullName: "com.azure.storage.common.sas.CommonSasQueryParameters.getVersion()"
name: "getVersion()"
nameWithType: "CommonSasQueryParameters.getVersion()"
summary: "Gets the storage version."
syntax: "public String getVersion()"
desc: "Gets the storage version."
returns:
description: "The storage version"
type: "String"
type: "class"
desc: "Represents the components that make up an Azure Storage SAS' query parameters. This type is not constructed directly by the user; it is only generated by the URLParts type. NOTE: Instances of this class are immutable to ensure thread safety."
metadata: {}
package: "com.azure.storage.common.sas"
artifact: com.azure:azure-storage-common:12.27.1