구성

다음 구문은 키 리소스를 나타냅니다.

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

작업

주요 리소스는 다음 작업을 지원합니다.

• List

모든 작업에 대해 name은 선택적 필터 매개 변수입니다. 생략하면 모든 키를 의미합니다.

필수 조건

• 모든 HTTP 요청은 인증되어야 합니다. 인증 섹션을 참조하세요.
• 모든 HTTP 요청은 명시적 api-version. 버전 관리 세션을 참조하세요.

키를 나열합니다.

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

응답:

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

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

페이지 매김

반환된 항목 수가 응답 제한을 초과하면 결과가 페이지가 매겨집니다. 선택적 Link 응답 헤더를 따르고 탐색에 사용합니다 rel="next" . 또는 콘텐츠는 속성 형식의 @nextLink 다음 링크를 제공합니다. 다음 링크에는 api-version 매개 변수가 포함됩니다.

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

응답:

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

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

필터링

name에 의한 필터링이 지원됩니다.

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

다음 필터가 지원됩니다.

키 필터	효과
name은 생략 또는 name=*	모든 키와 일치
name=abc	abc라는 이름의 키와 일치
name=abc*	abc로 시작하는 키 이름과 일치
name=abc,xyz	키 이름 abc 또는 xyz (5 CSV로 제한됨)와 일치합니다.

다음 문자가 예약되어 있습니다. *, \, ,

예약 문자가 값의 일부인 \{Reserved Character}경우 . 예약되지 않은 문자도 이스케이프할 수 있습니다.

필터 유효성 검사

필터 유효성 검사 오류의 경우 응답은 오류 세부 정보가 포함된 HTTP 400 입니다.

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
}

예제

• 모두

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

• 키 이름은 abc로 시작합니다.

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

• 키 이름은 abc 또는 xyz입니다.

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

요청 관련 필드

선택적 $select 쿼리 문자열 매개 변수를 사용하고 요청된 필드의 쉼표로 구분된 목록을 제공합니다. $select 매개 변수를 생략하면 응답에 기본 세트가 포함됩니다.

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

시간 기반 액세스

과거와 같은 결과의 표시를 얻습니다. 섹션 2.1.1 참조

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

응답:

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