Product Api - List By Product

Zobrazí kolekci rozhraní API přidružených k produktu.

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

Parametry identifikátoru URI

Name In Required Type Description
productId
path True
  • string

Identifikátor produktu. V aktuální instanci služby API Management musí být jedinečné.

resourceGroupName
path True
  • string

Název skupiny prostředků.

serviceName
path True
  • string

Název služby API Management.

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

subscriptionId
path True
  • string

Přihlašovací údaje předplatného, které jednoznačně identifikují Microsoft Azure předplatné. ID předplatného tvoří součást identifikátoru URI pro každé volání služby.

api-version
query True
  • string

Verze rozhraní API, která se má použít s žádostí klienta.

$filter
query
  • string

| Pole | | využití Podporované operátory | Podporované funkce |
|-------------|-------------|-------------|-------------|
| název | | filtru ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwith |
| displayName | | filtru ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwith |
| popis | | filtru ge, le, eq, ne, gt, lt | podřetězce, obsahuje, startwith, endwith |
| | serviceUrl | filtru ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwith |
| cesta | | filtru ge, le, eq, ne, gt, lt | substringof, contains, startswith, endwith |

$skip
query
  • integer
int32

Počet záznamů, které se mají přeskočit

$top
query
  • integer
int32

Počet vrácených záznamů.

Odpovědi

Name Type Description
200 OK

Text odpovědi obsahuje kolekci entit rozhraní API v produktu.

Other Status Codes

Odpověď na chybu popisující, proč operace selhala.

Zabezpečení

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 zosobnění uživatelského účtu

Příklady

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

Definice

ApiCollection

Reprezentace stránkovaného seznamu rozhraní API

ApiContactInformation

Kontaktní informace rozhraní API

ApiContract

Podrobnosti rozhraní API

ApiLicenseInformation

Informace o licencích rozhraní API

ApiType

Typ rozhraní API.

ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje společnou konfiguraci pro sadu verzí rozhraní API souvisejících

AuthenticationSettingsContract

Ověřování rozhraní API Nastavení

ErrorFieldContract

Kontrakt pole chyby.

ErrorResponse

Chybová odpověď.

OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování rozhraní API OAuth2

OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování rozhraní API OAuth2

SubscriptionKeyParameterNamesContract

Podrobnosti o názvech parametrů klíče předplatného

ApiCollection

Reprezentace stránkovaného seznamu rozhraní API

Name Type Description
count
  • integer

Celkový počet záznamů na všech stránkách

nextLink
  • string

Odkaz na další stránku, pokud existuje.

value

Hodnoty stránky

ApiContactInformation

Kontaktní informace rozhraní API

Name Type Description
email
  • string

E-mailová adresa kontaktní osoby nebo organizace. Musí být ve formátu e-mailové adresy.

name
  • string

Jméno kontaktní osoby nebo organizace

url
  • string

Adresa URL odkazující na kontaktní údaje. Musí být ve formátu adresy URL.

ApiContract

Podrobnosti rozhraní API

Name Type Description
id
  • string

Plně kvalifikované ID prostředku pro daný prostředek. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Název prostředku

properties.apiRevision
  • string

Popisuje revizi rozhraní API. Pokud není zadána žádná hodnota, vytvoří se výchozí revize 1.

properties.apiRevisionDescription
  • string

Popis revize rozhraní API.

properties.apiVersion
  • string

Označuje identifikátor verze rozhraní API, pokud je rozhraní API ve verzi.

properties.apiVersionDescription
  • string

Popis verze rozhraní API.

properties.apiVersionSet

Podrobnosti sady verzí

properties.apiVersionSetId
  • string

Identifikátor prostředku pro související sadu ApiVersionSet.

properties.authenticationSettings

Kolekce nastavení ověřování, která jsou součástí tohoto rozhraní API.

properties.contact

Kontaktní informace pro rozhraní API

properties.description
  • string

Popis rozhraní API Může obsahovat značky formátování HTML.

