SASQueryParameters class

Referensi

Paket:: @azure/storage-blob

Mewakili komponen yang membentuk parameter kueri Azure Storage SAS. Jenis ini tidak dibangun langsung oleh pengguna; ini hanya dihasilkan oleh jenis AccountSASSignatureValues dan BlobSASSignatureValues . Setelah dibuat, itu dapat dikodekan ke dalam toString() dan ditambahkan ke URL secara langsung (meskipun hati-hati harus diambil di sini jika ada parameter kueri yang ada, yang mungkin memengaruhi cara yang sesuai untuk menambahkan parameter kueri ini).

CATATAN: Instans kelas ini tidak dapat diubah.

Konstruktor

SASQueryParameters(string, string, SASQueryParametersOptions)	Membuat instans SASQueryParameters.
SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)	Membuat instans SASQueryParameters.

Properti

cacheControl	Nilai untuk header cache-control di Blob/File Service SAS.
contentDisposition	Nilai untuk header disposisi konten di Blob/File Service SAS.
contentEncoding	Nilai untuk header pengodean konten di Blob/File Service SAS.
contentLanguage	Nilai untuk header panjang konten di SaS Blob/File Service.
contentType	Nilai untuk header jenis konten di SaS Blob/File Service.
correlationId	Nilai GUID yang akan dicatat dalam log diagnostik penyimpanan dan dapat digunakan untuk menghubungkan pembuatan SAS dengan akses sumber daya penyimpanan. Ini hanya digunakan untuk Delegasi Pengguna SAS.
encryptionScope	Pilihan. Cakupan enkripsi untuk digunakan saat mengirim permintaan yang diotorisasi dengan URI SAS ini.
expiresOn	Opsional hanya ketika pengidentifikasi disediakan. Waktu kedaluwarsa untuk token SAS ini.
identifier	Pilihan. Pengidentifikasi yang ditandatangani (hanya untuk BlobSASSignatureValues). Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy
ipRange	Pilihan. Rentang IP diperbolehkan untuk SAS ini.
permissions	Opsional hanya ketika pengidentifikasi disediakan. Silakan merujuk ke AccountSASPermissions, BlobSASPermissions, atau ContainerSASPermissions untuk detail selengkapnya.
preauthorizedAgentObjectId	ID Objek AAD resmi dalam format GUID. ID Objek AAD pengguna yang diotorisasi oleh pemilik Kunci Delegasi Pengguna untuk melakukan tindakan yang diberikan oleh SAS. Layanan Azure Storage akan memastikan bahwa pemilik kunci delegasi pengguna memiliki izin yang diperlukan sebelum memberikan akses tetapi tidak ada pemeriksaan izin tambahan untuk pengguna yang ditentukan dalam nilai ini yang akan dilakukan. Ini hanya digunakan untuk Delegasi Pengguna SAS.
protocol	Pilihan. Protokol HTTP yang diizinkan.
resource	Pilihan. Menentukan sumber daya mana yang dapat diakses melalui SAS (hanya untuk BlobSASSSignatureValues). Lihat https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only
resourceTypes	Opsional. Jenis sumber daya penyimpanan yang diakses (hanya untuk SAS Akun). Silakan merujuk ke AccountSASResourceTypes untuk detail selengkapnya.
services	Pilihan. Layanan penyimpanan sedang diakses (hanya untuk AKUN SAS). Silakan merujuk ke AccountSASServices untuk detail selengkapnya.
signature	Tanda tangan untuk token SAS.
startsOn	Opsional. Waktu mulai untuk token SAS ini.
version	Versi API penyimpanan.

Metode

toString()

Mengodekan semua parameter kueri SAS ke dalam string yang dapat ditambahkan ke URL.

Detail Konstruktor

SASQueryParameters(string, string, SASQueryParametersOptions)

Membuat instans SASQueryParameters.

new SASQueryParameters(version: string, signature: string, options?: SASQueryParametersOptions)

Parameter

version: string

Mewakili versi penyimpanan

signature: string

Mewakili tanda tangan untuk token SAS

options: SASQueryParametersOptions

Pilihan. Opsi untuk membuat SASQueryParameters.

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)

Membuat instans 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, preauthorizedAgentObjectId?: string, correlationId?: string, encryptionScope?: string)

Parameter

version: string

Mewakili versi penyimpanan

signature: string

Mewakili tanda tangan untuk token SAS

permissions: string

Mewakili izin penyimpanan

services: string

Mewakili layanan penyimpanan yang diakses (hanya untuk SAS Akun)

resourceTypes: string

Mewakili jenis sumber daya penyimpanan yang sedang diakses (hanya untuk SAS Akun)

protocol: SASProtocol

Mewakili protokol HTTP yang diizinkan

startsOn: Date

Mewakili waktu mulai untuk token SAS ini

expiresOn: Date

Mewakili waktu kedaluwarsa untuk token SAS ini

ipRange: SasIPRange

Mewakili rentang alamat IP yang valid untuk token SAS ini

identifier: string

Mewakili pengidentifikasi yang ditandatangani (hanya untuk SaS Layanan)

resource: string

Mewakili kontainer penyimpanan atau blob (hanya untuk SaS Layanan)

cacheControl: string

Mewakili header kontrol cache (hanya untuk SAS Blob/File Service)

contentDisposition: string

Mewakili header disposisi konten (hanya untuk SaS Blob/File Service)

contentEncoding: string

Mewakili header pengodean konten (hanya untuk SAS Blob/File Service)

contentLanguage: string

Mewakili header bahasa konten (hanya untuk SaS Blob/File Service)

