simétricas

A seguinte sintaxe representa um recurso importante:

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

Operations

Os principais recursos são compatíveis com a seguinte operação:

• Lista

name é um parâmetro de filtro opcional usado em todas as operações. Caso seja omitido, ele implicará em outra chave.

Pré-requisitos

• Todas as solicitações HTTP deverão ser autenticadas. Confira a seção autenticação.
• Todas as solicitações HTTP deverão fornecer uma api-version explícita. Confira a seção controle de versão.

Listar chaves

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

Respostas:

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

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

Paginação

Caso o número de itens retornados exceda o limite de resposta, o resultado será paginado. Siga os cabeçalhos de resposta opcionais do Link e use rel="next" para navegação. Como alternativa, o conteúdo fornecerá o próximo link no formulário da propriedade @nextLink. O próximo link contém o parâmetro api-version.

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

Resposta:

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

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

Filtragem

Há suporte para uma filtragem por name.

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

Há suporte para os seguintes filtros:

Filtro Principal	Efeito
name é omitido ou name=*	Corresponde a qualquer chave
name=abc	Corresponde a uma chave denominada abc
name=abc*	Corresponde aos nomes de chave que começam com abc
name=abc,xyz	Corresponde aos nomes de chave abc ou xyz (limitado a cinco CSVs)

Estes caracteres são reservados: *, \ e ,

Caso um caractere reservado faça parte do valor, ele deverá ter um escape usando o \{Reserved Character}. Os caracteres não reservados também podem ser ignorados.

Validação de filtro

Caso ocorra um erro de validação de filtro, a resposta será HTTP 400 com os detalhes do erro:

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
}

Exemplos

• Tudo

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

• O nome da chave começa com abc

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

• O nome da chave é abc ou xyz

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

Solicitar campos específicos

Use o parâmetro opcional $select da cadeia de caracteres de consulta e forneça uma lista separada por vírgulas dos campos solicitados. Caso o parâmetro $select seja omitido, a resposta conterá o conjunto padrão.

GET /keys?$select=name&api-version={api-version} HTTP/1.1

Acesso baseado em tempo

Obtenha uma representação do resultado mostrado anteriormente. Confira a seção 2.1.1

GET /keys&api-version={api-version} HTTP/1.1
Accept-Datetime: Sat, 12 May 2018 02:10:00 GMT

Resposta:

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": [
        ....
    ]
}