Workspace Api - Get

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API-Revisionsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein. Die nicht aktuelle Überarbeitung hat ; rev=n als Suffix, wobei n die Revisionsnummer ist.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Arbeitsbereichsbezeichner. Muss in der aktuellen API-Verwaltungsdienstinstanz eindeutig sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	ApiContract	Der Antworttext enthält die angegebene API-Entität. Header ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Name

Typ

Beschreibung

200 OK

ApiContract

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

Header

ETag: string

Other Status Codes

ErrorResponse

Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementGetWorkspaceApiContract

ApiManagementGetWorkspaceApiRevision

ApiManagementGetWorkspaceApiContract

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/workspaces/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
  }
}

ApiManagementGetWorkspaceApiRevision

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api;rev=3?api-version=2024-05-01

Beispiel für eine Antwort

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/workspaces/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"
  }
}

Definitionen

Name	Beschreibung
ApiContactInformation	API-Kontaktinformationen
ApiContract	API-Details.
ApiLicenseInformation	API-Lizenzinformationen
ApiType	API-Typ.
ApiVersionSetContractDetails	Ein API-Versionssatz enthält die allgemeine Konfiguration für eine Gruppe von API-Versionen im Zusammenhang
AuthenticationSettingsContract	API-Authentifizierungseinstellungen.
bearerTokenSendingMethods	So senden Sie token an den Server.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
OAuth2AuthenticationSettingsContract	Details zu den OAuth2-Authentifizierungseinstellungen der API.
OpenIdAuthenticationSettingsContract	Details zu den OAuth2-Authentifizierungseinstellungen der API.
Protocol	Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.
SubscriptionKeyParameterNamesContract	Details zu Abonnementschlüsselparametern.
versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

ApiContactInformation

Objekt

API-Kontaktinformationen

Name	Typ	Beschreibung
email	string	Die E-Mail-Adresse der Kontaktperson/Organisation. MUSS im Format einer E-Mail-Adresse vorliegen
name	string	Der Identifizierungsname der Kontaktperson/Organisation
url	string	Die URL, die auf die Kontaktinformationen verweist. MUSS im Format einer URL vorliegen

ApiContract

Objekt

API-Details.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.apiRevision	string minLength: 1 maxLength: 100	Beschreibt die Revision der API. Wenn kein Wert angegeben wird, wird die Standardrevision 1 erstellt.
properties.apiRevisionDescription	string maxLength: 256	Beschreibung der API-Revision.
properties.apiVersion	string maxLength: 100	Gibt den Versionsbezeichner der API an, wenn die API versioniert ist.
properties.apiVersionDescription	string maxLength: 256	Beschreibung der API-Version.
properties.apiVersionSet	ApiVersionSetContractDetails	Versionssatzdetails
properties.apiVersionSetId	string	Ein Ressourcenbezeichner für das zugehörige ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Sammlung von Authentifizierungseinstellungen, die in dieser API enthalten sind.
properties.contact	ApiContactInformation	Kontaktinformationen für die API.
properties.description	string	Beschreibung der API. Kann HTML-Formatierungstags enthalten.
properties.displayName	string minLength: 1 maxLength: 300	API-Name. Muss 1 bis 300 Zeichen lang sein.
properties.isCurrent	boolean	Gibt an, ob die API-Revision die aktuelle API-Revision ist.
properties.isOnline	boolean	Gibt an, ob über das Gateway auf die API-Revision zugegriffen werden kann.
properties.license	ApiLicenseInformation	Lizenzinformationen für die API.
properties.path	string minLength: 0 maxLength: 400	Relative URL identifiziert diese API und alle zugehörigen Ressourcenpfade innerhalb der API-Verwaltungsdienstinstanz eindeutig. Sie wird an die API-Endpunktbasis-URL angefügt, die während der Erstellung der Dienstinstanz angegeben wurde, um eine öffentliche URL für diese API zu bilden.
properties.protocols	Protocol[]	Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.
properties.provisioningState	string	Der Bereitstellungsstatus
properties.serviceUrl	string minLength: 0 maxLength: 2000	Absolute URL des Back-End-Diensts, der diese API implementiert. Maximal 2000 Zeichen lang.
properties.sourceApiId	string	API-ID der Quell-API.
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protokolle, über 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 vorliegen.
properties.type	ApiType	API-Typ.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Objekt

API-Lizenzinformationen

Name	Typ	Beschreibung
name	string	Der für die API verwendete Lizenzname
url	string	Eine URL zu der lizenz, die für die API verwendet wird. MUSS im Format einer URL vorliegen

ApiType

Enumeration

API-Typ.

Wert	Beschreibung
graphql
grpc
http
odata
soap
websocket

ApiVersionSetContractDetails

Objekt

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

Name	Typ	Beschreibung
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 `header`festgelegt ist.
versionQueryName	string	Name des Abfrageparameters, der die API-Version angibt, wenn versioningScheme auf `query`festgelegt ist.
versioningScheme	versioningScheme	Ein Wert, der bestimmt, wo sich der API-Versionsbezeichner in einer HTTP-Anforderung befindet.

AuthenticationSettingsContract

Objekt

API-Authentifizierungseinstellungen.

Name	Typ	Beschreibung
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2-Authentifizierungseinstellungen
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Sammlung der OAuth2-Authentifizierungseinstellungen, die in dieser API enthalten sind.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect-Authentifizierungseinstellungen
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Sammlung der in dieser API enthaltenen Open ID Connect-Authentifizierungseinstellungen.

bearerTokenSendingMethods

Enumeration

So senden Sie token an den Server.

Wert	Beschreibung
authorizationHeader	Zugriffstoken wird im Autorisierungsheader mithilfe des Bearer-Schemas übertragen.
query	Zugriffstoken wird als Abfrageparameter übertragen.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

OAuth2AuthenticationSettingsContract

Objekt

Details zu den OAuth2-Authentifizierungseinstellungen der API.

Name	Typ	Beschreibung
authorizationServerId	string	OAuth-Autorisierungsserverbezeichner.
scope	string	operations scope.

OpenIdAuthenticationSettingsContract

Objekt

Details zu den OAuth2-Authentifizierungseinstellungen der API.

Name	Typ	Beschreibung
bearerTokenSendingMethods	bearerTokenSendingMethods[]	So senden Sie token an den Server.
openidProviderId	string	OAuth-Autorisierungsserverbezeichner.

Protocol

Enumeration

Beschreibt, welche Protokolle die Vorgänge in dieser API aufrufen können.

Wert	Beschreibung
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Objekt

Details zu Abonnementschlüsselparametern.

Name	Typ	Beschreibung
header	string	Name des Abonnementschlüsselheaders.
query	string	Name des Zeichenfolgenparameters der Abonnementschlüsselabfrage.

versioningScheme

Enumeration

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

Wert	Beschreibung
Header	Die API-Version wird in einem HTTP-Header übergeben.
Query	Die API-Version wird in einem Abfrageparameter übergeben.
Segment	Die API-Version wird in einem Pfadsegment übergeben.

Freigeben über

Workspace Api - Get

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementGetWorkspaceApiContract

Beispielanforderung

Beispiel für eine Antwort

ApiManagementGetWorkspaceApiRevision

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

Zusätzliche Ressourcen