Apis - Get
Hiermee haalt u de details van de API op die is opgegeven door de id.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}?api-version=2022-08-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
api
|
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 pattern: |
resource
|
path | True |
string |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
service
|
path | True |
string |
De naam van de API Management service. Regex pattern: |
subscription
|
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 |
De antwoordtekst bevat de opgegeven API-entiteit. Headers ETag: string |
|
Other Status Codes |
Foutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Beveiliging
azure_auth
Azure Active Directory OAuth2-stroom.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | Uw gebruikersaccount imiteren |
Voorbeelden
Api |
Api |
ApiManagementGetApiContract
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a?api-version=2022-08-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"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"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=2022-08-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"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"subscriptionKeyParameterNames": {
"header": "Ocp-Apim-Subscription-Key",
"query": "subscription-key"
},
"apiRevisionDescription": "fixed bug in contract"
}
}
Definities
Name | Description |
---|---|
Api |
API-contactgegevens |
Api |
API-details. |
Api |
API-licentiegegevens |
Api |
Type of API. |
Api |
Een API-versieset bevat de algemene configuratie voor een set API-versies met betrekking tot |
Authentication |
Instellingen voor API-verificatie. |
bearer |
Token verzenden naar de server. |
Error |
Fout veldcontract. |
Error |
Foutreactie. |
OAuth2Authentication |
Details van de instellingen voor API OAuth2-verificatie. |
Open |
Details van de instellingen voor API OAuth2-verificatie. |
Protocol |
Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen. |
Subscription |
Details van parameternamen van abonnementssleutels. |
versioning |
Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt. |
ApiContactInformation
API-contactgegevens
Name | Type | Description |
---|---|---|
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. Bijvoorbeeld - /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 er versieversies van de API zijn |
properties.apiVersionDescription |
string |
Beschrijving van de API-versie. |
properties.apiVersionSet |
Details van versieset |
|
properties.apiVersionSetId |
string |
Een resource-id voor de gerelateerde ApiVersionSet. |
properties.authenticationSettings |
Verzameling van verificatie-instellingen die zijn opgenomen in deze API. |
|
properties.contact |
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 |
Licentiegegevens voor de API. |
|
properties.path |
string |
Relatieve URL die deze API en alle bijbehorende resourcepaden in 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[] |
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 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 |
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 |
versionQueryName |
string |
De naam van de queryparameter die de API-versie aangeeft als versioningScheme is ingesteld op |
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 |
OAuth2-verificatie-instellingen |
|
oAuth2AuthenticationSettings |
Verzameling van OAuth2-verificatie-instellingen die zijn opgenomen in deze API. |
|
openid |
OpenID Connect-verificatie-instellingen |
|
openidAuthenticationSettings |
Verzameling van Open ID Connect-verificatie-instellingen die zijn opgenomen in deze API. |
bearerTokenSendingMethods
Token verzenden naar de server.
Name | Type | Description |
---|---|---|
authorizationHeader |
string |
Het toegangstoken wordt verzonden in de autorisatie-header 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 |
De lijst met ongeldige velden verzenden in aanvraag, in geval van een validatiefout. |
|
error.message |
string |
Door mensen leesbare weergave van de fout. |
OAuth2AuthenticationSettingsContract
Details van de instellingen voor API OAuth2-verificatie.
Name | Type | Description |
---|---|---|
authorizationServerId |
string |
OAuth-autorisatieserver-id. |
scope |
string |
bewerkingsbereik. |
OpenIdAuthenticationSettingsContract
Details van de instellingen voor API OAuth2-verificatie.
Name | Type | Description |
---|---|---|
bearerTokenSendingMethods |
Token verzenden naar de server. |
|
openidProviderId |
string |
OAuth-autorisatieserver-id. |
Protocol
Beschrijft 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 |
Parameternaam 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. |