Etiquetas
El recurso Etiqueta se define de la siguiente manera:
{
"name": [string] // Name of the label
}
Admite las siguientes operaciones:
- List
Para todas las operaciones, name
es un parámetro de filtro opcional. Si se omite, implica cualquier etiqueta.
Requisitos previos
- Se deben autenticar todas las solicitudes HTTP. Consulte la sección Autenticación.
- Todas las solicitudes HTTP deben proporcionar parámetros
api-version
explícitos. Consulte la sección Control de versiones.
Enumeración de etiquetas
GET /labels?api-version={api-version} HTTP/1.1
Respuestas:
HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.labelset+json; charset=utf-8"
{
"items": [
{
"name": "{label-name}"
},
...
],
"@nextLink": "{relative uri}"
}
Paginación
El resultado se pagina si el número de elementos devueltos supera el límite de respuesta. Siga los encabezados de respuesta Link
opcionales y use rel="next"
para la navegación.
Como alternativa, el contenido proporciona un vínculo siguiente en forma de la propiedad @nextLink
. El siguiente vínculo contiene el parámetro api-version
.
GET /labels?api-version={api-version} HTTP/1.1
Respuesta:
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}"
}
Filtrado
Se admite el filtrado por name
.
GET /labels?name={label-name}&api-version={api-version}
Filtros admitidos
Filtros de etiqueta | Efecto |
---|---|
se omite name o name=* |
Coincide con cualquier etiqueta |
name=abc |
Coincide con una etiqueta denominada abc. |
name=abc* |
Coincide con los nombres de etiqueta que empiezan por abc. |
name=abc,xyz |
Coincide con los nombres de etiqueta abc o xyz (se limita a 5 archivos CSV). |
Caracteres reservados
*
, \
, ,
Si un carácter reservado forma parte del valor, se debe escapar mediante \{Reserved Character}
. También se puede aplicar escape a los caracteres no reservados.
Validación del filtro
Si se produce un error de validación del filtro, la respuesta es HTTP 400
con detalles del error:
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
}
Ejemplos
All
GET /labels?api-version={api-version}
El nombre de la etiqueta comienza con abs.
GET /labels?name=abc*&api-version={api-version}
El nombre de la etiqueta es abc o xyz.
GET /labels?name=abc,xyz&api-version={api-version}
Campos específicos de solicitud
Use el parámetro de cadena de consulta $select
opcional y proporcione una lista separada por comas de los campos solicitados. Si se omite el parámetro $select
, la respuesta contiene el conjunto predeterminado.
GET /labels?$select=name&api-version={api-version} HTTP/1.1
Acceso basado en el tiempo
Obtenga una representación del resultado tal como era en un momento anterior. Consulte la sección 2.1.1
GET /labels&api-version={api-version} HTTP/1.1
Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT
Respuesta:
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": [
....
]
}