Referenční informace k datovému modelu šablony služby Azure API Management

Toto téma popisuje reprezentaci entit a typů pro běžné položky používané v datových modelech pro šablony portálu pro vývojáře ve službě Azure API Management.

Další informace o práci se šablonami najdete v tématu Jak přizpůsobit portál pro vývojáře služby API Management pomocí šablon.

Poznámka:

Následující obsah dokumentace se týká zastaralého portálu pro vývojáře. Můžete ji dál používat jako obvykle do jejího vyřazení z provozu v říjnu 2023, kdy se odebere ze všech služeb API Management. Zastaralý portál bude dostávat pouze důležité aktualizace zabezpečení. Další podrobnosti najdete v následujících článcích:

PLATÍ PRO: Vývojář | Základní | Standardní | Premium

Odkazy

API
Souhrn rozhraní API
Aplikace
Příloha
Ukázka kódu
Komentář
filtrování
záhlaví
HTTP požadavek
Odpověď HTTP
Úkol
Operace
menu operací
Položka nabídky operace
Stránkovací
Parametr
produkt
poskytovatel
Reprezentace
Předplatné
souhrn předplatného
informace o uživatelském účtu
přihlášení uživatele
registrace uživatele

API (rozhraní pro programování aplikací)

Entita API má následující vlastnosti:

Vlastnictví	Typ	Popis
`id`	řetězec	Identifikátor prostředku. Jednoznačně identifikuje rozhraní API v rámci aktuální instance služby API Management. Hodnota je platná relativní adresa URL ve formátu `apis/{id}`, kde `{id}` je identifikátor rozhraní API. Tato vlastnost je pouze pro čtení.
`name`	řetězec	Název rozhraní API Nesmí být prázdný. Maximální délka je 100 znaků.
`description`	řetězec	Popis rozhraní API Nesmí být prázdný. Může obsahovat značky formátování HTML. Maximální délka je 1000 znaků.
`serviceUrl`	řetězec	Absolutní adresa URL back-endové služby, která toto rozhraní API implementuje.
`path`	řetězec	Relativní adresa URL, která jednoznačně identifikuje toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
`protocols`	pole čísel	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. Povolené hodnoty jsou `1 - http` a `2 - https`nebo obojí.
`authenticationSettings`	nastavení ověřování autorizačního serveru	Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.
`subscriptionKeyParameterNames`	objekt	Volitelná vlastnost, která se dá použít k zadání vlastních názvů pro parametry dotazu nebo hlavičky obsahující klíč předplatného. Pokud je tato vlastnost přítomna, musí obsahovat alespoň jednu z následujících dvou vlastností. `{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }`

Souhrn rozhraní API

Entita API summary má následující vlastnosti:

Vlastnictví	Typ	Popis
`id`	řetězec	Identifikátor prostředku. Jednoznačně identifikuje rozhraní API v rámci aktuální instance služby API Management. Hodnota je platná relativní adresa URL ve formátu `apis/{id}`, kde `{id}` je identifikátor rozhraní API. Tato vlastnost je pouze pro čtení.
`name`	řetězec	Název rozhraní API Nesmí být prázdný. Maximální délka je 100 znaků.
`description`	řetězec	Popis rozhraní API Nesmí být prázdný. Může obsahovat značky formátování HTML. Maximální délka je 1000 znaků.

Aplikace

Entita application má následující vlastnosti:

Vlastnictví	Typ	Popis
`Id`	řetězec	Jedinečný identifikátor aplikace.
`Title`	řetězec	Název aplikace.
`Description`	řetězec	Popis aplikace.
`Url`	URI	Identifikátor URI aplikace.
`Version`	řetězec	Informace o verzi aplikace
`Requirements`	řetězec	Popis požadavků pro aplikaci.
`State`	číslo	Aktuální stav aplikace. - 0 - Registrováno - 1 – Odesláno - 2 - Publikováno - 3 – Odmítnuto - 4 - Nepublikováno
`RegistrationDate`	Datum a čas	Datum a čas registrace aplikace.
`CategoryId`	číslo	Kategorie aplikace (Finance, zábava atd.)
`DeveloperId`	řetězec	Jedinečný identifikátor vývojáře, který aplikaci odeslal.
`Attachments`	Kolekce entit příloh	Všechny přílohy aplikace, jako jsou snímky obrazovky nebo ikony.
`Icon`	Příloha	Ikona aplikace.

