Наклейки
Ресурс Метка определяется следующим образом:
{
"name": [string] // Name of the label
}
Поддерживает следующие операции:
- List
Для всех операций name
— необязательный параметр фильтра. Если он не указан, подразумевается любая метка.
Необходимые компоненты
- Все HTTP-запросы должны пройти проверку подлинности. См. раздел об аутентификации.
- Все HTTP-запросы должны предоставлять явный запрос
api-version
. См. раздел о версионировании.
Вывод списка меток
GET /labels?api-version={api-version} HTTP/1.1
Ответы:
HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.labelset+json; charset=utf-8"
{
"items": [
{
"name": "{label-name}"
},
...
],
"@nextLink": "{relative uri}"
}
Разбиение на страницы
Если число возвращаемых элементов превышает предельное значение, то результат разбивается на страницы. Следуйте дополнительным заголовкам ответа Link
и используйте rel="next"
для навигации.
Иначе содержимое предоставляет следующую ссылку в форме свойства @nextLink
. Следующая ссылка содержит параметр api-version
.
GET /labels?api-version={api-version} HTTP/1.1
Ответ.
HTTP/1.1 OK
Content-Type: application/vnd.microsoft.appconfig.labelset+json; charset=utf-8
Accept-Ranges: items
Link: <{relative uri}>; rel="next"
{
"items": [
...
],
"@nextLink": "{relative uri}"
}
Фильтрация
Поддерживается фильтр по name
.
GET /labels?name={label-name}&api-version={api-version}
Поддерживаемые фильтры
Фильтр меток | Действие |
---|---|
name не указан или имеет значение name=* |
Совпадает с любой меткой |
name=abc |
Совпадает с меткой с именем abc |
name=abc* |
Совпадает с именами меток, которые начинаются с abc |
name=abc,xyz |
Совпадает с именами меток abc или xyz (ограничение: пять CSV-файлов) |
Зарезервированные знаки
*
, , \
,
Если зарезервированный знак является частью значения, он должен быть экранирован с помощью \{Reserved Character}
. Незарезервированные знаки также могут быть экранированы.
Проверка фильтра
Если возникает ошибка проверки фильтра, ответом является HTTP 400
со сведениями об ошибке:
HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
"type": "https://azconfig.io/errors/invalid-argument",
"title": "Invalid request parameter 'name'",
"name": "name",
"detail": "name(2): Invalid character",
"status": 400
}
Примеры
Все
GET /labels?api-version={api-version}
Имя метки начинается с abc
GET /labels?name=abc*&api-version={api-version}
Имя метки — abc или xyz
GET /labels?name=abc,xyz&api-version={api-version}
Поля со сведениями о запросах
Используйте необязательный параметр строки запроса $select
и укажите список запрошенных полей, разделенный запятыми. Если параметр $select
пропущен, ответ содержит набор по умолчанию.
GET /labels?$select=name&api-version={api-version} HTTP/1.1
Доступ на основе времени
Получение представления результата, который был в прошлый раз. См. раздел 2.1.1
GET /labels&api-version={api-version} HTTP/1.1
Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT
Ответ.
HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.labelset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <{relative uri}>; rel="original"
{
"items": [
....
]
}