FileSharesOperations Klasa

Ostrzeżenie

NIE należy bezpośrednio utworzyć wystąpienia tej klasy.

Zamiast tego należy uzyskać dostęp do następujących operacji za pośrednictwem

StorageManagementClient's'

<xref:file_shares> Atrybut.

Dziedziczenie
builtins.object
FileSharesOperations

Konstruktor

FileSharesOperations(*args, **kwargs)

Metody

create

Tworzy nowy udział w ramach określonego konta 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

Usuwa określony udział na jego koncie.

get

Pobiera właściwości określonego udziału.

lease

Operacja Udziału dzierżawy ustanawia blokadę udziału i zarządza nią na potrzeby operacji usuwania. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony.

list

Wyświetla listę wszystkich udziałów.

restore

Jeśli udział nietrwały jest włączony, przywróć udział plików w ciągu prawidłowych dni przechowywania.

update

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.

create

Tworzy nowy udział w ramach określonego konta 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.

create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: str | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

share_name
str
Wymagane

Nazwa udziału plików w ramach określonego konta 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ą. Wymagane.

file_share
FileShare lub IO
Wymagane

Właściwości udziału plików do utworzenia. Jest typem udziałów plików lub typem we/wy. Wymagane.

expand
str
Wymagane

Opcjonalnie służy do rozwijania właściwości we właściwościach udziału. Prawidłowe wartości to: migawki. Należy przekazać jako ciąg z ogranicznikiem ",". Wartość domyślna to Brak.

content_type
str

Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Udział plików lub wynik cls(response)

Typ zwracany

Wyjątki

delete

Usuwa określony udział na jego koncie.

delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, include: str | None = None, **kwargs: Any) -> None

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

share_name
str
Wymagane

Nazwa udziału plików w ramach określonego konta 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ą. Wymagane.

x_ms_snapshot
str
Wymagane

Opcjonalnie, używane do usuwania migawki. Wartość domyślna to Brak.

include
str
Wymagane

Opcjonalny. Prawidłowe wartości to: migawki, migawki dzierżawione, brak. Wartość domyślna to migawki. W przypadku migawek udział plików jest usuwany wraz ze wszystkimi migawkami udziału plików. Jeśli udział plików zawiera migawki dzierżawione, usunięcie nie powiedzie się. W przypadku plików "leased-snapshots" udział plików jest usuwany, dołączane są wszystkie jego migawki udziału plików (dzierżawione/nieleasowane). W przypadku elementu "none" udział plików jest usuwany, jeśli nie ma migawek udziałów. Jeśli udział plików zawiera migawki (dzierżawione lub nieuprawione), usunięcie nie powiedzie się. Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Brak lub wynik cls(response)

Typ zwracany

Wyjątki

get

Pobiera właściwości określonego udziału.

get(resource_group_name: str, account_name: str, share_name: str, expand: str | None = None, x_ms_snapshot: str | None = None, **kwargs: Any) -> FileShare

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

share_name
str
Wymagane

Nazwa udziału plików w ramach określonego konta 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ą. Wymagane.

expand
str
Wymagane

Opcjonalnie służy do rozwijania właściwości we właściwościach udziału. Prawidłowe wartości to: statystyki. Należy przekazać jako ciąg z ogranicznikiem ",". Wartość domyślna to Brak.

x_ms_snapshot
str
Wymagane

Opcjonalnie służy do pobierania właściwości migawki. Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Udział plików lub wynik cls(response)

Typ zwracany

Wyjątki

lease

Operacja Udziału dzierżawy ustanawia blokadę udziału i zarządza nią na potrzeby operacji usuwania. Czas trwania blokady może wynosić od 15 do 60 sekund lub może być nieskończony.

lease(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: str | None = None, parameters: _models.LeaseShareRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseShareResponse

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

share_name
str
Wymagane

Nazwa udziału plików w ramach określonego konta 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ą. Wymagane.

x_ms_snapshot
str
Wymagane

Opcjonalny. Określ czas migawek do dzierżawy migawki. Wartość domyślna to Brak.

parameters
LeaseShareRequest lub IO
Wymagane

Treść żądania udziału dzierżawy. Jest typem LeaseShareRequest lub typem we/wy. Wartość domyślna to Brak.

content_type
str

Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

LeaseShareResponse lub wynik cls(response)

Typ zwracany

Wyjątki

list

Wyświetla listę wszystkich udziałów.

list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | None = None, **kwargs: Any) -> Iterable[FileShareItem]

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

maxpagesize
str
Wymagane

Opcjonalny. Określona maksymalna liczba udziałów, które można uwzględnić na liście. Wartość domyślna to Brak.

filter
str
Wymagane

Opcjonalny. Po określeniu nazwy udziałów rozpoczynające się od filtru będą wyświetlane. Wartość domyślna to Brak.

expand
str
Wymagane

Opcjonalnie służy do rozwijania właściwości we właściwościach udziału. Prawidłowe wartości to: usunięte, migawki. Należy przekazać jako ciąg z ogranicznikiem ",". Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Iterator, taki jak wystąpienie elementu FileShareItem lub wynik cls(response)

Typ zwracany

Wyjątki

restore

Jeśli udział nietrwały jest włączony, przywróć udział plików w ciągu prawidłowych dni przechowywania.

restore(resource_group_name: str, account_name: str, share_name: str, deleted_share: _models.DeletedShare, *, content_type: str = 'application/json', **kwargs: Any) -> None

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

share_name
str
Wymagane

Nazwa udziału plików w ramach określonego konta 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ą. Wymagane.

deleted_share
DeletedShare lub IO
Wymagane

Jest typem DeletedShare lub typem we/wy. Wymagane.

content_type
str

Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Brak lub wynik cls(response)

Typ zwracany

Wyjątki

update

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.

update(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare

Parametry

resource_group_name
str
Wymagane

Nazwa grupy zasobów w ramach subskrypcji użytkownika. W nazwie jest uwzględniana wielkość liter. Wymagane.

account_name
str
Wymagane

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. Wymagane.

share_name
str
Wymagane

Nazwa udziału plików w ramach określonego konta 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ą. Wymagane.

file_share
FileShare lub IO
Wymagane

Właściwości do zaktualizowania udziału plików. Jest typem udziałów plików lub typem we/wy. Wymagane.

content_type
str

Typ zawartości parametru treści. Znane wartości to: "application/json". Wartość domyślna to Brak.

cls
callable

Typ niestandardowy lub funkcja, która zostanie przekazana bezpośrednia odpowiedź

Zwraca

Udział plików lub wynik cls(response)

Typ zwracany

Wyjątki

Atrybuty

models

models = <module 'azure.mgmt.storage.v2021_08_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2021_08_01\\models\\__init__.py'>