ShareClient class

Pakiet:: @azure/storage-file-share

Obiekt ShareClient reprezentuje adres URL udziału usługi Azure Storage, który umożliwia manipulowanie jego katalogami i plikami.

Rozszerzenie: StorageClient

Konstruktory

ShareClient(string, Credential \| TokenCredential, ShareClientOptions)	Tworzy wystąpienie klasy ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Tworzy wystąpienie klasy ShareClient.
ShareClient(string, string, ShareClientOptions)

Właściwości

name

Nazwa udziału

rootDirectoryClient

Pobiera klienta katalogu dla katalogu głównego tego udziału. Należy pamiętać, że katalog główny zawsze istnieje i nie można go usunąć.

Nowy obiekt ShareDirectoryClient dla katalogu głównego.

Właściwości dziedziczone

accountName
url	Wartość ciągu adresu URL.

Metody

create(ShareCreateOptions)	Tworzy nowy udział na określonym koncie. Jeśli udział o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-share
createDirectory(string, DirectoryCreateOptions)	Tworzy nowy podkatalog w ramach tego udziału. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-directory
createFile(string, number, FileCreateOptions)	Tworzy nowy plik lub zastępuje plik w katalogu głównym tego udziału. Pamiętaj, że inicjuje tylko plik bez zawartości. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-file
createIfNotExists(ShareCreateOptions)	Tworzy nowy udział na określonym koncie. Jeśli udział o tej samej nazwie już istnieje, nie zostanie zmieniony. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-share
createPermission(string \| SharePermission, ShareCreatePermissionOptions)	Tworzy uprawnienie do pliku (deskryptor zabezpieczeń) na poziomie udziału. Utworzony deskryptor zabezpieczeń może być używany dla plików/katalogów w udziale. Zobacz https://learn.microsoft.com/rest/api/storageservices/create-permission
createSnapshot(ShareCreateSnapshotOptions)	Tworzy migawkę udziału tylko do odczytu.
delete(ShareDeleteMethodOptions)	Oznacza określony udział do usunięcia. Udział i wszystkie zawarte w nim katalogi lub pliki zostaną później usunięte podczas odzyskiwania pamięci. Zobacz https://learn.microsoft.com/rest/api/storageservices/delete-share
deleteDirectory(string, DirectoryDeleteOptions)	Usuwa określony pusty podkatalog w tym udziale. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć. Zobacz https://learn.microsoft.com/rest/api/storageservices/delete-directory
deleteFile(string, FileDeleteOptions)	Usuwa plik w katalogu głównym tego udziału z konta magazynu. Po pomyślnym usunięciu pliku jest on natychmiast usuwany z indeksu konta magazynu i nie jest już dostępny dla klientów. Dane pliku zostaną później usunięte z usługi podczas odzyskiwania pamięci. Usuwanie pliku zakończy się niepowodzeniem z kodem stanu 409 (konflikt) i kodem błędu `SharingViolation`, jeśli plik jest otwarty na kliencie SMB. Usuwanie pliku nie jest obsługiwane w migawki udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawki udziału zakończy się niepowodzeniem z 400 (`InvalidQueryParameterValue`) Zobacz https://learn.microsoft.com/rest/api/storageservices/delete-file2
deleteIfExists(ShareDeleteMethodOptions)	Oznacza określony udział do usunięcia, jeśli istnieje. Udział i wszystkie zawarte w nim katalogi lub pliki zostaną później usunięte podczas odzyskiwania pamięci. Zobacz https://learn.microsoft.com/rest/api/storageservices/delete-share
exists(ShareExistsOptions)	Zwraca wartość true, jeśli istnieje zasób udziału Azrue reprezentowany przez tego klienta; w przeciwnym razie wartość false. UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący udział może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe udziały mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.
generateSasStringToSign(ShareGenerateSasUrlOptions)	Dostępne tylko dla elementu ShareClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego. Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta. Zobacz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
generateSasUrl(ShareGenerateSasUrlOptions)	Dostępne tylko dla elementu ShareClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego. Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta. Zobacz https://learn.microsoft.com/rest/api/storageservices/constructing-a-service-sas
getAccessPolicy(ShareGetAccessPolicyOptions)	Pobiera uprawnienia dla określonego udziału. Uprawnienia wskazują, czy dane udziału mogą być dostępne publicznie. OSTRZEŻENIE: Data języka JavaScript może utracić precyzję podczas analizowania ciągu rozpoczęcia i wygaśnięcia. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z". Zobacz https://learn.microsoft.com/rest/api/storageservices/get-share-acl
getDirectoryClient(string)	Tworzy obiekt ShareDirectoryClient.
getPermission(string, ShareGetPermissionOptions)	Pobiera język definicji deskryptora zabezpieczeń (SDDL) dla danego klucza uprawnień pliku, który wskazuje deskryptor zabezpieczeń. Zobacz https://learn.microsoft.com/rest/api/storageservices/get-permission
getProperties(ShareGetPropertiesOptions)	Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego udziału. Zobacz https://learn.microsoft.com/rest/api/storageservices/get-share-properties OSTRZEŻENIE: Obiekt `metadata` zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metodę `listShares`ShareServiceClient przy użyciu opcji `includeMetadata`, która zachowa oryginalną wielkość liter.
getShareLeaseClient(string)	Pobierz ShareLeaseClient, który zarządza dzierżawami w pliku.
getStatistics(ShareGetStatisticsOptions)	Pobiera statystyki związane z udziałem.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Ustawia uprawnienia dla określonego udziału. Uprawnienia wskazują, czy katalogi lub pliki w udziale mogą być dostępne publicznie. Po ustawieniu uprawnień dla udziału istniejące uprawnienia zostaną zastąpione. Jeśli lista ACL udziału nie zostanie podana, istniejąca lista ACL udziału zostanie usunięta. Po ustanowieniu przechowywanych zasad dostępu w udziale może upłynąć do 30 sekund. W tym interwale sygnatura dostępu współdzielonego skojarzona z zapisanymi zasadami dostępu zakończy się niepowodzeniem z kodem stanu 403 (Zabronione), dopóki zasady dostępu nie staną się aktywne. Zobacz https://learn.microsoft.com/rest/api/storageservices/set-share-acl
setMetadata(Metadata, ShareSetMetadataOptions)	Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego udziału. Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze opcji, metadane udziału zostaną usunięte. Zobacz https://learn.microsoft.com/rest/api/storageservices/set-share-metadata
setProperties(ShareSetPropertiesOptions)	Ustawia właściwości udziału.
setQuota(number, ShareSetQuotaOptions)	Ustawia limit przydziału dla określonego udziału.
withSnapshot(string)	Tworzy nowy obiekt ShareClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie adresu URL do udziału podstawowego.

