Поделиться через

FileSharesOperations Класс

  • Ссылка

Предупреждение

НЕ следует создавать экземпляр этого класса напрямую.

Вместо этого вы должны получить доступ к следующим операциям с помощью

StorageManagementClient's

атрибут<xref:file_shares> .

Наследование
builtins.object
FileSharesOperations

Конструктор

FileSharesOperations(*args, **kwargs)

Методы

create

Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка.
delete

Удаляет указанную общую папку под своей учетной записью.
get

Возвращает свойства указанной общей папки.
lease

Операция аренды общего ресурса устанавливает и управляет блокировкой общего ресурса для операций удаления. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.
list

Выводит список всех общих папок.
restore

Восстановите общую папку в течение допустимых дней хранения, если включено обратимое удаление общей папки.
update

Обновления свойства общего доступа, как указано в тексте запроса. Свойства, не упомянутые в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.

create

Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка.

async 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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

share_name
str
Обязательно

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.

file_share
FileShare или IO
Обязательно

Свойства создаваемой общей папки. Тип общей папки или тип ввода-вывода. Обязательный.

expand
str
Обязательно

Необязательный параметр, используемый для развертывания свойств в свойствах общей папки. Допустимые значения: моментальные снимки. Должен передаваться в виде строки с разделителем ",". Значение по умолчанию —Нет.

content_type
str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

FileShare или результат cls(response)

Возвращаемый тип

FileShare

Исключения

HttpResponseError

delete

Удаляет указанную общую папку под своей учетной записью.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

share_name
str
Обязательно

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.

x_ms_snapshot
str
Обязательно

Необязательный параметр, используемый для удаления snapshot. Значение по умолчанию —Нет.

include
str
Обязательно

Необязательный элемент. Допустимые значения: snapshots, leased-snapshots, none. Значение по умолчанию — snapshots. Для моментальных снимков общая папка удаляется, включая все моментальные снимки общей папки. Если общая папка содержит арендованные моментальные снимки, удаление завершается ошибкой. Для "арендованных моментальных снимков" общая папка удаляется, включая все моментальные снимки общей папки (арендованные или неэтилированные). В случае none общая папка удаляется, если в ней нет моментальных снимков общих папок. Если общая папка содержит какие-либо моментальные снимки (арендованные или неэтилированные), удаление завершается ошибкой. Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

None или результат cls(response)

Возвращаемый тип

None

Исключения

HttpResponseError

get

Возвращает свойства указанной общей папки.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

share_name
str
Обязательно

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.

expand
str
Обязательно

Необязательный параметр, используемый для развертывания свойств в свойствах общей папки. Допустимые значения: stats. Должен передаваться в виде строки с разделителем ",". Значение по умолчанию —Нет.

x_ms_snapshot
str
Обязательно

Необязательный параметр, используемый для получения свойств snapshot. Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

FileShare или результат cls(response)

Возвращаемый тип

FileShare

Исключения

HttpResponseError

lease

Операция аренды общего ресурса устанавливает и управляет блокировкой общего ресурса для операций удаления. Длительность блокировки может составлять 15–60 секунд либо быть бесконечной.

async 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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

share_name
str
Обязательно

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.

x_ms_snapshot
str
Обязательно

Необязательный элемент. Укажите snapshot время аренды snapshot. Значение по умолчанию —Нет.

parameters
LeaseShareRequest или IO
Обязательно

Текст запроса аренды общей папки. Тип LeaseShareRequest или тип ввода-вывода. Значение по умолчанию —Нет.

content_type
str

Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которым будет передан прямой ответ

Возвращаемое значение

LeaseShareResponse или результат cls(response)

Возвращаемый тип

LeaseShareResponse

Исключения

HttpResponseError

list

Выводит список всех общих папок.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

maxpagesize
str
Обязательно

Необязательный элемент. Указано максимальное количество общих папок, которые могут быть включены в список. Значение по умолчанию —Нет.

filter
str
Обязательно

Необязательный элемент. Если этот параметр указан, будут перечислены только имена общих ресурсов, начиная с фильтра. Значение по умолчанию —Нет.

expand
str
Обязательно

Необязательный параметр, используемый для развертывания свойств в свойствах общего ресурса. Допустимые значения: deleted, snapshots. Должен передаваться в виде строки с разделителем ",". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

Итератор, например экземпляр FileShareItem или результат cls(response)

Возвращаемый тип

AsyncItemPaged[FileShareItem]

Исключения

HttpResponseError

restore

Восстановите общую папку в течение допустимых дней хранения, если включено обратимое удаление общей папки.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

share_name
str
Обязательно

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.

deleted_share
DeletedShare или IO
Обязательно

Тип DeletedShare или тип ввода-вывода. Обязательный.

content_type
str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

None или результат cls(response)

Возвращаемый тип

None

Исключения

HttpResponseError

update

Обновления свойства общего доступа, как указано в тексте запроса. Свойства, не упомянутые в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.

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

Параметры

resource_group_name
str
Обязательно

Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.

account_name
str
Обязательно

Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.

share_name
str
Обязательно

Имя общей папки в указанной учетной записи хранения. Имена общих папок должны быть длиной от 3 до 63 символов и содержать только цифры, строчные буквы и дефис (-). Каждый дефис (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.

file_share
FileShare или IO
Обязательно

Свойства, обновляемые для общей папки. Тип FileShare или тип ввода-вывода. Обязательный.

content_type
str

Тип содержимого параметра тела. Известные значения: "application/json". Значение по умолчанию —Нет.

cls
callable

Пользовательский тип или функция, которые будут переданы в прямой ответ.

Возвращаемое значение

FileShare или результат cls(response)

Возвращаемый тип

FileShare

Исключения

HttpResponseError

Атрибуты

models 

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