Chaves

A sintaxe a seguir representa um recurso chave:

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

Operações

Os principais recursos apoiam a seguinte operação:

• Listagem

Para todas as operações name é um parâmetro de filtro opcional. Se omitido, implica qualquer chave.

Pré-requisitos

• Todas as solicitações HTTP devem ser autenticadas. Consulte a seção de autenticação .
• Todas as solicitações HTTP devem fornecer arquivos .api-version Consulte a seção de 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

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

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

A filtragem por name é suportada.

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

Os seguintes filtros são suportados:

Filtro de chave	Efeito
name for omitida ou name=*	Corresponde a qualquer tecla
name=abc	Corresponde a uma chave chamada abc
name=abc*	Corresponde a nomes de chaves que começam com abc
name=abc,xyz	Corresponde a nomes de chave abc ou xyz (limitado a 5 CSV)

Os seguintes caracteres são reservados: *, \, ,

Se um caractere reservado fizer parte do valor, ele deverá ser escapado usando \{Reserved Character}. Caracteres não reservados também podem ser escapados.

Validação do filtro

No caso de um erro de validação de filtro, a resposta é HTTP 400 com 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

• Todos

  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 de seqüência de caracteres de consulta e forneça uma lista separada por vírgulas dos campos solicitados. Se o $select parâmetro for omitido, a resposta conterá o conjunto padrão.

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

Acesso baseado no tempo

Obter uma representação do resultado como era em um momento passado. Ver secçã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": [
        ....
    ]
}