Szczegóły konstruktora

Tworzy wystąpienie klasy ShareClient.

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

Parametry

url: string

Ciąg adresu URL wskazujący udział plików usługi Azure Storage, taki jak "https://myaccount.file.core.windows.net/share". Sygnaturę dostępu współdzielonego można dołączyć, jeśli jest używana funkcja AnonymousCredential, na przykład "https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Na przykład AnonymousCredential lub StorageSharedKeyCredential. Jeśli nie zostanie określony, zostanie użyty parametr AnonymousCredential.

options: ShareClientOptions

Optional. Opcje konfigurowania potoku HTTP.

Tworzy wystąpienie klasy ShareClient.

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

Parametry

url: string

pipeline: Pipeline

Wywołaj metodę newPipeline(), aby utworzyć domyślny potok lub podaj dostosowany potok.

options: ShareClientConfig

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

Parametry

connectionString: string

Parametry połączenia konta lub parametry połączenia sygnatury dostępu współdzielonego konta usługi Azure Storage. [ Uwaga — parametry połączenia konta mogą być używane tylko w środowisku uruchomieniowym NODE.JS. ] Przykład parametrów połączenia konta — przykład parametrów połączenia sygnatury dostępu współdzielonego 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

Nazwa udziału.

options: ShareClientOptions

Optional. Opcje konfigurowania potoku HTTP.

Szczegóły właściwości

Nazwa udziału

string name

Wartość właściwości

string

Pobiera klienta katalogu dla katalogu głównego tego udziału. Należy pamiętać, że katalog główny zawsze istnieje i nie można go usunąć.

Nowy obiekt ShareDirectoryClient dla katalogu głównego.

ShareDirectoryClient rootDirectoryClient

Wartość właściwości

ShareDirectoryClient

Szczegóły właściwości dziedziczonej

accountName: string

Wartość właściwości

string

dziedziczone z StorageClient.accountName

Wartość ciągu adresu URL.

url: string