contentType: string

Mewakili header jenis konten (hanya untuk SaS Blob/File Service)

userDelegationKey: UserDelegationKey

Mewakili properti kunci delegasi pengguna

preauthorizedAgentObjectId: string

Mewakili ID Objek AAD resmi (hanya untuk SAS Delegasi Pengguna)

correlationId: string

Mewakili ID korelasi (hanya untuk Delegasi Pengguna SAS)

encryptionScope: string

Detail Properti

cacheControl

Nilai untuk header cache-control di Blob/File Service SAS.

cacheControl?: string

Nilai Properti

string

contentDisposition

Nilai untuk header disposisi konten di Blob/File Service SAS.

contentDisposition?: string

Nilai Properti

string

contentEncoding

Nilai untuk header pengodean konten di Blob/File Service SAS.

contentEncoding?: string

Nilai Properti

string

contentLanguage

Nilai untuk header panjang konten di SaS Blob/File Service.

contentLanguage?: string

Nilai Properti

string

contentType

Nilai untuk header jenis konten di SaS Blob/File Service.

contentType?: string

Nilai Properti

string

correlationId

Nilai GUID yang akan dicatat dalam log diagnostik penyimpanan dan dapat digunakan untuk menghubungkan pembuatan SAS dengan akses sumber daya penyimpanan. Ini hanya digunakan untuk Delegasi Pengguna SAS.

correlationId?: string

Nilai Properti

string

encryptionScope

Pilihan. Cakupan enkripsi untuk digunakan saat mengirim permintaan yang diotorisasi dengan URI SAS ini.

encryptionScope?: string

Nilai Properti

string

expiresOn

Opsional hanya ketika pengidentifikasi disediakan. Waktu kedaluwarsa untuk token SAS ini.

expiresOn?: Date

Nilai Properti

Date

identifier

Pilihan. Pengidentifikasi yang ditandatangani (hanya untuk BlobSASSignatureValues).

Lihat https://docs.microsoft.com/en-us/rest/api/storageservices/establishing-a-stored-access-policy

identifier?: string

Nilai Properti

string

ipRange

Pilihan. Rentang IP diperbolehkan untuk SAS ini.

undefined | SasIPRange ipRange

Nilai Properti

undefined | SasIPRange

permissions

Opsional hanya ketika pengidentifikasi disediakan. Silakan merujuk ke AccountSASPermissions, BlobSASPermissions, atau ContainerSASPermissions untuk detail selengkapnya.

permissions?: string

Nilai Properti

string

preauthorizedAgentObjectId

ID Objek AAD resmi dalam format GUID. ID Objek AAD pengguna yang diotorisasi oleh pemilik Kunci Delegasi Pengguna untuk melakukan tindakan yang diberikan oleh SAS. Layanan Azure Storage akan memastikan bahwa pemilik kunci delegasi pengguna memiliki izin yang diperlukan sebelum memberikan akses tetapi tidak ada pemeriksaan izin tambahan untuk pengguna yang ditentukan dalam nilai ini yang akan dilakukan. Ini hanya digunakan untuk Delegasi Pengguna SAS.

preauthorizedAgentObjectId?: string

Nilai Properti

string

protocol

Pilihan. Protokol HTTP yang diizinkan.

protocol?: SASProtocol

Nilai Properti

SASProtocol

resource

Pilihan. Menentukan sumber daya mana yang dapat diakses melalui SAS (hanya untuk BlobSASSSignatureValues).

Lihat https://docs.microsoft.com/rest/api/storageservices/create-service-sas#specifying-the-signed-resource-blob-service-only

resource?: string

Nilai Properti

string

resourceTypes

Opsional. Jenis sumber daya penyimpanan yang diakses (hanya untuk SAS Akun). Silakan merujuk ke AccountSASResourceTypes untuk detail selengkapnya.

resourceTypes?: string

Nilai Properti

string

services

Pilihan. Layanan penyimpanan sedang diakses (hanya untuk AKUN SAS). Silakan merujuk ke AccountSASServices untuk detail selengkapnya.

services?: string

Nilai Properti

string

signature

Tanda tangan untuk token SAS.

signature: string

Nilai Properti

string

startsOn

Opsional. Waktu mulai untuk token SAS ini.

startsOn?: Date

Nilai Properti

Date

version

Versi API penyimpanan.

version: string

Nilai Properti

string

Detail Metode

toString()

Mengodekan semua parameter kueri SAS ke dalam string yang dapat ditambahkan ke URL.

function toString(): string

Mengembalikan

string

SASQueryParameters class

Konstruktor

Properti

Metode

Detail Konstruktor

SASQueryParameters(string, string, SASQueryParametersOptions)

Parameter

SASQueryParameters(string, string, string, string, string, SASProtocol, Date, Date, SasIPRange, string, string, string, string, string, string, string, UserDelegationKey, string, string, string)

Parameter

Detail Properti

cacheControl

Nilai Properti

contentDisposition

Nilai Properti

contentEncoding

Nilai Properti

contentLanguage

Nilai Properti

contentType

Nilai Properti

correlationId

Nilai Properti

encryptionScope

Nilai Properti

expiresOn

Nilai Properti

identifier

Nilai Properti

ipRange

Nilai Properti

permissions

Nilai Properti

preauthorizedAgentObjectId

Nilai Properti

protocol

Nilai Properti

resource

Nilai Properti

resourceTypes

Nilai Properti

services

Nilai Properti

signature

Nilai Properti

startsOn

Nilai Properti

version

Nilai Properti

Detail Metode

toString()

Mengembalikan

Sumber Daya Tambahan: