Apis - Get

Hiermee haalt u de details op van de API die is opgegeven door de id.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2020-12-01

URI-parameters

Name In Required 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 achtervoegsel, waarbij n het revisienummer is.

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

resourceGroupName
path True
  • string

De naam van de resourcegroep.

serviceName
path True
  • string

De naam van de API Management service.

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

subscriptionId
path True
  • string

Abonnementsreferenties die een uniek Microsoft Azure identificeren. De abonnements-id maakt deel uit van de URI voor elke serviceoproep.

api-version
query True
  • string

Versie van de API die moet worden gebruikt met de clientaanvraag.

Antwoorden

Name Type Description
200 OK

De antwoord-body bevat de opgegeven API-entiteit.

Media Types: "application/json", "application/vnd.sun.wadl+xml", "application/vnd.swagger.doc+json", "application/wsdl+xml", "application/vnd.oai.openapi", "application/vnd.oai.openapi+json"

Headers

  • ETag: string
Other Status Codes

Foutbericht waarin wordt beschreven waarom de bewerking is mislukt.

Media Types: "application/json", "application/vnd.sun.wadl+xml", "application/vnd.swagger.doc+json", "application/wsdl+xml", "application/vnd.oai.openapi", "application/vnd.oai.openapi+json"

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetApiContract
ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a?api-version=2020-12-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2020-12-01

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

Definities

ApiContract

API-details.

ApiType

Type of API.

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

API-verificatie Instellingen.

ErrorFieldContract

Foutveldcontract.

ErrorResponse

Foutbericht.

OAuth2AuthenticationSettingsContract

Details van verificatie-instellingen voor API OAuth2.

OpenIdAuthenticationSettingsContract

Details van verificatie-instellingen voor API OAuth2.

SubscriptionKeyParameterNamesContract

Details van parameternamen van abonnementssleutels.

ApiContract

API-details.

Name Type Description
id
  • string

Resource-id.

name
  • string

Resourcenaam.

properties.apiRevision
  • string

Beschrijft de revisie van de API. Als er geen waarde is 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 er een versie van de API is

properties.apiVersionDescription
  • string

Beschrijving van de API-versie.

properties.apiVersionSet

Details van de versieset

properties.apiVersionSetId
  • string

Een resource-id voor de gerelateerde ApiVersionSet.

properties.authenticationSettings

Verzameling verificatie-instellingen die zijn opgenomen in deze 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.path
  • string

Relatieve URL die deze API en alle resourcepaden binnen het service 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
  • string[]

Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.

properties.serviceUrl
  • string

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

properties.sourceApiId
  • string

API-id van de bron-API.

properties.subscriptionKeyParameterNames

Protocollen waarover API beschikbaar wordt gesteld.

properties.subscriptionRequired
  • boolean

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

properties.type

Type of API.

type
  • string

Resourcetype voor API Management resource.

ApiType

Type of API.

Name Type Description
http
  • string
soap
  • 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

Naam van 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 enum:
  • Header
  • Query
  • Segment

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

AuthenticationSettingsContract

API-verificatie Instellingen.

Name Type Description
oAuth2

OAuth2-verificatie-instellingen

openid

OpenID Verbinding maken verificatie Instellingen

ErrorFieldContract

Foutveldcontract.

Name Type Description
code
  • string

Foutcode op eigenschapsniveau.

message
  • string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target
  • string

Eigenschapsnaam.

ErrorResponse

Foutbericht.

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

De lijst met ongeldige velden die in de aanvraag worden weergegeven, in het geval van een validatiefout.

error.message
  • string

Door mensen leesbare weergave van de fout.

OAuth2AuthenticationSettingsContract

Details van verificatie-instellingen voor API OAuth2.

Name Type Description
authorizationServerId
  • string

OAuth-autorisatieserver-id.

scope
  • string

bereik van bewerkingen.

OpenIdAuthenticationSettingsContract

Details van verificatie-instellingen voor API OAuth2.

Name Type Description
bearerTokenSendingMethods
  • string[]

Token verzenden naar de server.

openidProviderId
  • string

OAuth-autorisatieserver-id.

SubscriptionKeyParameterNamesContract

Details van parameternamen van abonnementssleutels.

Name Type Description
header
  • string

Naam van abonnementssleutelheader.

query
  • string

Parameternaam van queryreeks voor abonnementssleutel.