ShareClient class

Paket:: @azure/storage-file-share

ShareClient mewakili URL ke berbagi Azure Storage yang memungkinkan Anda memanipulasi direktori dan filenya.

Memperluas: StorageClient

Konstruktor

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	Membuat instans ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Membuat instans ShareClient.
ShareClient(string, string, ShareClientOptions)

Properti

name

Nama berbagi

rootDirectoryClient

Mendapatkan klien direktori untuk direktori akar berbagi ini. Perhatikan bahwa direktori akar selalu ada dan tidak dapat dihapus.

Objek ShareDirectoryClient baru untuk direktori akar.

Properti yang Diwariskan

accountName
url	Nilai string URL.

Metode

create(ShareCreateOptions)	Membuat berbagi baru di bawah akun yang ditentukan. Jika berbagi dengan nama yang sama sudah ada, operasi gagal. Lihat https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Membuat subdirektori baru di bawah berbagi ini. Lihat https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Membuat file baru atau mengganti file di bawah direktori akar berbagi ini. Perhatikan bahwa file hanya menginisialisasi file tanpa konten. Lihat https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Membuat berbagi baru di bawah akun yang ditentukan. Jika berbagi dengan nama yang sama sudah ada, itu tidak diubah. Lihat https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Membuat izin file (deskriptor keamanan) di tingkat berbagi. Deskriptor keamanan yang dibuat dapat digunakan untuk file/direktori dalam berbagi. Lihat https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Membuat rekam jepret berbagi baca-saja.
delete(ShareDeleteMethodOptions)	Menandai berbagi yang ditentukan untuk dihapus. Berbagi dan direktori atau file apa pun yang terkandung di dalamnya kemudian dihapus selama pengumpulan sampah. Lihat https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Menghapus sub direktori kosong yang ditentukan di bawah berbagi ini. Perhatikan bahwa direktori harus kosong sebelum dapat dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Menghapus file di bawah direktori akar berbagi ini dari akun penyimpanan. Ketika file berhasil dihapus, file segera dihapus dari indeks akun penyimpanan dan tidak lagi dapat diakses oleh klien. Data file kemudian dihapus dari layanan selama pengumpulan sampah. Hapus File akan gagal dengan kode status 409 (Konflik) dan kode kesalahan `SharingViolation` jika file terbuka pada klien SMB. Hapus File tidak didukung pada salinan bayangan berbagi, yang merupakan salinan berbagi baca-saja. Upaya untuk melakukan operasi ini pada rekam jepret berbagi akan gagal dengan 400 (`InvalidQueryParameterValue`) Lihat https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Menandai berbagi yang ditentukan untuk penghapusan jika ada. Berbagi dan direktori atau file apa pun yang terkandung di dalamnya kemudian dihapus selama pengumpulan sampah. Lihat https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Mengembalikan true jika sumber daya berbagi Azrue yang diwakili oleh klien ini ada; false jika tidak. CATATAN: gunakan fungsi ini dengan hati-hati karena berbagi yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya berbagi baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.
generateSasStringToSign(ShareGenerateSasUrlOptions)	Hanya tersedia untuk ShareClient yang dibangun dengan kredensial kunci bersama. Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	Hanya tersedia untuk ShareClient yang dibangun dengan kredensial kunci bersama. Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien. Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Mendapatkan izin untuk berbagi yang ditentukan. Izin menunjukkan apakah data berbagi dapat diakses secara publik. PERINGATAN: Tanggal JavaScript akan berpotensi kehilangan presisi saat mengurai string mulai dan kedaluwarsa. Misalnya, Tanggal baru("2018-12-31T03:44:23.8827891Z").toISOString() akan mendapatkan "2018-12-31T03:44:23.882Z". Lihat https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Membuat objek ShareDirectoryClient.
getPermission(string, ShareGetPermissionOptions)	Mendapatkan Security Descriptor Definition Language (SDDL) untuk kunci izin file tertentu yang menunjukkan deskriptor keamanan. Lihat https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk berbagi yang ditentukan. Lihat https://learn.microsoft.com/rest/api/storageservices/get-share-properties PERINGATAN: Objek `metadata` yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode `listShares`ShareServiceClient menggunakan opsi `includeMetadata`, yang akan mempertahankan casing aslinya.
getShareLeaseClient(string)	Dapatkan ShareLeaseClient yang mengelola sewa pada file.
getStatistics(ShareGetStatisticsOptions)	Mengambil statistik yang terkait dengan berbagi.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Mengatur izin untuk berbagi yang ditentukan. Izin menunjukkan apakah direktori atau file dalam berbagi dapat diakses secara publik. Saat Anda mengatur izin untuk berbagi, izin yang ada akan diganti. Jika tidak ada shareAcl yang disediakan, berbagi ACL yang ada akan dihapus. Saat Anda membuat kebijakan akses tersimpan pada berbagi, mungkin perlu waktu hingga 30 detik untuk diterapkan. Selama interval ini, tanda tangan akses bersama yang terkait dengan kebijakan akses tersimpan akan gagal dengan kode status 403 (Terlarang), hingga kebijakan akses menjadi aktif. Lihat https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk berbagi yang ditentukan. Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter opsi, metadata berbagi akan dihapus. Lihat https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Mengatur properti berbagi.
setQuota(number, ShareSetQuotaOptions)	Mengatur kuota untuk berbagi yang ditentukan.
withSnapshot(string)	Membuat objek ShareClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan URL ke berbagi dasar.

