Aracılığıyla paylaş

ShareServiceClient class

Paket:
@azure/storage-file-share

ShareServiceClient, Dosya paylaşımlarını işlemenize olanak sağlayan Azure Depolama Dosyası hizmetinin URL'sini temsil eder.

Extends

StorageClient

Oluşturucular

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

ShareServiceClient örneği oluşturur.
ShareServiceClient(string, Pipeline, ShareClientConfig)

ShareServiceClient örneği oluşturur.

Devralınan Özellikler

accountName
url

URL dizesi değeri.

Yöntemler

createShare(string, ShareCreateOptions)

Paylaşım oluşturur.
deleteShare(string, ShareDeleteMethodOptions)

Paylaşımı siler.
fromConnectionString(string, ShareClientOptions)

Bağlantı dizesinden bir ShareServiceClient örneği oluşturur.
generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen ShareServiceClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir hesap 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/create-account-sas
generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen ShareServiceClient için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) URI'sine imza atacak dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/create-account-sas
getProperties(ServiceGetPropertiesOptions)

Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının dosya hizmetinin özelliklerini alır.

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-file-service-properties
getShareClient(string)

ShareClient nesnesi oluşturur.
getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

SADECE BEARER TOKEN AUTHENTICATION (TokenCredential) kullanıldığında erişilebilirdir.

Dosya servisi için kullanıcı delegasyon anahtarını alır. Bu işlem yalnızca taşıyıcı token doğrulaması kullanıldığında geçerli bir işlemdir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key
listShares(ServiceListSharesOptions)

Belirtilen hesap altındaki tüm paylaşımları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki paylaşımları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const share of serviceClient.listShares()) {
  console.log(`Share${i++}: ${share.name}`);
}

iter.next()kullanan örnek:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareIter = serviceClient.listShares();
let i = 1;
let { value, done } = await shareIter.next();
while (!done) {
  console.log(`Share ${i++}: ${value.name}`);
  ({ value, done } = await shareIter.next());
}

byPage()kullanan örnek:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  console.log(`Page ${i++}:`);
  for (const share of response.shareItems || []) {
    console.log(`\tShare: ${share.name}`);
  }
}

İşaretçi ile disk belleği kullanma örneği:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken
iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}
setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Depolama Analizi, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları gibi depolama hesabının dosya hizmeti uç noktasının özelliklerini ayarlar.

Bkz. https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties
undeleteShare(string, string, ServiceUndeleteShareOptions)

Daha önce silinmiş bir paylaşımı geri yükler. Bu API yalnızca paylaşımla ilişkilendirilmiş depolama hesabı için Geçici Silme Paylaş etkinleştirildiğinde çalışır.

Oluşturucu Ayrıntıları

ShareServiceClient(string, Credential | TokenCredential, ShareClientOptions)

ShareServiceClient örneği oluşturur.

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

Parametreler

url

string

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

credential

Credential | TokenCredential

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

options
ShareClientOptions

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

ShareServiceClient(string, Pipeline, ShareClientConfig)

ShareServiceClient örneği oluşturur.

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

Parametreler

url

string

Azure Depolama dosya hizmetine işaret eden "https://myaccount.file.core.windows.net" gibi bir URL dizesi. AnonymousCredential kullanıyorsanız , "https://myaccount.file.core.windows.net?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 newPipeline() çağrısında bulunabilirsiniz.

options
ShareClientConfig

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

Devralınan Özellik Detayları

accountName 

accountName: string

Özellik Değeri

string

StorageClient.accountName'den Devralınan

url

URL dizesi değeri.

url: string

Özellik Değeri

string

StorageClient.url'den Devralınan

Yöntem Ayrıntıları

createShare(string, ShareCreateOptions)

Paylaşım oluşturur.

function createShare(shareName: string, options?: ShareCreateOptions): Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

Parametreler

shareName

string

options
ShareCreateOptions

Döndürülenler

Promise<{ shareClient: ShareClient, shareCreateResponse: ShareCreateResponse }>

Paylaşım oluşturma yanıtı ve karşılık gelen paylaşım istemcisi.

deleteShare(string, ShareDeleteMethodOptions)

