Workspace Api - Get

Referentie

Service:: API Management

API-versie:: 2024-05-01

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

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

URI-parameters

Name	In	Vereist	Type	Description
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API-revisie-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service. Niet-huidige herziening heeft ; rev=n als achtervoegsel waarbij n het revisienummer is.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Werkruimte-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	ApiContract	De hoofdtekst van het antwoord bevat de opgegeven API-entiteit. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

ApiContract

De hoofdtekst van het antwoord bevat de opgegeven API-entiteit.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementGetWorkspaceApiContract

ApiManagementGetWorkspaceApiRevision

ApiManagementGetWorkspaceApiContract

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ApiContactInformation	API-contactgegevens
ApiContract	API-gegevens.
ApiLicenseInformation	API-licentiegegevens
ApiType	Type of API.
ApiVersionSetContractDetails	Een API-versieset bevat de algemene configuratie voor een set API-versies met betrekking tot
AuthenticationSettingsContract	API-verificatie-instellingen.
bearerTokenSendingMethods	Token naar de server verzenden.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
OAuth2AuthenticationSettingsContract	Details van verificatie-instellingen voor API OAuth2.
OpenIdAuthenticationSettingsContract	Details van verificatie-instellingen voor API OAuth2.
Protocol	Beschrijft op welke protocollen de bewerkingen in deze API kunnen worden aangeroepen.
SubscriptionKeyParameterNamesContract	Details van parameternamen voor abonnementssleutels.
versioningScheme	Een waarde die bepaalt waar de API-versie-id zich in een HTTP-aanvraag bevindt.

ApiContactInformation

Object

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 identificatienaam van de contactpersoon/organisatie
url	string	De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben

ApiContract

Object

API-gegevens.

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 minLength: 1 maxLength: 100	Beschrijft de revisie van de API. Als er geen waarde is opgegeven, wordt standaardrevisie 1 gemaakt
properties.apiRevisionDescription	string maxLength: 256	Beschrijving van de API-revisie.
properties.apiVersion	string maxLength: 100	Geeft de versie-id van de API aan als de API is geversied
properties.apiVersionDescription	string maxLength: 256	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 minLength: 1 maxLength: 300	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 minLength: 0 maxLength: 400	Relatieve URL die deze API en alle bijbehorende resourcepaden uniek identificeert binnen het API Management-service-exemplaar. 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.provisioningState	string	De inrichtingsstatus
properties.serviceUrl	string minLength: 0 maxLength: 2000	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	SubscriptionKeyParameterNamesContract	Protocollen over welke API beschikbaar wordt gemaakt.
properties.subscriptionRequired	boolean	Hiermee geeft u op of een API- of productabonnement vereist is 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

Object

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

Inventarisatie

Type of API.

Waarde	Description
graphql
grpc
http
odata
soap
websocket

ApiVersionSetContractDetails

Object

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 de HTTP-headerparameter die de API-versie aangeeft als versioningScheme is ingesteld op `header`.
versionQueryName	string	De naam van de 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

Object

API-verificatie-instellingen.

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

Inventarisatie

Token naar de server verzenden.

Waarde	Description
authorizationHeader	Toegangstoken wordt verzonden in de autorisatieheader met behulp van het Bearer-schema
query	Het toegangstoken wordt verzonden als queryparameters.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

OAuth2AuthenticationSettingsContract

Object

Details van verificatie-instellingen voor API OAuth2.

Name	Type	Description
authorizationServerId	string	OAuth-autorisatieserver-id.
scope	string	bewerkingsbereik.

OpenIdAuthenticationSettingsContract

Object

Details van verificatie-instellingen voor API OAuth2.

Name	Type	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Token naar de server verzenden.
openidProviderId	string	OAuth-autorisatieserver-id.

Protocol

Inventarisatie

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

Waarde	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Details van parameternamen voor abonnementssleutels.

Name	Type	Description
header	string	Naam van abonnementssleutelheader.
query	string	Naam van queryreeksparameter voor abonnementssleutel.

versioningScheme

Inventarisatie

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

Waarde	Description
Header	De API-versie wordt doorgegeven in een HTTP-header.
Query	De API-versie wordt doorgegeven in een queryparameter.
Segment	De API-versie wordt doorgegeven in een padsegment.

Delen via

Workspace Api - Get

URI-parameters

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementGetWorkspaceApiContract

Voorbeeldaanvraag

Voorbeeldrespons

ApiManagementGetWorkspaceApiRevision

Voorbeeldaanvraag

Voorbeeldrespons

Definities

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

Aanvullende resources