Dela via

Referens för Azure API Management-malldatamodell

  • Artikel

Det här avsnittet beskriver entitets- och typrepresentationer för vanliga objekt som används i datamodellerna för utvecklarportalmallarna i Azure API Management.

Mer information om hur du arbetar med mallar finns i Anpassa API Management utvecklarportalen med hjälp av mallar.

Anteckning

Följande dokumentationsinnehåll handlar om den inaktuella utvecklarportalen. Du kan fortsätta att använda den som vanligt tills den dras tillbaka i oktober 2023, då den tas bort från alla API Management-tjänster. Den inaktuella portalen får bara kritiska säkerhetsuppdateringar. Mer information finns i följande artiklar:

Tillgänglighet

Viktigt

Den här funktionen är tillgänglig på nivåerna Premium, Standard, Basic och Developer för API Management.

Information om funktionstillgänglighet på v2-nivåerna (förhandsversion) finns i översikten över v2-nivåer.

Referens

API

Entiteten API har följande egenskaper:

Egenskap Typ Description
id sträng Resursidentifierare. Identifierar API:et unikt i den aktuella API Management tjänstinstansen. Värdet är en giltig relativ URL i formatet apis/{id} där {id} är en API-identifierare. Den här egenskapen är skrivskyddad.
name sträng Namn på API:et. Får inte vara tom. Maximal längd är 100 tecken.
description sträng Beskrivning av API:et. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.
serviceUrl sträng Absolut URL för serverdelstjänsten som implementerar det här API:et.
path sträng Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.
protocols matris med tal Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för. Tillåtna värden är 1 - http och 2 - https, eller båda.
authenticationSettings Autentiseringsinställningar för auktoriseringsserver Samling autentiseringsinställningar som ingår i det här API:et.
subscriptionKeyParameterNames objekt Valfri egenskap som kan användas för att ange anpassade namn för fråge- och/eller rubrikparametrar som innehåller prenumerationsnyckeln. När den här egenskapen finns måste den innehålla minst en av följande två egenskaper.

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

API-sammanfattning

Entiteten API summary har följande egenskaper:

Egenskap Typ Description
id sträng Resursidentifierare. Identifierar API:et unikt i den aktuella API Management tjänstinstansen. Värdet är en giltig relativ URL i formatet apis/{id} där {id} är en API-identifierare. Den här egenskapen är skrivskyddad.
name sträng Namn på API:et. Får inte vara tom. Maximal längd är 100 tecken.
description sträng Beskrivning av API:et. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.

Program

Entiteten application har följande egenskaper:

Egenskap Typ Description
Id sträng Den unika identifieraren för programmet.
Title sträng Programmets titel.
Description sträng Beskrivningen av programmet.
Url URI URI:n för programmet.
Version sträng Versionsinformation för programmet.
Requirements sträng En beskrivning av kraven för programmet.
State antal Programmets aktuella tillstånd.

- 0 - Registrerad

- 1 - Inskickad

- 2 - Publicerad

- 3 - Avvisad

- 4 – Avpublicerad
RegistrationDate DateTime Datum och tid då programmet registrerades.
CategoryId antal Kategorin för programmet (ekonomi, underhållning osv.)
DeveloperId sträng Den unika identifieraren för utvecklaren som skickade programmet.
Attachments Samling bifogade filer-entiteter. Bifogade filer för programmet, till exempel skärmbilder eller ikoner.
Icon Bilaga Ikonen för programmet.

Bilaga

Entiteten attachment har följande egenskaper:

Egenskap Typ Description
UniqueId sträng Den unika identifieraren för den bifogade filen.
Url sträng Url:en för resursen.
Type sträng Typ av bifogad fil.
ContentType sträng Medietypen för den bifogade filen.

Kodexempel

Egenskap Typ Description
title sträng Namnet på åtgärden.
snippet sträng Den här egenskapen är inaktuell och bör inte användas.
brush sträng Vilken kodsyntaxfärgningsmall som ska användas när kodexemplet visas. Tillåtna värden är plain, php, java, xml, objc, python, rubyoch csharp.
template sträng Namnet på den här kodexempelmallen.
body sträng En platshållare för kodexempeldelen av kodfragmentet.
method sträng HTTP-metoden för åtgärden.
scheme sträng Det protokoll som ska användas för åtgärdsbegäran.
path sträng Sökvägen till åtgärden.
query sträng Exempel på frågesträng med definierade parametrar.
host sträng URL:en för den API Management tjänstgatewayen för API:et som innehåller den här åtgärden.
headers Samling med rubrikentiteter. Rubriker för den här åtgärden.
parameters Samling parameterentiteter. Parametrar som har definierats för den här åtgärden.

