Sdílet prostřednictvím

Referenční informace k mezipaměti vlastních prostředků

  • Článek

Tento článek projde požadavky na koncové body, které implementují vlastní prostředky mezipaměti. Pokud nejste obeznámeni s vlastními poskytovateli prostředků Azure, projděte si přehled o vlastních poskytovatelích prostředků.

Definování koncového bodu prostředku mezipaměti

Prostředek proxy serveru je možné vytvořit zadáním routingType pole Proxy, mezipaměť.

Ukázkový vlastní poskytovatel prostředků:

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

Vytvoření koncového bodu prostředku proxy serveru

Koncový bod, který implementuje koncový bod prostředku Proxy, mezipaměť, musí zpracovat požadavek a odpověď na nové rozhraní API v Azure. V tomto případě resourceType vygeneruje nové rozhraní API prostředků Azure pro PUT, GETa DELETE pro provedení CRUD pro jeden prostředek a GET také pro načtení všech existujících prostředků.

Poznámka

Rozhraní Azure API vygeneruje metody PUTpožadavků , GETa DELETE, ale koncový bod mezipaměti musí zpracovat PUT pouze a DELETE. Doporučujeme, aby koncový bod implementoval GETtaké .

Vytvoření vlastního prostředku

Příchozí požadavek rozhraní Azure API:

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

Tento požadavek se pak předá koncovému bodu ve formátu:

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

Odpověď z koncového bodu se pak přepošla zpět zákazníkovi. Odpověď by měla vrátit:

  • Platný dokument objektu JSON. Všechna pole a řetězce by měly být vnořené pod horním objektem.
  • Hlavička Content-Type by měla být nastavená na application/json; charset=utf-8".
  • Vlastní poskytovatel prostředků přepíše namepole , typea id pro požadavek.
  • Vlastní poskytovatel prostředků vrátí pouze pole pod objektem properties pro koncový bod mezipaměti.

Odpověď koncového bodu:

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

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

Vlastní nameposkytovatel prostředků automaticky vygeneruje pole , ida type pro vlastní prostředek.

Odpověď vlastního poskytovatele prostředků 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"
        }
    }
}

Odebrání vlastního prostředku

Příchozí požadavek rozhraní Azure API:

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

Tento požadavek se pak předá koncovému bodu ve formátu:

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}

Odpověď z koncového bodu se pak přepošla zpět zákazníkovi. Odpověď by měla vrátit:

  • Platný dokument objektu JSON. Všechna pole a řetězce by měly být vnořené pod horním objektem.
  • Hlavička Content-Type by měla být nastavená na application/json; charset=utf-8".
  • Poskytovatel vlastních prostředků Azure odebere položku ze své mezipaměti pouze v případě, že se vrátí odpověď na úrovni 200. I když prostředek neexistuje, koncový bod by měl vrátit hodnotu 204.

Odpověď koncového bodu:

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

Odpověď vlastního poskytovatele prostředků Azure:

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

Načtení vlastního prostředku

Příchozí požadavek rozhraní Azure API:

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

Požadavek se nepředá koncovému bodu.

Odpověď vlastního poskytovatele prostředků 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"
        }
    }
}

Výčet všech vlastních prostředků

Příchozí požadavek rozhraní Azure API:

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

Požadavek se nepředá koncovému bodu.

Odpověď vlastního poskytovatele prostředků 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"
                }
            }
        }
    ]
}

Další kroky