Detail Konstruktor

Membuat instans ShareClient.

new ShareClient(url: string, credential?: Credential | TokenCredential, options?: ShareClientOptions)

Parameter

url: string

String URL yang menunjuk ke berbagi file Azure Storage, seperti "https://myaccount.file.core.windows.net/share". Anda dapat menambahkan SAS jika menggunakan AnonymousCredential, seperti "https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Seperti AnonymousCredential atau StorageSharedKeyCredential. Jika tidak ditentukan, AnonymousCredential digunakan.

options: ShareClientOptions

Optional. Opsi untuk mengonfigurasi alur HTTP.

Membuat instans ShareClient.

new ShareClient(url: string, pipeline: Pipeline, options?: ShareClientConfig)

Parameter

url: string

pipeline: Pipeline

Panggil newPipeline() untuk membuat alur default, atau sediakan alur yang disesuaikan.

options: ShareClientConfig

new ShareClient(connectionString: string, name: string, options?: ShareClientOptions)

Parameter

connectionString: string

String koneksi akun atau string koneksi SAS dari akun penyimpanan Azure. [ Catatan - String koneksi akun hanya dapat digunakan dalam runtime NODE.JS. ] Contoh string koneksi akun - contoh string koneksi SAS DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net - BlobEndpoint=https://myaccount.blob.core.windows.net/;QueueEndpoint=https://myaccount.queue.core.windows.net/;FileEndpoint=https://myaccount.file.core.windows.net/;TableEndpoint=https://myaccount.table.core.windows.net/;SharedAccessSignature=sasString

name: string

Bagikan nama.

options: ShareClientOptions

Optional. Opsi untuk mengonfigurasi alur HTTP.

Detail Properti

Nama berbagi

string name

Nilai Properti

string

Mendapatkan klien direktori untuk direktori akar berbagi ini. Perhatikan bahwa direktori akar selalu ada dan tidak dapat dihapus.

Objek ShareDirectoryClient baru untuk direktori akar.

ShareDirectoryClient rootDirectoryClient

Nilai Properti

ShareDirectoryClient

Detail Properti yang Diwariskan

accountName: string

Nilai Properti

string

Diwarisi Dari StorageClient.accountName

Nilai string URL.

url: string

Nilai Properti

string

Diwariskan Dari StorageClient.url

Detail Metode

Membuat berbagi baru di bawah akun yang ditentukan. Jika berbagi dengan nama yang sama sudah ada, operasi gagal.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-share

function create(options?: ShareCreateOptions): Promise<ShareCreateResponse>

Parameter

options: ShareCreateOptions

Opsi untuk operasi Buat Berbagi.

Mengembalikan

Promise<ShareCreateResponse>

Data respons untuk operasi Buat Berbagi.

Membuat subdirektori baru di bawah berbagi ini.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-directory

function createDirectory(directoryName: string, options?: DirectoryCreateOptions): Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Parameter

directoryName: string

options: DirectoryCreateOptions

Opsi untuk operasi Buat Direktori.

Mengembalikan

Promise<{ directoryClient: ShareDirectoryClient, directoryCreateResponse: DirectoryCreateResponse }>

Data respons pembuatan direktori dan klien direktori yang sesuai.

Membuat file baru atau mengganti file di bawah direktori akar berbagi ini. Perhatikan bahwa file hanya menginisialisasi file tanpa konten.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-file

function createFile(fileName: string, size: number, options?: FileCreateOptions): Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Parameter

fileName: string

size: number

Menentukan ukuran maksimum dalam byte untuk file, hingga 4 TB.

options: FileCreateOptions

