Product Api - List By Product

Visar en samling api:er som är associerade med en produkt.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis?api-version=2021-12-01-preview
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-12-01-preview

URI-parametrar

Name In Required Type Description
productId
path True
  • string

Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.

resourceGroupName
path True
  • string

Namnet på resursgruppen.

serviceName
path True
  • string

Namnet på API Management-tjänsten.

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

subscriptionId
path True
  • string

Prenumerationsautentiseringsuppgifter som unikt identifierar Microsoft Azure prenumeration. Prenumerations-ID:t utgör en del av URI:n för varje tjänstanrop.

api-version
query True
  • string

Version av API:et som ska användas med klientbegäran.

$filter
query
  • string

| Fält | Användning | Operatorer som stöds | Funktioner som stöds |
|-------------|-------------|-------------|-------------|
| namn | filtrera | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| displayName | filtrera | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| beskrivning | filtrera | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| serviceUrl | filtrera | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| sökväg | filtrera | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |

$skip
query
  • integer
int32

Antal poster att hoppa över.

$top
query
  • integer
int32

Antal poster som ska returneras.

Svar

Name Type Description
200 OK

Svarstexten innehåller en samling API-entiteter i produkten.

Other Status Codes

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

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 personifiera ditt användarkonto

Exempel

ApiManagementListProductApis

Sample Request

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

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca",
      "type": "Microsoft.ApiManagement/service/products/apis",
      "name": "57681820a40f7eb6c49f6aca",
      "properties": {
        "displayName": "api_57681820a40f7eb6c49f6acb",
        "apiRevision": "1",
        "description": "description_57681820a40f7eb6c49f6acc",
        "serviceUrl": "http://contoso/57681820a40f7eb6c49f6acd",
        "path": "suffix_57681820a40f7eb6c49f6ace",
        "protocols": [
          "https"
        ],
        "isCurrent": true
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definitioner

ApiCollection

Sid-API-listrepresentation.

ApiContactInformation

API-kontaktinformation

ApiContract

API-information.

ApiLicenseInformation

API-licensinformation

ApiType

Typ av API.

ApiVersionSetContractDetails

En API-versionsuppsättning innehåller den vanliga konfigurationen för en uppsättning API-versioner relaterade

AuthenticationSettingsContract

API-autentisering Inställningar.

ErrorFieldContract

Fel Fältkontrakt.

ErrorResponse

Felsvar.

OAuth2AuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

OpenIdAuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

SubscriptionKeyParameterNamesContract

Information om namn på prenumerationsnyckelparametrar.

ApiCollection

Sid-API-listrepresentation.

Name Type Description
count
  • integer

Totalt antal poster på alla sidor.

nextLink
  • string

Om det finns någon länk till nästa sida.

value

Sidvärden.

ApiContactInformation

API-kontaktinformation

Name Type Description
email
  • string

Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress

name
  • string

Identitetsnamnet för kontaktpersonen/organisationen

url
  • string

Url:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL

ApiContract

API-information.

Name Type Description
id
  • string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Namnet på resursen

properties.apiRevision
  • string

Beskriver revisionen av API:et. Om inget värde anges skapas standardrevision 1

properties.apiRevisionDescription
  • string

Beskrivning av API Revision.

properties.apiVersion
  • string

Anger versionsidentifieraren för API:et om API:et är versionshanterat

properties.apiVersionDescription
  • string

Beskrivning av API-versionen.

properties.apiVersionSet

Information om versionsuppsättning

properties.apiVersionSetId
  • string

En resursidentifierare för den relaterade ApiVersionSet.

properties.authenticationSettings

Samling autentiseringsinställningar som ingår i det här API:et.

properties.contact

Kontaktuppgifter för API:et.

properties.description
  • string

Beskrivning av API:et. Kan innehålla HTML-formateringstaggar.

properties.displayName
  • string

API-namn. Måste vara mellan 1 och 300 tecken långt.

properties.isCurrent
  • boolean

Anger om API-revision är aktuell API-revision.

properties.isOnline
  • boolean

Anger om API-revisionen är tillgänglig via gatewayen.

properties.license

Licensinformation för API:et.

properties.path
  • string

Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar inom API Management tjänstinstans. Den läggs till i DEN API-slutpunktsbas-URL som angavs när tjänstinstansen skapades för att skapa en offentlig URL för det här API:et.

properties.protocols
  • string[]

Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.

properties.serviceUrl
  • string

Absolut URL för serverdelstjänsten som implementerar det här API:et. Får inte vara längre än 2 000 tecken.

properties.sourceApiId
  • string

API-identifierare för käll-API:et.

properties.subscriptionKeyParameterNames

Protokoll över vilka API:et görs tillgängligt.

properties.subscriptionRequired
  • boolean

Anger om ett API eller en produktprenumeration krävs för åtkomst till API:et.

properties.termsOfServiceUrl
  • string

En URL till användarvillkoren för API:et. MÅSTE vara i formatet för en URL.

properties.type

Typ av API.

type
  • string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft. Storage/storageAccounts"

ApiLicenseInformation

API-licensinformation

Name Type Description
name
  • string

Licensnamnet som används för API:et

url
  • string

En URL till den licens som används för API:et. MÅSTE vara i formatet för en URL

ApiType

Typ av API.

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

ApiVersionSetContractDetails

En API-versionsuppsättning innehåller den vanliga konfigurationen för en uppsättning API-versioner relaterade

Name Type Description
description
  • string

Beskrivning av API-versionsuppsättning.

id
  • string

Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet för att skapa en ny versionsuppsättning.

name
  • string

Visningsnamnet för API-versionsuppsättningen.

versionHeaderName
  • string

Namnet på HTTP-huvudparametern som anger API-versionen om versionshanteringScheme är inställt på header.

versionQueryName
  • string

Namnet på frågeparametern som anger API-versionen om versionshanteringScheme är inställt på query.

versioningScheme enum:
  • Header
  • Query
  • Segment

Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

AuthenticationSettingsContract

API-autentisering Inställningar.

Name Type Description
oAuth2

Autentiseringsinställningar för OAuth2

openid

OpenID Anslut Authentication Inställningar

ErrorFieldContract

Fel Fältkontrakt.

Name Type Description
code
  • string

Felkod på egenskapsnivå.

message
  • string

Mänsklig läsbar representation av fel på egenskapsnivå.

target
  • string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Type Description
error.code
  • string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.

error.details

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.

error.message
  • string

Mänsklig läsbar representation av felet.

OAuth2AuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name Type Description
authorizationServerId
  • string

OAuth-auktoriseringsserveridentifierare.

scope
  • string

åtgärdsomfång.

OpenIdAuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name Type Description
bearerTokenSendingMethods
  • string[]

Så här skickar du token till servern.

openidProviderId
  • string

OAuth-auktoriseringsserveridentifierare.

SubscriptionKeyParameterNamesContract

Information om namn på prenumerationsnyckelparametrar.

Name Type Description
header
  • string

Namn på prenumerationsnyckelhuvud.

query
  • string

Parameternamn för frågesträng för prenumerationsnyckel.