ShareClient class

Referenz

Paket:: @azure/storage-file-share

Ein ShareClient stellt eine URL zur Azure Storage-Freigabe dar, mit der Sie ihre Verzeichnisse und Dateien bearbeiten können.

Extends: StorageClient

Konstruktoren

ShareClient(string, Credential_2 \| TokenCredential, ShareClientOptions)	Erstellt eine Instanz von ShareClient.
ShareClient(string, Pipeline, ShareClientConfig)	Erstellt eine Instanz von ShareClient.
ShareClient(string, string, ShareClientOptions)

Eigenschaften

name

Der Name der Freigabe

rootDirectoryClient

Ruft den Verzeichnisclient für das Stammverzeichnis dieser Freigabe ab. Beachten Sie, dass das Stammverzeichnis immer vorhanden ist und nicht gelöscht werden kann.

Ein neues ShareDirectoryClient-Objekt für das Stammverzeichnis.

Geerbte Eigenschaften

accountName
url	URL-Zeichenfolgenwert.

Methoden

create(ShareCreateOptions)	Erstellt eine neue Freigabe unter dem angegebenen Konto. Wenn eine Freigabe mit demselben Namen bereits vorhanden ist, misslingt der Vorgang. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-share.
createDirectory(string, DirectoryCreateOptions)	Erstellt ein neues Unterverzeichnis unter dieser Freigabe. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory.
createFile(string, number, FileCreateOptions)	Erstellt eine neue Datei oder ersetzt eine Datei im Stammverzeichnis dieser Freigabe. Beachten Sie, dass die Datei nur ohne Inhalt initialisiert wird. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-file.
createIfNotExists(ShareCreateOptions)	Erstellt eine neue Freigabe unter dem angegebenen Konto. Wenn die Freigabe mit demselben Namen bereits vorhanden ist, wird sie nicht geändert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-share.
createPermission(string, ShareCreatePermissionOptions)	Erstellt eine Dateiberechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene. Der erstellte Sicherheitsdeskriptor kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission.
createSnapshot(ShareCreateSnapshotOptions)	Erstellt eine schreibgeschützte Momentaufnahme einer Freigabe.
delete(ShareDeleteMethodOptions)	Markiert die angegebene Freigabe zum Löschen. Die Freigabe und alle darin enthaltenen Verzeichnisse oder Dateien werden später während der Garbage Collection gelöscht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share.
deleteDirectory(string, DirectoryDeleteOptions)	Entfernt das angegebene leere Unterverzeichnis unter dieser Freigabe. Beachten Sie, dass das Verzeichnis leer sein muss, es kann sonst nicht gelöscht werden. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory.
deleteFile(string, FileDeleteOptions)	Entfernt eine Datei unter dem Stammverzeichnis dieser Freigabe aus dem Speicherkonto. Beim erfolgreichen Löschen einer Datei wird diese sofort aus dem Index des Speicherkontos entfernt, und Clients haben keinen Zugriff mehr darauf. Die Daten der Datei werden später während der automatischen Speicherbereinigung aus dem Dienst entfernt. Datei löschen schlägt mit Statuscode 409 (Konflikt) und Fehlercode `SharingViolation` fehl, wenn die Datei auf einem SMB-Client geöffnet ist. Datei löschen wird für eine Freigabemomentaufnahme, die eine schreibgeschützte Kopie einer Freigabe ist, nicht unterstützt. Ein Versuch, diesen Vorgang für eine Freigabemomentaufnahme auszuführen, schlägt mit 400 (`InvalidQueryParameterValue`) fehl. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.
deleteIfExists(ShareDeleteMethodOptions)	Markiert die angegebene Freigabe zum Löschen, sofern vorhanden. Die Freigabe und alle darin enthaltenen Verzeichnisse oder Dateien werden später während der Garbage Collection gelöscht. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share.
exists(ShareExistsOptions)	Gibt true zurück, wenn die von diesem Client dargestellte Azrue-Freigaberessource vorhanden ist. false andernfalls. HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, da eine vorhandene Freigabe möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Freigaben von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.
generateSasUrl(ShareGenerateSasUrlOptions)	Nur für ShareClient verfügbar, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde. Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.
getAccessPolicy(ShareGetAccessPolicyOptions)	Ruft die Berechtigungen für die angegebene Freigabe ab. Die Berechtigungen geben an, ob auf Freigabedaten öffentlich zugegriffen werden darf. WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge an Genauigkeit verlieren. New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z". Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl.
getDirectoryClient(string)	Erstellt ein ShareDirectoryClient-Objekt .
getPermission(string, ShareGetPermissionOptions)	Ruft die Security Descriptor Definition Language (SDDL) für einen bestimmten Dateiberechtigungsschlüssel ab, der einen Sicherheitsdeskriptor angibt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission.
getProperties(ShareGetPropertiesOptions)	Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Freigabe zurück. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties. WARNUNG: Das `metadata` in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von der `listShares`ShareServiceClient-Methode mit der `includeMetadata` Option zurückgegeben werden, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.
getStatistics(ShareGetStatisticsOptions)	Ruft Statistiken ab, die sich auf die Freigabe beziehen.
setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)	Legt die Berechtigungen für die angegebene Freigabe fest. Die Berechtigungen geben an, ob auf Verzeichnisse oder Dateien in einer Freigabe öffentlich zugegriffen werden kann. Wenn Sie Berechtigungen für eine Freigabe festlegen, werden die vorhandenen Berechtigungen ersetzt. Wenn kein shareAcl bereitgestellt wird, wird die vorhandene Freigabe-ACL entfernt. Wenn Sie eine gespeicherte Zugriffsrichtlinie für eine Freigabe einrichten, kann es bis zu 30 Sekunden dauern, bis sie wirksam wird. Während dieses Intervalls schlägt eine SAS, die der gespeicherten Zugriffsrichtlinie zugeordnet ist, mit dem Statuscode 403 (Unzulässig) so lange fehl, bis die Zugriffsrichtlinie aktiv ist. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl.
setMetadata(Metadata, ShareSetMetadataOptions)	Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für die angegebene Freigabe fest. Wenn keine Option oder keine Metadaten im Optionsparameter definiert sind, werden die Freigabemetadaten entfernt. Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata.
setProperties(ShareSetPropertiesOptions)	Legt die Eigenschaften der Freigabe fest.
setQuota(number, ShareSetQuotaOptions)	Legt das Kontingent für die angegebene Freigabe fest.
withSnapshot(string)	Erstellt ein neues ShareClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und eine URL an die Basisfreigabe zurückzugeben.

