302 строки
30 KiB
YAML
302 строки
30 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.storage.common.sas.AccountSasSignatureValues"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues"
|
|
name: "AccountSasSignatureValues"
|
|
nameWithType: "AccountSasSignatureValues"
|
|
summary: "Used to initialize parameters for a Shared Access Signature (SAS) for an Azure Storage account."
|
|
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 **AccountSasSignatureValues**"
|
|
constructors:
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.AccountSasSignatureValues()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.AccountSasSignatureValues()"
|
|
name: "AccountSasSignatureValues()"
|
|
nameWithType: "AccountSasSignatureValues.AccountSasSignatureValues()"
|
|
summary: "Initializes a new <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> object."
|
|
deprecatedTag: "Please use <xref uid=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\"></xref>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public AccountSasSignatureValues()"
|
|
desc: "Initializes a new <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> object."
|
|
hasDeprecatedTag: true
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.AccountSasSignatureValues(java.time.OffsetDateTime,com.azure.storage.common.sas.AccountSasPermission,com.azure.storage.common.sas.AccountSasService,com.azure.storage.common.sas.AccountSasResourceType)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.AccountSasSignatureValues(OffsetDateTime expiryTime, AccountSasPermission permissions, AccountSasService services, AccountSasResourceType resourceTypes)"
|
|
name: "AccountSasSignatureValues(OffsetDateTime expiryTime, AccountSasPermission permissions, AccountSasService services, AccountSasResourceType resourceTypes)"
|
|
nameWithType: "AccountSasSignatureValues.AccountSasSignatureValues(OffsetDateTime expiryTime, AccountSasPermission permissions, AccountSasService services, AccountSasResourceType resourceTypes)"
|
|
summary: "Initializes a new <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> object."
|
|
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.common.sas.AccountSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasPermission\"></xref> allowed by the SAS."
|
|
name: "permissions"
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasPermission?alt=com.azure.storage.common.sas.AccountSasPermission&text=AccountSasPermission\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.azure.storage.common.sas.AccountSasService\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasService\"></xref> targeted by the SAS."
|
|
name: "services"
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasService?alt=com.azure.storage.common.sas.AccountSasService&text=AccountSasService\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "<xref uid=\"com.azure.storage.common.sas.AccountSasResourceType\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasResourceType\"></xref> targeted by the SAS."
|
|
name: "resourceTypes"
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasResourceType?alt=com.azure.storage.common.sas.AccountSasResourceType&text=AccountSasResourceType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AccountSasSignatureValues(OffsetDateTime expiryTime, AccountSasPermission permissions, AccountSasService services, AccountSasResourceType resourceTypes)"
|
|
desc: "Initializes a new <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> object."
|
|
methods:
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.generateSasQueryParameters(com.azure.storage.common.StorageSharedKeyCredential)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
name: "generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
nameWithType: "AccountSasSignatureValues.generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
summary: "Generates a <xref uid=\"com.azure.storage.common.sas.AccountSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasQueryParameters\"></xref> object which contains all SAS query parameters for authenticating requests."
|
|
deprecatedTag: "Please use the generate<wbr>Account<wbr>Sas(Account<wbr>Sas<wbr>Signature<wbr>Values) method on the desired service client after initializing <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>."
|
|
parameters:
|
|
- description: "Credentials for the storage account."
|
|
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 AccountSasQueryParameters generateSasQueryParameters(StorageSharedKeyCredential storageSharedKeyCredentials)"
|
|
desc: "Generates a <xref uid=\"com.azure.storage.common.sas.AccountSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasQueryParameters\"></xref> object which contains all SAS query parameters for authenticating requests.\n\n**Notes on SAS generation**\n\n * If <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues.setVersion(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"version\"></xref> is not set, the latest service version is used.\n * The following parameters are required to generate a SAS:\n \n * <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues.setExpiryTime(java.time.OffsetDateTime)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"expiryTime\"></xref>\n * <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues.setServices(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"services\"></xref>\n * <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues.setPermissions(com.azure.storage.common.sas.AccountSasPermission)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"permissions\"></xref>\n * <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues.setResourceTypes(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"resourceTypes\"></xref>\n\nFor samples, see class level JavaDocs."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "A new <xref uid=\"com.azure.storage.common.sas.AccountSasQueryParameters\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasQueryParameters\"></xref> used for authenticating requests."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasQueryParameters?alt=com.azure.storage.common.sas.AccountSasQueryParameters&text=AccountSasQueryParameters\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.getEncryptionScope()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getEncryptionScope()"
|
|
name: "getEncryptionScope()"
|
|
nameWithType: "AccountSasSignatureValues.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: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.getExpiryTime()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getExpiryTime()"
|
|
name: "getExpiryTime()"
|
|
nameWithType: "AccountSasSignatureValues.getExpiryTime()"
|
|
summary: "Gets the time after which the SAS will no longer work."
|
|
syntax: "public OffsetDateTime getExpiryTime()"
|
|
desc: "Gets the time after which the SAS will no longer work."
|
|
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.common.sas.AccountSasSignatureValues.getPermissions()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getPermissions()"
|
|
name: "getPermissions()"
|
|
nameWithType: "AccountSasSignatureValues.getPermissions()"
|
|
summary: "Gets the operations the SAS user may perform."
|
|
syntax: "public String getPermissions()"
|
|
desc: "Gets the operations the SAS user may perform."
|
|
returns:
|
|
description: "The operations the SAS user may perform. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasPermission\"></xref> to help determine\n which permissions are allowed."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.getProtocol()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getProtocol()"
|
|
name: "getProtocol()"
|
|
nameWithType: "AccountSasSignatureValues.getProtocol()"
|
|
summary: "Gets the <xref uid=\"com.azure.storage.common.sas.SasProtocol\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasProtocol\"></xref> which determines the HTTP protocol that will be used."
|
|
syntax: "public SasProtocol getProtocol()"
|
|
desc: "Gets the <xref uid=\"com.azure.storage.common.sas.SasProtocol\" data-throw-if-not-resolved=\"false\" data-raw-source=\"SasProtocol\"></xref> which determines the HTTP protocol that will be used."
|
|
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 HTTP protocol that will be used."
|
|
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.common.sas.AccountSasSignatureValues.getResourceTypes()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getResourceTypes()"
|
|
name: "getResourceTypes()"
|
|
nameWithType: "AccountSasSignatureValues.getResourceTypes()"
|
|
summary: "Gets the resource types accessible with this SAS."
|
|
syntax: "public String getResourceTypes()"
|
|
desc: "Gets the resource types accessible with this SAS. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasResourceType\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasResourceType\"></xref> to help determine the resource types that are accessible."
|
|
returns:
|
|
description: "the resource types accessible with this SAS. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasResourceType\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasResourceType\"></xref> to help\n determine the resource types that are accessible."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.getSasIpRange()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getSasIpRange()"
|
|
name: "getSasIpRange()"
|
|
nameWithType: "AccountSasSignatureValues.getSasIpRange()"
|
|
summary: "Gets 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."
|
|
syntax: "public SasIpRange getSasIpRange()"
|
|
desc: "Gets 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 <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.common.sas.AccountSasSignatureValues.getServices()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getServices()"
|
|
name: "getServices()"
|
|
nameWithType: "AccountSasSignatureValues.getServices()"
|
|
summary: "Gets the services accessible with this SAS."
|
|
syntax: "public String getServices()"
|
|
desc: "Gets the services accessible with this SAS. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasService\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasService\"></xref> to help determine which services are accessible."
|
|
returns:
|
|
description: "the services accessible with this SAS. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasService\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasService\"></xref> to help determine which\n services are accessible."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.getStartTime()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getStartTime()"
|
|
name: "getStartTime()"
|
|
nameWithType: "AccountSasSignatureValues.getStartTime()"
|
|
summary: "Gets when the SAS will take effect."
|
|
syntax: "public OffsetDateTime getStartTime()"
|
|
desc: "Gets when the SAS will take effect."
|
|
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.common.sas.AccountSasSignatureValues.getVersion()"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.getVersion()"
|
|
name: "getVersion()"
|
|
nameWithType: "AccountSasSignatureValues.getVersion()"
|
|
summary: "Gets the service version that is targeted, if `null` or empty the latest service version targeted by the library will be used."
|
|
syntax: "public String getVersion()"
|
|
desc: "Gets the service version that is targeted, if `null` or empty the latest service version targeted by the library will be used."
|
|
returns:
|
|
description: "the service version that is targeted, if <code>null</code> or empty the latest service version targeted by the\n library will be used."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setEncryptionScope(java.lang.String)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setEncryptionScope(String encryptionScope)"
|
|
name: "setEncryptionScope(String encryptionScope)"
|
|
nameWithType: "AccountSasSignatureValues.setEncryptionScope(String encryptionScope)"
|
|
summary: "Sets the encryption scope that will be applied to any write operations performed with the sas"
|
|
parameters:
|
|
- description: "the encryption scope to set"
|
|
name: "encryptionScope"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public AccountSasSignatureValues setEncryptionScope(String encryptionScope)"
|
|
desc: "Sets the encryption scope that will be applied to any write operations performed with the sas"
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setExpiryTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setExpiryTime(OffsetDateTime expiryTime)"
|
|
name: "setExpiryTime(OffsetDateTime expiryTime)"
|
|
nameWithType: "AccountSasSignatureValues.setExpiryTime(OffsetDateTime expiryTime)"
|
|
summary: "Sets the time after which the SAS will no longer work."
|
|
deprecatedTag: "Please use <xref uid=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\"></xref> to specify the expiry time."
|
|
parameters:
|
|
- description: "Expiry time to set"
|
|
name: "expiryTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html\">@Deprecated</a></br>public AccountSasSignatureValues setExpiryTime(OffsetDateTime expiryTime)"
|
|
desc: "Sets the time after which the SAS will no longer work."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setPermissions(com.azure.storage.common.sas.AccountSasPermission)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setPermissions(AccountSasPermission permissions)"
|
|
name: "setPermissions(AccountSasPermission permissions)"
|
|
nameWithType: "AccountSasSignatureValues.setPermissions(AccountSasPermission permissions)"
|
|
summary: "Sets the operations the account SAS user may perform."
|
|
deprecatedTag: "Please use <xref uid=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\"></xref> to specify the allowed permissions."
|
|
parameters:
|
|
- description: "Permissions to set."
|
|
name: "permissions"
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasPermission?alt=com.azure.storage.common.sas.AccountSasPermission&text=AccountSasPermission\" 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 AccountSasSignatureValues setPermissions(AccountSasPermission permissions)"
|
|
desc: "Sets the operations the account SAS user may perform. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasPermission\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasPermission\"></xref> for help constructing the permissions string."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setProtocol(com.azure.storage.common.sas.SasProtocol)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setProtocol(SasProtocol protocol)"
|
|
name: "setProtocol(SasProtocol protocol)"
|
|
nameWithType: "AccountSasSignatureValues.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 HTTP protocol that will be used."
|
|
parameters:
|
|
- description: "Protocol to set"
|
|
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 AccountSasSignatureValues 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 HTTP protocol that will be used."
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setResourceTypes(java.lang.String)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setResourceTypes(String resourceTypes)"
|
|
name: "setResourceTypes(String resourceTypes)"
|
|
nameWithType: "AccountSasSignatureValues.setResourceTypes(String resourceTypes)"
|
|
summary: "Sets the resource types accessible with this SAS."
|
|
deprecatedTag: "Please use <xref uid=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\"></xref> to specify the resource types being targeted."
|
|
parameters:
|
|
- description: "Allowed resource types string to set"
|
|
name: "resourceTypes"
|
|
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 AccountSasSignatureValues setResourceTypes(String resourceTypes)"
|
|
desc: "Sets the resource types accessible with this SAS. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasResourceType\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasResourceType\"></xref> to construct this value."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setSasIpRange(com.azure.storage.common.sas.SasIpRange)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setSasIpRange(SasIpRange sasIpRange)"
|
|
name: "setSasIpRange(SasIpRange sasIpRange)"
|
|
nameWithType: "AccountSasSignatureValues.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 AccountSasSignatureValues 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 AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setServices(java.lang.String)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setServices(String services)"
|
|
name: "setServices(String services)"
|
|
nameWithType: "AccountSasSignatureValues.setServices(String services)"
|
|
summary: "Sets the services accessible with this SAS."
|
|
deprecatedTag: "Please use <xref uid=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#AccountSasSignatureValues(OffsetDateTime, AccountSasPermission, AccountSasService,\n AccountSasResourceType)\"></xref> to specify the services being targeted."
|
|
parameters:
|
|
- description: "Allowed services string to set"
|
|
name: "services"
|
|
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 AccountSasSignatureValues setServices(String services)"
|
|
desc: "Sets the services accessible with this SAS. Please refer to <xref uid=\"com.azure.storage.common.sas.AccountSasService\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasService\"></xref> to construct this value."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setStartTime(java.time.OffsetDateTime)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setStartTime(OffsetDateTime startTime)"
|
|
name: "setStartTime(OffsetDateTime startTime)"
|
|
nameWithType: "AccountSasSignatureValues.setStartTime(OffsetDateTime startTime)"
|
|
summary: "Sets when the SAS will take effect."
|
|
parameters:
|
|
- description: "Start time to set"
|
|
name: "startTime"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
|
|
syntax: "public AccountSasSignatureValues setStartTime(OffsetDateTime startTime)"
|
|
desc: "Sets when the SAS will take effect."
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.storage.common.sas.AccountSasSignatureValues.setVersion(java.lang.String)"
|
|
fullName: "com.azure.storage.common.sas.AccountSasSignatureValues.setVersion(String version)"
|
|
name: "setVersion(String version)"
|
|
nameWithType: "AccountSasSignatureValues.setVersion(String version)"
|
|
summary: "Sets the service version that is targeted."
|
|
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: "Target version to set"
|
|
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 AccountSasSignatureValues setVersion(String version)"
|
|
desc: "Sets the service version that is targeted. Leave this `null` or empty to target the version used by the library."
|
|
hasDeprecatedTag: true
|
|
returns:
|
|
description: "the updated AccountSasSignatureValues object."
|
|
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Used to initialize parameters for a Shared Access Signature (SAS) for an Azure Storage account. Once all the values here are set, use the generateSas method on the desired service 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.common.sas"
|
|
artifact: com.azure:azure-storage-common:12.27.1
|