Product Api - Create Or Update

Szolgáltatás:: API Management

API-verzió:: 2024-05-01

Hozzáad egy API-t a megadott termékhez.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API-változat azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. A nem aktuális változat rendelkezik ; rev=n utótagként, ahol n a változat száma.
productId	path	True	string minLength: 1 maxLength: 256	Termékazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Válaszok

Name	Típus	Description
200 OK	ApiContract	A megadott API már hozzá van adva a termékhez.
201 Created	ApiContract	Az API sikeresen hozzá lett adva a termékhez.
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementCreateProductApi

Mintakérelem

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

Mintaválasz

Állapotkód:: 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
  }
}

Állapotkód:: 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
  }
}

Definíciók

Name	Description
ApiContactInformation	AZ API kapcsolattartási adatai
ApiContract	API-részletek.
ApiLicenseInformation	API-licencinformációk
ApiType	Az API típusa.
ApiVersionSetContractDetails	Az API-verziókészletek a kapcsolódó API-verziók halmazának általános konfigurációját tartalmazzák
AuthenticationSettingsContract	API-hitelesítési beállítások.
bearerTokenSendingMethods	Jogkivonat küldése a kiszolgálóra.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
OAuth2AuthenticationSettingsContract	AZ API OAuth2 hitelesítési beállításainak részletei.
OpenIdAuthenticationSettingsContract	AZ API OAuth2 hitelesítési beállításainak részletei.
Protocol	Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.
SubscriptionKeyParameterNamesContract	Az előfizetéskulcs paraméterneveinek részletei.
versioningScheme	Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérelemben.

ApiContactInformation

Objektum

AZ API kapcsolattartási adatai

Name	Típus	Description
email	string	A kapcsolattartó/szervezet e-mail-címe. E-mail-cím formátumúnak kell lennie
name	string	A kapcsolattartó/szervezet azonosító neve
url	string	A kapcsolattartási adatokra mutató URL-cím. URL-cím formátumban kell lennie

ApiContract

Objektum

API-részletek.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.apiRevision	string minLength: 1 maxLength: 100	Az API felülvizsgálatát ismerteti. Ha nincs megadva érték, a rendszer létrehozza az 1. alapértelmezett változatot
properties.apiRevisionDescription	string maxLength: 256	Az API-változat leírása.
properties.apiVersion	string maxLength: 100	Az API verzióazonosítóját jelzi, ha az API verziószámozott
properties.apiVersionDescription	string maxLength: 256	Az API-verzió leírása.
properties.apiVersionSet	ApiVersionSetContractDetails	Verziókészlet részletei
properties.apiVersionSetId	string	A kapcsolódó ApiVersionSet erőforrás-azonosítója.
properties.authenticationSettings	AuthenticationSettingsContract	Az API-ba foglalt hitelesítési beállítások gyűjteménye.
properties.contact	ApiContactInformation	Az API kapcsolattartási adatai.
properties.description	string	Az API leírása. HTML-formázási címkéket is tartalmazhat.
properties.displayName	string minLength: 1 maxLength: 300	API-név. 1–300 karakter hosszúságúnak kell lennie.
properties.isCurrent	boolean	Azt jelzi, hogy az API-változat aktuális API-változat-e.
properties.isOnline	boolean	Azt jelzi, hogy az API-változat elérhető-e az átjárón keresztül.
properties.license	ApiLicenseInformation	Az API licencadatai.
properties.path	string minLength: 0 maxLength: 400	Relatív URL-cím, amely egyedileg azonosítja ezt az API-t és annak összes erőforrásútvonalát az API Management szolgáltatáspéldányon belül. A rendszer hozzáfűzi a szolgáltatáspéldány létrehozása során megadott API-végpontbázis URL-címéhez, hogy nyilvános URL-címet képezze ehhez az API-hoz.
properties.protocols	Protocol[]	Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.
properties.provisioningState	string	A kiépítés állapota
properties.serviceUrl	string minLength: 0 maxLength: 2000	Az API-t implementáló háttérszolgáltatás abszolút URL-címe. Legfeljebb 2000 karakter hosszú lehet.
properties.sourceApiId	string	A forrás API API-azonosítója.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokollok, amelyeken keresztül az API elérhetővé válik.
properties.subscriptionRequired	boolean	Megadja, hogy szükség van-e API- vagy termék-előfizetésre az API eléréséhez.
properties.termsOfServiceUrl	string	Az API szolgáltatási feltételeinek URL-címe. URL-cím formátumúnak kell lennie.
properties.type	ApiType	Az API típusa.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Objektum