Kommentar

Entiteten API har följande egenskaper:

Egenskap Typ Description
Id antal ID för kommentaren.
CommentText sträng Kommentarens brödtext. Kan innehålla HTML.
DeveloperCompany sträng Utvecklarens företagsnamn.
PostedOn DateTime Datum och tid då kommentaren publicerades.

Problem

Entiteten issue har följande egenskaper.

Egenskap Typ Description
Id sträng Den unika identifieraren för problemet.
ApiID sträng ID:t för DET API som det här problemet rapporterades för.
Title sträng Frågans titel.
Description sträng Beskrivning av problemet.
SubscriptionDeveloperName sträng Förnamnet på utvecklaren som rapporterade problemet.
IssueState sträng Det aktuella tillståndet för problemet. Möjliga värden är Föreslagna, Öppnade, Stängda.
ReportedOn DateTime Datum och tid då problemet rapporterades.
Comments Samling kommentarsentiteter. Kommentarer om det här problemet.
Attachments Samling bifogade filer-entiteter. Eventuella bifogade filer till problemet.
Services Samling API-entiteter . API:erna som prenumereras på av användaren som lämnade in problemet.

Filtrering

Entiteten filtering har följande egenskaper:

Egenskap Typ Description
Pattern sträng Den aktuella söktermen; eller null om det inte finns någon sökterm.
Placeholder sträng Den text som ska visas i sökrutan när ingen sökterm har angetts.

I det här avsnittet beskrivs representationen parameter .

Egenskap Typ Description
name sträng Parameternamn.
description sträng Parameterbeskrivning.
value sträng Rubrikvärde.
typeName sträng Datatyp för rubrikvärde.
options sträng Alternativ.
required boolean Om rubriken krävs.
readOnly boolean Om rubriken är skrivskyddad.

HTTP-begäran

I det här avsnittet beskrivs representationen request .

Egenskap Typ Description
description sträng Beskrivning av åtgärdsbegäran.
headers matris med rubrikentiteter. Begärandehuvuden.
parameters matris med parameter Samling parametrar för åtgärdsbegäran.
representations matris med representation Samling av representationer av åtgärdsbegäranden.

HTTP-svar

I det här avsnittet beskrivs representationen response .

Egenskap Typ Description
statusCode positivt heltal Statuskod för åtgärdssvar.
description sträng Åtgärdssvarsbeskrivning.
representations matris med representation Samling av åtgärdssvarsrepresentationer.

Åtgärd

Entiteten operation har följande egenskaper:

Egenskap Typ Description
id sträng Resursidentifierare. Identifierar åtgärden unikt i den aktuella API Management-tjänstinstansen. Värdet är en giltig relativ URL i formatet apis/{aid}/operations/{id} där {aid} är en API-identifierare och {id} är en åtgärdsidentifierare. Den här egenskapen är skrivskyddad.
name sträng Namnet på åtgärden. Får inte vara tom. Maximal längd är 100 tecken.
description sträng Beskrivning av åtgärden. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maxlängden är 1 000 tecken.
scheme sträng Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för. Tillåtna värden är http, https, eller både http och https.
uriTemplate sträng Relativ URL-mall som identifierar målresursen för den här åtgärden. Kan innehålla parametrar. Exempel: customers/{cid}/orders/{oid}/?date={date}
host sträng Den API Management gateway-URL som är värd för API:et.
httpMethod sträng Http-metod för åtgärd.
request HTTP-begäran En entitet som innehåller information om begäran.
responses matris med HTTP-svar Matris med HTTP-svarsentiteter för åtgärden.

Entiteten operation menu har följande egenskaper:

Egenskap Typ Description
ApiId sträng ID:t för det aktuella API:et.
CurrentOperationId sträng ID för den aktuella åtgärden.
Action sträng Menytypen.
MenuItems Samling av entiteter för åtgärdsmenyobjekt . Åtgärderna för det aktuella API:et.

Entiteten operation menu item har följande egenskaper:

