Product Api - List By Product

Service:

API Management

API Version:

2022-08-01

Vypíše kolekci rozhraní API přidruženou k produktu.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis?api-version=2022-08-01

With optional parameters:

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=2022-08-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
productId	path	True	string	Identifikátor produktu. Musí být v aktuální instanci služby API Management jedinečná.
resourceGroupName	path	True	string	Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
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	ID cílového předplatného.
api-version	query	True	string	Verze rozhraní API, která se má použít pro tuto operaci.
$filter	query		string	| Pole | Využití | Podporované operátory | Podporované funkce | |-------------|-------------|-------------|-------------| | name | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s | | displayName | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s | | popis | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s | | serviceUrl | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s | | cesta | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná s, končí |
$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	Typ	Description
200 OK	ApiCollection	Text odpovědi obsahuje kolekci entit rozhraní API v produktu.
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory 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

HTTP

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

Java

/** Samples for ProductApi ListByProduct. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.json
     */
    /**
     * Sample code: ApiManagementListProductApis.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListProductApis(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .productApis()
            .listByProduct(
                "rg1", "apimService1", "5768181ea40f7eb6c49f6ac7", null, null, null, com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_list_product_apis.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.product_api.list_by_product(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="5768181ea40f7eb6c49f6ac7",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.json
func ExampleProductAPIClient_NewListByProductPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewProductAPIClient().NewListByProductPager("rg1", "apimService1", "5768181ea40f7eb6c49f6ac7", &armapimanagement.ProductAPIClientListByProductOptions{Filter: nil,
		Top:  nil,
		Skip: nil,
	})
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.APICollection = armapimanagement.APICollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.APIContract{
		// 		{
		// 			Name: to.Ptr("57681820a40f7eb6c49f6aca"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/products/apis"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/5768181ea40f7eb6c49f6ac7/apis/57681820a40f7eb6c49f6aca"),
		// 			Properties: &armapimanagement.APIContractProperties{
		// 				Description: to.Ptr("description_57681820a40f7eb6c49f6acc"),
		// 				APIRevision: to.Ptr("1"),
		// 				IsCurrent: to.Ptr(true),
		// 				Path: to.Ptr("suffix_57681820a40f7eb6c49f6ace"),
		// 				DisplayName: to.Ptr("api_57681820a40f7eb6c49f6acb"),
		// 				Protocols: []*armapimanagement.Protocol{
		// 					to.Ptr(armapimanagement.ProtocolHTTPS)},
		// 					ServiceURL: to.Ptr("http://contoso/57681820a40f7eb6c49f6acd"),
		// 				},
		// 		}},
		// 	}
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Lists a collection of the APIs associated with a product.
 *
 * @summary Lists a collection of the APIs associated with a product.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductApis.json
 */
async function apiManagementListProductApis() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "5768181ea40f7eb6c49f6ac7";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.productApi.listByProduct(
    resourceGroupName,
    serviceName,
    productId
  )) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

Name	Description
ApiCollection	Reprezentace seznamu stránkovaného rozhraní API
ApiContactInformation	Kontaktní informace rozhraní API
ApiContract	Podrobnosti rozhraní API
ApiLicenseInformation	Informace o licenci rozhraní API
ApiType	Typ rozhraní API
ApiVersionSetContractDetails	Sada verzí rozhraní API obsahuje běžnou konfiguraci pro sadu verzí rozhraní API, které se týkají.
AuthenticationSettingsContract	Nastavení ověřování rozhraní API.
bearerTokenSendingMethods	Postup odeslání tokenu na server
ErrorFieldContract	Chyba Kontrakt pole.
ErrorResponse	Odpověď na chybu.
OAuth2AuthenticationSettingsContract	Podrobnosti o nastavení ověřování api OAuth2
OpenIdAuthenticationSettingsContract	Podrobnosti o nastavení ověřování api OAuth2
Protocol	Popisuje, na kterých protokolech lze vyvolat operace v tomto rozhraní API.
SubscriptionKeyParameterNamesContract	Podrobnosti o názvech parametrů klíče předplatného
versioningScheme	Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API.

ApiCollection

Reprezentace seznamu stránkovaného rozhraní API

Name	Typ	Description
count	integer	Celkový počet záznamů na všech stránkách.
nextLink	string	Odkaz na další stránku, pokud existuje.
value	ApiContract[]	Hodnoty stránky.

ApiContactInformation

Kontaktní informace rozhraní API

