Product Api - List By Product

Referens

Service:: API Management

API Version:: 2022-08-01

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=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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
productId	path	True	string	Produktidentifierare. Måste vara unikt i den aktuella API Management tjänstinstansen.
resourceGroupName	path	True	string	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
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	ID för målprenumerationen.
api-version	query	True	string	Den API-version som ska användas för den här åtgärden.
$filter	query		string	\| Fält \| Användning \| Operatorer som stöds \| Funktioner som stöds \| \|-------------\|-------------\|-------------\|-------------\| \| namn \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| displayName \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| description \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| serviceUrl \| filter \| ge, le, eq, ne, gt, lt \| substringof, contains, startswith, endswith \| \| sökväg \| filter \| 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	Typ	Description
200 OK	ApiCollection	Svarstexten innehåller en samling API-entiteter i produkten.
Other Status Codes	ErrorResponse	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=2022-08-01

/** 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

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

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

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

Definitioner

Name	Description
ApiCollection	Växlings-API-listrepresentation.
ApiContactInformation	API-kontaktinformation
ApiContract	API-information.
ApiLicenseInformation	API-licensinformation
ApiType	Typ av API.
ApiVersionSetContractDetails	En API-versionsuppsättning innehåller den gemensamma konfigurationen för en uppsättning API-versioner som relaterar
AuthenticationSettingsContract	Inställningar för API-autentisering.
bearerTokenSendingMethods	Skicka token till servern.
ErrorFieldContract	Fel fältkontrakt.
ErrorResponse	Felsvar.
OAuth2AuthenticationSettingsContract	Information om API OAuth2-autentiseringsinställningar.
OpenIdAuthenticationSettingsContract	Information om API OAuth2-autentiseringsinställningar.
Protocol	Beskriver vilka protokoll som åtgärderna i det här API:et kan anropas för.
SubscriptionKeyParameterNamesContract	Information om parameternamn för prenumerationsnyckel.
versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

ApiCollection

Växlings-API-listrepresentation.

Name	Typ	Description
count	integer	Totalt antal poster på alla sidor.
nextLink	string	Länk till nästa sida om det finns någon.
value	ApiContract[]	Sidvärden.

ApiContactInformation

API-kontaktinformation

Name	Typ	Description
email	string	Kontaktpersonens/organisationens e-postadress. MÅSTE vara i formatet för en e-postadress
name	string	Kontaktpersonens/organisationens identifieringsnamn
url	string	URL:en som pekar på kontaktinformationen. MÅSTE vara i formatet för en URL

ApiContract

API-information.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Exempel – /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-revisionen.
properties.apiVersion	string	Anger versionsidentifieraren för API:et om API:et är versionshanterat
properties.apiVersionDescription	string	Beskrivning av API-versionen.
properties.apiVersionSet	ApiVersionSetContractDetails	Information om versionsuppsättning
properties.apiVersionSetId	string	En resursidentifierare för den relaterade ApiVersionSet.
properties.authenticationSettings	AuthenticationSettingsContract	Samling autentiseringsinställningar som ingår i det här API:et.
properties.contact	ApiContactInformation	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-revisionen är aktuell API-revision.
properties.isOnline	boolean	Anger om API-revisionen är tillgänglig via gatewayen.
properties.license	ApiLicenseInformation	Licensinformation för API:et.
properties.path	string	Relativ URL som unikt identifierar det här API:et och alla dess resurssökvägar i 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	Protocol[]	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	SubscriptionKeyParameterNamesContract	Protokoll som API:et görs tillgängligt för.
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ändningsvillkoren för API:et. MÅSTE vara i formatet för en URL.
properties.type	ApiType	Typ av API.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

API-licensinformation

Name	Typ	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	Typ	Description
graphql	string
http	string
soap	string
websocket	string

ApiVersionSetContractDetails

En API-versionsuppsättning innehåller den gemensamma konfigurationen för en uppsättning API-versioner som relaterar

Name	Typ	Description
description	string	Beskrivning av API-versionsuppsättning.
id	string	Identifierare för befintlig API-versionsuppsättning. Utelämna det här värdet om du vill skapa en ny versionsuppsättning.
name	string	Visningsnamn för API-versionsuppsättningen.
versionHeaderName	string	Namnet på HTTP-huvudparametern som anger API-versionen om versioningScheme har angetts till `header`.
versionQueryName	string	Namnet på frågeparametern som anger API-versionen om versioningScheme är inställt på `query`.
versioningScheme	versioningScheme	Ett värde som avgör var API-versionsidentifieraren ska finnas i en HTTP-begäran.

AuthenticationSettingsContract

Inställningar för API-autentisering.

Name	Typ	Description
oAuth2	OAuth2AuthenticationSettingsContract	Inställningar för OAuth2-autentisering
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Samling OAuth2-autentiseringsinställningar som ingår i det här API:et.
openid	OpenIdAuthenticationSettingsContract	Inställningar för OpenID Connect-autentisering
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Samling autentiseringsinställningar för Open ID Connect som ingår i det här API:et.

bearerTokenSendingMethods

Skicka token till servern.

Name	Typ	Description
authorizationHeader	string	Åtkomsttoken överförs i auktoriseringshuvudet med hjälp av ägarschemat
query	string	Åtkomsttoken överförs som frågeparametrar.

ErrorFieldContract

Fel fältkontrakt.

Name	Typ	Description
code	string	Felkod på egenskapsnivå.
message	string	Mänsklig läsbar representation av fel på egenskapsnivå.
target	string	Egenskapsnamn.

ErrorResponse

Felsvar.

Name	Typ	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	ErrorFieldContract[]	Listan över ogiltiga fält som skickas i begäran, vid valideringsfel.
error.message	string	Mänsklig läsbar representation av felet.

OAuth2AuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name	Typ	Description
authorizationServerId	string	OAuth-auktoriseringsserveridentifierare.
scope	string	omfång för åtgärder.

OpenIdAuthenticationSettingsContract

Information om API OAuth2-autentiseringsinställningar.

Name	Typ	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	Skicka token till servern.
openidProviderId	string	OAuth-auktoriseringsserveridentifierare.

Protocol

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

Name	Typ	Description
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

Information om parameternamn för prenumerationsnyckel.

Name	Typ	Description
header	string	Rubriknamn för prenumerationsnyckel.
query	string	Parameternamn för frågesträng för prenumerationsnyckel.

versioningScheme

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

Name	Typ	Description
Header	string	API-versionen skickas i ett HTTP-huvud.
Query	string	API-versionen skickas i en frågeparameter.
Segment	string	API-versionen skickas i ett sökvägssegment.

Product Api - List By Product

URI-parametrar

Svar

Säkerhet

azure_auth

Scopes

Exempel

ApiManagementListProductApis

Sample Request

Sample Response

Definitioner

ApiCollection

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorFieldContract

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

Ytterligare resurser