Membuat dan menggunakan penyedia sumber daya kustom

Penyedia sumber daya kustom adalah kontrak antara Azure dan titik akhir. Dengan penyedia sumber daya kustom, Anda dapat mengubah alur kerja di Azure. Tutorial ini menunjukkan proses pembuatan penyedia sumber daya kustom. Jika Anda tidak terbiasa dengan Penyedia Sumber Daya Kustom Azure, lihat gambaran umum Penyedia Sumber Daya Kustom Azure.

Membuat penyedia sumber daya kustom

Catatan

Tutorial ini tidak menunjukkan cara menulis titik akhir. Jika Anda tidak memiliki titik akhir RESTFUL, ikuti tutorial tentang penulisan titik akhir RESTful, yang merupakan fondasi untuk tutorial saat ini.

Setelah membuat titik akhir, Anda dapat membuat penyedia sumber daya kustom untuk menghasilkan kontrak antara penyedia dan titik akhir. Dengan penyedia sumber daya kustom, Anda dapat menentukan daftar definisi titik akhir:

{
  "name": "myEndpointDefinition",
  "routingType": "Proxy",
  "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
}

Properti	Diperlukan	Deskripsi
nama	Ya	Nama definisi titik akhir. Azure mengekspos nama ini melalui API-nya pada /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders /resourceProviders/{resourceProviderName}/{endpointDefinitionName}
jenisPerutean	Tidak	Jenis kontrak titik akhir. Jika nilainya tidak ditentukan, nilai tersebut akan di-default ke "Proksi".
titikAkhir	Ya	Titik akhir untuk merutekan permintaan. Titik akhir ini menangani respons dan semua efek samping dari permintaan.

Nilai titikAkhir adalah URL pemicu aplikasi fungsi Azure. Placeholder <yourapp>, <funcname>, dan <functionkey> harus diganti dengan nilai untuk aplikasi fungsi yang Anda buat.

Tetapkan tindakan dan sumber daya kustom

Penyedia sumber daya kustom berisi daftar definisi titik akhir yang dimodelkan di bawah properti tindakan dan resourceTypes . Properti tindakan memetakan ke tindakan kustom yang diekspos oleh penyedia sumber daya kustom, dan properti resourceTypes adalah sumber daya kustom. Dalam tutorial ini, penyedia sumber daya kustom memiliki properti tindakan bernama myCustomAction dan properti resourceTypes bernama myCustomResources.

{
  "properties": {
    "actions": [
      {
        "name": "myCustomAction",
        "routingType": "Proxy",
        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
      }
    ],
    "resourceTypes": [
      {
        "name": "myCustomResources",
        "routingType": "Proxy",
        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
      }
    ]
  },
  "location": "eastus"
}

Menyebarkan penyedia sumber daya kustom

Catatan

Anda harus mengganti nilai titikAkhir dengan URL pemicu dari aplikasi fungsi yang dibuat dalam tutorial sebelumnya.

Anda dapat menyebarkan penyedia sumber daya kustom sebelumnya dengan menggunakan templat Azure Resource Manager:

{
    "$schema": "http://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "resources": [
        {
            "type": "Microsoft.CustomProviders/resourceProviders",
            "name": "myCustomProvider",
            "apiVersion": "2018-09-01-preview",
            "location": "eastus",
            "properties": {
                "actions": [
                    {
                        "name": "myCustomAction",
                        "routingType": "Proxy",
                        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
                    }
                ],
                "resourceTypes": [
                    {
                        "name": "myCustomResources",
                        "routingType": "Proxy",
                        "endpoint": "https://<yourapp>.azurewebsites.net/api/<funcname>?code=<functionkey>"
                    }
                ]
            }
        }
    ]
}

Gunakan tindakan dan sumber daya kustom

Setelah membuat penyedia sumber daya kustom, Anda dapat menggunakan API Azure baru. Bagian berikut menjelaskan cara memanggil dan menggunakan penyedia sumber daya kustom.

Tindakan kustom

Azure CLI

Catatan

Anda harus mengganti tempat penampung {subscriptionId} dan {resourceGroupName} dengan langganan dan grup sumber daya tempat Anda menyebarkan penyedia sumber daya kustom.

az resource invoke-action --action myCustomAction \
                          --ids /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/myCustomProvider \
                          --request-body
                            '{
                                "hello": "world"
                            }'

Parameter	Diperlukan	Deskripsi
tindakan	Ya	Nama tindakan yang ditentukan dalam penyedia sumber daya kustom.
id	Ya	ID sumber daya penyedia sumber daya kustom.
isi-permintaan	Tidak	Isi permintaan yang akan dikirim ke titik akhir.

Sumber daya kustom

Azure CLI

Catatan

Anda harus mengganti tempat penampung {subscriptionId} dan {resourceGroupName} dengan langganan dan grup sumber daya tempat Anda menyebarkan penyedia sumber daya kustom.

Buat sumber daya kustom

az resource create --is-full-object \
                   --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/myCustomProvider/myCustomResources/myTestResourceName1 \
                   --properties
                    '{
                        "location": "eastus",
                        "properties": {
                            "hello" : "world"
                        }
                    }'

Parameter	Diperlukan	Deskripsi
adalah-objek-penuh	Ya	Menunjukkan apakah objek properti menyertakan opsi lain seperti lokasi, tag, SKU, atau paket.
id	Ya	ID sumber daya penyedia kustom. ID ini adalah ekstensi dari ID sumber daya penyedia sumber daya kustom.
properti	Ya	Isi permintaan yang akan dikirim ke titik akhir.

Hapus sumber daya kustom

az resource delete --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/myCustomProvider/myCustomResources/myTestResourceName1

Parameter	Diperlukan	Deskripsi
id	Ya	ID sumber daya penyedia kustom. ID ini adalah ekstensi dari ID sumber daya penyedia sumber daya kustom.

Ambil sumber daya kustom

az resource show --id /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.CustomProviders/resourceProviders/myCustomProvider/myCustomResources/myTestResourceName1

Parameter	Diperlukan	Deskripsi
id	Ya	ID sumber daya penyedia kustom. ID ini adalah ekstensi dari ID sumber daya penyedia sumber daya kustom.

Templat

Sampel templat Resource Manager:

{
    "$schema": "http://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "resources": [
        {
            "type": "Microsoft.CustomProviders/resourceProviders/myCustomResources",
            "name": "myCustomProvider/myTestResourceName1",
            "apiVersion": "2018-09-01-preview",
            "location": "eastus",
            "properties": {
                "hello": "world"
            }
        }
    ]
}

Parameter	Diperlukan	Deskripsi
jenisSumberDaya	Ya	Nilai name properti resourceTypes yang ditentukan dalam penyedia sumber daya kustom.
namaPenyediaSumberDaya	Ya	Nama instans penyedia sumber daya kustom.
namaSumberDayaKustom	Ya	Nama sumber daya kustom.

Catatan

Setelah Anda selesai menyebarkan dan menggunakan penyedia sumber daya kustom, ingatlah untuk membersihkan semua sumber daya yang dibuat termasuk aplikasi fungsi Azure.

Langkah berikutnya

Dalam artikel ini, Anda mempelajari tentang penyedia sumber daya kustom. Untuk informasi selengkapnya, lihat:

• Cara untuk: Menambahkan tindakan kustom ke Azure REST API
• Cara untuk: Menambahkan sumber daya kustom ke Azure REST API