Name	Typ	Description
email	string	E-mailová adresa kontaktní osoby nebo organizace. MUSÍ být ve formátu e-mailové adresy.
name	string	Identifikační jméno kontaktní osoby nebo organizace
url	string	Adresa URL odkazující na kontaktní informace. MUSÍ být ve formátu adresy URL.

ApiContract

Podrobnosti rozhraní API

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku. 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	ApiVersionSetContractDetails	Podrobnosti o sadě verzí
properties.apiVersionSetId	string	Identifikátor prostředku pro související apiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Kolekce nastavení ověřování zahrnutých v tomto rozhraní API
properties.contact	ApiContactInformation	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í revize rozhraní API.
properties.isOnline	boolean	Označuje, jestli je revize rozhraní API přístupná přes bránu.
properties.license	ApiLicenseInformation	Informace o licencích pro rozhraní API
properties.path	string	Relativní adresa URL jednoznačně identifikující toto rozhraní API a všechny jeho cesty k prostředkům v rámci instance služby API Management. Připojí se k základní adrese URL koncového bodu rozhraní API zadanou při vytváření instance služby a vytvoří veřejnou adresu URL pro toto rozhraní API.
properties.protocols	Protocol[]	Popisuje, na který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	SubscriptionKeyParameterNamesContract	Protokoly, přes které je k dispozici rozhraní API.
properties.subscriptionRequired	boolean	Určuje, jestli se pro přístup k rozhraní API vyžaduje předplatné rozhraní API nebo product.
properties.termsOfServiceUrl	string	Adresa URL pro podmínky služby pro rozhraní API. MUSÍ být ve formátu adresy URL.
properties.type	ApiType	Typ rozhraní API
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

ApiLicenseInformation

Informace o licenci rozhraní API

Name	Typ	Description
name	string	Název licence použitý pro rozhraní API
url	string	Adresa URL licence použité pro rozhraní API. MUSÍ být ve formátu adresy URL.

ApiType

Typ rozhraní API

Name	Typ	Description
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

Sada verzí rozhraní API obsahuje běžnou konfiguraci pro sadu verzí rozhraní API, které se týkají.

Name	Typ	Description
description	string	Popis sady verzí rozhraní API
id	string	Identifikátor existující sady verzí rozhraní API. Pokud chcete vytvořit novou sadu verzí, tuto hodnotu vynecháte.
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 funkce VersioningScheme nastavená na headerhodnotu .
versionQueryName	string	Název parametru dotazu, který označuje verzi rozhraní API, pokud je parametr versioningScheme nastavený na queryhodnotu .
versioningScheme	versioningScheme	Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API.

AuthenticationSettingsContract

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

Name	Typ	Description
oAuth2	OAuth2AuthenticationSettingsContract	Nastavení ověřování OAuth2
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Kolekce nastavení ověřování OAuth2, která jsou součástí tohoto rozhraní API.
openid	OpenIdAuthenticationSettingsContract	Nastavení ověřování OpenID Connect
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Kolekce nastavení ověřování Open ID Connect, která jsou součástí tohoto rozhraní API.

bearerTokenSendingMethods

Postup odeslání tokenu na server

Name	Typ	Description
authorizationHeader	string	Přístupový token se bude přenášet v autorizační hlavičce pomocí nosného schématu.
query	string	Přístupový token se bude přenášet jako parametry dotazu.

ErrorFieldContract

Chyba Kontrakt pole.

Name	Typ	Description
code	string	Kód chyby na úrovni vlastnosti.
message	string	Čitelné znázornění chyby na úrovni vlastností.
target	string	Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name	Typ	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	ErrorFieldContract[]	Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message	string	Znázornění chyby čitelné pro člověka

OAuth2AuthenticationSettingsContract

Podrobnosti o nastavení ověřování api OAuth2

Name	Typ	Description
authorizationServerId	string	Identifikátor autorizačního serveru OAuth.
scope	string	rozsah operací.

OpenIdAuthenticationSettingsContract

Podrobnosti o nastavení ověřování api OAuth2

Name	Typ	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Postup odeslání tokenu na server
openidProviderId	string	Identifikátor autorizačního serveru OAuth.

Protocol

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

Name	Typ	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

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

Name	Typ	Description
header	string	Název hlavičky klíče předplatného.
query	string	Název parametru řetězce dotazu s klíčem předplatného.

versioningScheme

Hodnota, která určuje, kde se bude v požadavku HTTP nacházet identifikátor verze rozhraní API.

Name	Typ	Description
Header	string	Verze rozhraní API se předává v hlavičce HTTP.
Query	string	Verze rozhraní API se předává v parametru dotazu.
Segment	string	Verze rozhraní API se předává v segmentu cesty.