Egenskap Typ Description
Id sträng ID för åtgärden.
Title sträng Beskrivning av åtgärden.
HttpMethod sträng Http-metoden för åtgärden.

Sidindelning

Entiteten paging har följande egenskaper:

Egenskap Typ Description
Page antal Det aktuella sidnumret.
PageSize antal Maximalt antal resultat som ska visas på en enda sida.
TotalItemCount antal Antalet objekt som ska visas.
ShowAll boolean Om du vill visa alla resultat på en enda sida.
PageCount antal Antalet sidor med resultat.

Parameter

I det här avsnittet beskrivs representationen parameter .

Egenskap Typ Description
name sträng Parameternamn.
description sträng Parameterbeskrivning.
value sträng Parametervärde.
options strängmatris Värden som definierats för frågeparametervärden.
required boolean Anger om parametern krävs eller inte.
kind antal Om den här parametern är en sökvägsparameter (1) eller en frågesträngsparameter (2).
typeName sträng Parametertyp.

Produkt

Entiteten product har följande egenskaper:

Egenskap Typ Description
Id sträng Resursidentifierare. Identifierar produkten unikt i den aktuella API Management tjänstinstansen. Värdet är en giltig relativ URL i formatet products/{pid} där {pid} är en produktidentifierare. Den här egenskapen är skrivskyddad.
Title sträng Namn på produkten. Får inte vara tom. Maximal längd är 100 tecken.
Description sträng Beskrivning av produkten. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maxlängden är 1 000 tecken.
Terms sträng Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste godkänna dessa villkor innan de kan slutföra prenumerationsprocessen.
ProductState antal Anger om produkten har publicerats eller inte. Publicerade produkter kan identifieras av utvecklare på utvecklarportalen. Icke-publicerade produkter är endast synliga för administratörer.

De tillåtna värdena för produkttillstånd är:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions boolean Anger om en användare kan ha flera prenumerationer på den här produkten samtidigt.
MultipleSubscriptionsCount antal Maximalt antal prenumerationer på den här produkten som en användare får ha samtidigt.

Leverantör

Entiteten provider har följande egenskaper:

Egenskap Typ Description
Properties strängordlista Egenskaper för den här autentiseringsprovidern.
AuthenticationType sträng Providertypen. (Microsoft Entra-ID, Facebook-inloggning, Google-konto, Microsoft-konto, Twitter).
Caption sträng Leverantörens visningsnamn.

Representation

I det här avsnittet beskrivs en representation.

Egenskap Typ Description
contentType sträng Anger en registrerad eller anpassad innehållstyp för den här representationen, till exempel application/xml.
sample sträng Ett exempel på representationen.

Prenumeration

Entiteten subscription har följande egenskaper:

Egenskap Typ Description
Id sträng Resursidentifierare. Identifierar prenumerationen unikt i den aktuella API Management tjänstinstansen. Värdet är en giltig relativ URL i formatet subscriptions/{sid} där {sid} är en prenumerationsidentifierare. Den här egenskapen är skrivskyddad.
ProductId sträng Produktresursidentifieraren för den prenumererade produkten. Värdet är en giltig relativ URL i formatet products/{pid} där {pid} är en produktidentifierare.
ProductTitle sträng Namn på produkten. Får inte vara tom. Maximal längd är 100 tecken.
ProductDescription sträng Beskrivning av produkten. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.
ProductDetailsUrl sträng Relativ URL till produktinformationen.
state sträng Prenumerationens tillstånd. Möjliga tillstånd är:

- 0 - suspended – prenumerationen är blockerad och prenumeranten kan inte anropa några API:er för produkten.

- 1 - active – prenumerationen är aktiv.

- 2 - expired – prenumerationen nådde utgångsdatumet och inaktiverades.

- 3 - submitted – prenumerationsbegäran har gjorts av utvecklaren, men har ännu inte godkänts eller avvisats.

- 4 - rejected – prenumerationsbegäran har nekats av en administratör.

