Dela via

Referens för Azure API Management-malldatamodell

I det här avsnittet beskrivs entitets- och typrepresentationer för vanliga objekt som används i datamodellerna för mallarna för utvecklarportalen i Azure API Management.

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

Anmärkning

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 endast kritiska säkerhetsuppdateringar. Mer information finns i följande artiklar:

GÄLLER FÖR: Utvecklare | Grundläggande | Standard | Premie

Hänvisning

API (gränssnitt för programmering av applikationer)

Entiteten API har följande egenskaper:

Fastighet Typ Beskrivning
id snöre 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 snöre Namn på API:et. Får inte vara tom. Maximal längd är 100 tecken.
description snöre Beskrivning av API:et. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.
serviceUrl snöre Absolut URL för serverdelstjänsten som implementerar det här API:et.
path snöre Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i API Management-tjänstinstansen. 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:

Fastighet Typ Beskrivning
id snöre 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 snöre Namn på API:et. Får inte vara tom. Maximal längd är 100 tecken.
description snöre Beskrivning av API:et. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.

Applikation/Ansökan

Entiteten application har följande egenskaper:

Fastighet Typ Beskrivning
Id snöre Programmets unika identifierare.
Title snöre Ansökningens titel.
Description snöre Beskrivningen av programmet.
Url URI (Uniform Resource Identifier) URI:n för programmet.
Version snöre Versionsinformation för programmet.
Requirements snöre En beskrivning av kraven för programmet.
State nummer Programmets aktuella tillstånd.

- 0 - Registrerad

- 1 - Inskickad

- 2 - Publicerad

- 3 - Avvisade

- 4 - Avpublicerad
RegistrationDate Datum och tid Datum och tid då programmet registrerades.
CategoryId nummer Kategorin för programmet (Ekonomi, underhållning osv.)
DeveloperId snöre Den unika identifieraren för utvecklaren som skickade programmet.
Attachments Samling av Bilaga-entiteter. Eventuella bifogade filer för programmet, till exempel skärmbilder eller ikoner.
Icon Bifogad fil Ikonen för appen.

Bifogad fil

Entiteten attachment har följande egenskaper:

Fastighet Typ Beskrivning
UniqueId snöre Den unika identifieraren för den bifogade filen.
Url snöre Resursens URL.
Type snöre Typ av bifogad fil.
ContentType snöre Medietypen för den bifogade filen.

Kodexempel

Fastighet Typ Beskrivning
title snöre Operationens namn
snippet snöre Den här egenskapen är inaktuell och bör inte användas.
brush snöre Vilken kodsyntaxfärgmall som ska användas när kodexemplet visas. Tillåtna värden är plain, php, java, xml, objc, python, rubyoch csharp.
template snöre Namnet på den här kodexempelmallen.
body snöre En platshållare för kodexemplet i kodfragmentet.
method snöre HTTP-metoden för åtgärden.
scheme snöre Protokollet som ska användas för åtgärdsbegäran.
path snöre Sökvägen till operationen.
query snöre Exempel på frågesträngar med definierade parametrar.
host snöre URL för API Management-gatewayen för API:et som innehåller den här åtgärden.
headers Samling av rubrikentiteter. Rubriker för den här operationen.
parameters Samling av parameterentiteter. Parametrar som har definierats för den här åtgärden.

Kommentar

Entiteten API har följande egenskaper:

Fastighet Typ Beskrivning
Id nummer ID:t för kommentaren.
CommentText snöre Kommentarens brödtext. Kan innehålla HTML.
DeveloperCompany snöre Utvecklarens företagsnamn.
PostedOn Datum och tid Datum och tid då kommentaren publicerades.

Problematik

Entiteten issue har följande egenskaper.

Fastighet Typ Beskrivning
Id snöre Den unika identifieraren för problemet.
ApiID snöre ID:t för API:et som det här problemet rapporterades för.
Title snöre Namn på problemet.
Description snöre Beskrivning av problemet.
SubscriptionDeveloperName snöre Förnamnet på utvecklaren som rapporterade problemet.
IssueState snöre Det aktuella tillståndet för problemet. Möjliga värden är Föreslagna, Öppnade, Stängda.
ReportedOn Datum och tid Datum och tid då problemet rapporterades.
Comments Samling av kommentar-enheter. Kommentarer om det här problemet.
Attachments Samling av Bilaga-entiteter. Eventuella bifogade filer till problemet.
Services En samling av API-entiteter. De API:er som prenumereras på av den användare som lämnade in problemet.

Filtrering

Entiteten filtering har följande egenskaper:

Fastighet Typ Beskrivning
Pattern snöre Den aktuella söktermen; eller null om det inte finns någon sökterm.
Placeholder snöre Texten som ska visas i sökrutan när ingen sökterm har angetts.

Det här avsnittet beskriver representationen parameter .

Fastighet Typ Beskrivning
name snöre Parameternamn.
description snöre Parameterbeskrivning.
value snöre Rubrikvärde
typeName snöre Datatyp för huvudvärde.
options snöre Alternativ.
required booleskt Om rubriken krävs.
readOnly booleskt Om rubriken är skrivskyddad.

HTTP-begäran

Det här avsnittet beskriver representationen request .

Fastighet Typ Beskrivning
description snöre Beskrivning av åtgärdsbegäran.
headers matris med rubrikentiteter. Förfrågningshuvuden.
parameters matris med parameter Samling av begäranparametrar för operation.
representations uppsättning av representation Samling av representationer av operationsförfrågan.

HTTP-svar

Det här avsnittet beskriver representationen response .

Fastighet Typ Beskrivning
statusCode positivt heltal Statuskod för åtgärdssvar.
description snöre Beskrivning av åtgärdssvar.
representations uppsättning av representation Samling av operationssvarsrepresentationer.

Verksamhet

Entiteten operation har följande egenskaper:

Fastighet Typ Beskrivning
id snöre Resursidentifikator. 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 endast läsbar.
name snöre Namnet på åtgärden. Får inte vara tom. Maximal längd är 100 tecken.
description snöre Beskrivning av åtgärden. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.
scheme snöre 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 snöre 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 snöre URL:en för API Management-gatewayen som är värd för API:et.
httpMethod snöre HTTP-metod för operationen.
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ärd.

Entiteten operation menu har följande egenskaper:

Fastighet Typ Beskrivning
ApiId snöre ID:t för det aktuella API:et.
CurrentOperationId snöre ID:n för den aktuella åtgärden.
Action snöre Menytypen.
MenuItems Samling av entiteter för åtgärdsmenyobjekt . Operationerna för det aktuella API:et.

Entiteten operation menu item har följande egenskaper:

Fastighet Typ Beskrivning
Id snöre ID för åtgärden.
Title snöre Beskrivningen av åtgärden.
HttpMethod snöre Http-metoden för åtgärden.

Bläddring

Entiteten paging har följande egenskaper:

Fastighet Typ Beskrivning
Page nummer Det aktuella sidnumret.
PageSize nummer Maximalt antal resultat som ska visas på en enda sida.
TotalItemCount nummer Antalet objekt som ska visas.
ShowAll booleskt Om du vill visa alla resultat på en enda sida.
PageCount nummer Antal sidor med resultat.

Parameter

Det här avsnittet beskriver representationen parameter .

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

Produkt

Entiteten product har följande egenskaper:

Fastighet Typ Beskrivning
Id snöre 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 snöre Namn på produkten. Får inte vara tom. Maximal längd är 100 tecken.
Description snöre Beskrivning av produkten. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.
Terms snöre Användningsvillkor för produkten. Utvecklare som försöker prenumerera på produkten kommer att presenteras och måste acceptera dessa villkor innan de kan slutföra prenumerationsprocessen.
ProductState nummer Anger om produkten publiceras 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 booleskt Anger om en användare kan ha flera prenumerationer på den här produkten samtidigt.
MultipleSubscriptionsCount nummer Maximalt antal prenumerationer på den här produkten som en användare får ha samtidigt.

Leverantör

Entiteten provider har följande egenskaper:

Fastighet Typ Beskrivning
Properties strängordlista Egenskaper för den här autentiseringsprovidern.
AuthenticationType snöre Providertypen. (Microsoft Entra-ID, Facebook-inloggning, Google-konto, Microsoft-konto, Twitter).
Caption snöre Visningsnamn för leverantören.

Representation

I det här avsnittet beskrivs en representation.

Fastighet Typ Beskrivning
contentType snöre Anger en registrerad eller anpassad innehållstyp för den här representationen, till exempel application/xml.
sample snöre Ett exempel på representationen.

Prenumeration

Entiteten subscription har följande egenskaper:

Fastighet Typ Beskrivning
Id snöre 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 snöre Produktresursidentifieraren för den prenumererade produkten. Värdet är en giltig relativ URL i formatet products/{pid} där {pid} är en produktidentifierare.
ProductTitle snöre Namn på produkten. Får inte vara tom. Maximal längd är 100 tecken.
ProductDescription snöre Beskrivning av produkten. Får inte vara tom. Kan innehålla HTML-formateringstaggar. Maximal längd är 1 000 tecken.
ProductDetailsUrl snöre Relativ URL till produktinformationen.
state snöre Prenumerationens tillstånd. Möjliga tillstånd är:

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

- 1 - active – prenumerationen är aktiv.

- 2 - expired – prenumerationen nådde sitt utgångsdatum 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 snöre Visningsnamn för prenumerationen.
CreatedDate datumtid Det datum då prenumerationen skapades, i ISO 8601-format: 2014-06-24T16:25:00Z.
CanBeCancelled booleskt Om prenumerationen kan avbrytas av den aktuella användaren.
IsAwaitingApproval booleskt Om prenumerationen väntar på godkännande.
StartDate datumtid Startdatumet för prenumerationen i ISO 8601-format: 2014-06-24T16:25:00Z.
ExpirationDate datumtid Förfallodatumet för prenumerationen i ISO 8601-format: 2014-06-24T16:25:00Z.
NotificationDate datumtid Meddelandedatumet för prenumerationen i ISO 8601-format: 2014-06-24T16:25:00Z.
primaryKey snöre Den primära prenumerationsnyckeln. Maximal längd är 256 tecken.
secondaryKey snöre Den sekundära prenumerationsnyckeln. Maximal längd är 256 tecken.
CanBeRenewed booleskt Om prenumerationen kan förnyas av den aktuella användaren.
HasExpired booleskt Om prenumerationen har upphört att gälla.
IsRejected booleskt Om prenumerationsbegäran nekades.
CancelUrl snöre Den relativa URL:en för att avbryta prenumerationen.
RenewUrl snöre Den relativa URL:en för att förnya prenumerationen.

Prenumerationssammanfattning

Entiteten subscription summary har följande egenskaper:

Fastighet Typ Beskrivning
Id snöre 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 snöre Visningsnamnet för prenumerationen

Information om användarkonto

Entiteten user account info har följande egenskaper:

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

Användarinloggning

Entiteten user sign in har följande egenskaper:

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

Registrera dig för användare

Entiteten user sign up har följande egenskaper:

Fastighet Typ Beskrivning
PasswordConfirm booleskt Värde som används av anmälningskontrollen.
Password snöre Lösenord för användarkonto.
PasswordVerdictLevel nummer Värde som används av anmälningskontrollen.
UserRegistrationTerms snöre Villkor som en användare måste godkänna innan de loggar in.
UserRegistrationTermsOptions nummer Värde som används av anmälningskontrollen.
ConsentAccepted booleskt Värde som används av anmälningskontrollen.
Email snöre E-postadress. Får inte vara tom och måste vara unik inom tjänstinstansen. Maximal längd är 254 tecken.
FirstName snöre Förnamn. Får inte vara tom. Maximal längd är 100 tecken.
LastName snöre Efternamn. Får inte vara tom. Maximal längd är 100 tecken.
UserData snöre Värde som används av registreringskontrollen .
NameIdentifier snöre Värde som används av anmälningskontrollen.
ProviderName snöre Autentiseringsproviderns namn.

Nästa steg

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

  • Last updated on