SASQueryParameters class
表示組成 Azure 記憶體 SAS 查詢參數的元件。 使用者不會直接建構此類型;它只會由 AccountSASSignatureValues 和 <xref:BlobSASSignatureValues> 類型產生。 產生之後,它可以編碼成 toString() 並直接附加至 URL(不過,如果現有的查詢參數存在,則應該在這裡小心,這可能會影響附加這些查詢參數的適當方法)。
注意:這個類別的實例是不可變的。
建構函式
屬性
| agent |
GUID 格式的未經授權 AAD 物件識別碼。 假設使用者委派密鑰擁有者未經授權之使用者的 AAD 物件識別碼。 Azure 記憶體服務會執行額外的 POSIX ACL 檢查,以判斷使用者是否已獲授權執行要求的作業。 這無法與 <xref:signedAuthorizedUserObjectId>搭配使用。 這隻適用於使用者委派SAS。 |
| cache |
Blob/檔案服務 SAS 中快取控制標頭的值。 |
| content |
Blob/檔案服務 SAS 中內容處置標頭的值。 |
| content |
Blob/檔案服務 SAS 中內容編碼標頭的值。 |
| content |
Blob/檔案服務 SAS 中內容長度標頭的值。 |
| content |
Blob/檔案服務 SAS 中內容類型標頭的值。 |
| correlation |
將記錄在記憶體診斷記錄中的 GUID 值,可用來將 SAS 產生與記憶體資源存取相互關聯。 這隻適用於使用者委派SAS。 |
| directory |
指出 string-to-sign 標準化資源欄位中所指定的目錄深度。 目錄的深度是根資料夾底下的目錄數目。 |
| encryption |
Optional. 傳送具有此SAS URI授權的要求時要使用的加密範圍。 |
| expires |
只有在提供標識符時,才為選擇性。 此 SAS 令牌的到期時間。 |
| identifier | Optional. 帶正負號的標識碼(僅適用於 <xref:BlobSASSignatureValues>)。 請參閱 https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy |
| ip |
Optional. 此 SAS 允許的IP範圍。 |
| permissions | 只有在提供標識符時,才為選擇性。 如需詳細資訊,請參閱 AccountSASPermissions、<xref:BlobSASPermissions>或 <xref:ContainerSASPermissions>。 |
| preauthorized |
GUID 格式的授權 AAD 物件識別碼。 使用者委派密鑰擁有者授權的使用者 AAD 物件識別碼,以執行 SAS 所授與的動作。 Azure 記憶體服務會確保使用者委派密鑰的擁有者在授與存取權之前具有必要許可權,但不會執行此值中所指定使用者的額外許可權檢查。 這無法與 <xref:signedUnauthorizedUserObjectId>搭配使用。 這隻適用於使用者委派SAS。 |
| protocol | Optional. 允許的 HTTP 通訊協定(s)。 |
| resource | Optional. 指定哪些資源可透過 SAS 存取(僅適用於 <xref:BlobSASSignatureValues>)。 |
| resource |
Optional. 要存取的記憶體資源類型(僅適用於帳戶 SAS)。 如需詳細資訊,請參閱 AccountSASResourceTypes。 |
| services | Optional. 要存取的記憶體服務(僅適用於帳戶 SAS)。 如需詳細資訊,請參閱 AccountSASServices。 |
| signature | SAS 令牌的簽章。 |
| starts |
Optional. 此 SAS 令牌的開始時間。 |
| version | 記憶體 API 版本。 |
方法
| to |
將所有 SAS 查詢參數編碼為可附加至 URL 的字串。 |
建構函式詳細資料
SASQueryParameters(string, string, SASQueryParametersOptions)
建立 SASQueryParameters 的實例。
new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)
參數
- version
-
string
代表記憶體版本
- signature
-
string
表示 SAS 令牌的簽章
- options
- SASQueryParametersOptions
Optional. 建構 SASQueryParameters 的選項。
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, number, string, string, string, string)
建立 SASQueryParameters 的實例。
new SASQueryParameters(version: string, signature: string, permissions?: string, services?: string, resourceTypes?: string, protocol?: SASProtocol, startsOn?: Date, expiresOn?: Date, ipRange?: SasIPRange, identifier?: string, resource?: string, cacheControl?: string, contentDisposition?: string, contentEncoding?: string, contentLanguage?: string, contentType?: string, userDelegationKey?: UserDelegationKey, directoryDepth?: number, preauthorizedAgentObjectId?: string, agentObjectId?: string, correlationId?: string, encryptionScope?: string)
參數
- version
-
string
代表記憶體版本
- signature
-
string
表示 SAS 令牌的簽章
- permissions
-
string
代表記憶體許可權
- services
-
string
代表正在存取的記憶體服務(僅適用於帳戶 SAS)
- resourceTypes
-
string
代表要存取的記憶體資源類型(僅適用於帳戶 SAS)
- protocol
- SASProtocol
表示允許的 HTTP 通訊協定(s)
- startsOn
-
Date
表示此 SAS 令牌的開始時間
- expiresOn
-
Date
表示此 SAS 令牌的到期時間
- ipRange
- SasIPRange
表示此 SAS 令牌的有效 IP 位址範圍
- identifier
-
string
代表已簽署的識別碼(僅適用於服務 SAS)
- resource
-
string
代表記憶體容器或 Blob(僅適用於服務 SAS)
- cacheControl
-
string
表示快取控制標頭(僅適用於 Blob/檔案服務 SAS)
- contentDisposition
-
string
代表內容處置標頭(僅適用於 Blob/檔案服務 SAS)
- contentEncoding
-
string
代表內容編碼標頭(僅適用於 Blob/檔案服務 SAS)
- contentLanguage
-
string
代表內容語言標頭(僅適用於 Blob/檔案服務 SAS)
- contentType
-
string
代表內容類型標頭(僅適用於 Blob/檔案服務 SAS)
- userDelegationKey
- UserDelegationKey
代表使用者委派索引鍵屬性
- directoryDepth
-
number
- preauthorizedAgentObjectId
-
string
代表授權的 AAD 物件識別元(僅適用於使用者委派 SAS)
- agentObjectId
-
string
代表未經授權的 AAD 物件識別碼(僅適用於使用者委派 SAS)
- correlationId
-
string
代表相互關聯識別碼(僅適用於使用者委派 SAS)
- encryptionScope
-
string
屬性詳細資料
agentObjectId
GUID 格式的未經授權 AAD 物件識別碼。 假設使用者委派密鑰擁有者未經授權之使用者的 AAD 物件識別碼。 Azure 記憶體服務會執行額外的 POSIX ACL 檢查,以判斷使用者是否已獲授權執行要求的作業。 這無法與 <xref:signedAuthorizedUserObjectId>搭配使用。 這隻適用於使用者委派SAS。
agentObjectId?: string
屬性值
string
cacheControl
Blob/檔案服務 SAS 中快取控制標頭的值。
cacheControl?: string
屬性值
string
contentDisposition
Blob/檔案服務 SAS 中內容處置標頭的值。
contentDisposition?: string
屬性值
string
contentEncoding
Blob/檔案服務 SAS 中內容編碼標頭的值。
contentEncoding?: string
屬性值
string
contentLanguage
Blob/檔案服務 SAS 中內容長度標頭的值。
contentLanguage?: string
屬性值
string
contentType
Blob/檔案服務 SAS 中內容類型標頭的值。
contentType?: string
屬性值
string
correlationId
將記錄在記憶體診斷記錄中的 GUID 值,可用來將 SAS 產生與記憶體資源存取相互關聯。 這隻適用於使用者委派SAS。
correlationId?: string
屬性值
string
directoryDepth
指出 string-to-sign 標準化資源欄位中所指定的目錄深度。 目錄的深度是根資料夾底下的目錄數目。
directoryDepth?: number
屬性值
number
encryptionScope
Optional. 傳送具有此SAS URI授權的要求時要使用的加密範圍。
encryptionScope?: string
屬性值
string
expiresOn
只有在提供標識符時,才為選擇性。 此 SAS 令牌的到期時間。
expiresOn?: Date
屬性值
Date
identifier
Optional. 帶正負號的標識碼(僅適用於 <xref:BlobSASSignatureValues>)。
請參閱 https://learn.microsoft.com/rest/api/storageservices/establishing-a-stored-access-policy
identifier?: string
屬性值
string
ipRange
permissions
只有在提供標識符時,才為選擇性。 如需詳細資訊,請參閱 AccountSASPermissions、<xref:BlobSASPermissions>或 <xref:ContainerSASPermissions>。
permissions?: string
屬性值
string
preauthorizedAgentObjectId
GUID 格式的授權 AAD 物件識別碼。 使用者委派密鑰擁有者授權的使用者 AAD 物件識別碼,以執行 SAS 所授與的動作。 Azure 記憶體服務會確保使用者委派密鑰的擁有者在授與存取權之前具有必要許可權,但不會執行此值中所指定使用者的額外許可權檢查。 這無法與 <xref:signedUnauthorizedUserObjectId>搭配使用。 這隻適用於使用者委派SAS。
preauthorizedAgentObjectId?: string
屬性值
string
protocol
resource
Optional. 指定哪些資源可透過 SAS 存取(僅適用於 <xref:BlobSASSignatureValues>)。
resource?: string
屬性值
string
resourceTypes
Optional. 要存取的記憶體資源類型(僅適用於帳戶 SAS)。 如需詳細資訊,請參閱 AccountSASResourceTypes。
resourceTypes?: string
屬性值
string
services
signature
SAS 令牌的簽章。
signature: string
屬性值
string
startsOn
Optional. 此 SAS 令牌的開始時間。
startsOn?: Date
屬性值
Date
version
記憶體 API 版本。
version: string
屬性值
string
方法詳細資料
toString()
將所有 SAS 查詢參數編碼為可附加至 URL 的字串。
function toString(): string
傳回
string