Příloha

Entita attachment má následující vlastnosti:

Vlastnictví	Typ	Popis
`UniqueId`	řetězec	Jedinečný identifikátor přílohy.
`Url`	řetězec	Adresa URL prostředku.
`Type`	řetězec	Typ přílohy.
`ContentType`	řetězec	Typ média přílohy.

Ukázka kódu

Vlastnictví	Typ	Popis
`title`	řetězec	Název operace.
`snippet`	řetězec	Tato vlastnost je zastaralá a neměla by se používat.
`brush`	řetězec	Která šablona obarvení syntaxe kódu, která se má použít při zobrazení ukázky kódu Povolené hodnoty jsou `plain`, `php`, `java`, `xml`, `objc`, `python`, `ruby`a `csharp`.
`template`	řetězec	Název této ukázkové šablony kódu.
`body`	řetězec	Zástupný symbol pro ukázkovou část fragmentu kódu
`method`	řetězec	Metoda operace HTTP.
`scheme`	řetězec	Protokol, který se má použít pro požadavek operace.
`path`	řetězec	Cesta procesu.
`query`	řetězec	Příklad řetězce dotazu s definovanými parametry
`host`	řetězec	Adresa URL brány služby API Management pro rozhraní API, které tuto operaci obsahuje.
`headers`	Kolekce entit záhlaví	Záhlaví pro tuto operaci.
`parameters`	Kolekce entit parametru.	Parametry definované pro tuto operaci

Komentář

Entita API má následující vlastnosti:

Vlastnictví	Typ	Popis
`Id`	číslo	ID komentáře.
`CommentText`	řetězec	Text komentáře. Může obsahovat KÓD HTML.
`DeveloperCompany`	řetězec	Název společnosti vývojáře.
`PostedOn`	Datum a čas	Datum a čas publikování komentáře.

Problém

Entita issue má následující vlastnosti.

Vlastnictví	Typ	Popis
`Id`	řetězec	Jedinečný identifikátor problému.
`ApiID`	řetězec	ID rozhraní API, pro které byl tento problém nahlášen.
`Title`	řetězec	Název problému.
`Description`	řetězec	Popis problému
`SubscriptionDeveloperName`	řetězec	Jméno vývojáře, který problém oznámil.
`IssueState`	řetězec	Aktuální stav problému. Možné hodnoty jsou Navrhované, Otevřeno, Uzavřeno.
`ReportedOn`	Datum a čas	Datum a čas nahlášení problému
`Comments`	Kolekce entit typu Comment.	Komentáře k tomuto problému
`Attachments`	Kolekce entit příloh	Jakékoliv přílohy k problému.
`Services`	Kolekce entit API	Rozhraní API, která jsou přihlášená k odběru uživatelem, který problém podal.

Filtrování

Entita filtering má následující vlastnosti:

Vlastnictví	Typ	Popis
`Pattern`	řetězec	Aktuální hledaný termín; nebo `null`, pokud neexistuje hledaný termín.
`Placeholder`	řetězec	Text, který se má zobrazit ve vyhledávacím poli, pokud není zadaný hledaný termín.

Tato část popisuje reprezentaci parameter.

Vlastnictví	Typ	Popis
`name`	řetězec	Název parametru.
`description`	řetězec	Popis parametru
`value`	řetězec	Hodnota záhlaví.
`typeName`	řetězec	Datový typ hodnoty záhlaví
`options`	řetězec	Možnosti.
`required`	Boolean	Určuje, jestli je záhlaví povinné.
`readOnly`	Boolean	Určuje, jestli je záhlaví jen pro čtení.

Požadavek HTTP

Tato část popisuje reprezentaci request.

Vlastnictví	Typ	Popis
`description`	řetězec	Popis žádosti o operaci.
`headers`	Pole hlavička entit.	Požadované hlavičky.
`parameters`	pole parametru	Kolekce parametrů požadavku operace.
`representations`	pole reprezentace	Kolekce žádostí o reprezentaci operace

Odpověď protokolu HTTP

Tato část popisuje reprezentaci response.

