FileShares interface
Interfejs reprezentujący udziały plików.
Metody
| create(string, string, string, File |
Tworzy nowy udział na określonym koncie zgodnie z opisem w treści żądania. Zasób udziału zawiera metadane i właściwości dla tego udziału. Nie zawiera listy plików zawartych w udziale. |
| delete(string, string, string, File |
Usuwa określony udział na koncie. |
| get(string, string, string, File |
Pobiera właściwości określonego udziału. |
| lease(string, string, string, File |
Operacja dzierżawy udziału ustanawia blokadę udziału i zarządza blokadą udziału na potrzeby operacji usuwania. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony. |
| list(string, string, File |
Wyświetla listę wszystkich udziałów. |
| restore(string, string, string, Deleted |
Przywracanie udziału plików w prawidłowych dniach przechowywania, jeśli włączono usuwanie nietrwałe udziału |
| update(string, string, string, File |
Aktualizacje właściwości udziału określone w treści żądania. Właściwości, które nie zostały wymienione w żądaniu, nie zostaną zmienione. Aktualizacja kończy się niepowodzeniem, jeśli określony udział jeszcze nie istnieje. |
Szczegóły metody
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Tworzy nowy udział na określonym koncie zgodnie z opisem w treści żądania. Zasób udziału zawiera metadane i właściwości dla tego udziału. Nie zawiera listy plików zawartych w udziale.
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- shareName
-
string
Nazwa udziału plików na określonym koncie magazynu. Nazwy udziałów plików muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- fileShare
- FileShare
Właściwości udziału plików do utworzenia.
- options
- FileSharesCreateOptionalParams
Parametry opcji.
Zwraca
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Usuwa określony udział na koncie.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- shareName
-
string
Nazwa udziału plików na określonym koncie magazynu. Nazwy udziałów plików muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- options
- FileSharesDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Pobiera właściwości określonego udziału.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- shareName
-
string
Nazwa udziału plików na określonym koncie magazynu. Nazwy udziałów plików muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- options
- FileSharesGetOptionalParams
Parametry opcji.
Zwraca
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
Operacja dzierżawy udziału ustanawia blokadę udziału i zarządza blokadą udziału na potrzeby operacji usuwania. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony.
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- shareName
-
string
Nazwa udziału plików na określonym koncie magazynu. Nazwy udziałów plików muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- options
- FileSharesLeaseOptionalParams
Parametry opcji.
Zwraca
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Wyświetla listę wszystkich udziałów.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- options
- FileSharesListOptionalParams
Parametry opcji.
Zwraca
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Przywracanie udziału plików w prawidłowych dniach przechowywania, jeśli włączono usuwanie nietrwałe udziału
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- shareName
-
string
Nazwa udziału plików na określonym koncie magazynu. Nazwy udziałów plików muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- deletedShare
- DeletedShare
Usunięty udział do przywrócenia.
- options
- FileSharesRestoreOptionalParams
Parametry opcji.
Zwraca
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Aktualizacje właściwości udziału określone w treści żądania. Właściwości, które nie zostały wymienione w żądaniu, nie zostaną zmienione. Aktualizacja kończy się niepowodzeniem, jeśli określony udział jeszcze nie istnieje.
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter.
- accountName
-
string
Nazwa konta magazynu w określonej grupie zasobów. Nazwy kont magazynu muszą mieć długość od 3 do 24 znaków, a tylko cyfry i małe litery.
- shareName
-
string
Nazwa udziału plików na określonym koncie magazynu. Nazwy udziałów plików muszą mieć długość od 3 do 63 znaków i używać cyfr, małych liter i kreski (-). Każdy znak kreski (-) musi być bezpośrednio poprzedzony i poprzedzony literą lub cyfrą.
- fileShare
- FileShare
Właściwości do aktualizacji udziału plików.
- options
- FileSharesUpdateOptionalParams
Parametry opcji.
Zwraca
Promise<FileShare>