مشاركة عبر

المفاتيح

  • مقالة

يمثل بناء الجملة التالي موردًا رئيسًا:

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

العمليات

تدعم الموارد الأساسية العملية التالية:

  • List

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

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

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