Получение свойств общих ресурсов
Запрос Get Share Properties возвращает свойства для указанной общей папки или snapshot общей папки.
Хотя этот API полностью поддерживается, он является устаревшим API управления. По этой причине рекомендуется использовать файловые ресурсы — Get, предоставляемые поставщиком ресурсов хранилища (Microsoft.Storage).
Дополнительные сведения о программном взаимодействии с FileShare ресурсами с помощью поставщика ресурсов хранилища см. в статье Операции с общими папками.
Доступность протокола
| Включенный протокол общей папки | Доступно |
|---|---|
| SMB |  |
| NFS | |
Запрос
Запрос Get Share Properties можно составить следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS.
| Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
|---|---|---|
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share |
HTTP/1.1 |
GET/HEAD |
https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> |
HTTP/1.1 |
Замените компоненты пути, показанный в URI запроса, следующим образом:
| Компонент path | Описание |
|---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
Сведения об ограничениях именования путей см. в разделе Имена и ссылочные общие папки, каталоги, файлы и метаданные.
Параметры универсального кода ресурса (URI)
В URI запроса можно указать следующие дополнительные параметры:
| Параметр | Описание |
|---|---|
sharesnapshot |
Необязательный элемент. Версия 17.04.2017 и более поздняя. Параметр sharesnapshot представляет собой непрозрачное значение даты и времени, которое при наличии указывает общую snapshot для запроса для получения свойств. |
timeout |
Необязательный элемент. Параметр времени ожидания указывается в секундах. Дополнительные сведения см. в разделе Настройка времени ожидания для операций Файлы Azure. |
Заголовки запросов
Обязательные и необязательные заголовки описаны в следующей таблице:
| Заголовок запроса | Описание |
|---|---|
Authorization |
Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Файлы Azure. |
x-ms-lease-id:<ID> |
Необязательный элемент. Версия 2020-02-10 и более поздняя. Если указан заголовок, операция выполняется только в том случае, если аренда общей папки в данный момент активна, а идентификатор аренды, указанный в запросе, соответствует идентификатору аренды общей папки. Если совпадения нет, операция завершается ошибкой с кодом состояния 412 (сбой предварительного условия). |
Текст запроса
Нет.
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Дополнительные сведения о кодах состояния см. в разделе Коды состояния и ошибок.
Заголовки ответов
Ответ для этой операции включает следующие заголовки. Ответ может также включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
| Заголовок ответа | Описание |
|---|---|
Last-Modified |
Возвращает дату и время последнего изменения общей папки. Дата в формате согласно RFC 1123. Дополнительные сведения см. в разделе Представление значений Date-Time в заголовках. Любая операция, которая изменяет общий ресурс или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения общего ресурса. |
x-ms-meta-name:value |
Набор пар "имя-значение", содержащих определяемые пользователем метаданные общего ресурса. |
ETag |
Содержит значение, которое можно использовать для условного выполнения операций. Значение заключено в кавычки. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос и может использоваться для устранения неполадок с запросом. Дополнительные сведения см. в разделе Устранение неполадок с операциями API. |
x-ms-version |
Версия Файлы Azure, которая использовалась для выполнения запроса. |
Date |
Значение даты и времени в формате UTC, созданное службой, указывающее время, когда был инициирован ответ. |
x-ms-share-quota |
Версия 21.02.2015 и более поздняя. Возвращает текущую квоту общей папки в гибибайтах (ГиБ). |
x-ms-share-provisioned-iops |
Версия 2019-07-07 и более поздние. Возвращается только для общих папок уровня "Премиум" (общих папок в учетной записи хранения FileStorage). Возвращает количество операций ввода-вывода в секунду (IOPS), подготовленное для общей папки уровня "Премиум". |
x-ms-share-provisioned-ingress-mbps |
Версия 2019-07-07 и более поздние. Возвращается только для общих папок уровня "Премиум" (общих папок в учетной записи хранения FileStorage). Возвращает входящий трафик в мебибайтах в секунду (МиБ/с), подготовленный для общей папки уровня "Премиум". |
x-ms-share-provisioned-egress-mbps |
Версия 2019-07-07 и более поздние. Возвращается только для общих папок уровня "Премиум" (общих папок в учетной записи хранения FileStorage). Возвращает исходящий трафик в МиБ/с, подготовленный для общей папки уровня "Премиум". |
x-ms-share-provisioned-bandwidth-mibps |
Версия 12.02.2021 и более поздняя. Возвращается только для общих папок уровня "Премиум" (общих папок в учетной записи хранения FileStorage). Возвращает объединенную пропускную способность (входящий + исходящий трафик) в МиБ/с, подготовленную для общей папки уровня "Премиум". |
x-ms-share-next-allowed-quota-downgrade-time |
Версия 2019-07-07 и более поздние. Возвращается только для общих папок уровня "Премиум" (общих папок в учетной записи хранения FileStorage). Значение даты и времени, указывающее, когда разрешено уменьшить квоту для общей папки уровня "Премиум". Дата в формате согласно RFC 1123. |
x-ms-access-tier |
Версия 12.12.2019 и более поздняя. Возвращает текущий уровень доступа к общей папке. В учетных записях TransationOptimized хранения общего назначения версии 2 (GPv2) является уровнем по умолчанию для общей папки. В разделе Типы Premium учетных записей хранения FileStorage — это уровень по умолчанию для общей папки. |
x-ms-access-tier-change-time |
Версия 12.12.2019 и более поздняя. Возвращает дату и время последнего изменения уровня доступа в общей папке. |
x-ms-access-tier-transition-state |
Версия 12.12.2019 и более поздняя. Если общая папка переходит на уровень, этот заголовок указывает уровень, с который она переходит. |
x-ms-lease-duration:<fixed,infinite> |
Версия 10.02.2020 и более поздняя. Указывает, является ли аренда общей папки бесконечной или фиксированной. |
x-ms-lease-state: <available;leased;expired;breaking;broken> |
Версия 10.02.2020 и более поздняя. При аренде общей папки этот заголовок указывает состояние аренды общей папки. |
x-ms-lease-status: <locked;unlocked> |
Версия 10.02.2020 и более поздняя. При аренде общей папки этот заголовок указывает состояние аренды общей папки. |
x-ms-enabled-protocols: <SMB;NFS> |
Возвращает текущие протоколы с поддержкой общего доступа для версии 2019-07-07 и более поздних версий. - SMB: доступ к общей папке можно получить с помощью SMBv3.0, SMBv2.1 и REST.- NFS: доступ к общей папке можно получить с помощью NFS версии 4.1. |
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> |
Возвращает текущее поведение корневой общей папки для версии 2019-07-07 и более поздних версий. Только NFS. - NoRootSquash: корневое сжатие отключено.- RootSquash: запросы из UID/GID 0 сопоставляются с анонимным UID/GID.- AllSquash: все идентификаторы пользовательского интерфейса и идентификаторы GID сопоставляются с анонимным пользователем. |
x-ms-client-request-id |
Может использоваться для устранения неполадок запросов и соответствующих ответов. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, он не будет присутствовать в ответе. |
Текст ответа
Нет.
Пример ответа
Response Status:
HTTP/1.1 200 OK
Response Headers:
Transfer-Encoding: chunked
x-ms-meta-name: some_metadata
Date: <date>
ETag: "0x8CB171DBEAD6A6B"
Last-Modified: <date>
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0
Авторизация
Вызов этой операции доступен только владельцу учетной записи.
Remarks
Нет.