Product Api - Create Or Update

Layanan:: API Management

Versi API:: 2024-05-01

Menambahkan API ke produk yang ditentukan.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}?api-version=2024-05-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	Pengidentifikasi revisi API. Harus unik dalam instans layanan API Management saat ini. Revisi non-saat ini memiliki ; rev=n sebagai akhiran di mana n adalah nomor revisi.
productId	path	True	string minLength: 1 maxLength: 256	Pengidentifikasi produk. Harus unik dalam instans layanan API Management saat ini.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	ApiContract	API yang ditentukan sudah ditambahkan ke produk.
201 Created	ApiContract	API berhasil ditambahkan ke produk.
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementCreateProductApi

Permintaan sampel

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apis/echo-api?api-version=2024-05-01

Respon sampel

Kode status:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

Definisi

Nama	Deskripsi
ApiContactInformation	Informasi kontak API
ApiContract	Detail API.
ApiLicenseInformation	Informasi lisensi API
ApiType	Jenis API.
ApiVersionSetContractDetails	Set Versi API berisi konfigurasi umum untuk sekumpulan Versi API yang berkaitan
AuthenticationSettingsContract	Pengaturan Autentikasi API.
bearerTokenSendingMethods	Cara mengirim token ke server.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
OAuth2AuthenticationSettingsContract	Detail pengaturan Autentikasi API OAuth2.
OpenIdAuthenticationSettingsContract	Detail pengaturan Autentikasi API OAuth2.
Protocol	Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.
SubscriptionKeyParameterNamesContract	Detail nama parameter kunci langganan.
versioningScheme	Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

ApiContactInformation

Objek

Informasi kontak API

Nama	Jenis	Deskripsi
email	string	Alamat email orang/organisasi kontak. HARUS dalam format alamat email
name	string	Nama pengidentifikasi orang/organisasi kontak
url	string	URL yang menunjuk ke informasi kontak. HARUS dalam format URL

ApiContract

Objek

Detail API.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.apiRevision	string minLength: 1 maxLength: 100	Menjelaskan revisi API. Jika tidak ada nilai yang disediakan, revisi default 1 dibuat
properties.apiRevisionDescription	string maxLength: 256	Deskripsi Revisi API.
properties.apiVersion	string maxLength: 100	Menunjukkan pengidentifikasi versi API jika API diberi versi
properties.apiVersionDescription	string maxLength: 256	Deskripsi Versi API.
properties.apiVersionSet	ApiVersionSetContractDetails	Detail set versi
properties.apiVersionSetId	string	Pengidentifikasi sumber daya untuk ApiVersionSet terkait.
properties.authenticationSettings	AuthenticationSettingsContract	Kumpulan pengaturan autentikasi yang disertakan dalam API ini.
properties.contact	ApiContactInformation	Informasi kontak untuk API.
properties.description	string	Deskripsi API. Dapat mencakup tag pemformatan HTML.
properties.displayName	string minLength: 1 maxLength: 300	Nama API. Panjangnya harus 1 hingga 300 karakter.
properties.isCurrent	boolean	Menunjukkan apakah revisi API adalah revisi api saat ini.
properties.isOnline	boolean	Menunjukkan apakah revisi API dapat diakses melalui gateway.
properties.license	ApiLicenseInformation	Informasi lisensi untuk API.
properties.path	string minLength: 0 maxLength: 400	URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL dasar titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini.
properties.protocols	Protocol[]	Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.
properties.provisioningState	string	Status provisi
properties.serviceUrl	string minLength: 0 maxLength: 2000	URL absolut layanan backend yang mengimplementasikan API ini. Panjangnya tidak boleh lebih dari 2000 karakter.
properties.sourceApiId	string	Pengidentifikasi API dari API sumber.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokol tempat API tersedia.
properties.subscriptionRequired	boolean	Menentukan apakah API atau Langganan produk diperlukan untuk mengakses API.
properties.termsOfServiceUrl	string	URL ke Ketentuan Layanan untuk API. HARUS dalam format URL.
properties.type	ApiType	Jenis API.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Objek

Informasi lisensi API

Nama	Jenis	Deskripsi
name	string	Nama lisensi yang digunakan untuk API
url	string	URL ke lisensi yang digunakan untuk API. HARUS dalam format URL

ApiType

Enumeration

Jenis API.

Nilai	Deskripsi
http
soap
websocket
graphql
odata
grpc

ApiVersionSetContractDetails

Objek

Set Versi API berisi konfigurasi umum untuk sekumpulan Versi API yang berkaitan

Nama	Jenis	Deskripsi
description	string	Deskripsi Set Versi API.
id	string	Pengidentifikasi untuk Set Versi API yang ada. Hilangkan nilai ini untuk membuat Set Versi baru.
name	string	Nama tampilan Set Versi API.
versionHeaderName	string	Nama parameter header HTTP yang menunjukkan Versi API jika penerapan versiScheme diatur ke `header`.
versionQueryName	string	Nama parameter kueri yang menunjukkan Versi API jika penerapan versiScheme diatur ke `query`.
versioningScheme	versioningScheme	Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

AuthenticationSettingsContract

Objek

Pengaturan Autentikasi API.

Nama	Jenis	Deskripsi
oAuth2	OAuth2AuthenticationSettingsContract	Pengaturan Autentikasi OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Kumpulan pengaturan autentikasi OAuth2 yang disertakan ke dalam API ini.
openid	OpenIdAuthenticationSettingsContract	Pengaturan Autentikasi OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Kumpulan pengaturan autentikasi Open ID Connect yang disertakan ke dalam API ini.

bearerTokenSendingMethods

Enumeration

Cara mengirim token ke server.

Nilai	Deskripsi
authorizationHeader	Token akses akan dikirimkan di header Otorisasi menggunakan skema Pembawa
query	Token akses akan ditransmisikan sebagai parameter kueri.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

OAuth2AuthenticationSettingsContract

Objek

Detail pengaturan Autentikasi API OAuth2.

Nama	Jenis	Deskripsi
authorizationServerId	string	Pengidentifikasi server otorisasi OAuth.
scope	string	cakupan operasi.

OpenIdAuthenticationSettingsContract

Objek

Detail pengaturan Autentikasi API OAuth2.

Nama	Jenis	Deskripsi
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Cara mengirim token ke server.
openidProviderId	string	Pengidentifikasi server otorisasi OAuth.

Protocol

Enumeration

Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini.

Nilai	Deskripsi
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objek

Detail nama parameter kunci langganan.

Nama	Jenis	Deskripsi
header	string	Nama header kunci langganan.
query	string	Nama parameter string kueri kunci langganan.

versioningScheme

Enumeration

Nilai yang menentukan di mana pengidentifikasi Versi API akan berada dalam permintaan HTTP.

Nilai	Deskripsi
Segment	Versi API diteruskan dalam segmen jalur.
Query	Versi API diteruskan dalam parameter kueri.
Header	Versi API diteruskan di header HTTP.

Bagikan melalui

Product Api - Create Or Update

Parameter URI

Respons

Keamanan

azure_auth

Cakupan

Contoh

ApiManagementCreateProductApi

Permintaan sampel

Respon sampel

Definisi

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme