المفاتيح

  • مقالة
  • قراءة خلال 2 دقائق

إصدار واجهة برمجة التطبيقات: 1.0

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

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

العمليات

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

  • قائمة

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

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

مفاتيح القائمة

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

الوصول Time-Based

الحصول على تمثيل للنتيجة كما كانت في وقت سابق. انظر القسم 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": [
        ....
    ]
}