Details zum Konstruktor

Erstellt eine Instanz von ShareClient.

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

Parameter

url: string

Eine URL-Zeichenfolge, die auf die Azure Storage-Dateifreigabe zeigt, z. B. "https://myaccount.file.core.windows.net/share"". Sie können eine SAS anfügen, wenn Sie AnonymousCredential verwenden, z. B. "https://myaccount.file.core.windows.net/share?sasString".

credential: Credential | TokenCredential

Beispielsweise AnonymousCredential oder StorageSharedKeyCredential. Wenn nicht angegeben, wird AnonymousCredential verwendet.

options: ShareClientOptions

Dies ist optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Erstellt eine Instanz von ShareClient.

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

Parameter

url: string

pipeline: Pipeline

Rufen Sie newPipeline() auf, um eine Standardpipeline zu erstellen, oder stellen Sie eine benutzerdefinierte Pipeline bereit.

options: ShareClientConfig

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

Parameter

connectionString: string

Kontoverbindungszeichenfolge oder SAS-Verbindungszeichenfolge eines Azure-Speicherkontos. [ Hinweis: Die Kontoverbindungszeichenfolge kann nur in NODE.JS Runtime verwendet werden. ] Beispiel für eine Kontoverbindungszeichenfolge :DefaultEndpointsProtocol=https;AccountName=myaccount;AccountKey=accountKey;EndpointSuffix=core.windows.net Beispiel für eine SAS-Verbindungszeichenfolge: 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

Freigabename.

options: ShareClientOptions

Dies ist optional. Optionen zum Konfigurieren der HTTP-Pipeline.

Details zur Eigenschaft

Der Name der Freigabe

string name

Eigenschaftswert

string

Ruft den Verzeichnisclient für das Stammverzeichnis dieser Freigabe ab. Beachten Sie, dass das Stammverzeichnis immer vorhanden ist und nicht gelöscht werden kann.

Ein neues ShareDirectoryClient-Objekt für das Stammverzeichnis.

ShareDirectoryClient rootDirectoryClient

Eigenschaftswert

ShareDirectoryClient

Geerbte Eigenschaftsdetails

accountName: string

Eigenschaftswert

string

Geerbt von StorageClient.accountName

URL-Zeichenfolgenwert.

url: string

Eigenschaftswert

string

Geerbt von StorageClient.url

Details zur Methode

Erstellt eine neue Freigabe unter dem angegebenen Konto. Wenn eine Freigabe mit demselben Namen bereits vorhanden ist, misslingt der Vorgang.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-share.

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

Parameter