properties.displayName
  • string

Název rozhraní API Musí mít délku 1 až 300 znaků.

properties.isCurrent
  • boolean

Označuje, jestli je revize rozhraní API aktuální revizí rozhraní API.

properties.isOnline
  • boolean

Označuje, jestli je revize rozhraní API přístupná přes bránu.

properties.license

Informace o licencích pro rozhraní API

properties.path
  • string

Relativní adresa URL jednoznačně identifikuje toto rozhraní API a všechny jeho cesty prostředků v instanci služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadané během vytváření instance služby a vytvoří veřejnou adresu URL tohoto rozhraní API.

properties.protocols
  • string[]

Popisuje, na jakých protokolech lze vyvolat operace v tomto rozhraní API.

properties.serviceUrl
  • string

Absolutní adresa URL back-endové služby implementuje toto rozhraní API. Nesmí být delší než 2000 znaků.

properties.sourceApiId
  • string

Identifikátor rozhraní API zdrojového rozhraní API

properties.subscriptionKeyParameterNames

Protokoly, u kterých je rozhraní API dostupné.

properties.subscriptionRequired
  • boolean

Určuje, jestli je pro přístup k rozhraní API vyžadováno rozhraní API nebo předplatné produktu.

properties.termsOfServiceUrl
  • string

Adresa URL podmínek služby pro rozhraní API. Musí být ve formátu adresy URL.

properties.type

Typ rozhraní API.

type
  • string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft. Storage/storageAccounts

ApiLicenseInformation

Informace o licencích rozhraní API

Name Type Description
name
  • string

Název licence používaný pro rozhraní API

url
  • string

Adresa URL licence používané pro rozhraní API. Musí být ve formátu adresy URL.

ApiType

Typ rozhraní API.

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

ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje společnou konfiguraci pro sadu verzí rozhraní API souvisejících

Name Type Description
description
  • string

Popis sady verzí rozhraní API

id
  • string

Identifikátor existující sady verzí rozhraní API Tuto hodnotu vynecháte, pokud chcete vytvořit novou sadu verzí.

name
  • string

Zobrazovaný název sady verzí rozhraní API.

versionHeaderName
  • string

Název parametru hlavičky HTTP, který označuje verzi rozhraní API, pokud je verze versioningScheme nastavena na header.

versionQueryName
  • string

Název parametru dotazu, který označuje verzi rozhraní API, pokud je verze versioningScheme nastavena na query.

versioningScheme enum:
  • Header
  • Query
  • Segment

Hodnota, která určuje, kde bude identifikátor verze rozhraní API umístěn v požadavku HTTP.

AuthenticationSettingsContract

Ověřování rozhraní API Nastavení

Name Type Description
oAuth2

Nastavení ověřování OAuth2

openid

Nastavení ověřování OpenID Připojení

ErrorFieldContract

Kontrakt pole chyby.

Name Type Description
code
  • string

Kód chyby na úrovni vlastnosti

message
  • string

Lidské čitelné znázornění chyby na úrovni vlastností

target
  • string

Název vlastnosti

ErrorResponse

Chybová odpověď.

Name Type Description
error.code
  • string

Kód chyby definovaný službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.

error.details

Seznam neplatnýchpolích

error.message
  • string

Znázornění chyby čitelné člověkem

OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování rozhraní API OAuth2

Name Type Description
authorizationServerId
  • string

Identifikátor autorizačního serveru OAuth.

scope
  • string

rozsah operací.

OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování rozhraní API OAuth2

Name Type Description
bearerTokenSendingMethods
  • string[]

Postup odeslání tokenu na server

openidProviderId
  • string

Identifikátor autorizačního serveru OAuth.

SubscriptionKeyParameterNamesContract

Podrobnosti o názvech parametrů klíče předplatného

Name Type Description
header
  • string

Název hlavičky klíče předplatného

query
  • string

Název parametru řetězce dotazu klíče předplatného