Opsi untuk operasi Buat File.

Mengembalikan

Promise<{ fileClient: ShareFileClient, fileCreateResponse: FileCreateResponse }>

Data respons pembuatan file dan klien file yang sesuai.

Membuat berbagi baru di bawah akun yang ditentukan. Jika berbagi dengan nama yang sama sudah ada, itu tidak diubah.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-share

function createIfNotExists(options?: ShareCreateOptions): Promise<ShareCreateIfNotExistsResponse>

Parameter

options: ShareCreateOptions

Mengembalikan

Promise<ShareCreateIfNotExistsResponse>

Membuat izin file (deskriptor keamanan) di tingkat berbagi. Deskriptor keamanan yang dibuat dapat digunakan untuk file/direktori dalam berbagi.

Lihat https://learn.microsoft.com/rest/api/storageservices/create-permission

function createPermission(filePermission: string | SharePermission, options?: ShareCreatePermissionOptions): Promise<ShareCreatePermissionResponse>

Parameter

filePermission: string | SharePermission

Izin file yang dijelaskan dalam SDDL

options: ShareCreatePermissionOptions

Opsi untuk operasi Buat Izin Berbagi.

Mengembalikan

Promise<ShareCreatePermissionResponse>

Membuat rekam jepret berbagi baca-saja.

function createSnapshot(options?: ShareCreateSnapshotOptions): Promise<ShareCreateSnapshotResponse>

Parameter

options: ShareCreateSnapshotOptions

Opsi untuk berbagi operasi Buat Rekam Jepret.

Mengembalikan

Promise<ShareCreateSnapshotResponse>

Data respons untuk operasi Buat Rekam Jepret Berbagi.

Menandai berbagi yang ditentukan untuk dihapus. Berbagi dan direktori atau file apa pun yang terkandung di dalamnya kemudian dihapus selama pengumpulan sampah.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-share