options: ShareCreateOptions

Optionen zum Freigeben des Erstellungsvorgangs.

Gibt zurück

Promise<ShareCreateResponse>

Antwortdaten für den Vorgang "Freigabe erstellen".

Erstellt ein neues Unterverzeichnis unter dieser Freigabe.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-directory.

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

Parameter

directoryName: string

options: DirectoryCreateOptions

Optionen zum Verzeichniserstellungsvorgang.

Gibt zurück

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

Antwortdaten für die Verzeichniserstellung und den entsprechenden Verzeichnisclient.

Erstellt eine neue Datei oder ersetzt eine Datei im Stammverzeichnis dieser Freigabe. Beachten Sie, dass die Datei nur ohne Inhalt initialisiert wird.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-file.

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

Parameter

fileName: string

size: number

Gibt die maximale Größe in Bytes für die Datei an, bis zu 4 TB.

options: FileCreateOptions

Optionen zum Dateierstellungsvorgang.

Gibt zurück

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

Antwortdaten für die Dateierstellung und den entsprechenden Dateiclient.

Erstellt eine neue Freigabe unter dem angegebenen Konto. Wenn die Freigabe mit demselben Namen bereits vorhanden ist, wird sie nicht geändert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-share.

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

Parameter

options: ShareCreateOptions

Gibt zurück

Promise<ShareCreateIfNotExistsResponse>

Erstellt eine Dateiberechtigung (eine Sicherheitsbeschreibung) auf Freigabeebene. Der erstellte Sicherheitsdeskriptor kann für die Dateien/Verzeichnisse in der Freigabe verwendet werden.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/create-permission.

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

Parameter

filePermission: string

In der SDDL beschriebene Dateiberechtigung

options: ShareCreatePermissionOptions

Optionen zum Freigeben des Berechtigungserstellungsvorgangs.

Gibt zurück

Promise<ShareCreatePermissionResponse>

Erstellt eine schreibgeschützte Momentaufnahme einer Freigabe.

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

Parameter

options: ShareCreateSnapshotOptions

Optionen zum Freigeben des Vorgangs "Momentaufnahme erstellen".

Gibt zurück

Promise<ShareCreateSnapshotResponse>

Antwortdaten für den Vorgang "Momentaufnahme freigeben".

Markiert die angegebene Freigabe zum Löschen. Die Freigabe und alle darin enthaltenen Verzeichnisse oder Dateien werden später während der Garbage Collection gelöscht.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share.

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

Parameter

options: ShareDeleteMethodOptions

Optionen zum Freigeben des Löschvorgangs.

Gibt zurück

Promise<ShareDeleteResponse>

Antwortdaten für den Löschvorgang freigeben.

Entfernt das angegebene leere Unterverzeichnis unter dieser Freigabe. Beachten Sie, dass das Verzeichnis leer sein muss, es kann sonst nicht gelöscht werden.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-directory.

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

Parameter

directoryName: string

options: DirectoryDeleteOptions

Optionen zum Verzeichnislöschvorgang.

Gibt zurück

Promise<DirectoryDeleteResponse>

Antwortdaten zum Löschen von Verzeichnissen.

Entfernt eine Datei unter dem Stammverzeichnis dieser Freigabe aus dem Speicherkonto. Beim erfolgreichen Löschen einer Datei wird diese sofort aus dem Index des Speicherkontos entfernt, und Clients haben keinen Zugriff mehr darauf. Die Daten der Datei werden später während der automatischen Speicherbereinigung aus dem Dienst entfernt.

Datei löschen schlägt mit Statuscode 409 (Konflikt) und Fehlercode SharingViolation fehl, wenn die Datei auf einem SMB-Client geöffnet ist.

Datei löschen wird für eine Freigabemomentaufnahme, die eine schreibgeschützte Kopie einer Freigabe ist, nicht unterstützt. Ein Versuch, diesen Vorgang für eine Freigabemomentaufnahme auszuführen, schlägt mit 400 (InvalidQueryParameterValue) fehl.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-file2.

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

Parameter

fileName: string

options: FileDeleteOptions

Optionen zum Dateilöschvorgang.

Gibt zurück

Promise<FileDeleteResponse>

Versprechen Datei Löschen Sie Antwortdaten.

Markiert die angegebene Freigabe zum Löschen, sofern vorhanden. Die Freigabe und alle darin enthaltenen Verzeichnisse oder Dateien werden später während der Garbage Collection gelöscht.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/delete-share.

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

Parameter

options: ShareDeleteMethodOptions

Gibt zurück

Promise<ShareDeleteIfExistsResponse>

