ShareClient class

Paket:: @azure/storage-file-share

ShareClient, Azure Depolama paylaşımının dizinlerini ve dosyalarını işlemenize olanak sağlayan bir URL'yi temsil eder.

Extends: StorageClient

Oluşturucular

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	ShareClient örneği oluşturur.
ShareClient(string, Pipeline, ShareClientConfig)	ShareClient örneği oluşturur.
ShareClient(string, string, ShareClientOptions)

Özellikler

name

Paylaşımın adı

rootDirectoryClient

Bu paylaşımın kök dizini için dizin istemcisini alır. Kök dizinin her zaman var olduğunu ve silinemeyeceğini unutmayın.

Kök dizin için yeni bir ShareDirectoryClient nesnesi.

Devralınan Özellikler

accountName
url	URL dizesi değeri.

Yöntemler

create(ShareCreateOptions)	Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa işlem başarısız olur. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Bu paylaşım altında yeni bir alt dizin oluşturur. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Yeni bir dosya oluşturur veya bu paylaşımın kök dizininin altındaki bir dosyayı değiştirir. Yalnızca içeriği olmayan dosyayı başlatdığını unutmayın. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa, değiştirilmez. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Paylaşım düzeyinde bir dosya izni (güvenlik tanımlayıcısı) oluşturur. Oluşturulan güvenlik tanımlayıcısı, paylaşımdaki dosyalar/dizinler için kullanılabilir. Bkz. https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Paylaşımın salt okunur anlık görüntüsünü oluşturur.
delete(ShareDeleteMethodOptions)	Belirtilen paylaşımı silinmek üzere işaretler. Paylaşım ve içindeki dizinler veya dosyalar daha sonra çöp toplama sırasında silinir. Bkz. https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Bu paylaşım altında belirtilen boş alt dizini kaldırır. Silinebilmesi için önce dizinin boş olması gerektiğini unutmayın. Bkz. https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Bu paylaşımın kök dizini altındaki bir dosyayı depolama hesabından kaldırır. Bir dosya başarıyla silindiğinde, depolama hesabının dizininden hemen kaldırılır ve artık istemciler tarafından erişilemez. Dosyanın verileri daha sonra çöp toplama sırasında hizmetten kaldırılır. Dosya Silme işlemi, SMB istemcisinde açıksa 409 (Çakışma) durum kodu ve hata kodu `SharingViolation` başarısız olur. Dosya Sil, paylaşımın salt okunur bir kopyası olan paylaşım anlık görüntüsünde desteklenmez. Paylaşım anlık görüntüsünde bu işlemi gerçekleştirme girişimi 400 (`InvalidQueryParameterValue`) ile başarısız olur Bkz. https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Varsa, belirtilen paylaşımı silinmek üzere işaretler. Paylaşım ve içindeki dizinler veya dosyalar daha sonra çöp toplama sırasında silinir. Bkz. https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Bu istemci tarafından temsil edilen Azrue paylaşım kaynağı varsa true döndürür; false olarak ayarlayın. NOT: Mevcut bir paylaşım diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni paylaşımlar eklenebilir.
generateSasStringToSign(ShareGenerateSasUrlOptions)	Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan ShareClient için kullanılabilir. Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan ShareClient için kullanılabilir. geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)	geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)	geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır. Bkz. https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Belirtilen paylaşım için izinleri alır. İzinler, paylaşım verilerine genel olarak erişilip erişilemeyeceğini gösterir. UYARI: Başlangıç ve süre sonu dizesini ayrıştırırken JavaScript Tarihi duyarlık kaybına neden olabilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır. Bkz. https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	ShareDirectoryClient nesnesi oluşturur.
getPermission(string, ShareGetPermissionOptions)	Bir güvenlik tanımlayıcısını gösteren belirli bir dosya izin anahtarı için Güvenlik Tanımlayıcısı Tanım Dili'ni (SDDL) alır. Bkz. https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	Belirtilen paylaşım için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür. Bkz. https://learn.microsoft.com/rest/api/storageservices/get-share-properties UYARI: Yanıtta döndürülen `metadata` nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak `listShares` seçeneğini kullanarak ShareServiceClient`includeMetadata` yöntemi tarafından döndürülen meta veri anahtarlarından farklıdır.
getShareLeaseClient(string)	Dosyadaki kiraları yöneten bir ShareLeaseClient alın.
getStatistics(ShareGetStatisticsOptions)	Paylaşımla ilgili istatistikleri alır.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Belirtilen paylaşım için izinleri ayarlar. İzinler, bir paylaşımdaki dizinlere veya dosyalara genel olarak erişilip erişilemeyeceğini gösterir. Bir paylaşım için izinleri ayarladığınızda, var olan izinler değiştirilir. ShareAcl sağlanmadıysa, mevcut paylaşım ACL'i kaldırılır. Bir paylaşımda depolanmış erişim ilkesi oluşturduğunuzda, etkin olması 30 saniye kadar sürebilir. Bu aralık boyunca, depolanan erişim ilkesiyle ilişkili paylaşılan erişim imzası, erişim ilkesi etkin olana kadar 403 (Yasak) durum koduyla başarısız olur. Bkz. https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Belirtilen paylaşım için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar. Seçenek sağlanmadıysa veya seçenek parametresinde tanımlı meta veri yoksa, paylaşım meta verileri kaldırılır. Bkz. https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Paylaşımın özelliklerini ayarlar.
setQuota(number, ShareSetQuotaOptions)	Belirtilen paylaşım için kotayı ayarlar.
withSnapshot(string)	Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir ShareClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel paylaşıma bir URL döndürür.