function delete(options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Parameter

options: ShareDeleteMethodOptions

Opsi untuk operasi Hapus Berbagi.

Mengembalikan

Promise<ShareDeleteResponse>

Data respons untuk operasi Hapus Berbagi.

Menghapus sub direktori kosong yang ditentukan di bawah berbagi ini. Perhatikan bahwa direktori harus kosong sebelum dapat dihapus.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-directory

function deleteDirectory(directoryName: string, options?: DirectoryDeleteOptions): Promise<DirectoryDeleteResponse>

Parameter

directoryName: string

options: DirectoryDeleteOptions

Opsi untuk operasi Hapus Direktori.

Mengembalikan

Promise<DirectoryDeleteResponse>

Data respons penghapusan direktori.

Menghapus file di bawah direktori akar berbagi ini dari akun penyimpanan. Ketika file berhasil dihapus, file segera dihapus dari indeks akun penyimpanan dan tidak lagi dapat diakses oleh klien. Data file kemudian dihapus dari layanan selama pengumpulan sampah.

Hapus File akan gagal dengan kode status 409 (Konflik) dan kode kesalahan SharingViolation jika file terbuka pada klien SMB.

Hapus File tidak didukung pada salinan bayangan berbagi, yang merupakan salinan berbagi baca-saja. Upaya untuk melakukan operasi ini pada rekam jepret berbagi akan gagal dengan 400 (InvalidQueryParameterValue)

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-file2

function deleteFile(fileName: string, options?: FileDeleteOptions): Promise<FileDeleteResponse>

Parameter

fileName: string

options: FileDeleteOptions

Opsi untuk operasi Penghapusan File.

Mengembalikan

Promise<FileDeleteResponse>

File Promise<FileDeleteResponse> Hapus data respons.

Menandai berbagi yang ditentukan untuk penghapusan jika ada. Berbagi dan direktori atau file apa pun yang terkandung di dalamnya kemudian dihapus selama pengumpulan sampah.

Lihat https://learn.microsoft.com/rest/api/storageservices/delete-share

function deleteIfExists(options?: ShareDeleteMethodOptions): Promise<ShareDeleteIfExistsResponse>

Parameter

options: ShareDeleteMethodOptions

Mengembalikan

Promise<ShareDeleteIfExistsResponse>

Mengembalikan true jika sumber daya berbagi Azrue yang diwakili oleh klien ini ada; false jika tidak.

CATATAN: gunakan fungsi ini dengan hati-hati karena berbagi yang ada mungkin dihapus oleh klien atau aplikasi lain. Sebaliknya berbagi baru mungkin ditambahkan oleh klien atau aplikasi lain setelah fungsi ini selesai.

function exists(options?: ShareExistsOptions): Promise<boolean>

Parameter

options: ShareExistsOptions

opsi untuk operasi Ada.

Mengembalikan

Promise<boolean>

Hanya tersedia untuk ShareClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan string untuk masuk ke URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Parameter

options: ShareGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Hanya tersedia untuk ShareClient yang dibangun dengan kredensial kunci bersama.

Menghasilkan URI Tanda Tangan Akses Bersama Layanan (SAS) berdasarkan properti klien dan parameter yang diteruskan. SAS ditandatangani oleh kredensial kunci bersama klien.

Lihat https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parameter

options: ShareGenerateSasUrlOptions

Parameter opsional.

Mengembalikan

string

URI SAS yang terdiri dari URI ke sumber daya yang diwakili oleh klien ini, diikuti dengan token SAS yang dihasilkan.

Mendapatkan izin untuk berbagi yang ditentukan. Izin menunjukkan apakah data berbagi dapat diakses secara publik.

PERINGATAN: Tanggal JavaScript akan berpotensi kehilangan presisi saat mengurai string mulai dan kedaluwarsa. Misalnya, Tanggal baru("2018-12-31T03:44:23.8827891Z").toISOString() akan mendapatkan "2018-12-31T03:44:23.882Z".

Lihat https://learn.microsoft.com/rest/api/storageservices/get-share-acl

function getAccessPolicy(options?: ShareGetAccessPolicyOptions): Promise<ShareGetAccessPolicyResponse>

Parameter

options: ShareGetAccessPolicyOptions

Mengembalikan

Promise<ShareGetAccessPolicyResponse>

Data respons untuk operasi Bagikan Dapatkan Kebijakan Akses.

Membuat objek ShareDirectoryClient.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parameter

directoryName: string

Nama direktori

Mengembalikan

ShareDirectoryClient

Objek ShareDirectoryClient untuk nama direktori yang diberikan.

Mendapatkan Security Descriptor Definition Language (SDDL) untuk kunci izin file tertentu yang menunjukkan deskriptor keamanan.

Lihat https://learn.microsoft.com/rest/api/storageservices/get-permission

function getPermission(filePermissionKey: string, options?: ShareGetPermissionOptions): Promise<ShareGetPermissionResponse>

Parameter

filePermissionKey: string

Kunci izin file yang menunjukkan pendeskripsi keamanan izin.

options: ShareGetPermissionOptions

Opsi untuk operasi Buat Izin Berbagi.

Mengembalikan

Promise<ShareGetPermissionResponse>

Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk berbagi yang ditentukan.

Lihat https://learn.microsoft.com/rest/api/storageservices/get-share-properties

PERINGATAN: Objek metadata yang dikembalikan dalam respons akan memiliki kuncinya dalam huruf kecil, bahkan jika awalnya berisi karakter huruf besar. Ini berbeda dari kunci metadata yang dikembalikan oleh metode listSharesShareServiceClient menggunakan opsi includeMetadata, yang akan mempertahankan casing aslinya.

function getProperties(options?: ShareGetPropertiesOptions): Promise<ShareGetPropertiesResponse>

Parameter

options: ShareGetPropertiesOptions

Mengembalikan

Promise<ShareGetPropertiesResponse>

Data respons untuk operasi Bagikan Dapatkan Properti.

Dapatkan ShareLeaseClient yang mengelola sewa pada file.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parameter

proposeLeaseId: string

Id sewa awal yang diusulkan.

Mengembalikan

ShareLeaseClient

Objek ShareLeaseClient baru untuk mengelola sewa pada file.

Mengambil statistik yang terkait dengan berbagi.

function getStatistics(options?: ShareGetStatisticsOptions): Promise<ShareGetStatisticsResponse>

Parameter

options: ShareGetStatisticsOptions

Mengembalikan

Promise<ShareGetStatisticsResponse>

Data respons untuk operasi Bagikan Dapatkan Statistik.

Mengatur izin untuk berbagi yang ditentukan. Izin menunjukkan apakah direktori atau file dalam berbagi dapat diakses secara publik.

Saat Anda mengatur izin untuk berbagi, izin yang ada akan diganti. Jika tidak ada shareAcl yang disediakan, berbagi ACL yang ada akan dihapus.

Saat Anda membuat kebijakan akses tersimpan pada berbagi, mungkin perlu waktu hingga 30 detik untuk diterapkan. Selama interval ini, tanda tangan akses bersama yang terkait dengan kebijakan akses tersimpan akan gagal dengan kode status 403 (Terlarang), hingga kebijakan akses menjadi aktif.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-share-acl

function setAccessPolicy(shareAcl?: SignedIdentifier[], options?: ShareSetAccessPolicyOptions): Promise<ShareSetAccessPolicyResponse>

Parameter

shareAcl: SignedIdentifier[]

Array pengidentifikasi yang ditandatangani, masing-masing memiliki Id unik dan detail kebijakan akses.

options: ShareSetAccessPolicyOptions

Mengembalikan

Promise<ShareSetAccessPolicyResponse>

Data respons untuk operasi Kebijakan Akses Set Berbagi.

Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk berbagi yang ditentukan.

Jika tidak ada opsi yang disediakan, atau tidak ada metadata yang ditentukan dalam parameter opsi, metadata berbagi akan dihapus.

Lihat https://learn.microsoft.com/rest/api/storageservices/set-share-metadata

function setMetadata(metadata?: Metadata, options?: ShareSetMetadataOptions): Promise<ShareSetMetadataResponse>

Parameter

metadata: Metadata

Jika tidak ada metadata yang disediakan, semua metadata direktori yang ada akan dihapus.

options: ShareSetMetadataOptions

Mengembalikan

Promise<ShareSetMetadataResponse>

Data respons untuk operasi Share Set Metadata.

Mengatur properti berbagi.

function setProperties(options?: ShareSetPropertiesOptions): Promise<ShareSetPropertiesResponse>

Parameter

options: ShareSetPropertiesOptions

Mengembalikan

Promise<ShareSetPropertiesResponse>

Data respons untuk operasi Properti Set Berbagi.

Peringatan

API ini sudah tidak digunakan lagi.

Use setProperties instead.

Mengatur kuota untuk berbagi yang ditentukan.

function setQuota(quotaInGB: number, options?: ShareSetQuotaOptions): Promise<ShareSetQuotaResponse>

Parameter

quotaInGB: number

Menentukan ukuran maksimum berbagi dalam gigabyte

options: ShareSetQuotaOptions

Mengembalikan

Promise<ShareSetQuotaResponse>

Data respons untuk operasi Bagikan Dapatkan Kuota.

Membuat objek ShareClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan. Berikan "" akan menghapus rekam jepret dan mengembalikan URL ke berbagi dasar.

function withSnapshot(snapshot: string): ShareClient

Parameter

snapshot: string

Tanda waktu rekam jepret.

Mengembalikan

ShareClient

Objek ShareClient baru yang identik dengan sumber tetapi dengan tanda waktu rekam jepret yang ditentukan

Bagikan melalui

ShareClient class

Konstruktor

Properti

Properti yang Diwariskan

Metode

Detail Konstruktor

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

Parameter

ShareClient(string, Pipeline, ShareClientConfig)

Parameter

ShareClient(string, string, ShareClientOptions)

Parameter

Detail Properti

name

Nilai Properti

rootDirectoryClient

Nilai Properti

Detail Properti yang Diwariskan

accountName

Nilai Properti

url

Nilai Properti

Detail Metode

create(ShareCreateOptions)

Parameter

Mengembalikan

createDirectory(string, DirectoryCreateOptions)

Parameter

Mengembalikan

createFile(string, number, FileCreateOptions)

Parameter

Mengembalikan

createIfNotExists(ShareCreateOptions)

Parameter

Mengembalikan

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Parameter

Mengembalikan

createSnapshot(ShareCreateSnapshotOptions)

Parameter

Mengembalikan

delete(ShareDeleteMethodOptions)

Parameter

Mengembalikan

deleteDirectory(string, DirectoryDeleteOptions)

Parameter

Mengembalikan

deleteFile(string, FileDeleteOptions)

Parameter

Mengembalikan

deleteIfExists(ShareDeleteMethodOptions)

Parameter

Mengembalikan

exists(ShareExistsOptions)

Parameter

Mengembalikan

generateSasStringToSign(ShareGenerateSasUrlOptions)

Parameter

Mengembalikan

generateSasUrl(ShareGenerateSasUrlOptions)

Parameter

Mengembalikan

getAccessPolicy(ShareGetAccessPolicyOptions)

Parameter

Mengembalikan

getDirectoryClient(string)

Parameter

Mengembalikan

getPermission(string, ShareGetPermissionOptions)

Parameter

Mengembalikan

getProperties(ShareGetPropertiesOptions)

Parameter

Mengembalikan

getShareLeaseClient(string)

Parameter

Mengembalikan

getStatistics(ShareGetStatisticsOptions)

Parameter