Gibt true zurück, wenn die von diesem Client dargestellte Azrue-Freigaberessource vorhanden ist. false andernfalls.

HINWEIS: Verwenden Sie diese Funktion mit Sorgfalt, da eine vorhandene Freigabe möglicherweise von anderen Clients oder Anwendungen gelöscht wird. Umgekehrt können neue Freigaben von anderen Clients oder Anwendungen hinzugefügt werden, nachdem diese Funktion abgeschlossen ist.

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

Parameter

options: ShareExistsOptions

Options to Exists-Vorgang.

Gibt zurück

Promise<boolean>

Nur für ShareClient verfügbar, der mit Anmeldeinformationen für gemeinsam genutzte Schlüssel erstellt wurde.

Generiert einen SAS-URI (Service Shared Access Signature) basierend auf den übergebenen Clienteigenschaften und Parametern. Die SAS wird von den Anmeldeinformationen für gemeinsam genutzte Schlüssel des Clients signiert.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/constructing-a-service-sas.

function generateSasUrl(options: ShareGenerateSasUrlOptions): string

Parameter

options: ShareGenerateSasUrlOptions

Optionale Parameter.

Gibt zurück

string

Der SAS-URI, der aus dem URI für die von diesem Client dargestellte Ressource besteht, gefolgt vom generierten SAS-Token.

Ruft die Berechtigungen für die angegebene Freigabe ab. Die Berechtigungen geben an, ob auf Freigabedaten öffentlich zugegriffen werden darf.

WARNUNG: Das JavaScript-Datum kann beim Analysieren der Start- und Ablaufzeichenfolge an Genauigkeit verlieren. New Date("2018-12-31T03:44:23.8827891Z"). toISOString() erhält beispielsweise "2018-12-31T03:44:23.882Z".

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-acl.

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

Parameter

options: ShareGetAccessPolicyOptions

Gibt zurück

Promise<ShareGetAccessPolicyResponse>

Antwortdaten für den Vorgang "Zugriffsrichtlinie freigeben".

Erstellt ein ShareDirectoryClient-Objekt .

function getDirectoryClient(directoryName: string): ShareDirectoryClient

Parameter

directoryName: string

Ein Verzeichnisname

Gibt zurück

ShareDirectoryClient

Das ShareDirectoryClient-Objekt für den angegebenen Verzeichnisnamen.

Ruft die Security Descriptor Definition Language (SDDL) für einen bestimmten Dateiberechtigungsschlüssel ab, der einen Sicherheitsdeskriptor angibt.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-permission.

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

Parameter

filePermissionKey: string

Dateiberechtigungsschlüssel, der den Sicherheitsdeskriptor der Berechtigung angibt.

options: ShareGetPermissionOptions

Optionen zum Freigeben von Berechtigungserstellungsvorgang.

Gibt zurück

Promise<ShareGetPermissionResponse>

Gibt alle benutzerdefinierten Metadaten und Systemeigenschaften für die angegebene Freigabe zurück.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/get-share-properties.

WARNUNG: Das metadata in der Antwort zurückgegebene Objekt weist seine Schlüssel in Kleinbuchstaben auf, auch wenn sie ursprünglich Großbuchstaben enthielten. Dies unterscheidet sich von den Metadatenschlüsseln, die von der listSharesShareServiceClient-Methode mit der includeMetadata Option zurückgegeben werden, die ihre ursprüngliche Groß- und Kleinschreibung beibehält.

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

Parameter

options: ShareGetPropertiesOptions

Gibt zurück

Promise<ShareGetPropertiesResponse>

Antwortdaten für den Vorgang "Eigenschaften freigeben".

Ruft Statistiken ab, die sich auf die Freigabe beziehen.

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

Parameter

options: ShareGetStatisticsOptions

Gibt zurück

Promise<ShareGetStatisticsResponse>

Antwortdaten für den Vorgang "Statistiken abrufen freigeben".

Legt die Berechtigungen für die angegebene Freigabe fest. Die Berechtigungen geben an, ob auf Verzeichnisse oder Dateien in einer Freigabe öffentlich zugegriffen werden kann.

Wenn Sie Berechtigungen für eine Freigabe festlegen, werden die vorhandenen Berechtigungen ersetzt. Wenn kein shareAcl bereitgestellt wird, wird die vorhandene Freigabe-ACL entfernt.

Wenn Sie eine gespeicherte Zugriffsrichtlinie für eine Freigabe einrichten, kann es bis zu 30 Sekunden dauern, bis sie wirksam wird. Während dieses Intervalls schlägt eine SAS, die der gespeicherten Zugriffsrichtlinie zugeordnet ist, mit dem Statuscode 403 (Unzulässig) so lange fehl, bis die Zugriffsrichtlinie aktiv ist.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-acl.

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