Oluşturucu Ayrıntıları

ShareClient örneği oluşturur.

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

Parametreler

url: string

Azure Depolama dosya paylaşımını işaret eden "https://myaccount.file.core.windows.net/share" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.file.core.windows.net/share?sasString" gibi bir SAS ekleyebilirsiniz.

credential: Credential | TokenCredential

AnonymousCredential veya StorageSharedKeyCredential gibi. Belirtilmezse, AnonymousCredential kullanılır.

options: ShareClientOptions

Optional. HTTP işlem hattını yapılandırma seçenekleri.

ShareClient örneği oluşturur.

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

Parametreler

url: string

pipeline: Pipeline

Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için newPipeline() çağrısında bulunabilirsiniz.

options: ShareClientConfig

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

Parametreler

connectionString: string

Bir Azure depolama hesabının hesap bağlantı dizesi veya SAS bağlantı dizesi. [ Not - Hesap bağlantı dizesi yalnızca NODE.JS çalışma zamanında kullanılabilir. ] Hesap bağlantı dizesi örneği - SAS bağlantı dizesi örneği 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

Hisse adı.

options: ShareClientOptions

Optional. HTTP işlem hattını yapılandırma seçenekleri.

Özellik Ayrıntıları

Paylaşımın adı

string name

Özellik Değeri

string

Bu paylaşımın kök dizini için dizin istemcisini alır. Kök dizinin her zaman var olduğunu ve silinemeyeceğini unutmayın.

Kök dizin için yeni bir ShareDirectoryClient nesnesi.

ShareDirectoryClient rootDirectoryClient

Özellik Değeri

ShareDirectoryClient

Devralınan Özellik Detayları

accountName: string

Özellik Değeri

string

StorageClient.accountName'den Devralınan

URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralınan

Yöntem Ayrıntıları

Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa işlem başarısız olur.

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

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

Parametreler

options: ShareCreateOptions

Oluşturma işlemini paylaşma seçenekleri.

Döndürülenler

Promise<ShareCreateResponse>

Paylaş Oluşturma işlemi için yanıt verileri.

Bu paylaşım altında yeni bir alt dizin oluşturur.

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

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

Parametreler

directoryName: string

options: DirectoryCreateOptions

Dizin Oluşturma işlemi seçenekleri.

Döndürülenler

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

Dizin oluşturma yanıt verileri ve karşılık gelen dizin istemcisi.

Yeni bir dosya oluşturur veya bu paylaşımın kök dizininin altındaki bir dosyayı değiştirir. Yalnızca içeriği olmayan dosyayı başlatdığını unutmayın.

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

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

Parametreler

fileName: string

size: number

Dosya için bayt cinsinden en büyük boyutu (en fazla 4 TB) belirtir.

options: FileCreateOptions

