ラベル

  • [アーティクル]

api-version: 1.0

ラベル リソースは次のように定義されます。

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

次の操作がサポートされています。

  • List

すべての操作について、name は省略可能なフィルター パラメーターです。 省略されている場合、これは任意のラベルを意味します。

前提条件

  • すべての HTTP 要求が認証される必要があります。 認証に関するセクションを参照してください。
  • すべての HTTP 要求で、明示的な api-version を指定する必要があります。 バージョン管理に関するセクションを参照してください。

ラベルを一覧表示する

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

応答:

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

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

改ページ位置の自動修正

返された項目の数が応答の制限を超えている場合、結果は改ページされます。 省略可能な Link 応答ヘッダーに従い、rel="next" を使用してナビゲーションを行います。 また、コンテンツで、@nextLink プロパティの形式で次のリンクが指定されます。 次のリンクには api-version パラメーターが含まれています。

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

応答:

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

フィルター処理

name によるフィルター処理がサポートされています。

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

サポートされているフィルター

キー フィルター 結果
name を省略 (または name=*) すべてのラベルに一致します
name=abc abc という名前のラベルに一致します
name=abc* abc で始まるラベル名に一致します
name=abc,xyz ラベル名 abc または xyz に一致します (CSV の上限は 5 つ)

予約文字

*, \, ,

予約文字が値の一部である場合は、\{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
}

例

  • All

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

  • ラベル名が abc で始まる

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

  • ラベル名が abc または xyz のいずれかである

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

要求に固有のフィールド

省略可能な $select クエリ文字列パラメーターを使用して、要求されたフィールドのコンマ区切りリストを指定します。 $select パラメーターを省略した場合、応答には既定のセットが含まれます。

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

時間ベースのアクセス

過去の時間のものとして結果の表現を取得します。 2.1.1 セクションを参照してください。

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

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