Parameter

shareAcl: SignedIdentifier[]

Array von signierten Bezeichnern, die jeweils eine eindeutige ID und Details der Zugriffsrichtlinie aufweisen.

options: ShareSetAccessPolicyOptions

Gibt zurück

Promise<ShareSetAccessPolicyResponse>

Antwortdaten für den Vorgang "Share Set Access Policy"

Legt mindestens ein benutzerdefiniertes Name-Wert-Paar für die angegebene Freigabe fest.

Wenn keine Option oder keine Metadaten im Optionsparameter definiert sind, werden die Freigabemetadaten entfernt.

Siehe https://docs.microsoft.com/en-us/rest/api/storageservices/set-share-metadata.

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

Parameter

metadata: Metadata

Wenn keine Metadaten bereitgestellt werden, werden alle vorhandenen Verzeichnismetadaten entfernt.

options: ShareSetMetadataOptions

Gibt zurück

Promise<ShareSetMetadataResponse>

Antwortdaten für den Vorgang "Metadaten freigeben".

Legt die Eigenschaften der Freigabe fest.

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

Parameter

options: ShareSetPropertiesOptions

Gibt zurück

Promise<ShareSetPropertiesResponse>

Antwortdaten für den Vorgang Freigabesatzeigenschaften.

Warnung

Diese API ist nun veraltet.

Use setProperties instead.

Legt das Kontingent für die angegebene Freigabe fest.

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

Parameter

quotaInGB: number

Gibt die maximale Größe der Freigabe in Gigabyte an.

options: ShareSetQuotaOptions

Gibt zurück

Promise<ShareSetQuotaResponse>

Antwortdaten für den Share Get Quota-Vorgang.

Erstellt ein neues ShareClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel. Geben Sie "" an, um die Momentaufnahme zu entfernen und eine URL an die Basisfreigabe zurückzugeben.

function withSnapshot(snapshot: string): ShareClient

Parameter

snapshot: string

Der Momentaufnahmezeitstempel.

Gibt zurück

ShareClient

Ein neues ShareClient-Objekt, das mit der Quelle identisch ist, aber mit dem angegebenen Momentaufnahmezeitstempel

Freigeben über

ShareClient class

Konstruktoren

Eigenschaften

Geerbte Eigenschaften

Methoden

Details zum Konstruktor

ShareClient(string, Credential_2 | TokenCredential, ShareClientOptions)

Parameter

ShareClient(string, Pipeline, ShareClientConfig)

Parameter

ShareClient(string, string, ShareClientOptions)

Parameter

Details zur Eigenschaft

name

Eigenschaftswert

rootDirectoryClient

Eigenschaftswert

Geerbte Eigenschaftsdetails

accountName

Eigenschaftswert

url

Eigenschaftswert

Details zur Methode

create(ShareCreateOptions)

Parameter

Gibt zurück

createDirectory(string, DirectoryCreateOptions)

Parameter

Gibt zurück

createFile(string, number, FileCreateOptions)

Parameter

Gibt zurück

createIfNotExists(ShareCreateOptions)

Parameter

Gibt zurück

createPermission(string, ShareCreatePermissionOptions)

Parameter

Gibt zurück

createSnapshot(ShareCreateSnapshotOptions)

Parameter

Gibt zurück

delete(ShareDeleteMethodOptions)

Parameter

Gibt zurück

deleteDirectory(string, DirectoryDeleteOptions)

Parameter

Gibt zurück

deleteFile(string, FileDeleteOptions)

Parameter

Gibt zurück

deleteIfExists(ShareDeleteMethodOptions)

Parameter

Gibt zurück

exists(ShareExistsOptions)

Parameter

Gibt zurück

generateSasUrl(ShareGenerateSasUrlOptions)

Parameter

Gibt zurück

getAccessPolicy(ShareGetAccessPolicyOptions)

Parameter

Gibt zurück

getDirectoryClient(string)

Parameter

Gibt zurück

getPermission(string, ShareGetPermissionOptions)

Parameter

Gibt zurück

getProperties(ShareGetPropertiesOptions)

Parameter

Gibt zurück

getStatistics(ShareGetStatisticsOptions)

Parameter

Gibt zurück

setAccessPolicy(SignedIdentifier[], ShareSetAccessPolicyOptions)

Parameter

Gibt zurück

setMetadata(Metadata, ShareSetMetadataOptions)

Parameter