مشاركة عبر

بطاقات عنونة

  • مقالة

يُعرّف مورد التسمية على النحو التالي:

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

يدعم العملياتِ التالية:

  • List

بالنسبة لجميع العمليات، name هي معلمة تصفيةٍ اختيارية. في حال تم حذفها، فإنها تعني أي تسمية.

المتطلبات الأساسية

  • لابد من مصادقة جميع طلبات HTTP. راجع القسم authentication.
  • يجب أن توفر جميع طلبات 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 (تقتصر على 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 /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": [
        ....
    ]
}