ShareURL class

Paket:

@azure/storage-file

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

Extends

StorageURL

Oluşturucular

ShareURL(string, Pipeline)

ShareURL örneği oluşturur.

Özellikler

pipeline	İstek ilkesi işlem hattı.
url	URL dizesi değeri.

Yöntemler

create(Aborter, IShareCreateOptions)	Belirtilen hesap altında yeni bir paylaşım oluşturur. Aynı ada sahip paylaşım zaten varsa işlem başarısız olur.
createPermission(Aborter, string)	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.
createSnapshot(Aborter, IShareCreateSnapshotOptions)	Paylaşımın salt okunur anlık görüntüsünü oluşturur.
delete(Aborter, IShareDeleteMethodOptions)	Belirtilen paylaşımı silinmek üzere işaretler. Paylaşım ve içindeki dizinler veya dosyalar daha sonra çöp toplama sırasında silinir.
fromServiceURL(ServiceURL, string)	ServiceURL'den ShareURL nesnesi oluşturur
getAccessPolicy(Aborter)	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.
getPermission(Aborter, string)	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.
getProperties(Aborter)	Belirtilen paylaşım için tüm kullanıcı tanımlı meta verileri ve sistem özelliklerini döndürür.
getStatistics(Aborter)	Paylaşımla ilgili istatistikleri alır.
newPipeline(Credential, INewPipelineOptions)	Kimlik bilgisi sağlanan yeni bir İşlem Hattı nesnesi oluşturmak için kullanılan statik bir yöntem.
setAccessPolicy(Aborter, ISignedIdentifier[])	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.
setMetadata(Aborter, IMetadata)	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.
setQuota(Aborter, number)	Belirtilen paylaşım için kotayı ayarlar.
withPipeline(Pipeline)	Kaynakla aynı ancak belirtilen istek ilkesi işlem hattıyla yeni bir ShareURL nesnesi oluşturur.
withSnapshot(string)	Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir ShareURL 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ı

ShareURL(string, Pipeline)

ShareURL örneği oluşturur.

new ShareURL(url: string, pipeline: Pipeline)

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.

pipeline

Pipeline

Varsayılan işlem hattı oluşturmak veya özelleştirilmiş bir işlem hattı sağlamak için StorageURL.newPipeline() öğesini çağırabilirsiniz.

Özellik Ayrıntıları

pipeline

İstek ilkesi işlem hattı.

pipeline: Pipeline

Özellik Değeri

Pipeline

url

URL dizesi değeri.

url: string

Özellik Değeri

string

Yöntem Ayrıntıları

create(Aborter, IShareCreateOptions)

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

function create(aborter: Aborter, options?: IShareCreateOptions)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

options

IShareCreateOptions

Döndürülenler

Promise<Models.ShareCreateResponse>

createPermission(Aborter, string)

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.

function createPermission(aborter: Aborter, filePermission: string)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

filePermission

string

SDDL'de açıklanan dosya izni

Döndürülenler

Promise<Models.ShareCreatePermissionResponse>

createSnapshot(Aborter, IShareCreateSnapshotOptions)

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

function createSnapshot(aborter: Aborter, options?: IShareCreateSnapshotOptions)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

options

IShareCreateSnapshotOptions

Döndürülenler

Promise<Models.ShareCreateSnapshotResponse>

delete(Aborter, IShareDeleteMethodOptions)

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

function delete(aborter: Aborter, options?: IShareDeleteMethodOptions)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

options

IShareDeleteMethodOptions

Döndürülenler

Promise<Models.ShareDeleteResponse>

fromServiceURL(ServiceURL, string)

ServiceURL'den ShareURL nesnesi oluşturur

static function fromServiceURL(serviceURL: ServiceURL, shareName: string)

Parametreler

serviceURL

ServiceURL

shareName

string

Döndürülenler

ShareURL

getAccessPolicy(Aborter)

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.

function getAccessPolicy(aborter: Aborter)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

Döndürülenler

Promise<ShareGetAccessPolicyResponse>

getPermission(Aborter, string)

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.

function getPermission(aborter: Aborter, filePermissionKey: string)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

filePermissionKey

string

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

Döndürülenler

Promise<Models.ShareGetPermissionResponse>

getProperties(Aborter)

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

function getProperties(aborter: Aborter)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

Döndürülenler

Promise<Models.ShareGetPropertiesResponse>

getStatistics(Aborter)

Paylaşımla ilgili istatistikleri alır.

function getStatistics(aborter: Aborter)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

Döndürülenler

Promise<ShareGetStatisticsResponse>

newPipeline(Credential, INewPipelineOptions)

Kimlik bilgisi sağlanan yeni bir İşlem Hattı nesnesi oluşturmak için kullanılan statik bir yöntem.

static function newPipeline(credential: Credential, pipelineOptions?: INewPipelineOptions)

Parametreler

credential

Credential

AnonymousCredential, SharedKeyCredential gibi.

pipelineOptions

INewPipelineOptions

Döndürülenler

Pipeline

Yeni bir İşlem Hattı nesnesi.

setAccessPolicy(Aborter, ISignedIdentifier[])

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.

function setAccessPolicy(aborter: Aborter, shareAcl?: ISignedIdentifier[])

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

shareAcl

ISignedIdentifier[]

Döndürülenler

Promise<Models.ShareSetAccessPolicyResponse>

setMetadata(Aborter, IMetadata)

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.

function setMetadata(aborter: Aborter, metadata?: IMetadata)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

metadata

IMetadata

Döndürülenler

Promise<Models.ShareSetMetadataResponse>

setQuota(Aborter, number)

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

function setQuota(aborter: Aborter, quotaInGB: number)

Parametreler

aborter

Aborter

aborter.none veya Aborter.timeout() ile yeni bir Aborter örneği oluşturun, istek iptali hakkında daha fazla örnek için Aborter belgelerine gidin

quotaInGB

number

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

Döndürülenler

Promise<Models.ShareSetQuotaResponse>

withPipeline(Pipeline)

Kaynakla aynı ancak belirtilen istek ilkesi işlem hattıyla yeni bir ShareURL nesnesi oluşturur.

function withPipeline(pipeline: Pipeline)

Parametreler

pipeline

Pipeline

Döndürülenler

ShareURL

withSnapshot(string)

Kaynakla aynı ancak belirtilen anlık görüntü zaman damgasıyla yeni bir ShareURL 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)

Parametreler

snapshot

string

Döndürülenler

ShareURL

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