Поделиться через

Справочник по кэшу пользовательских ресурсов

  • Статья

В этой статье рассматриваются требования к конечным точкам для применения кэша настраиваемых ресурсов. Для ознакомления с поставщиками настраиваемых ресурсов Azure см. статью Общие сведения о поставщиках настраиваемых ресурсов.

Определение конечной точки кэша ресурсов

Ресурс прокси-сервера можно создать, указав для routingType значение "Прокси-сервер, кэш".

Пример поставщика настраиваемого ресурса::

{
  "properties": {
    "resourceTypes": [
      {
        "name": "myCustomResources",
        "routingType": "Proxy, Cache",
        "endpoint": "https://{endpointURL}/"
      }
    ]
  },
  "location": "eastus",
  "type": "Microsoft.CustomProviders/resourceProviders",
  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}",
  "name": "{resourceProviderName}"
}

Создание конечной точки ресурса прокси-сервера

Конечная точка, реализующая конечную точку ресурса "Прокси-сервер, кэш" должна поддерживать запрос и ответ для нового API в Azure. В этом случае resourceType создаст новый API ресурсов Azure для PUT, GET и DELETE для выполнения CRUD в одном ресурсе, а также GET, чтобы получить все существующие ресурсы.

Примечание

Программный интерфейс API Azure создаст методы запроса PUT, GET и DELETE, но конечной точке кэша будет необходимо обработать только PUT и DELETE. Мы рекомендуем, чтобы конечная точка также применяла GET.

Создание настраиваемого ресурса

Входящий запрос API Azure:

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

{
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Этот запрос в дальнейшем будет направлен в конечную точку в формате:

PUT https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}

{
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Ответ от конечной точки в дальнейшем перенаправляется обратно клиенту. Ответ должен быть следующим:

  • Допустимый документ объекта JSON. Все массивы и строки должны быть вложены в объект верхнего уровня.
  • Content-Type Заголовок должен иметь настройку "application/json; charset=utf-8".
  • Поставщик настраиваемого ресурса перепишет поля name, type и id для запроса.
  • Поставщик настраиваемого ресурса вернет только поля под properties объект для кэша конечной точки.

Ответ конечной точки:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Поля name, id и type будут автоматически созданы для настраиваемого ресурса поставщиком настраиваемого ресурса.

Ответ поставщика настраиваемых ресурсов Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Удаление настраиваемого ресурса

Входящий запрос API Azure:

Delete https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

Этот запрос в дальнейшем будет направлен в конечную точку в формате:

Delete https://{endpointURL}/?api-version=2018-09-01-preview
Content-Type: application/json
X-MS-CustomProviders-RequestPath: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}

Ответ от конечной точки в дальнейшем перенаправляется обратно клиенту. Ответ должен быть следующим:

  • Допустимый документ объекта JSON. Все массивы и строки должны быть вложены в объект верхнего уровня.
  • Content-Type Заголовок должен иметь настройку "application/json; charset=utf-8".
  • Поставщик настраиваемого ресурса Azure только удаляет элемент из своего кэша, когда возвращается ответ уровня 200. Даже, если ресурса не существует конечная точка должна вернуть ответ 204.

Ответ конечной точки:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Ответ поставщика настраиваемых ресурсов Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Извлечение настраиваемого ресурса

Входящий запрос API Azure:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

Запрос не будет перенаправлен в конечную точку.

Ответ поставщика настраиваемых ресурсов Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "name": "{myCustomResourceName}",
    "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
    "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
    "properties": {
        "myProperty1": "myPropertyValue1",
        "myProperty2": {
            "myProperty3" : "myPropertyValue3"
        }
    }
}

Перечисление всех настраиваемых ресурсов

Входящий запрос API Azure:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources?api-version=2018-09-01-preview
Authorization: Bearer eyJ0e...
Content-Type: application/json

Запрос не будет перенаправлен в конечную точку.

Ответ поставщика настраиваемых ресурсов Azure:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "value" : [
        {
            "name": "{myCustomResourceName}",
            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/{resourceProviderName}/myCustomResources/{myCustomResourceName}",
            "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
            "properties": {
                "myProperty1": "myPropertyValue1",
                "myProperty2": {
                    "myProperty3" : "myPropertyValue3"
                }
            }
        }
    ]
}

Дальнейшие действия