- 5 - cancelled – prenumerationen har avbrutits av utvecklaren eller administratören.
DisplayName sträng Visningsnamn för prenumerationen.
CreatedDate Datetime Datumet då prenumerationen skapades i ISO 8601-format: 2014-06-24T16:25:00Z.
CanBeCancelled boolean Om prenumerationen kan avbrytas av den aktuella användaren.
IsAwaitingApproval boolean Om prenumerationen väntar på godkännande.
StartDate Datetime Startdatumet för prenumerationen i ISO 8601-format: 2014-06-24T16:25:00Z.
ExpirationDate Datetime Förfallodatumet för prenumerationen i ISO 8601-format: 2014-06-24T16:25:00Z.
NotificationDate Datetime Meddelandedatumet för prenumerationen i ISO 8601-format: 2014-06-24T16:25:00Z.
primaryKey sträng Den primära prenumerationsnyckeln. Maximal längd är 256 tecken.
secondaryKey sträng Den sekundära prenumerationsnyckeln. Maximal längd är 256 tecken.
CanBeRenewed boolean Om prenumerationen kan förnyas av den aktuella användaren.
HasExpired boolean Om prenumerationen har upphört att gälla.
IsRejected boolean Om prenumerationsbegäran nekades.
CancelUrl sträng Den relativa URL:en för att avbryta prenumerationen.
RenewUrl sträng Den relativa URL:en för att förnya prenumerationen.

Prenumerationssammanfattning

Entiteten subscription summary har följande egenskaper:

Egenskap Typ Description
Id sträng Resursidentifierare. Identifierar prenumerationen unikt i den aktuella API Management tjänstinstansen. Värdet är en giltig relativ URL i formatet subscriptions/{sid} där {sid} är en prenumerationsidentifierare. Den här egenskapen är skrivskyddad.
DisplayName sträng Visningsnamnet för prenumerationen

Information om användarkonton

Entiteten user account info har följande egenskaper:

Egenskap Typ Description
FirstName sträng Förnamn. Får inte vara tom. Maximal längd är 100 tecken.
LastName sträng Efternamn. Får inte vara tom. Maximal längd är 100 tecken.
Email sträng E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. Maximal längd är 254 tecken.
Password sträng Lösenord för användarkonto.
NameIdentifier sträng Kontoidentifierare, samma som användarens e-post.
ProviderName sträng Autentiseringsproviderns namn.
IsBasicAccount boolean Sant om det här kontot har registrerats med e-post och lösenord. falskt om kontot har registrerats med hjälp av en provider.

Användarinloggning

Entiteten user sign in har följande egenskaper:

Egenskap Typ Description
Email sträng E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. Maximal längd är 254 tecken.
Password sträng Lösenord för användarkonto.
ReturnUrl sträng URL:en för sidan där användaren klickade på logga in.
RememberMe boolean Om den aktuella användarens information ska sparas.
RegistrationEnabled boolean Om registrering är aktiverat.
DelegationEnabled boolean Om delegerad inloggning är aktiverad.
DelegationUrl sträng Den delegerade inloggnings-URL:en, om den är aktiverad.
SsoSignUpUrl sträng Url för enkel inloggning för användaren, om den finns.
AuxServiceUrl sträng Om den aktuella användaren är administratör är detta en länk till tjänstinstansen i Azure Portal.
Providers Insamling av providerentiteter Autentiseringsprovidrar för den här användaren.
UserRegistrationTerms sträng Villkor som en användare måste godkänna innan de loggar in.
UserRegistrationTermsEnabled boolean Om villkoren är aktiverade.

Registrera dig för användare

Entiteten user sign up har följande egenskaper:

Egenskap Typ Description
PasswordConfirm boolean Värde som används av registreringskontrollen.
Password sträng Lösenord för användarkonto.
PasswordVerdictLevel antal Värde som används av registreringskontrollen.
UserRegistrationTerms sträng Villkor som en användare måste godkänna innan de loggar in.
UserRegistrationTermsOptions antal Värde som används av registreringskontrollen.
ConsentAccepted boolean Värde som används av registreringskontrollen.
Email sträng E-postadress. Får inte vara tom och måste vara unik i tjänstinstansen. Maximal längd är 254 tecken.
FirstName sträng Förnamn. Får inte vara tom. Maximal längd är 100 tecken.
LastName sträng Efternamn. Får inte vara tom. Maximal längd är 100 tecken.
UserData sträng Värde som används av registreringskontrollen .
NameIdentifier sträng Värde som används av registreringskontrollen.
ProviderName sträng Autentiseringsproviderns namn.

Nästa steg

Mer information om hur du arbetar med mallar finns i Anpassa API Management utvecklarportalen med hjälp av mallar.