Paylaşımı siler.

function deleteShare(shareName: string, options?: ShareDeleteMethodOptions): Promise<ShareDeleteResponse>

Parametreler

shareName

string

options
ShareDeleteMethodOptions

Döndürülenler

Promise<ShareDeleteResponse>

Paylaşım silme yanıtı ve karşılık gelen paylaşım istemcisi.

fromConnectionString(string, ShareClientOptions)

Bağlantı dizesinden bir ShareServiceClient örneği oluşturur.

static function fromConnectionString(connectionString: string, options?: ShareClientOptions): ShareServiceClient

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

options
ShareClientOptions

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

Döndürülenler

ShareServiceClient

Verilen bağlantı dizesinden yeni bir ShareServiceClient.

generateAccountSasUrl(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen ShareServiceClient için kullanılabilir.

geçirilen istemci özelliklerine ve parametrelerine göre bir hesap 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/create-account-sas

function generateAccountSasUrl(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parametreler

expiresOn

Date

Optional. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Belirtilmezse varsayılan olarak bir saat sonraya ayarlanmıştır.

permissions
AccountSASPermissions

SAS ile ilişkilendirilecek izinlerin listesini belirtir.

resourceTypes

string

Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.

options
ServiceGenerateAccountSasUrlOptions

İ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 bir hesap SAS URI'si.

generateSasStringToSign(Date, AccountSASPermissions, string, ServiceGenerateAccountSasUrlOptions)

Yalnızca paylaşılan anahtar kimlik bilgileriyle derlenen ShareServiceClient için kullanılabilir.

Geçirilen istemci özelliklerine ve parametrelerine göre bir hesap Paylaşılan Erişim İmzası (SAS) URI'sine imza atacak dize oluşturur. SAS, istemcinin paylaşılan anahtar kimlik bilgileriyle imzalanır.

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

function generateSasStringToSign(expiresOn?: Date, permissions?: AccountSASPermissions, resourceTypes?: string, options?: ServiceGenerateAccountSasUrlOptions): string

Parametreler

expiresOn

Date

Optional. Paylaşılan erişim imzasının geçersiz hale geldiği saat. Belirtilmezse varsayılan olarak bir saat sonraya ayarlanmıştır.

permissions
AccountSASPermissions

SAS ile ilişkilendirilecek izinlerin listesini belirtir.

resourceTypes

string

Paylaşılan erişim imzası ile ilişkili kaynak türlerini belirtir.

options
ServiceGenerateAccountSasUrlOptions

İ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 bir hesap SAS URI'si.

getProperties(ServiceGetPropertiesOptions)

Depolama Analizi ve CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kurallarının özellikleri de dahil olmak üzere depolama hesabının dosya hizmetinin özelliklerini alır.

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

function getProperties(options?: ServiceGetPropertiesOptions): Promise<ServiceGetPropertiesResponse>

Parametreler

options
ServiceGetPropertiesOptions

Özellikleri Alma işlemi seçenekleri.

Döndürülenler

Promise<ServiceGetPropertiesResponse>

Özellikleri Al işlemi için yanıt verileri.

getShareClient(string)

ShareClient nesnesi oluşturur.

function getShareClient(shareName: string): ShareClient

Parametreler

shareName

string

Paylaşımın adı.

Döndürülenler

ShareClient

Verilen paylaşım adı için ShareClient nesnesi.

Örnek kullanım:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareName = "<share name>";
const shareClient = serviceClient.getShareClient(shareName);
await shareClient.create();

getUserDelegationKey(Date, Date, ServiceGetUserDelegationKeyOptions)

SADECE BEARER TOKEN AUTHENTICATION (TokenCredential) kullanıldığında erişilebilirdir.

Dosya servisi için kullanıcı delegasyon anahtarını alır. Bu işlem yalnızca taşıyıcı token doğrulaması kullanıldığında geçerli bir işlemdir.

Bkz. https://learn.microsoft.com/rest/api/storageservices/get-user-delegation-key

function getUserDelegationKey(startsOn: Date, expiresOn: Date, options?: ServiceGetUserDelegationKeyOptions): Promise<ServiceGetUserDelegationKeyResponse>

Parametreler

startsOn

Date

Kullanıcı delegasyonu SAS'ın başlangıç zamanı. Mevcut saatten 7 gün içinde olmalı

expiresOn

Date

Kullanıcı delegasyonu SAS'ın son zamanı. Mevcut saatten 7 gün içinde olmalı

options
ServiceGetUserDelegationKeyOptions

Döndürülenler

Promise<ServiceGetUserDelegationKeyResponse>

listShares(ServiceListSharesOptions)

Belirtilen hesap altındaki tüm paylaşımları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

.byPage() sayfalardaki paylaşımları listelemek için zaman uyumsuz bir yinelenebilir yineleyici döndürür.

for await söz dizimi kullanan örnek:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const share of serviceClient.listShares()) {
  console.log(`Share${i++}: ${share.name}`);
}

iter.next()kullanan örnek:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

const shareIter = serviceClient.listShares();
let i = 1;
let { value, done } = await shareIter.next();
while (!done) {
  console.log(`Share ${i++}: ${value.name}`);
  ({ value, done } = await shareIter.next());
}

byPage()kullanan örnek:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let i = 1;
for await (const response of serviceClient.listShares().byPage({ maxPageSize: 20 })) {
  console.log(`Page ${i++}:`);
  for (const share of response.shareItems || []) {
    console.log(`\tShare: ${share.name}`);
  }
}

İşaretçi ile disk belleği kullanma örneği:

import { StorageSharedKeyCredential, ShareServiceClient } from "@azure/storage-file-share";

const account = "<account>";
const accountKey = "<accountkey>";

const credential = new StorageSharedKeyCredential(account, accountKey);
const serviceClient = new ShareServiceClient(
  `https://${account}.file.core.windows.net`,
  credential,
);

let iterator = serviceClient.listShares().byPage({ maxPageSize: 2 });
let response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

// Gets next marker
let marker = response.continuationToken;

// Passing next marker as continuationToken
iterator = serviceClient.listShares().byPage({ continuationToken: marker, maxPageSize: 10 });
response = (await iterator.next()).value;

for await (const share of response.shareItems || []) {
  console.log(`\tShare: ${share.name}`);
}

function listShares(options?: ServiceListSharesOptions): PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

Parametreler

options
ServiceListSharesOptions

Paylaşımları listeleme işlemi seçenekleri.

Disk belleğini destekleyen asyncIterableIterator.

Döndürülenler

PagedAsyncIterableIterator<ShareItem, ServiceListSharesSegmentResponse, PageSettings>

setProperties(FileServiceProperties, ServiceSetPropertiesOptions)

Depolama Analizi, CORS (Çıkış Noktaları Arası Kaynak Paylaşımı) kuralları ve geçici silme ayarları gibi depolama hesabının dosya hizmeti uç noktasının özelliklerini ayarlar.

Bkz. https://learn.microsoft.com/rest/api/storageservices/set-file-service-properties

function setProperties(properties: FileServiceProperties, options?: ServiceSetPropertiesOptions): Promise<ServiceSetPropertiesResponse>

Parametreler

properties
FileServiceProperties
options
ServiceSetPropertiesOptions

Özellikleri Ayarlama işlemi seçenekleri.

Döndürülenler

Promise<ServiceSetPropertiesResponse>

Özellikleri Ayarla işlemi için yanıt verileri.

undeleteShare(string, string, ServiceUndeleteShareOptions)

Daha önce silinmiş bir paylaşımı geri yükler. Bu API yalnızca paylaşımla ilişkilendirilmiş depolama hesabı için Geçici Silme Paylaş etkinleştirildiğinde çalışır.

function undeleteShare(deletedShareName: string, deletedShareVersion: string, options?: ServiceUndeleteShareOptions): Promise<ShareClient>

Parametreler

deletedShareName

string

Daha önce silinen paylaşımın adı.

deletedShareVersion

string

Daha önce silinen paylaşımın sürümü.

options
ServiceUndeleteShareOptions

Silme işlemini paylaşma seçenekleri.

Döndürülenler

Promise<ShareClient>

Paylaşım geri yüklendi.