FileSharesOperations Класс
Предупреждение
НЕ следует создавать экземпляр этого класса напрямую.
Вместо этого вы должны получить доступ к следующим операциям с помощью
атрибут<xref:file_shares> .
- Наследование
-
builtins.objectFileSharesOperations
Конструктор
FileSharesOperations(*args, **kwargs)
Методы
create |
Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка. |
delete |
Удаляет указанную общую папку под своей учетной записью. |
get |
Возвращает свойства указанной общей папки. |
list |
Выводит список всех общих папок. |
restore |
Восстановите общую папку в течение допустимых дней хранения, если включено обратимое удаление общей папки. |
update |
Обновления совместного использования свойств, как указано в тексте запроса. Свойства, не указанные в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует. |
create
Создает новую общую папку в указанной учетной записи, как описано в тексте запроса. Ресурс общей папки содержит метаданные и свойства для данной общей папки. Ресурс не включает список файлов, которые содержит общая папка.
create(resource_group_name: str, account_name: str, share_name: str, file_share: _models.FileShare, expand: Literal['snapshots'] = 'snapshots', *, content_type: str = 'application/json', **kwargs: Any) -> _models.FileShare
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- share_name
- str
Имя общей папки в указанной учетной записи хранения. Имена общих папок должны содержать от 3 до 63 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.
Свойства создаваемой общей папки. Тип общей папки или тип ввода-вывода. Обязательный.
- expand
- str
Необязательный параметр, используемый для создания snapshot. Известными значениями являются "моментальные снимки" и "Нет". Значение по умолчанию — "snapshots".
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
FileShare или результат cls(response)
Возвращаемый тип
Исключения
delete
Удаляет указанную общую папку под своей учетной записью.
delete(resource_group_name: str, account_name: str, share_name: str, x_ms_snapshot: 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. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
None или результат cls(response)
Возвращаемый тип
Исключения
get
Возвращает свойства указанной общей папки.
get(resource_group_name: str, account_name: str, share_name: str, expand: Literal['stats'] = 'stats', 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 и None. Значение по умолчанию — "stats".
- x_ms_snapshot
- str
Необязательный параметр, используемый для получения свойств snapshot. Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
FileShare или результат cls(response)
Возвращаемый тип
Исключения
list
Выводит список всех общих папок.
list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, expand: str | ListSharesExpand | None = None, **kwargs: Any) -> Iterable[FileShareItem]
Параметры
- resource_group_name
- str
Имя группы ресурсов в подписке пользователя. Регистр букв в имени не учитывается. Обязательный.
- account_name
- str
Имя учетной записи хранения в указанной группе ресурсов. Имя учетной записи хранения должно содержать от 3 до 24 символов и состоять только из цифр и букв нижнего регистра. Обязательный.
- maxpagesize
- str
Необязательный элемент. Указано максимальное количество общих папок, которые могут быть включены в список. Значение по умолчанию —Нет.
- filter
- str
Необязательный элемент. Если этот параметр указан, будут перечислены только имена общих ресурсов, начиная с фильтра. Значение по умолчанию —Нет.
- expand
- str или ListSharesExpand
Необязательный параметр, используемый для развертывания свойств в свойствах общей папки. Известные значения: "deleted" и "snapshots". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
Итератор, например экземпляр FileShareItem или результат cls(response)
Возвращаемый тип
Исключения
restore
Восстановите общую папку в течение допустимых дней хранения, если включено обратимое удаление общей папки.
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 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
None или результат cls(response)
Возвращаемый тип
Исключения
update
Обновления совместного использования свойств, как указано в тексте запроса. Свойства, не указанные в запросе, не будут изменены. Обновление завершается ошибкой, если указанная общая папка еще не существует.
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 символов и использовать только цифры, строчные буквы и дефис (-). Каждый тире (-) должен быть непосредственно перед символом, за которым следует буква или цифра. Обязательный.
Свойства, обновляемые для общей папки. Тип общей папки или тип ввода-вывода. Обязательный.
- content_type
- str
Тип содержимого параметра body. Известные значения: "application/json". Значение по умолчанию —Нет.
- cls
- callable
Пользовательский тип или функция, которым будет передан прямой ответ
Возвращаемое значение
FileShare или результат cls(response)
Возвращаемый тип
Исключения
Атрибуты
models
models = <module 'azure.mgmt.storage.v2020_08_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2020_08_01_preview\\models\\__init__.py'>
Azure SDK for Python