FileSharesOperations Класс

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

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

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

StorageManagementClient's

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

Наследование

builtins.object

FileSharesOperations

Конструктор

FileSharesOperations(*args, **kwargs)

Методы

create	Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка.
delete	Удаляет указанную общую папку под своей учетной записью.
get	Возвращает свойства указанной общей папки.
list	Выводит список всех общих папок.
restore	Восстановите общую папку в течение допустимых дней хранения, если включено обратимое удаление общей папки.
update	Обновления свойства общего доступа, как указано в тексте запроса. Свойства, не упомянутые в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.

create

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

async create(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

Обязательно

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

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, **kwargs: Any) -> None

Параметры

resource_group_name

str

Обязательно

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

account_name

str

Обязательно

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

share_name

str

Обязательно

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

cls

callable

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

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

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

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

None

Исключения

HttpResponseError

get

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

async get(resource_group_name: str, account_name: str, share_name: str, expand: Literal['stats'] = 'stats', **kwargs: Any) -> FileShare

Параметры

resource_group_name

str

Обязательно

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

account_name

str

Обязательно

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

share_name

str

Обязательно

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

expand

str

Обязательно

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

cls

callable

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

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

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

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

FileShare

Исключения

HttpResponseError

list

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

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

Параметры

resource_group_name

str

Обязательно

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

account_name

str

Обязательно

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

maxpagesize

str

Обязательно

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

filter

str

Обязательно

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

expand

str

Обязательно

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

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

Тип содержимого параметра body. Известные значения: "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.v2019_06_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2019_06_01\\models\\__init__.py'>