Vlastnictví	Typ	Popis
`statusCode`	kladné celé číslo	Stavový kód odpovědi operace.
`description`	řetězec	Popis reakce operace.
`representations`	pole reprezentace	Kolekce zobrazení odpovědí na operace

Operace

Entita operation má následující vlastnosti:

Vlastnictví	Typ	Popis
`id`	řetězec	Identifikátor prostředku. Jednoznačně identifikuje operaci v rámci aktuální instance služby API Management. Hodnota je platná relativní adresa URL ve formátu `apis/{aid}/operations/{id}`, kde `{aid}` je identifikátor rozhraní API a `{id}` je identifikátor operace. Tato vlastnost je pouze pro čtení.
`name`	řetězec	Název operace. Nesmí být prázdný. Maximální délka je 100 znaků.
`description`	řetězec	Popis operace Nesmí být prázdný. Může obsahovat značky formátování HTML. Maximální délka je 1000 znaků.
`scheme`	řetězec	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API. Povolené hodnoty jsou `http`, `https`nebo `http` i `https`.
`uriTemplate`	řetězec	Relativní šablona adresy URL identifikující cílový prostředek pro tuto operaci Může obsahovat parametry. Příklad: `customers/{cid}/orders/{oid}/?date={date}`
`host`	řetězec	Adresa URL brány služby API Management, která je hostitelem rozhraní API.
`httpMethod`	řetězec	HTTP metoda operace.
`request`	HTTP požadavek	Entita obsahující podrobnosti žádosti.
`responses`	pole odpovědi HTTP	Pole entit odpovědi HTTP operace.

Entita operation menu má následující vlastnosti:

Vlastnictví	Typ	Popis
`ApiId`	řetězec	ID aktuálního rozhraní API.
`CurrentOperationId`	řetězec	ID aktuální operace.
`Action`	řetězec	Typ nabídky.
`MenuItems`	Kolekce entit položek nabídky operace .	Operace pro současné rozhraní API.

Operace položky nabídky

Entita operation menu item má následující vlastnosti:

Vlastnictví	Typ	Popis
`Id`	řetězec	Identifikátor operace.
`Title`	řetězec	Popis operace.
`HttpMethod`	řetězec	Metoda HTTP této operace.

Stránkování

Entita paging má následující vlastnosti:

Vlastnictví	Typ	Popis
`Page`	číslo	Číslo aktuální stránky.
`PageSize`	číslo	Maximální počet výsledků, které se mají zobrazit na jedné stránce.
`TotalItemCount`	číslo	Počet položek pro zobrazení.
`ShowAll`	Boolean	Zda se mají zobrazit všechny výsledky na jedné stránce.
`PageCount`	číslo	Počet stránek výsledků

Parametr

Tato část popisuje reprezentaci parameter.

Vlastnictví	Typ	Popis
`name`	řetězec	Název parametru.
`description`	řetězec	Popis parametru
`value`	řetězec	Hodnota parametru.
`options`	pole řetězce	Hodnoty definované pro hodnoty parametrů dotazu.
`required`	Boolean	Určuje, jestli je parametr povinný nebo ne.
`kind`	číslo	Bez ohledu na to, jestli je tento parametr parametrem cesty (1), nebo parametrem řetězce dotazu (2).
`typeName`	řetězec	Typ parametru.

Výrobek

Entita product má následující vlastnosti:

Vlastnictví	Typ	Popis
`Id`	řetězec	Identifikátor prostředku. Jednoznačně identifikuje produkt v rámci aktuální instance služby API Management. Hodnota je platná relativní adresa URL ve formátu `products/{pid}`, kde `{pid}` je identifikátor produktu. Tato vlastnost je pouze pro čtení.
`Title`	řetězec	Název produktu Nesmí být prázdný. Maximální délka je 100 znaků.
`Description`	řetězec	Popis produktu. Nesmí být prázdný. Může obsahovat značky formátování HTML. Maximální délka je 1000 znaků.
`Terms`	řetězec	Podmínky použití produktu. Vývojářům, kteří se pokoušejí přihlásit k odběru produktu, se zobrazí tyto podmínky a bude vyžadováno, aby je přijali, než mohou dokončit proces předplatného.
`ProductState`	číslo	Určuje, jestli je produkt publikovaný nebo ne. Publikované produkty jsou zjistitelné vývojáři na portálu pro vývojáře. Nepublikované produkty jsou viditelné jenom správcům. Povolené hodnoty pro stav produktu: - `0 - Not Published` - `1 - Published` - `2 - Deleted`
`AllowMultipleSubscriptions`	Boolean	Určuje, jestli uživatel může mít současně více předplatných tohoto produktu.
`MultipleSubscriptionsCount`	číslo	Maximální počet předplatných tohoto produktu může uživatel mít současně.