Dosya Oluşturma işlemi seçenekleri.

Döndürülenler

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

Dosya oluşturma yanıt verileri ve buna karşılık gelen dosya istemcisi.

Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa, değiştirilmez.

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

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

Parametreler

options: ShareCreateOptions

Döndürülenler

Promise<ShareCreateIfNotExistsResponse>

Paylaşım düzeyinde bir dosya izni (güvenlik tanımlayıcısı) oluşturur. Oluşturulan güvenlik tanımlayıcısı, paylaşımdaki dosyalar/dizinler için kullanılabilir.

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

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

Parametreler

filePermission: string | SharePermission

SDDL'de açıklanan dosya izni

options: ShareCreatePermissionOptions

Oluşturma İzniNi Paylaşma seçenekleri.

Döndürülenler

Promise<ShareCreatePermissionResponse>

Paylaşımın salt okunur anlık görüntüsünü oluşturur.

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

Parametreler

options: ShareCreateSnapshotOptions

Anlık Görüntü Oluşturma işlemini paylaşma seçenekleri.

Döndürülenler

Promise<ShareCreateSnapshotResponse>

Anlık Görüntü Oluştur işleminin yanıt verileri.

Belirtilen paylaşımı silinmek üzere işaretler. Paylaşım ve içindeki dizinler veya dosyalar daha sonra çöp toplama sırasında silinir.

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

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

Parametreler

options: ShareDeleteMethodOptions

Silmeyi Paylaşma seçenekleri.

Döndürülenler

Promise<ShareDeleteResponse>

Paylaş Silme işlemi için yanıt verileri.

Bu paylaşım altında belirtilen boş alt dizini kaldırır. Silinebilmesi için önce dizinin boş olması gerektiğini unutmayın.

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

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

Parametreler

directoryName: string

options: DirectoryDeleteOptions

Dizin Silme işlemi seçenekleri.

Döndürülenler

Promise<DirectoryDeleteResponse>

Dizin silme yanıt verileri.

Bu paylaşımın kök dizini altındaki bir dosyayı depolama hesabından kaldırır. Bir dosya başarıyla silindiğinde, depolama hesabının dizininden hemen kaldırılır ve artık istemciler tarafından erişilemez. Dosyanın verileri daha sonra çöp toplama sırasında hizmetten kaldırılır.

Dosya Silme işlemi, SMB istemcisinde açıksa 409 (Çakışma) durum kodu ve hata kodu SharingViolation başarısız olur.

Dosya Sil, paylaşımın salt okunur bir kopyası olan paylaşım anlık görüntüsünde desteklenmez. Paylaşım anlık görüntüsünde bu işlemi gerçekleştirme girişimi 400 (InvalidQueryParameterValue) ile başarısız olur

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

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

Parametreler

fileName: string

options: FileDeleteOptions

Dosya Silme işlemi seçenekleri.

Döndürülenler

Promise<FileDeleteResponse>

Promise<FileDeleteResponse> File Delete yanıt verilerini silin.

Varsa, belirtilen paylaşımı silinmek üzere işaretler. Paylaşım ve içindeki dizinler veya dosyalar daha sonra çöp toplama sırasında silinir.

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

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

Parametreler

options: ShareDeleteMethodOptions

Döndürülenler

Promise<ShareDeleteIfExistsResponse>

Bu istemci tarafından temsil edilen Azrue paylaşım kaynağı varsa true döndürür; false olarak ayarlayın.

NOT: Mevcut bir paylaşım diğer istemciler veya uygulamalar tarafından silinebileceğinden bu işlevi dikkatli kullanın. Bu işlev tamamlandıktan sonra diğer istemciler veya uygulamalar tarafından yeni paylaşımlar eklenebilir.

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

Parametreler

options: ShareExistsOptions

seçeneklerine tıklayın.

Döndürülenler

Promise<boolean>

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan ShareClient için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini imzalamak için dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Parametreler

options: ShareGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

Yalnızca paylaşılan anahtar kimlik bilgileriyle yapılan ShareClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parametreler

options: ShareGenerateSasUrlOptions

İsteğe bağlı parametreler.

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

