FileShares interface
Rozhraní představující sdílené složky.
Metody
| create(string, string, string, File |
Vytvoří novou sdílenou složku v rámci zadaného účtu, jak je popsáno v textu požadavku. Prostředek sdílené složky obsahuje metadata a vlastnosti pro danou sdílenou složku. Neobsahuje seznam souborů obsažených ve sdílené složce. |
| delete(string, string, string, File |
Odstraní zadanou sdílenou složku v rámci svého účtu. |
| get(string, string, string, File |
Získá vlastnosti zadané sdílené složky. |
| lease(string, string, string, File |
Operace zapůjčení sdílené složky vytvoří a spravuje zámek sdílené složky pro operace odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná. |
| list(string, string, File |
Zobrazí seznam všech sdílených složek. |
| restore(string, string, string, Deleted |
Obnovení sdílené složky během platných dnů uchovávání, pokud je povolené obnovitelné odstranění sdílené složky |
| update(string, string, string, File |
Aktualizace sdílet vlastnosti uvedené v textu požadavku. Vlastnosti, které nejsou uvedené v požadavku, se nezmění. Aktualizace selže, pokud zadaná sdílená složka ještě neexistuje. |
Podrobnosti metody
create(string, string, string, FileShare, FileSharesCreateOptionalParams)
Vytvoří novou sdílenou složku v rámci zadaného účtu, jak je popsáno v textu požadavku. Prostředek sdílené složky obsahuje metadata a vlastnosti pro danou sdílenou složku. Neobsahuje seznam souborů obsažených ve sdílené složce.
function create(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesCreateOptionalParams): Promise<FileShare>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- shareName
-
string
Název sdílené složky v rámci zadaného účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčky (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.
- fileShare
- FileShare
Vlastnosti sdílené složky, která se má vytvořit.
- options
- FileSharesCreateOptionalParams
Parametry možností.
Návraty
Promise<FileShare>
delete(string, string, string, FileSharesDeleteOptionalParams)
Odstraní zadanou sdílenou složku v rámci svého účtu.
function delete(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesDeleteOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- shareName
-
string
Název sdílené složky v rámci zadaného účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčky (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.
- options
- FileSharesDeleteOptionalParams
Parametry možností.
Návraty
Promise<void>
get(string, string, string, FileSharesGetOptionalParams)
Získá vlastnosti zadané sdílené složky.
function get(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesGetOptionalParams): Promise<FileShare>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- shareName
-
string
Název sdílené složky v rámci zadaného účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčky (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.
- options
- FileSharesGetOptionalParams
Parametry možností.
Návraty
Promise<FileShare>
lease(string, string, string, FileSharesLeaseOptionalParams)
Operace zapůjčení sdílené složky vytvoří a spravuje zámek sdílené složky pro operace odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná.
function lease(resourceGroupName: string, accountName: string, shareName: string, options?: FileSharesLeaseOptionalParams): Promise<FileSharesLeaseResponse>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- shareName
-
string
Název sdílené složky v rámci zadaného účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčky (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.
- options
- FileSharesLeaseOptionalParams
Parametry možností.
Návraty
Promise<FileSharesLeaseResponse>
list(string, string, FileSharesListOptionalParams)
Zobrazí seznam všech sdílených složek.
function list(resourceGroupName: string, accountName: string, options?: FileSharesListOptionalParams): PagedAsyncIterableIterator<FileShareItem, FileShareItem[], PageSettings>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- options
- FileSharesListOptionalParams
Parametry možností.
Návraty
restore(string, string, string, DeletedShare, FileSharesRestoreOptionalParams)
Obnovení sdílené složky během platných dnů uchovávání, pokud je povolené obnovitelné odstranění sdílené složky
function restore(resourceGroupName: string, accountName: string, shareName: string, deletedShare: DeletedShare, options?: FileSharesRestoreOptionalParams): Promise<void>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- shareName
-
string
Název sdílené složky v rámci zadaného účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčky (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.
- deletedShare
- DeletedShare
Odstraněná sdílená složka, která se má obnovit.
- options
- FileSharesRestoreOptionalParams
Parametry možností.
Návraty
Promise<void>
update(string, string, string, FileShare, FileSharesUpdateOptionalParams)
Aktualizace sdílet vlastnosti uvedené v textu požadavku. Vlastnosti, které nejsou uvedené v požadavku, se nezmění. Aktualizace selže, pokud zadaná sdílená složka ještě neexistuje.
function update(resourceGroupName: string, accountName: string, shareName: string, fileShare: FileShare, options?: FileSharesUpdateOptionalParams): Promise<FileShare>Parametry
- resourceGroupName
-
string
Název skupiny prostředků v rámci předplatného uživatele. V názvu se rozlišují malá a velká písmena.
- accountName
-
string
Název účtu úložiště v rámci zadané skupiny prostředků. Názvy účtů úložiště musí mít délku 3 až 24 znaků a musí používat jenom číslice a malá písmena.
- shareName
-
string
Název sdílené složky v rámci zadaného účtu úložiště. Názvy sdílených složek musí mít délku 3 až 63 znaků a musí obsahovat pouze číslice, malá písmena a pomlčky (-). Každá pomlčka (-) musí bezprostředně předcházet písmenu nebo číslici.
- fileShare
- FileShare
Vlastnosti, které se mají aktualizovat pro sdílenou složku.
- options
- FileSharesUpdateOptionalParams
Parametry možností.
Návraty
Promise<FileShare>