Poskytovatel

Entita provider má následující vlastnosti:

Vlastnictví	Typ	Popis
`Properties`	řetězcový slovník	Vlastnosti tohoto zprostředkovatele ověřování
`AuthenticationType`	řetězec	Typ zprostředkovatele. (Microsoft Entra ID, Facebook přihlášení, Google účet, Microsoft účet, Twitter).
`Caption`	řetězec	Zobrazovaný název poskytovatele.

Reprezentace

Tato část popisuje representation.

Vlastnictví	Typ	Popis
`contentType`	řetězec	Určuje registrovaný nebo vlastní typ obsahu pro tuto reprezentaci, například `application/xml`.
`sample`	řetězec	Příklad znázornění.

Předplatné

Entita subscription má následující vlastnosti:

Vlastnictví	Typ	Popis
`Id`	řetězec	Identifikátor prostředku. Jednoznačně identifikuje předplatné v rámci aktuální instance služby API Management. Hodnota je platná relativní adresa URL ve formátu `subscriptions/{sid}`, kde `{sid}` je identifikátor předplatného. Tato vlastnost je pouze pro čtení.
`ProductId`	řetězec	Identifikátor prostředku předplaceného produktu. Hodnota je platná relativní adresa URL ve formátu `products/{pid}`, kde `{pid}` je identifikátor produktu.
`ProductTitle`	řetězec	Název produktu Nesmí být prázdný. Maximální délka je 100 znaků.
`ProductDescription`	řetězec	Popis produktu. Nesmí být prázdný. Může obsahovat značky formátování HTML. Maximální délka je 1000 znaků.
`ProductDetailsUrl`	řetězec	Relativní adresa URL s podrobnostmi o produktu
`state`	řetězec	Stav předplatného. Možné stavy jsou: - `0 - suspended` – předplatné je zablokované a odběratel nemůže volat žádná rozhraní API produktu. - `1 - active` – předplatné je aktivní. - `2 - expired` – předplatné dosáhlo data vypršení platnosti a bylo deaktivováno. - `3 - submitted` – žádost o předplatné udělal vývojář, ale ještě nebyla schválena nebo odmítnuta. - `4 - rejected` – žádost o předplatné zamítl správce. - `5 - cancelled` – předplatné zrušil vývojář nebo správce.
`DisplayName`	řetězec	Zobrazovaný název předplatného
`CreatedDate`	datum a čas	Datum vytvoření předplatného ve formátu ISO 8601: `2014-06-24T16:25:00Z`.
`CanBeCancelled`	Boolean	Určuje, jestli je možné předplatné zrušit aktuálním uživatelem.
`IsAwaitingApproval`	Boolean	Jestli předplatné čeká na schválení.
`StartDate`	datum a čas	Počáteční datum předplatného ve formátu ISO 8601: `2014-06-24T16:25:00Z`.
`ExpirationDate`	datum a čas	Datum vypršení platnosti předplatného ve formátu ISO 8601: `2014-06-24T16:25:00Z`.
`NotificationDate`	datum a čas	Datum oznámení pro odběr ve formátu ISO 8601: `2014-06-24T16:25:00Z`.
`primaryKey`	řetězec	Primární klíč předplatného. Maximální délka je 256 znaků.
`secondaryKey`	řetězec	Sekundární klíč předplatného. Maximální délka je 256 znaků.
`CanBeRenewed`	Boolean	Určuje, jestli je možné předplatné prodloužit aktuálním uživatelem.
`HasExpired`	Boolean	Jestli vypršela platnost předplatného.
`IsRejected`	Boolean	Určuje, jestli se žádost o předplatné zamítla.
`CancelUrl`	řetězec	Relativní adresa URL pro zrušení předplatného.
`RenewUrl`	řetězec	Relativní adresa URL pro prodloužení předplatného.