geçirilen istemci özelliklerine ve parametrelerine göre bir Hizmet Paylaşılan Erişim İmzası (SAS) URI'sini oluşturur. SAS, kullanıcı delegasyonu anahtarı kimlik bilgisi girişiyle imzalanır.

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

function generateUserDelegationSasUrl(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options: ShareGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey: UserDelegationKey

SAS URI'sini imzalamak için kullanılan kullanıcı delegasyonu anahtarı

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

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

function generateUserDelegationStringToSign(options: ShareGenerateSasUrlOptions, userDelegationKey: UserDelegationKey): string

Parametreler

options: ShareGenerateSasUrlOptions

İsteğe bağlı parametreler.

userDelegationKey: UserDelegationKey

SAS URI'sini imzalamak için kullanılan kullanıcı delegasyonu anahtarı

Döndürülenler

string

Bu istemci tarafından temsil edilen kaynağın URI'sini ve ardından oluşturulan SAS belirtecini içeren SAS URI'sini.

Belirtilen paylaşım için izinleri alır. İzinler, paylaşım verilerine genel olarak erişilip erişilemeyeceğini gösterir.

UYARI: Başlangıç ve süre sonu dizesini ayrıştırırken JavaScript Tarihi duyarlık kaybına neden olabilir. Örneğin, yeni Date("2018-12-31T03:44:23.8827891Z").toISOString() "2018-12-31T03:44:23.882Z" değerini alır.

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

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

Parametreler

options: ShareGetAccessPolicyOptions

Döndürülenler

Promise<ShareGetAccessPolicyResponse>

Erişim İlkesiNi Paylaş işlemi için yanıt verileri.

ShareDirectoryClient nesnesi oluşturur.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parametreler

directoryName: string

Dizin adı

Döndürülenler

ShareDirectoryClient

Verilen dizin adı için ShareDirectoryClient nesnesi.

Bir güvenlik tanımlayıcısını gösteren belirli bir dosya izin anahtarı için Güvenlik Tanımlayıcısı Tanım Dili'ni (SDDL) alır.

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

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

Parametreler

filePermissionKey: string

İznin güvenlik tanımlayıcısını gösteren dosya izin anahtarı.

options: ShareGetPermissionOptions

Oluşturma İzniNi Paylaşma seçenekleri.

Döndürülenler

Promise<ShareGetPermissionResponse>

Belirtilen paylaşım için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür.

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

UYARI: Yanıtta döndürülen metadata nesnesinin anahtarları başlangıçta büyük harf karakterler içerse bile küçük harfle gösterilir. Bu, özgün büyük/küçük harflerini koruyacak listShares seçeneğini kullanarak ShareServiceClientincludeMetadata yöntemi tarafından döndürülen meta veri anahtarlarından farklıdır.

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

Parametreler

options: ShareGetPropertiesOptions

Döndürülenler

Promise<ShareGetPropertiesResponse>

Share Get Properties işlemi için yanıt verileri.

Dosyadaki kiraları yöneten bir ShareLeaseClient alın.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametreler

proposeLeaseId: string

İlk önerilen kira kimliği.

Döndürülenler

ShareLeaseClient

Dosyadaki kiraları yönetmek için yeni bir ShareLeaseClient nesnesi.

Paylaşımla ilgili istatistikleri alır.

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

Parametreler

options: ShareGetStatisticsOptions

Döndürülenler

Promise<ShareGetStatisticsResponse>

share get statistics işlemi için yanıt verileri.

Belirtilen paylaşım için izinleri ayarlar. İzinler, bir paylaşımdaki dizinlere veya dosyalara genel olarak erişilip erişilemeyeceğini gösterir.

Bir paylaşım için izinleri ayarladığınızda, var olan izinler değiştirilir. ShareAcl sağlanmadıysa, mevcut paylaşım ACL'i kaldırılır.

Bir paylaşımda depolanmış erişim ilkesi oluşturduğunuzda, etkin olması 30 saniye kadar sürebilir. Bu aralık boyunca, depolanan erişim ilkesiyle ilişkili paylaşılan erişim imzası, erişim ilkesi etkin olana kadar 403 (Yasak) durum koduyla başarısız olur.

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

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

Parametreler

shareAcl: SignedIdentifier[]

Her biri benzersiz bir kimliğe ve erişim ilkesinin ayrıntılarına sahip olan imzalı tanımlayıcı dizisi.

options: ShareSetAccessPolicyOptions

Döndürülenler

Promise<ShareSetAccessPolicyResponse>

Paylaşım Kümesi Erişim İlkesi işlemi için yanıt verileri.

Belirtilen paylaşım için bir veya daha fazla kullanıcı tanımlı ad-değer çifti ayarlar.

Seçenek sağlanmadıysa veya seçenek parametresinde tanımlı meta veri yoksa, paylaşım meta verileri kaldırılır.

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

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

Parametreler

metadata: Metadata

Meta veri sağlanmazsa, var olan tüm dizin meta verileri kaldırılır.

options: ShareSetMetadataOptions

Döndürülenler

Promise<ShareSetMetadataResponse>

Meta Verileri Paylaş işlemi için yanıt verileri.

Paylaşımın özelliklerini ayarlar.

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

Parametreler

options: ShareSetPropertiesOptions

Döndürülenler

Promise<ShareSetPropertiesResponse>

Paylaşım Kümesi Özellikleri işlemi için yanıt verileri.

Uyarı

Bu API artık kullanım dışıdır.

Use setProperties instead.

Belirtilen paylaşım için kotayı ayarlar.

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

Parametreler

quotaInGB: number

Paylaşımın en büyük boyutunu gigabayt cinsinden belirtir

options: ShareSetQuotaOptions

Döndürülenler

Promise<ShareSetQuotaResponse>

KotaYı Paylaş işleminin yanıt verileri.

Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir ShareClient nesnesi oluşturur. "" değerini sağlayın, anlık görüntüyü kaldırır ve temel paylaşıma bir URL döndürür.

function withSnapshot(snapshot: string): ShareClient

Parametreler

snapshot: string

Anlık görüntü zaman damgası.

Döndürülenler

ShareClient

Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasına sahip yeni bir ShareClient nesnesi

Aracılığıyla paylaş

ShareClient class

Oluşturucular

Özellikler

Devralınan Özellikler

Yöntemler

Oluşturucu Ayrıntıları

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

Parametreler

ShareClient(string, Pipeline, ShareClientConfig)

Parametreler

ShareClient(string, string, ShareClientOptions)

Parametreler

Özellik Ayrıntıları

name

Özellik Değeri

rootDirectoryClient

Özellik Değeri

Devralınan Özellik Detayları

accountName

Özellik Değeri

url

Özellik Değeri

Yöntem Ayrıntıları

create(ShareCreateOptions)

Parametreler

Döndürülenler

createDirectory(string, DirectoryCreateOptions)

Parametreler

Döndürülenler

createFile(string, number, FileCreateOptions)

Parametreler

Döndürülenler

createIfNotExists(ShareCreateOptions)

Parametreler

Döndürülenler

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Parametreler

Döndürülenler

createSnapshot(ShareCreateSnapshotOptions)

Parametreler

Döndürülenler

delete(ShareDeleteMethodOptions)

Parametreler

Döndürülenler

deleteDirectory(string, DirectoryDeleteOptions)

Parametreler

Döndürülenler

deleteFile(string, FileDeleteOptions)

Parametreler

Döndürülenler

deleteIfExists(ShareDeleteMethodOptions)

Parametreler

Döndürülenler

exists(ShareExistsOptions)

Parametreler

Döndürülenler

generateSasStringToSign(ShareGenerateSasUrlOptions)

Parametreler

Döndürülenler

generateSasUrl(ShareGenerateSasUrlOptions)

Parametreler

Döndürülenler

generateUserDelegationSasUrl(ShareGenerateSasUrlOptions, UserDelegationKey)

Parametreler

Döndürülenler

generateUserDelegationStringToSign(ShareGenerateSasUrlOptions, UserDelegationKey)

Parametreler

Döndürülenler

getAccessPolicy(ShareGetAccessPolicyOptions)

Parametreler

Döndürülenler

getDirectoryClient(string)

Parametreler

Döndürülenler

getPermission(string, ShareGetPermissionOptions)

Parametreler

Döndürülenler

getProperties(ShareGetPropertiesOptions)

Parametreler