Wartość właściwości

string

dziedziczone z StorageClient.url

Szczegóły metody

Tworzy nowy udział na określonym koncie. Jeśli udział o tej samej nazwie już istnieje, operacja zakończy się niepowodzeniem.

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

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

Parametry

options: ShareCreateOptions

Opcje udostępniania operacji tworzenia.

Zwraca

Promise<ShareCreateResponse>

Dane odpowiedzi dla operacji Tworzenia udziału.

Tworzy nowy podkatalog w ramach tego udziału.

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

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

Parametry

directoryName: string

options: DirectoryCreateOptions

Opcje operacji tworzenia katalogu.

Zwraca

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

Dane odpowiedzi tworzenia katalogu i odpowiedni klient katalogu.

Tworzy nowy plik lub zastępuje plik w katalogu głównym tego udziału. Pamiętaj, że inicjuje tylko plik bez zawartości.

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

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

Parametry

fileName: string

size: number

Określa maksymalny rozmiar w bajtach dla pliku, do 4 TB.

options: FileCreateOptions

Opcje operacji tworzenia pliku.

Zwraca

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

Dane odpowiedzi tworzenia pliku i odpowiedni klient pliku.

Tworzy nowy udział na określonym koncie. Jeśli udział o tej samej nazwie już istnieje, nie zostanie zmieniony.

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

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

Parametry

options: ShareCreateOptions

Zwraca

Promise<ShareCreateIfNotExistsResponse>

Tworzy uprawnienie do pliku (deskryptor zabezpieczeń) na poziomie udziału. Utworzony deskryptor zabezpieczeń może być używany dla plików/katalogów w udziale.

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

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

Parametry

filePermission: string | SharePermission

Uprawnienie do pliku opisane w standardzie SDDL

options: ShareCreatePermissionOptions

Opcje udostępniania operacji tworzenia uprawnień.

Zwraca

Promise<ShareCreatePermissionResponse>

Tworzy migawkę udziału tylko do odczytu.

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

Parametry

options: ShareCreateSnapshotOptions

Opcje udostępniania operacji tworzenia migawki.

Zwraca

Promise<ShareCreateSnapshotResponse>

Dane odpowiedzi dla operacji Tworzenia migawki udziału.

Oznacza określony udział do usunięcia. Udział i wszystkie zawarte w nim katalogi lub pliki zostaną później usunięte podczas odzyskiwania pamięci.

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

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

Parametry

options: ShareDeleteMethodOptions

Opcje udostępniania operacji usuwania.

Zwraca

Promise<ShareDeleteResponse>

Dane odpowiedzi dla operacji Usuwania udziału.

Usuwa określony pusty podkatalog w tym udziale. Należy pamiętać, że katalog musi być pusty, zanim będzie można go usunąć.

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

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

Parametry

directoryName: string

options: DirectoryDeleteOptions

Opcje operacji usuwania katalogu.

Zwraca

Promise<DirectoryDeleteResponse>

Dane odpowiedzi na usunięcie katalogu.

Usuwa plik w katalogu głównym tego udziału z konta magazynu. Po pomyślnym usunięciu pliku jest on natychmiast usuwany z indeksu konta magazynu i nie jest już dostępny dla klientów. Dane pliku zostaną później usunięte z usługi podczas odzyskiwania pamięci.

Usuwanie pliku zakończy się niepowodzeniem z kodem stanu 409 (konflikt) i kodem błędu SharingViolation, jeśli plik jest otwarty na kliencie SMB.

Usuwanie pliku nie jest obsługiwane w migawki udziału, która jest kopią udziału tylko do odczytu. Próba wykonania tej operacji na migawki udziału zakończy się niepowodzeniem z 400 (InvalidQueryParameterValue)

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

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

Parametry

fileName: string

options: FileDeleteOptions

Opcje operacji usuwania pliku.

Zwraca

Promise<FileDeleteResponse>

Promise<FileDeleteResponse> Dane odpowiedzi usunięcia pliku.

Oznacza określony udział do usunięcia, jeśli istnieje. Udział i wszystkie zawarte w nim katalogi lub pliki zostaną później usunięte podczas odzyskiwania pamięci.

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

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

Parametry

options: ShareDeleteMethodOptions

Zwraca

Promise<ShareDeleteIfExistsResponse>

Zwraca wartość true, jeśli istnieje zasób udziału Azrue reprezentowany przez tego klienta; w przeciwnym razie wartość false.

