Задание метаданных общего ресурса
Операция Set Share Metadata
задает одну или несколько определяемых пользователем пар "имя-значение" для указанной общей папки. Хотя эта операция полностью поддерживается, она является устаревшей операцией управления. Рекомендуется использовать операцию "Общие папки — обновление ", предоставляемую поставщиком ресурсов хранилища (Microsoft.Storage). Дополнительные сведения о программном взаимодействии с ресурсами с помощью поставщика ресурсов хранилища см. в разделе Операции с FileShare
ресурсами FileShare.
Доступность протокола
Включенный протокол общей папки | Доступно |
---|---|
SMB | |
NFS |
Запрос
Запрос создается Set Share Metadata
следующим образом. Рекомендуется использовать ПРОТОКОЛ HTTPS. Замените myaccount именем своей учетной записи хранения.
Метод | Универсальный код ресурса (URI) запроса | параметр "Версия HTTP" |
---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata |
HTTP/1.1 |
Замените компоненты пути, показанный в URI запроса, следующим образом:
Компонент path | Описание |
---|---|
myaccount |
Имя учетной записи хранения. |
myshare |
Имя файлового ресурса. |
Дополнительные сведения об ограничениях именования путей см. в статье Именование общих папок, каталогов, файлов и метаданных и ссылки на нее.
Параметры универсального кода ресурса (URI)
В запросе URI можно указать следующие дополнительные параметры.
Параметр | Описание |
---|---|
timeout |
Необязательный элемент. Выражается в секундах. Дополнительные сведения см. в статье Установка времени ожидания для Файлы Azure операций. |
Заголовки запросов
В следующей таблице описаны обязательные и необязательные заголовки запросов:
Заголовок запроса | Описание |
---|---|
Authorization |
Обязательный. Указывает схему авторизации, имя учетной записи и подпись. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
Date или x-ms-date |
Обязательный. Задает время запроса в формате UTC. Дополнительные сведения см. в статье Авторизация запросов к Службе хранилища Azure. |
x-ms-version |
Требуется для всех авторизованных запросов. Задает версию операции, используемой для этого запроса. Дополнительные сведения см. в разделе Управление версиями для служб хранилища Azure. |
x-ms-meta-name:value |
Необязательный элемент. Предоставляет пару "имя-значение", содержащую метаданные для общей папки. Каждый вызов этой операции приводит к замене всех существующих метаданных, присоединенных к общему ресурсу. Чтобы удалить все метаданные из общего ресурса, вызовите эту операцию без заголовков метаданных. Имена метаданных должны соответствовать правилам именования для идентификаторов C#. |
x-ms-client-request-id |
Необязательный элемент. Предоставляет созданное клиентом непрозрачное значение с ограничением в 1 кибибайт (КиБ), которое записывается в журналы Аналитика Службы хранилища при настройке ведения журнала. Мы настоятельно рекомендуем использовать этот заголовок для сопоставления действий на стороне клиента с запросами, получаемыми сервером. Дополнительные сведения см. в разделе Мониторинг Хранилище BLOB-объектов Azure. |
x-ms-lease-id:<ID> |
Требуется, если в целевой общей папке есть активная аренда. Доступно для версии 2020-02-10 и более поздних версий. Если запрос не содержит идентификатор аренды или он недопустим, операция завершается ошибкой с кодом состояния 412 (сбой условия). Если этот заголовок указан и в общей папке назначения сейчас нет активной аренды, операция завершается ошибкой с кодом состояния 412 (сбой условия). |
Текст запроса
Нет.
Пример запроса
PUT https://myaccount.file.core.windows.net/myshare?restype=share&comp=metadata HTTP/1.1
Request Headers:
x-ms-version: 2014-02-14
x-ms-date: Mon, 27 Jan 2014 22:50:32 GMT
x-ms-meta-Category: Images
Authorization: SharedKey myaccount:Z5043vY9MesKNh0PNtksNc9nbXSSqGHueE00JdjidOQ=
Ответ
Ответ включает код состояния HTTP и набор заголовков ответа.
Код состояния
Успешная операция возвращает код состояния 200 (ОК).
Сведения о кодах состояния см. в разделе Коды состояния и ошибок.
Заголовки ответов
Ответ для этой операции включает следующие заголовки. Ответ также может включать дополнительные стандартные заголовки HTTP. Все стандартные заголовки соответствуют спецификации протокола HTTP/1.1.
Заголовок ответа | Описание |
---|---|
Last-Modified |
Возвращает дату и время последнего изменения общей папки. Дата в формате согласно RFC 1123. Дополнительные сведения см. в разделе Представление значений даты и времени в заголовках. Любая операция, которая изменяет общий ресурс или его свойства, обновляет время последнего изменения. Операции с файлами не влияют на время последнего изменения общего ресурса. |
ETag |
Содержит значение, представляющее версию общей папки в кавычках. |
x-ms-request-id |
Уникально идентифицирует выполненный запрос. Его можно использовать для устранения неполадок с запросом. Дополнительные сведения см. в статье Устранение неполадок с операциями API. |
x-ms-version |
Указывает версию Файлы Azure, которая использовалась для выполнения запроса. |
Date или x-ms-date |
Значение даты и времени в формате UTC, указывающее время отправки ответа службой. |
x-ms-client-request-id |
Может использоваться для устранения неполадок запросов и соответствующих ответов. Значение этого заголовка равно значению заголовка x-ms-client-request-id , если он присутствует в запросе и содержит не более 1024 видимых символов ASCII. Если заголовок x-ms-client-request-id отсутствует в запросе, этот заголовок не будет присутствовать в ответе. |
Текст ответа
Нет.
Авторизация
Только владелец учетной записи может вызвать эту операцию.
Комментарии
Вызов Set Share Metadata
перезаписывает все существующие метаданные, связанные с общей папкой. Изменить отдельную пару "имя-значение" невозможно.
Вы также можете задать метаданные для общей папки во время ее создания в рамках операции Создания общего ресурса .
Вызов Set Share Metadata
обновляет ETag
свойства и Last-Modified-Time
для общей папки.
Set Share Metadata
не поддерживается для общей snapshot. Попытка выполнить эту операцию в общей snapshot завершится ошибкой с кодом состояния 400 (InvalidQueryParameterValue). Вы можете задать метаданные для общей snapshot во время его создания в рамках Snapshot Share
операции.