Sdílet prostřednictvím


Product Api - Create Or Update

Přidá rozhraní API k zadanému produktu.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
apiId
path True

string

Identifikátor revize rozhraní API. Musí být jedinečný v aktuální instanci služby API Management. Non-current revize má ; rev=n jako přípona, kde n je číslo revize.

Vzor regulárního výrazu: ^[^*#&+:<>?]+$

productId
path True

string

Identifikátor produktu. Musí být jedinečný v aktuální instanci služby API Management.

resourceGroupName
path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName
path True

string

Název služby API Management.

Vzor regulárního výrazu: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID cílového předplatného.

api-version
query True

string

Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name Typ Description
200 OK

ApiContract

Zadané rozhraní API je již přidáno do produktu.

201 Created

ApiContract

Rozhraní API bylo úspěšně přidáno do produktu.

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2.

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

ApiManagementCreateProductApi

Ukázkový požadavek

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apis/echo-api?api-version=2022-08-01

Ukázková odpověď

{
  "id": "/subscriptions/subid/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
  }
}
{
  "id": "/subscriptions/subid/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
  }
}

Definice

Name Description
ApiContactInformation

Kontaktní informace rozhraní API

ApiContract

Podrobnosti rozhraní API

ApiLicenseInformation

Informace o licencích rozhraní API

ApiType

Typ rozhraní API

ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje běžnou konfiguraci pro sadu verzí rozhraní API, které se týkají.

AuthenticationSettingsContract

Nastavení ověřování rozhraní API.

bearerTokenSendingMethods

Postup odeslání tokenu na server

ErrorFieldContract

Chybový kontrakt pole.

ErrorResponse

Odpověď na chybu.

OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování API OAuth2

OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování API OAuth2

Protocol

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

SubscriptionKeyParameterNamesContract

Podrobnosti o názvech parametrů klíče předplatného

versioningScheme

Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API.

ApiContactInformation

Kontaktní informace rozhraní API

Name Typ Description
email

string

E-mailová adresa kontaktní osoby nebo organizace MUSÍ být ve formátu e-mailové adresy.

name

string

Identifikační jméno kontaktní osoby nebo organizace

url

string

Adresa URL odkazující na kontaktní informace. MUSÍ být ve formátu adresy URL.

ApiContract

Podrobnosti rozhraní API

Name Typ Description
id

string

Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku}

name

string

Název prostředku

properties.apiRevision

string

Popisuje revizi rozhraní API. Pokud se nezadá žádná hodnota, vytvoří se výchozí revize 1.

properties.apiRevisionDescription

string

Popis revize rozhraní API

properties.apiVersion

string

Označuje identifikátor verze rozhraní API, pokud je rozhraní API s verzí.

properties.apiVersionDescription

string

Popis verze rozhraní API.

properties.apiVersionSet

ApiVersionSetContractDetails

Podrobnosti sady verzí

properties.apiVersionSetId

string

Identifikátor prostředku pro související ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Kolekce nastavení ověřování zahrnutých do tohoto rozhraní API

properties.contact

ApiContactInformation

Kontaktní informace pro rozhraní API.

properties.description

string

Popis rozhraní API. Mohou obsahovat značky formátování HTML.

properties.displayName

string

Název rozhraní API. Musí mít délku 1 až 300 znaků.

properties.isCurrent

boolean

Označuje, jestli je revize rozhraní API aktuální revize rozhraní API.

properties.isOnline

boolean

Označuje, jestli je revize rozhraní API přístupná prostřednictvím brány.

properties.license

ApiLicenseInformation

Informace o licenci pro rozhraní API

properties.path

string

Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v instanci služby API Management Připojí se k základní adrese URL koncového bodu rozhraní API zadané při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.

properties.protocols

Protocol[]

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

properties.serviceUrl

string

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2 000 znaků.

properties.sourceApiId

string

Identifikátor rozhraní API zdrojového rozhraní API

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokoly, přes které je k dispozici rozhraní API.

properties.subscriptionRequired

boolean

Určuje, jestli se pro přístup k rozhraní API vyžaduje rozhraní API nebo předplatné produktu.

properties.termsOfServiceUrl

string

Adresa URL podmínek služby pro rozhraní API. MUSÍ být ve formátu adresy URL.

properties.type

ApiType

Typ rozhraní API

type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ApiLicenseInformation

Informace o licencích rozhraní API

Name Typ Description
name

string

Název licence použitý pro rozhraní API

url

string

Adresa URL licence použité pro rozhraní API. MUSÍ být ve formátu adresy URL.

ApiType

Typ rozhraní API

Name Typ Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje běžnou konfiguraci pro sadu verzí rozhraní API, které se týkají.

Name Typ Description
description

string

Popis sady verzí rozhraní API.

id

string

Identifikátor existující sady verzí rozhraní API Pokud chcete vytvořit novou sadu verzí, tuto hodnotu vynecháte.

name

string

Zobrazovaný název sady verzí rozhraní API.

versionHeaderName

string

Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na headerhodnotu .

versionQueryName

string

Název parametru dotazu, který označuje verzi rozhraní API, pokud je správa verzíScheme nastavená na query.

versioningScheme

versioningScheme

Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API.

AuthenticationSettingsContract

Nastavení ověřování rozhraní API.

Name Typ Description
oAuth2

OAuth2AuthenticationSettingsContract

Nastavení ověřování OAuth2

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API.

openid

OpenIdAuthenticationSettingsContract

Nastavení ověřování OpenID Connect

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API.

bearerTokenSendingMethods

Postup odeslání tokenu na server

Name Typ Description
authorizationHeader

string

Přístupový token se bude přenášet v autorizační hlavičce pomocí nosného schématu.

query

string

Přístupový token se bude přenášet jako parametry dotazu.

ErrorFieldContract

Chybový kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.

message

string

Pro člověka čitelná reprezentace chyby na úrovni vlastností.

target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v požadavku v případě chyby ověření.

error.message

string

Pro člověka čitelná reprezentace chyby.

OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování API OAuth2

Name Typ Description
authorizationServerId

string

Identifikátor autorizačního serveru OAuth.

scope

string

rozsah operací.

OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování API OAuth2

Name Typ Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Postup odeslání tokenu na server

openidProviderId

string

Identifikátor autorizačního serveru OAuth.

Protocol

Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.

Name Typ Description
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

Podrobnosti o názvech parametrů klíče předplatného

Name Typ Description
header

string

Název hlavičky klíče předplatného.

query

string

Název parametru řetězce dotazu klíče předplatného.

versioningScheme

Hodnota, která určuje, kde se v požadavku HTTP bude nacházet identifikátor verze rozhraní API.

Name Typ Description
Header

string

Verze rozhraní API se předává v hlavičce HTTP.

Query

string

Verze rozhraní API se předává v parametru dotazu.

Segment

string

Verze rozhraní API se předává v segmentu cesty.