Delen via


Product Api - Create Or Update

Hiermee voegt u een API toe aan het opgegeven product.

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

URI-parameters

Name In Vereist Type Description
apiId
path True

string

API-revisie-id. Moet uniek zijn in het huidige API Management service-exemplaar. Niet-huidige revisie heeft ; rev=n als een achtervoegsel waarbij n het revisienummer is.

Regex-patroon: ^[^*#&+:<>?]+$

productId
path True

string

Product-id. Moet uniek zijn in het huidige API Management service-exemplaar.

resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName
path True

string

De naam van de API Management service.

Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name Type Description
200 OK

ApiContract

De opgegeven API is al toegevoegd aan het product.

201 Created

ApiContract

De API is toegevoegd aan het product.

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateProductApi

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name Description
ApiContactInformation

API-contactgegevens

ApiContract

API-details.

ApiLicenseInformation

API-licentiegegevens

ApiType

Type of API.

ApiVersionSetContractDetails

Een API-versieset bevat de algemene configuratie voor een set API-versies met betrekking tot

AuthenticationSettingsContract

Instellingen voor API-verificatie.

bearerTokenSendingMethods

Token verzenden naar de server.

ErrorFieldContract

Fout Veldcontract.

ErrorResponse

Foutreactie.

OAuth2AuthenticationSettingsContract

Details van instellingen voor API OAuth2-verificatie.

OpenIdAuthenticationSettingsContract

Details van instellingen voor API OAuth2-verificatie.

Protocol

Hierin wordt beschreven op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

SubscriptionKeyParameterNamesContract

Details van parameternamen van abonnementssleutels.

versioningScheme

Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.

ApiContactInformation

API-contactgegevens

Name Type Description
email

string

Het e-mailadres van de contactpersoon/organisatie. MOET de indeling van een e-mailadres hebben

name

string

De identificerende naam van de contactpersoon/organisatie

url

string

De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben

ApiContract

API-details.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

De naam van de resource

properties.apiRevision

string

Beschrijft de revisie van de API. Als er geen waarde wordt opgegeven, wordt standaardrevisie 1 gemaakt

properties.apiRevisionDescription

string

Beschrijving van de API-revisie.

properties.apiVersion

string

Geeft de versie-id van de API aan als de API een versie heeft

properties.apiVersionDescription

string

Beschrijving van de API-versie.

properties.apiVersionSet

ApiVersionSetContractDetails

Details van versieset

properties.apiVersionSetId

string

Een resource-id voor de gerelateerde ApiVersionSet.

properties.authenticationSettings

AuthenticationSettingsContract

Verzameling van verificatie-instellingen die zijn opgenomen in deze API.

properties.contact

ApiContactInformation

Contactgegevens voor de API.

properties.description

string

Beschrijving van de API. Kan HTML-opmaaktags bevatten.

properties.displayName

string

API-naam. Moet 1 tot 300 tekens lang zijn.

properties.isCurrent

boolean

Geeft aan of API-revisie de huidige API-revisie is.

properties.isOnline

boolean

Geeft aan of API-revisie toegankelijk is via de gateway.

properties.license

ApiLicenseInformation

Licentiegegevens voor de API.

properties.path

string

Relatieve URL die deze API en alle resourcepaden binnen het API Management service-exemplaar uniek identificeert. Deze wordt toegevoegd aan de basis-URL van het API-eindpunt die is opgegeven tijdens het maken van het service-exemplaar om een openbare URL voor deze API te vormen.

properties.protocols

Protocol[]

Hierin wordt beschreven op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

properties.serviceUrl

string

Absolute URL van de back-endservice die deze API implementeert. Het mag niet langer zijn dan 2000 tekens.

properties.sourceApiId

string

API-id van de bron-API.

properties.subscriptionKeyParameterNames

SubscriptionKeyParameterNamesContract

Protocollen waarvoor DE API beschikbaar wordt gesteld.

properties.subscriptionRequired

boolean

Hiermee geeft u op of een API- of productabonnement is vereist voor toegang tot de API.

properties.termsOfServiceUrl

string

Een URL naar de servicevoorwaarden voor de API. MOET de indeling van een URL hebben.

properties.type

ApiType

Type of API.

type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ApiLicenseInformation

API-licentiegegevens

Name Type Description
name

string

De licentienaam die wordt gebruikt voor de API

url

string

Een URL naar de licentie die wordt gebruikt voor de API. MOET de indeling van een URL hebben

ApiType

Type of API.

Name Type Description
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

Een API-versieset bevat de algemene configuratie voor een set API-versies met betrekking tot

Name Type Description
description

string

Beschrijving van API-versieset.

id

string

Id voor bestaande API-versieset. Laat deze waarde weg om een nieuwe versieset te maken.

name

string

De weergavenaam van de API-versieset.

versionHeaderName

string

De naam van de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op header.

versionQueryName

string

Naam van queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op query.

versioningScheme

versioningScheme

Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.

AuthenticationSettingsContract

Instellingen voor API-verificatie.

Name Type Description
oAuth2

OAuth2AuthenticationSettingsContract

OAuth2-verificatie-instellingen

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

Verzameling OAuth2-verificatie-instellingen die zijn opgenomen in deze API.

openid

OpenIdAuthenticationSettingsContract

OpenID Connect-verificatie-instellingen

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

Verzameling open ID Connect-verificatie-instellingen die zijn opgenomen in deze API.

bearerTokenSendingMethods

Token verzenden naar de server.

Name Type Description
authorizationHeader

string

Toegangstoken wordt verzonden in de autorisatieheader met behulp van het Bearer-schema

query

string

Het toegangstoken wordt verzonden als queryparameters.

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

OAuth2AuthenticationSettingsContract

Details van instellingen voor API OAuth2-verificatie.

Name Type Description
authorizationServerId

string

OAuth-autorisatieserver-id.

scope

string

bewerkingsbereik.

OpenIdAuthenticationSettingsContract

Details van instellingen voor API OAuth2-verificatie.

Name Type Description
bearerTokenSendingMethods

bearerTokenSendingMethods[]

Token verzenden naar de server.

openidProviderId

string

OAuth-autorisatieserver-id.

Protocol

Hierin wordt beschreven op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

Name Type Description
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

Details van parameternamen van abonnementssleutels.

Name Type Description
header

string

Naam van abonnementssleutelheader.

query

string

Naam van de parameter van de querytekenreeks van de abonnementssleutel.

versioningScheme

Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.

Name Type Description
Header

string

De API-versie wordt doorgegeven in een HTTP-header.

Query

string

De API-versie wordt doorgegeven in een queryparameter.

Segment

string

De API-versie wordt doorgegeven in een padsegment.