UWAGA: użyj tej funkcji z ostrożnością, ponieważ istniejący udział może zostać usunięty przez innych klientów lub aplikacje. Na odwrót nowe udziały mogą być dodawane przez innych klientów lub aplikacje po zakończeniu tej funkcji.

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

Parametry

options: ShareExistsOptions

opcje operacji Istnieje.

Zwraca

Promise<boolean>

Dostępne tylko dla elementu ShareClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje ciąg do logowania dla identyfikatora URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

function generateSasStringToSign(options: ShareGenerateSasUrlOptions): string

Parametry

options: ShareGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

Dostępne tylko dla elementu ShareClient skonstruowanego przy użyciu poświadczeń klucza współużytkowanego.

Generuje identyfikator URI sygnatury dostępu współdzielonego (SAS) usługi na podstawie właściwości i parametrów klienta przekazanych. Sygnatura dostępu współdzielonego jest podpisana przez poświadczenia klucza wspólnego klienta.

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

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parametry

options: ShareGenerateSasUrlOptions

Parametry opcjonalne.

Zwraca

string

Identyfikator URI sygnatury dostępu współdzielonego składający się z identyfikatora URI do zasobu reprezentowanego przez tego klienta, a następnie wygenerowany token SAS.

Pobiera uprawnienia dla określonego udziału. Uprawnienia wskazują, czy dane udziału mogą być dostępne publicznie.

OSTRZEŻENIE: Data języka JavaScript może utracić precyzję podczas analizowania ciągu rozpoczęcia i wygaśnięcia. Na przykład nowa data("2018-12-31T03:44:23.8827891Z").toISOString() otrzyma wartość "2018-12-31T03:44:23.882Z".

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

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

Parametry

options: ShareGetAccessPolicyOptions

Zwraca

Promise<ShareGetAccessPolicyResponse>

Dane odpowiedzi dla operacji Uzyskiwanie zasad dostępu do udziału.

Tworzy obiekt ShareDirectoryClient.

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parametry

directoryName: string

Nazwa katalogu

Zwraca

ShareDirectoryClient

Obiekt ShareDirectoryClient dla podanej nazwy katalogu.

Pobiera język definicji deskryptora zabezpieczeń (SDDL) dla danego klucza uprawnień pliku, który wskazuje deskryptor zabezpieczeń.

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

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

Parametry

filePermissionKey: string

Klucz uprawnień pliku wskazujący deskryptor zabezpieczeń uprawnienia.

options: ShareGetPermissionOptions

Opcje udostępniania operacji tworzenia uprawnień.

Zwraca

Promise<ShareGetPermissionResponse>

Zwraca wszystkie metadane zdefiniowane przez użytkownika i właściwości systemu dla określonego udziału.

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

OSTRZEŻENIE: Obiekt metadata zwrócony w odpowiedzi będzie miał klucze w małych literach, nawet jeśli pierwotnie zawierał wielkie litery. Różni się to od kluczy metadanych zwracanych przez metodę listSharesShareServiceClient przy użyciu opcji includeMetadata, która zachowa oryginalną wielkość liter.

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

Parametry

options: ShareGetPropertiesOptions

Zwraca

Promise<ShareGetPropertiesResponse>

Dane odpowiedzi dla operacji Uzyskiwanie właściwości udziału.

Pobierz ShareLeaseClient, który zarządza dzierżawami w pliku.

function getShareLeaseClient(proposeLeaseId?: string): ShareLeaseClient

Parametry

proposeLeaseId: string

Początkowy proponowany identyfikator dzierżawy.

Zwraca

ShareLeaseClient

Nowy obiekt ShareLeaseClient do zarządzania dzierżawami w pliku.

Pobiera statystyki związane z udziałem.

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

Parametry

options: ShareGetStatisticsOptions

Zwraca

Promise<ShareGetStatisticsResponse>

Dane odpowiedzi dla operacji Uzyskiwanie statystyk udziału.

Ustawia uprawnienia dla określonego udziału. Uprawnienia wskazują, czy katalogi lub pliki w udziale mogą być dostępne publicznie.

Po ustawieniu uprawnień dla udziału istniejące uprawnienia zostaną zastąpione. Jeśli lista ACL udziału nie zostanie podana, istniejąca lista ACL udziału zostanie usunięta.

