Apis - Get

Ottiene i dettagli dell'API specificata dall'identificatore.

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

Parametri dell'URI

Name In Required Type Description
apiId
path True
  • string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente include ;rev=n come suffisso in cui n è il numero di revisione.

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

resourceGroupName
path True
  • string

Nome del gruppo di risorse.

serviceName
path True
  • string

Nome del servizio Gestione API.

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

subscriptionId
path True
  • string

Credenziali di sottoscrizione che identificano in modo univoco Microsoft Azure sottoscrizione. L'ID sottoscrizione fa parte dell'URI per ogni chiamata di servizio.

api-version
query True
  • string

Versione dell'API da usare con la richiesta client.

Risposte

Name Type Description
200 OK

Il corpo della risposta contiene l'entità API specificata.

Headers

  • ETag: string
Other Status Codes

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Azure Active Directory Flow OAuth2.

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

Scopes

Name Description
user_impersonation rappresentare l'account utente

Esempio

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

Definizioni

ApiContactInformation

Informazioni di contatto dell'API

ApiContract

Dettagli dell'API.

ApiLicenseInformation

Informazioni sulla licenza API

ApiType

Tipo di API.

ApiVersionSetContractDetails

Un set di versioni api contiene la configurazione comune per un set di versioni API relative

AuthenticationSettingsContract

Autenticazione API Impostazioni.

ErrorFieldContract

Contratto campo errore.

ErrorResponse

Risposta errore.

OAuth2AuthenticationSettingsContract

Informazioni dettagliate sulle impostazioni di autenticazione dell'API OAuth2.

OpenIdAuthenticationSettingsContract

Informazioni dettagliate sulle impostazioni di autenticazione dell'API OAuth2.

SubscriptionKeyParameterNamesContract

Dettagli sui nomi dei parametri della chiave di sottoscrizione.

ApiContactInformation

Informazioni di contatto dell'API

Name Type Description
email
  • string

Indirizzo di posta elettronica della persona o dell'organizzazione di contatto. DEVE essere nel formato di un indirizzo di posta elettronica

name
  • string

Nome di identificazione della persona di contatto/organizzazione

url
  • string

URL che punta alle informazioni di contatto. DEVE essere nel formato di un URL

ApiContract

Dettagli dell'API.

Name Type Description
id
  • string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

nome della risorsa.

properties.apiRevision
  • string

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

properties.apiRevisionDescription
  • string

Descrizione della revisione DELL'API.

properties.apiVersion
  • string

Indica l'identificatore della versione dell'API se l'API è in versione

properties.apiVersionDescription
  • string

Descrizione della versione dell'API.

properties.apiVersionSet

Dettagli del set di versioni

properties.apiVersionSetId
  • string

Identificatore di risorsa per ApiVersionSet correlato.

properties.authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.

properties.contact

Informazioni di contatto per l'API.

properties.description
  • string

Descrizione dell'API. Può includere tag di formattazione HTML.

properties.displayName
  • string

Nome API. Deve essere lungo da 1 a 300 caratteri.

properties.isCurrent
  • boolean

Indica se la revisione dell'API è la revisione dell'API corrente.

properties.isOnline
  • boolean

Indica se la revisione API è accessibile tramite il gateway.

properties.license

Informazioni sulla licenza per l'API.

properties.path
  • string

URL relativo che identifica in modo univoco questa API e tutti i relativi percorsi delle risorse all'interno dell'istanza del servizio Gestione API. Viene aggiunto all'URL di base dell'endpoint API specificato durante la creazione dell'istanza del servizio in modo da formare un URL pubblico per questa API.

properties.protocols
  • string[]

Descrive su quali protocolli è possibile richiamare le operazioni in questa API.

properties.serviceUrl
  • string

URL assoluto del servizio back-end che implementa questa API. Impossibile contenere più di 2000 caratteri.

properties.sourceApiId
  • string

Identificatore API dell'API di origine.

properties.subscriptionKeyParameterNames

Protocolli su cui è disponibile l'API.

properties.subscriptionRequired
  • boolean

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

properties.termsOfServiceUrl
  • string

URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.

properties.type

Tipo di API.

type
  • string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft. Archiviazione/storageAccounts"

ApiLicenseInformation

Informazioni sulla licenza API

Name Type Description
name
  • string

Nome della licenza usato per l'API

url
  • string

URL della licenza usata per l'API. DEVE essere nel formato di un URL

ApiType

Tipo di API.

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

ApiVersionSetContractDetails

Un set di versioni api contiene la configurazione comune per un set di versioni API relative

Name Type Description
description
  • string

Descrizione del set di versioni dell'API.

id
  • string

Identificatore per il set di versioni DELL'API esistente. Omettere questo valore per creare un nuovo set di versioni.

name
  • string

Nome visualizzato del set di versioni dell'API.

versionHeaderName
  • string

Nome del parametro di intestazione HTTP che indica la versione DELL'API se il controllo delle versioniScheme è impostato su header.

versionQueryName
  • string

Nome del parametro di query che indica la versione DELL'API se il controllo delle versioniScheme è impostato su query.

versioningScheme enum:
  • Header
  • Query
  • Segment

Valore che determina dove si trova l'identificatore della versione API in una richiesta HTTP.

AuthenticationSettingsContract

Autenticazione API Impostazioni.

Name Type Description
oAuth2

Impostazioni di autenticazione OAuth2

openid

OpenID Connessione Autenticazione Impostazioni

ErrorFieldContract

Contratto campo errore.

Name Type Description
code
  • string

Codice di errore a livello di proprietà.

message
  • string

Rappresentazione leggibile dell'errore a livello di proprietà.

target
  • string

Nome della proprietà.

ErrorResponse

Risposta errore.

Name Type Description
error.code
  • string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message
  • string

Rappresentazione leggibile dell'errore.

OAuth2AuthenticationSettingsContract

Informazioni dettagliate sulle impostazioni di autenticazione dell'API OAuth2.

Name Type Description
authorizationServerId
  • string

Identificatore del server di autorizzazione OAuth.

scope
  • string

ambito operazioni.

OpenIdAuthenticationSettingsContract

Informazioni dettagliate sulle impostazioni di autenticazione dell'API OAuth2.

Name Type Description
bearerTokenSendingMethods
  • string[]

Come inviare il token al server.

openidProviderId
  • string

Identificatore del server di autorizzazione OAuth.

SubscriptionKeyParameterNamesContract

Dettagli sui nomi dei parametri della chiave di sottoscrizione.

Name Type Description
header
  • string

Nome dell'intestazione della chiave di sottoscrizione.

query
  • string

Nome del parametro della stringa di query della chiave di sottoscrizione.