Share via

Layanan/produk Microsoft.ApiManagement

  • Artikel

Definisi sumber daya Bicep

Jenis sumber daya layanan/produk dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/products, tambahkan Bicep berikut ke templat Anda.

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

Nilai properti

layanan/produk

Nama Deskripsi Nilai
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep.		 string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
induk Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk.

Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk.		 Nama simbolis untuk sumber daya jenis: layanan
properti Properti kontrak entitas produk. ProductContractProperties

ProductContractProperties

Nama Deskripsi Nilai
approvalRequired apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. bool
deskripsi Deskripsi produk. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama produk. string (diperlukan)
state apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan. 'notPublished'
'diterbitkan'
subscriptionRequired Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini. Jika true, produk disebut sebagai "dilindungi" dan kunci langganan yang valid diperlukan agar permintaan ke API yang disertakan dalam produk berhasil. Jika false, produk disebut sebagai "buka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar. bool
subscriptionsLimit Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. int
terms Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan. string

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat instance API Management dan semua sub-sumber daya menggunakan templat

Sebarkan ke Azure		 Templat ini menunjukkan cara membuat layanan API Management dan mengonfigurasi sub-entitas
Membuat Azure Front Door di depan Azure API Management

Sebarkan ke Azure		 Sampel ini menunjukkan cara menggunakan Azure Front Door sebagai load balancer global di depan Azure API Management.

Definisi sumber daya templat ARM

Jenis sumber daya layanan/produk dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/products, tambahkan JSON berikut ke templat Anda.

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

Nilai properti

layanan/produk

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.ApiManagement/service/products'
apiVersion Versi api sumber daya '2023-05-01-preview'
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di templat JSON ARM.		 string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
properti Properti kontrak entitas produk. ProductContractProperties

ProductContractProperties

Nama Deskripsi Nilai
approvalRequired apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. bool
deskripsi Deskripsi produk. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama produk. string (diperlukan)
state apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya dapat dilihat oleh administrator. Status default Produk tidak Diterbitkan. 'notPublished'
'diterbitkan'
subscriptionRequired Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini. Jika true, produk disebut sebagai "dilindungi" dan kunci langganan yang valid diperlukan agar permintaan ke API yang disertakan dalam produk berhasil. Jika false, produk disebut sebagai "buka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar. bool
subscriptionsLimit Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. int
terms Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan. string

Templat Mulai Cepat

Templat mulai cepat berikut menyebarkan jenis sumber daya ini.

Templat Deskripsi
Membuat instance API Management dan semua sub-sumber daya menggunakan templat

Sebarkan ke Azure		 Templat ini menunjukkan cara membuat layanan API Management dan mengonfigurasi sub-entitas
Membuat Azure Front Door di depan Azure API Management

Sebarkan ke Azure		 Sampel ini menunjukkan cara menggunakan Azure Front Door sebagai penyeimbang beban global di depan Azure API Management.

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya layanan/produk dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/products, tambahkan Terraform berikut ke templat Anda.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

Nilai properti

layanan/produk

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.ApiManagement/service/products@2023-05-01-preview"
nama Nama sumber daya string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: layanan
properti Properti kontrak entitas produk. ProductContractProperties

ProductContractProperties

Nama Deskripsi Nilai
approvalRequired apakah persetujuan langganan diperlukan. Jika false, langganan baru akan disetujui secara otomatis memungkinkan pengembang untuk memanggil API produk segera setelah berlangganan. Jika true, administrator harus menyetujui langganan secara manual sebelum pengembang dapat menggunakan API produk apa pun. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. bool
deskripsi Deskripsi produk. Mungkin menyertakan tag pemformatan HTML. string
displayName Nama produk. string (diperlukan)
state apakah produk diterbitkan atau tidak. Produk yang diterbitkan dapat ditemukan oleh pengguna portal pengembang. Produk yang tidak diterbitkan hanya terlihat oleh administrator. Status default Produk tidak Diterbitkan. "notPublished"
"diterbitkan"
subscriptionRequired Apakah langganan produk diperlukan untuk mengakses API yang disertakan dalam produk ini. Jika true, produk disebut sebagai "dilindungi" dan kunci langganan yang valid diperlukan agar permintaan ke API yang disertakan dalam produk berhasil. Jika false, produk disebut sebagai "buka" dan permintaan ke API yang disertakan dalam produk dapat dibuat tanpa kunci langganan. Jika properti dihilangkan saat membuat produk baru, nilainya diasumsikan benar. bool
subscriptionsLimit Apakah jumlah langganan yang dapat dimiliki pengguna ke produk ini secara bersamaan. Atur ke null atau hilangkan untuk mengizinkan langganan per pengguna tanpa batas. Dapat hadir hanya jika properti subscriptionRequired ada dan memiliki nilai false. int
terms Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan. string