Po ustanowieniu przechowywanych zasad dostępu w udziale może upłynąć do 30 sekund. W tym interwale sygnatura dostępu współdzielonego skojarzona z zapisanymi zasadami dostępu zakończy się niepowodzeniem z kodem stanu 403 (Zabronione), dopóki zasady dostępu nie staną się aktywne.

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

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

Parametry

shareAcl: SignedIdentifier[]

Tablica podpisanych identyfikatorów, z których każdy ma unikatowy identyfikator i szczegóły zasad dostępu.

options: ShareSetAccessPolicyOptions

Zwraca

Promise<ShareSetAccessPolicyResponse>

Dane odpowiedzi dla operacji Zasad dostępu zestawu udziałów.

Ustawia co najmniej jedną parę nazwa-wartość zdefiniowaną przez użytkownika dla określonego udziału.

Jeśli nie podano żadnej opcji lub żadne metadane zdefiniowane w parametrze opcji, metadane udziału zostaną usunięte.

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

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

Parametry

metadata: Metadata

Jeśli nie podano żadnych metadanych, wszystkie istniejące metadane katalogu zostaną usunięte.

options: ShareSetMetadataOptions

Zwraca

Promise<ShareSetMetadataResponse>

Dane odpowiedzi dla operacji Metadane zestawu udziałów.

Ustawia właściwości udziału.

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

Parametry

options: ShareSetPropertiesOptions

Zwraca

Promise<ShareSetPropertiesResponse>

Dane odpowiedzi dla operacji Właściwości zestawu udziałów.

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use setProperties instead.

Ustawia limit przydziału dla określonego udziału.

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

Parametry

quotaInGB: number

Określa maksymalny rozmiar udziału w gigabajtach

options: ShareSetQuotaOptions

Zwraca

Promise<ShareSetQuotaResponse>

Dane odpowiedzi dla operacji Uzyskiwanie przydziału udziału.

Tworzy nowy obiekt ShareClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki. Podaj wartość "" spowoduje usunięcie migawki i zwrócenie adresu URL do udziału podstawowego.

function withSnapshot(snapshot: string): ShareClient

Parametry

snapshot: string

Sygnatura czasowa migawki.

Zwraca

ShareClient

Nowy obiekt ShareClient identyczny ze źródłem, ale z określonym znacznikiem czasu migawki

Udostępnij za pomocą

ShareClient class

Konstruktory

Właściwości

Właściwości dziedziczone

Metody

Szczegóły konstruktora

ShareClient(string, Credential | TokenCredential, ShareClientOptions)

Parametry

ShareClient(string, Pipeline, ShareClientConfig)

Parametry

ShareClient(string, string, ShareClientOptions)

Parametry

Szczegóły właściwości

name

Wartość właściwości

rootDirectoryClient

Wartość właściwości

Szczegóły właściwości dziedziczonej

accountName

Wartość właściwości

url

Wartość właściwości

Szczegóły metody

create(ShareCreateOptions)

Parametry

Zwraca

createDirectory(string, DirectoryCreateOptions)

Parametry

Zwraca

createFile(string, number, FileCreateOptions)

Parametry

Zwraca

createIfNotExists(ShareCreateOptions)

Parametry

Zwraca

createPermission(string | SharePermission, ShareCreatePermissionOptions)

Parametry

Zwraca

createSnapshot(ShareCreateSnapshotOptions)

Parametry

Zwraca

delete(ShareDeleteMethodOptions)

Parametry

Zwraca

deleteDirectory(string, DirectoryDeleteOptions)

Parametry

Zwraca

deleteFile(string, FileDeleteOptions)

Parametry

Zwraca

deleteIfExists(ShareDeleteMethodOptions)

Parametry

Zwraca

exists(ShareExistsOptions)

Parametry

Zwraca

generateSasStringToSign(ShareGenerateSasUrlOptions)

Parametry

Zwraca

generateSasUrl(ShareGenerateSasUrlOptions)

Parametry

Zwraca

getAccessPolicy(ShareGetAccessPolicyOptions)

Parametry

Zwraca

getDirectoryClient(string)

Parametry

Zwraca

getPermission(string, ShareGetPermissionOptions)

Parametry

Zwraca

getProperties(ShareGetPropertiesOptions)

Parametry

Zwraca

getShareLeaseClient(string)

Parametry

Zwraca

getStatistics(ShareGetStatisticsOptions)

Parametry