API-licencinformációk

Name	Típus	Description
name	string	Az API-hoz használt licencnév
url	string	Az API-hoz használt licenc URL-címe. URL-cím formátumban kell lennie

ApiType

Enumerálás

Az API típusa.

Érték	Description
http
soap
websocket
graphql
odata
grpc

ApiVersionSetContractDetails

Objektum

Az API-verziókészletek a kapcsolódó API-verziók halmazának általános konfigurációját tartalmazzák

Name	Típus	Description
description	string	Az API verziókészletének leírása.
id	string	Meglévő API-verziókészlet azonosítója. Ezt az értéket kihagyva hozzon létre egy új verziókészletet.
name	string	Az API-verziókészlet megjelenítendő neve.
versionHeaderName	string	Az API-verziót jelző HTTP-fejlécparaméter neve, ha a versioningScheme értéke `header`.
versionQueryName	string	Az API-verziót jelző lekérdezési paraméter neve, ha a versioningScheme értéke `query`.
versioningScheme	versioningScheme	Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérelemben.

AuthenticationSettingsContract

Objektum

API-hitelesítési beállítások.

Name	Típus	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 hitelesítési beállítások
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Az API-ben található OAuth2 hitelesítési beállítások gyűjteménye.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect-hitelesítési beállítások
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Az API-hoz tartozó Open ID Connect hitelesítési beállítások gyűjteménye.

bearerTokenSendingMethods

Enumerálás

Jogkivonat küldése a kiszolgálóra.

Érték	Description
authorizationHeader	A hozzáférési jogkivonat az Engedélyezési fejlécben lesz továbbítva a Bearer-sémával
query	A hozzáférési jogkivonat lekérdezési paraméterekként lesz továbbítva.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

OAuth2AuthenticationSettingsContract

Objektum

AZ API OAuth2 hitelesítési beállításainak részletei.

Name	Típus	Description
authorizationServerId	string	OAuth engedélyezési kiszolgáló azonosítója.
scope	string	műveleti hatókör.

OpenIdAuthenticationSettingsContract

Objektum

AZ API OAuth2 hitelesítési beállításainak részletei.

Name	Típus	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Jogkivonat küldése a kiszolgálóra.
openidProviderId	string	OAuth engedélyezési kiszolgáló azonosítója.

Protocol

Enumerálás

Ez a cikk ismerteti, hogy az API műveletei mely protokollokon hívhatók meg.

Érték	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objektum

Az előfizetéskulcs paraméterneveinek részletei.

Name	Típus	Description
header	string	Az előfizetéskulcs fejlécének neve.
query	string	Előfizetési kulcs lekérdezési sztring paraméterének neve.

versioningScheme

Enumerálás

Egy érték, amely meghatározza, hogy az API-verzióazonosító hol található egy HTTP-kérelemben.

Érték	Description
Segment	Az API-verzió egy elérésiút-szegmensben lesz átadva.
Query	Az API-verzió egy lekérdezési paraméterben lesz átadva.
Header	Az API-verzió egy HTTP-fejlécben lesz átadva.

Megosztás:

Product Api - Create Or Update

URI-paraméterek

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

ApiManagementCreateProductApi

Mintakérelem

Mintaválasz

Definíciók

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme