Dela via


Product Api - Create Or Update

Lägger till ett API i den angivna produkten.

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

URI-parametrar

Name I Obligatorisk Typ Description
apiId
path True

string

API-revisionsidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen. Icke-aktuell revision har ; rev=n som ett suffix där n är revisionsnumret.

Reguljärt uttrycksmönster: ^[^*#&+:<>?]+$

productId
path True

string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

serviceName
path True

string

Namnet på API Management-tjänsten.

Reguljärt uttrycksmönster: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID för målprenumerationen.

api-version
query True

string

Den API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

ApiContract

Det angivna API:et har redan lagts till i produkten.

201 Created

ApiContract

API:et har lagts till i produkten.

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

ApiManagementCreateProductApi

Exempelbegäran

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

Exempelsvar

{
  "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
  }
}

Definitioner

Name Description
ApiContactInformation

API-kontaktinformation

ApiContract

API-information.

ApiLicenseInformation

API-licensinformation

ApiType

Typ av API.

ApiVersionSetContractDetails

En API-versionsuppsättning innehåller den gemensamma konfigurationen för en uppsättning API-versioner som relaterar

AuthenticationSettingsContract

Inställningar för API-autentisering.

bearerTokenSendingMethods

Skicka token till servern.

ErrorFieldContract

Fel fältkontrakt.

ErrorResponse

Felsvar.

OAuth2AuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

OpenIdAuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Protocol

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

SubscriptionKeyParameterNamesContract

Information om parameternamn för prenumerationsnyckel.

versioningScheme

Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

ApiContactInformation

API-kontaktinformation

Name Typ Description
email

string

Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress

name

string

Kontaktpersonens/organisationens identifieringsnamn

url

string

URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL

ApiContract

API-information.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Exempel – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

Namnet på resursen

properties.apiRevision

string

Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1

properties.apiRevisionDescription

string

Beskrivning av API-revisionen.

properties.apiVersion

string

Anger versionsidentifieraren för API:et om API:et är versionshanterat

properties.apiVersionDescription

string

Beskrivning av API-versionen.

properties.apiVersionSet

ApiVersionSetContractDetails

Information om versionsuppsättning

properties.apiVersionSetId

string

En resursidentifierare för den relaterade ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Samling autentiseringsinställningar som ingår i det här API:et.

properties.contact

ApiContactInformation

Kontaktuppgifter för API:et.

properties.description

string

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

properties.displayName

string

API-namn. Måste vara mellan 1 och 300 tecken långt.

properties.isCurrent

boolean

Anger om API-revisionen är aktuell API-revision.

properties.isOnline

boolean

Anger om API-revisionen är tillgänglig via gatewayen.

properties.license

ApiLicenseInformation

Licensinformation för API:et.

properties.path

string

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.

properties.protocols

Protocol[]

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

properties.serviceUrl

string

Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.

properties.sourceApiId

string

API-identifierare för käll-API:et.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protokoll som API:et görs tillgängligt för.

properties.subscriptionRequired

boolean

Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.

properties.termsOfServiceUrl

string

En URL till användningsvillkoren för API:et. MÅSTE vara i formatet för en URL.

properties.type

ApiType

Typ av API.

type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API-licensinformation

Name Typ Description
name

string

Licensnamnet som används för API:et

url

string

En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL

ApiType

Typ av API.

Name Typ Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

En API-versionsuppsättning innehåller den gemensamma konfigurationen för en uppsättning API-versioner som relaterar

Name Typ Description
description

string

Beskrivning av API-versionsuppsättning.

id

string

Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet om du vill skapa en ny versionsuppsättning.

name

string

Visningsnamn för API-versionsuppsättningen.

versionHeaderName

string

Namnet på HTTP-huvudparametern som anger API-versionen om versioningScheme har angetts till header.

versionQueryName

string

Namnet på frågeparametern som anger API-versionen om versioningScheme är inställt på query.

versioningScheme

versioningScheme

Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

AuthenticationSettingsContract

Inställningar för API-autentisering.

Name Typ Description
oAuth2

OAuth2AuthenticationSettingsContract

Inställningar för OAuth2-autentisering

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Samling OAuth2-autentiseringsinställningar som ingår i det här API:et.

openid

OpenIdAuthenticationSettingsContract

Inställningar för OpenID Connect-autentisering

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Samling autentiseringsinställningar för Open ID Connect som ingår i det här API:et.

bearerTokenSendingMethods

Skicka token till servern.

Name Typ Description
authorizationHeader

string

Åtkomsttoken överförs i auktoriseringshuvudet med hjälp av ägarschemat

query

string

Åtkomsttoken överförs som frågeparametrar.

ErrorFieldContract

Fel fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.

message

string

Mänsklig läsbar representation av fel på egenskapsnivå.

target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.

error.message

string

Mänsklig läsbar representation av felet.

OAuth2AuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name Typ Description
authorizationServerId

string

OAuth-auktoriseringsserveridentifierare.

scope

string

omfång för åtgärder.

OpenIdAuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name Typ Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Skicka token till servern.

openidProviderId

string

OAuth-auktoriseringsserveridentifierare.

Protocol

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

Name Typ Description
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

Information om parameternamn för prenumerationsnyckel.

Name Typ Description
header

string

Rubriknamn för prenumerationsnyckel.

query

string

Parameternamn för frågesträng för prenumerationsnyckel.

versioningScheme

Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

Name Typ Description
Header

string

API-versionen skickas i ett HTTP-huvud.

Query

string

API-versionen skickas i en frågeparameter.

Segment

string

API-versionen skickas i ett sökvägssegment.