Egyéni erőforrás-gyorsítótár – referencia

Cikk
06/01/2023

Ez a cikk az egyéni gyorsítótár-erőforrásokat implementáló végpontok követelményeit ismerteti. Ha nem ismeri az Azure-beli egyéni erőforrás-szolgáltatókat, tekintse meg az egyéni erőforrás-szolgáltatók áttekintését.

Gyorsítótár-erőforrásvégpont definiálása

Proxyerőforrás a "Proxy, Gyorsítótár" érték megadásával routingType hozható létre.

Minta egyéni erőforrás-szolgáltató:

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

Proxyerőforrás-végpont létrehozása

A "Proxy, Cache" erőforrásvégpontot implementáló végpontnak kezelnie kell az Új API kérését és válaszát az Azure-ban. Ebben az esetben a resourceType létrehoz egy új Azure-erőforrás API-t a PUT, GETDELETE és a CRUD egyetlen erőforráson való végrehajtásához, valamint GET az összes meglévő erőforrás lekéréséhez.

Megjegyzés

Az Azure API létrehozza a kérési metódusokat PUT, , és DELETE, de a gyorsítótárvégpontnak csak a és DELETEa parancsot kell kezelnie PUTGET. Azt javasoljuk, hogy a végpont is implementálja a következőt GET: .

Egyéni erőforrás létrehozása

Bejövő Azure API-kérés:

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

Ezt a kérést a rendszer a következő formában továbbítja a végpontra:

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

A végpont válasza ezután vissza lesz továbbítja az ügyfélnek. A válasznak a következőt kell visszaadnia:

Érvényes JSON-objektumdokumentum. Minden tömböt és sztringet egy felső objektum alá kell ágyazni.
A Content-Type fejlécet "application/json; charset=utf-8".
Az egyéni erőforrás-szolgáltató felülírja a namekérés , typeés id mezőit.
Az egyéni erőforrás-szolgáltató csak a properties gyorsítótárvégpont objektumában lévő mezőket adja vissza.

Végpont válasza:

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

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

A name, id, és type mezőket az egyéni erőforrás-szolgáltató automatikusan létrehozza az egyéni erőforráshoz.

Egyéni Azure-erőforrás-szolgáltató válasza:

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

Egyéni erőforrás eltávolítása

Bejövő Azure API-kérés:

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

Ezt a kérést a rendszer a következő formában továbbítja a végpontra:

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}

A végpont válasza ezután vissza lesz továbbítja az ügyfélnek. A válasznak a következőt kell visszaadnia:

Érvényes JSON-objektumdokumentum. Minden tömböt és sztringet egy felső objektum alá kell ágyazni.
A Content-Type fejlécet "application/json; charset=utf-8".
Az Azure Custom Resource Provider csak akkor távolítja el az elemet a gyorsítótárból, ha 200 szintű választ ad vissza. Még ha az erőforrás nem is létezik, a végpontnak a 204-et kell visszaadnia.

Végpont válasza:

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

Egyéni Azure-erőforrás-szolgáltató válasza:

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

Egyéni erőforrás lekérése

Bejövő Azure API-kérés:

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

A rendszer nem továbbítja a kérelmet a végpontnak.

Egyéni Azure-erőforrás-szolgáltató válasza:

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

Az összes egyéni erőforrás számbavétele

Bejövő Azure API-kérés:

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

A rendszer nem továbbítja a kérelmet a végpontnak.

Egyéni Azure-erőforrás-szolgáltató válasza:

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

Megosztás a következőn keresztül:

Egyéni erőforrás-gyorsítótár – referencia

Gyorsítótár-erőforrásvégpont definiálása

Proxyerőforrás-végpont létrehozása

Egyéni erőforrás létrehozása

Egyéni erőforrás eltávolítása

Egyéni erőforrás lekérése

Az összes egyéni erőforrás számbavétele

Következő lépések

Visszajelzés

További források