Claves

  • Artículo

La siguiente sintaxis representa un recurso de clave:

{
    "name": [string]             // Name of the key
}

Operations

Los recursos clave admiten la operación siguiente:

  • List

Para todas las operaciones, name es un parámetro de filtro opcional. Si se omite, indica cualquier clave.

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.

Enumera las claves

GET /keys?api-version={api-version} HTTP/1.1

Respuestas:

HTTP/1.1 200 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json; charset=utf-8"

{
    "items": [
        {
          "name": "{key-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 /keys?api-version={api-version} HTTP/1.1

Respuesta:

HTTP/1.1 OK
Content-Type: application/vnd.microsoft.appconfig.keyset+json; charset=utf-8
Link: <{relative uri}>; rel="next"

{
    "items": [
        ...
    ],
    "@nextLink": "{relative uri}"
}

Filtrado

Se admite el filtrado por name.

GET /keys?name={key-name}&api-version={api-version}

Se admiten los siguientes filtros:

Filtro de clave Efecto
se omite name o name=* Coincide con cualquier clave
name=abc Coincide con una clave de nombre abc
name=abc* Coincide con los nombres de clave que empiezan por abc
name=abc,xyz Coincide con los nombres de clave abc o xyz (se limita a 5 archivos .CSV)

No se permiten los caracteres siguientes: *, \ y ,

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

En el caso de 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 /keys?api-version={api-version}

  • El nombre de la clave comienza con abc.

    GET  /keys?name=abc*&api-version={api-version}

  • El nombre de la clave es abc o xyz.

    GET /keys?name=abc,xyz&api-version={api-version}

Solicitud de campos específicos

Use el parámetro de cadena de consulta opcional $select y proporcione una lista separada por comas de campos solicitados. Si se omite el parámetro $select, la respuesta contiene el conjunto predeterminado.

GET /keys?$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 /keys&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.keyset+json"
Memento-Datetime: Sat, 12 May 2018 02:10:00 GMT
Link: <relative uri>; rel="original"

{
    "items": [
        ....
    ]
}