Souhrn předplatného

Entita subscription summary má následující vlastnosti:

Vlastnictví	Typ	Popis
`Id`	řetězec	Identifikátor prostředku. Jednoznačně identifikuje předplatné v rámci aktuální instance služby API Management. Hodnota je platná relativní adresa URL ve formátu `subscriptions/{sid}`, kde `{sid}` je identifikátor předplatného. Tato vlastnost je pouze pro čtení.
`DisplayName`	řetězec	Zobrazovaný název předplatného

Informace o uživatelském účtu

Entita user account info má následující vlastnosti:

Vlastnictví	Typ	Popis
`FirstName`	řetězec	Křestní jméno. Nesmí být prázdný. Maximální délka je 100 znaků.
`LastName`	řetězec	Příjmení. Nesmí být prázdný. Maximální délka je 100 znaků.
`Email`	řetězec	E-mailová adresa. Nesmí být prázdný a musí být jedinečný v rámci instance služby. Maximální délka je 254 znaků.
`Password`	řetězec	Heslo uživatelského účtu.
`NameIdentifier`	řetězec	Identifikátor účtu, stejný jako e-mail uživatele.
`ProviderName`	řetězec	Název zprostředkovatele ověřování.
`IsBasicAccount`	Boolean	Pravda, pokud byl tento účet registrován pomocí e-mailu a hesla; nepravda, pokud byl účet registrován pomocí poskytovatele.

Přihlášení uživatele

Entita user sign in má následující vlastnosti:

Vlastnictví	Typ	Popis
`Email`	řetězec	E-mailová adresa. Nesmí být prázdný a musí být jedinečný v rámci instance služby. Maximální délka je 254 znaků.
`Password`	řetězec	Heslo uživatelského účtu.
`ReturnUrl`	řetězec	Adresa URL stránky, na které uživatel klikl na přihlášení.
`RememberMe`	Boolean	Zda se mají uložit informace o aktuálním uživateli.
`RegistrationEnabled`	Boolean	Určuje, jestli je povolená registrace.
`DelegationEnabled`	Boolean	Určuje, zda je povolené delegované přihlášení.
`DelegationUrl`	řetězec	Delegovaná přihlašovací adresa URL, pokud je povolená.
`SsoSignUpUrl`	řetězec	Adresa URL jednotného přihlašování pro uživatele, pokud je k dispozici.
`AuxServiceUrl`	řetězec	Pokud je aktuálním uživatelem správce, jedná se o odkaz na instanci služby na webu Azure Portal.
`Providers`	Kolekce entit poskytovatele	Zprostředkovatelé ověřování pro tohoto uživatele.
`UserRegistrationTerms`	řetězec	Podmínky, se kterými musí uživatel souhlasit před přihlášením.
`UserRegistrationTermsEnabled`	Boolean	Jsou termíny aktivovány?

Registrace uživatele

Entita user sign up má následující vlastnosti:

Vlastnictví	Typ	Popis
`PasswordConfirm`	Boolean	Hodnota používaná registračnímovládacím prvku registrace
`Password`	řetězec	Heslo uživatelského účtu.
`PasswordVerdictLevel`	číslo	Hodnota používaná ovládacím prvkem registrace
`UserRegistrationTerms`	řetězec	Podmínky, se kterými musí uživatel souhlasit před přihlášením.
`UserRegistrationTermsOptions`	číslo	Hodnota používaná registračním ovládacím prvkem.
`ConsentAccepted`	Boolean	Hodnota používaná ovládacím prvkem registrace.
`Email`	řetězec	E-mailová adresa. Nesmí být prázdný a musí být jedinečný v rámci instance služby. Maximální délka je 254 znaků.
`FirstName`	řetězec	Křestní jméno. Nesmí být prázdný. Maximální délka je 100 znaků.
`LastName`	řetězec	Příjmení. Nesmí být prázdný. Maximální délka je 100 znaků.
`UserData`	řetězec	Hodnota používaná ovládacím prvkem registrace .
`NameIdentifier`	řetězec	Hodnota používaná registračnímovládacím prvku registrace
`ProviderName`	řetězec	Název zprostředkovatele ověřování.

Další kroky