Apis - Get

Ruft die Details der API ab, die durch den Bezeichner angegeben wird.

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

URI-Parameter

Name In Required Type Description
apiId
path True
  • string

API-Revisionsbezeichner. Muss in der aktuellen API Management Dienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ;rev=n als Suffix, wobei n die Revisionsnummer ist.

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

resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

serviceName
path True
  • string

Der Name des API Management Diensts.

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

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die Microsoft Azure Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

Antworten

Name Type Description
200 OK

Der Antworttext enthält die angegebene API-Entität.

Headers

  • ETag: string
Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

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 Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementGetApiContract
ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

Sample Request

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

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=2021-12-01-preview

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

Definitionen

ApiContactInformation

API-Kontaktinformationen

ApiContract

API-Details.

ApiLicenseInformation

API-Lizenzinformationen

ApiType

Typ der API.

ApiVersionSetContractDetails

Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Reihe von API-Versionen im Zusammenhang

AuthenticationSettingsContract

API-Authentifizierung Einstellungen.

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

OAuth2AuthenticationSettingsContract

Details zu den OAuth2-Authentifizierungseinstellungen der API.

OpenIdAuthenticationSettingsContract

Details zu den OAuth2-Authentifizierungseinstellungen der API.

SubscriptionKeyParameterNamesContract

Details zu Abonnementschlüsselparametern.

ApiContactInformation

API-Kontaktinformationen

Name Type Description
email
  • string

Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse enthalten sein

name
  • string

Der Identifizierungsname der Kontaktperson/Organisation

url
  • string

Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL enthalten sein

ApiContract

API-Details.

Name Type Description
id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Der Name der Ressource

properties.apiRevision
  • string

Beschreibt die Überarbeitung der API. Wenn kein Wert angegeben wird, wird standardmäßige Revision 1 erstellt.

properties.apiRevisionDescription
  • string

Beschreibung der API-Revision.

properties.apiVersion
  • string

Gibt den Versionsbezeichner der API an, wenn die API versioniert ist

properties.apiVersionDescription
  • string

Beschreibung der API-Version.

properties.apiVersionSet

Details zum Versionssatz

properties.apiVersionSetId
  • string

Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.

properties.authenticationSettings

Sammlung der in dieser API enthaltenen Authentifizierungseinstellungen.

properties.contact

Kontaktinformationen für die API.

properties.description
  • string

Beschreibung der API. Kann HTML-Formatierungstags umfassen.

properties.displayName
  • string

API-Name. Muss 1 bis 300 Zeichen lang sein.

properties.isCurrent
  • boolean

Gibt an, ob die API-Revision aktuelle API-Revision ist.

properties.isOnline
  • boolean

Gibt an, ob über das Gateway auf API-Überarbeitung zugegriffen werden kann.

properties.license

Lizenzinformationen für die API.

properties.path
  • string

Relative URL, die diese API und all ihre Ressourcenpfade in der Instanz des API Management-Diensts eindeutig identifiziert. Sie wird an die Basis-URL des API-Endpunkts angehängt, die während der Dienstinstanzerstellung angegeben wurde, um eine öffentliche URL für diese API zu erstellen.

properties.protocols
  • string[]

Beschreibt, über welche Protokolle die Vorgänge in dieser API aufgerufen werden können.

properties.serviceUrl
  • string

Absolute URL des Back-End-Diensts, der diese API implementiert. Nicht mehr als 2000 Zeichen lang sein.

properties.sourceApiId
  • string

API-ID der Quell-API.

properties.subscriptionKeyParameterNames

Protokolle, über die die API verfügbar gemacht wird.

properties.subscriptionRequired
  • boolean

Gibt an, ob für den Zugriff auf die API ein API- oder Produktabonnement erforderlich ist.

properties.termsOfServiceUrl
  • string

Eine URL zu den Nutzungsbedingungen für die API. MUSS im Format einer URL enthalten sein.

properties.type

Typ der API.

type
  • string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft. Storage/storageAccounts"

ApiLicenseInformation

API-Lizenzinformationen

Name Type Description
name
  • string

Der Lizenzname, der für die API verwendet wird

url
  • string

Eine URL zur Lizenz, die für die API verwendet wird. MUSS im Format einer URL enthalten sein

ApiType

Typ der API.

Name Type Description
graphql
  • string
http
  • string
soap
  • string
websocket
  • string

ApiVersionSetContractDetails

Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Reihe von API-Versionen im Zusammenhang

Name Type Description
description
  • string

Beschreibung des API-Versionssatzes.

id
  • string

Bezeichner für vorhandene API-Versionssatz. Lassen Sie diesen Wert aus, um einen neuen Versionssatz zu erstellen.

name
  • string

Der Anzeigename des API-Versionssatzes.

versionHeaderName
  • string

Name des HTTP-Headerparameters, der die API-Version angibt, wenn versioningScheme auf headerfestgelegt ist.

versionQueryName
  • string

Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf queryfestgelegt ist.

versioningScheme enum:
  • Header
  • Query
  • Segment

Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

AuthenticationSettingsContract

API-Authentifizierung Einstellungen.

Name Type Description
oAuth2

OAuth2-Authentifizierungseinstellungen

openid

OpenID Verbinden Authentifizierung Einstellungen

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.

message
  • string

Humanlesbare Darstellung des Fehlers auf Eigenschaftsebene.

target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

Die Liste der ungültigen Felder, die in Anforderung gesendet werden, im Falle eines Überprüfungsfehlers.

error.message
  • string

Lesbare Darstellung des Fehlers.

OAuth2AuthenticationSettingsContract

Details zu den OAuth2-Authentifizierungseinstellungen der API.

Name Type Description
authorizationServerId
  • string

Bezeichner (ID) des OAuth-Autorisierungsservers.

scope
  • string

Operations scope.

OpenIdAuthenticationSettingsContract

Details zu den OAuth2-Authentifizierungseinstellungen der API.

Name Type Description
bearerTokenSendingMethods
  • string[]

So senden Sie Token an den Server.

openidProviderId
  • string

Bezeichner (ID) des OAuth-Autorisierungsservers.

SubscriptionKeyParameterNamesContract

Details zu Abonnementschlüsselparametern.

Name Type Description
header
  • string

Name des Abonnementschlüssels.

query
  • string

Parametername der Abonnementschlüsselabfragezeichenfolge.