Rótulos

  • Artigo

O recurso Etiqueta é definido do seguinte modo:

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

Ela é compatível com as seguintes operações:

  • Lista

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

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 etiquetas

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

Respostas:

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

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

Resposta:

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}"
}

Filtragem

Há suporte para uma filtragem por name.

GET /labels?name={label-name}&api-version={api-version}

Filtros com suporte

Filtro de rótulo Efeito
name é omitido ou name=* Corresponde a outra etiqueta
name=abc Corresponde a um rótulo chamado abc
name=abc* Corresponde a nomes de etiquetas que começam com abc
name=abc,xyz Corresponde a nomes de etiquetas abc ou xyz (limitados a cinco CSVs)

Caracteres reservados

*, \, ,

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 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 /labels?api-version={api-version}

  • O nome da etiqueta começa com abc

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

  • O nome da etiqueta é abc ou xyz

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

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