Product - Get

Service:

API Management

API Version:

2022-08-01

Ruft die Details des Produkts ab, das durch seinen Bezeichner angegeben wird.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
productId	path	True	string	Produktbezeichner. Muss im aktuellen API Management Dienst instance eindeutig sein.
resourceGroupName	path	True	string	Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string	Der Name des API Management-Diensts. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Hierbei handelt es sich um die ID des Zielabonnements.
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name	Typ	Beschreibung
200 OK	ProductContract	Der Antworttext enthält die angegebene Product-Entität. Headers ETag: string
Other Status Codes	ErrorResponse	Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name	Beschreibung
user_impersonation	Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementGetProduct

Sample Request

HTTP

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

Java

/** Samples for Product Get. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetProduct.json
     */
    /**
     * Sample code: ApiManagementGetProduct.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementGetProduct(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.products().getWithResponse("rg1", "apimService1", "unlimited", 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_get_product.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.get(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="unlimited",
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetProduct.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/ApiManagementGetProduct.json
func ExampleProductClient_Get() {
	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)
	}
	res, err := clientFactory.NewProductClient().Get(ctx, "rg1", "apimService1", "unlimited", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.ProductContract = armapimanagement.ProductContract{
	// 	Name: to.Ptr("unlimited"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/products"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited"),
	// 	Properties: &armapimanagement.ProductContractProperties{
	// 		Description: to.Ptr("Subscribers have completely unlimited access to the API. Administrator approval is required."),
	// 		ApprovalRequired: to.Ptr(true),
	// 		State: to.Ptr(armapimanagement.ProductStatePublished),
	// 		SubscriptionRequired: to.Ptr(true),
	// 		SubscriptionsLimit: to.Ptr[int32](1),
	// 		DisplayName: to.Ptr("Unlimited"),
	// 	},
	// }
}

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 Gets the details of the product specified by its identifier.
 *
 * @summary Gets the details of the product specified by its identifier.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetProduct.json
 */
async function apiManagementGetProduct() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "unlimited";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.product.get(resourceGroupName, serviceName, productId);
  console.log(result);
}

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

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/unlimited",
  "type": "Microsoft.ApiManagement/service/products",
  "name": "unlimited",
  "properties": {
    "displayName": "Unlimited",
    "description": "Subscribers have completely unlimited access to the API. Administrator approval is required.",
    "subscriptionRequired": true,
    "approvalRequired": true,
    "subscriptionsLimit": 1,
    "state": "published"
  }
}

Definitionen

Name	Beschreibung
ErrorFieldContract	Fehlerfeldvertrag.
ErrorResponse	Fehlerantwort.
ProductContract	Produktdetails.
ProductState	ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals gefunden werden. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht.

ErrorFieldContract

Fehlerfeldvertrag.

Name	Typ	Beschreibung
code	string	Fehlercode auf Eigenschaftsebene.
message	string	Für Menschen lesbare Darstellung eines Fehlers auf Eigenschaftsebene.
target	string	Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name	Typ	Beschreibung
error.code	string	Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.
error.details	ErrorFieldContract[]	Die Liste der ungültigen Felder, die im Falle eines Überprüfungsfehlers gesendet werden.
error.message	string	Lesbare Darstellung des Fehlers.

ProductContract

Produktdetails.

Name	Typ	Beschreibung
id	string	Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Der Name der Ressource
properties.approvalRequired	boolean	gibt an, ob die Abonnementgenehmigung erforderlich ist. Wenn false, werden neue Abonnements automatisch genehmigt, sodass Entwickler die APIs des Produkts sofort nach dem Abonnement aufrufen können. Wenn true, müssen Administratoren das Abonnement manuell genehmigen, bevor der Entwickler eine der APIs des Produkts verwenden kann. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist.
properties.description	string	Produktbeschreibung. Kann HTML-Formatierungstags umfassen.
properties.displayName	string	Produktname
properties.state	ProductState	ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals gefunden werden. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht.
properties.subscriptionRequired	boolean	Gibt an, ob ein Produktabonnement für den Zugriff auf in diesem Produkt enthaltene APIs erforderlich ist. Wenn true, wird das Produkt als "geschützt" bezeichnet, und ein gültiger Abonnementschlüssel ist erforderlich, damit eine Anforderung an eine im Produkt enthaltene API erfolgreich ist. Wenn false, wird das Produkt als "offen" bezeichnet, und Anforderungen an eine im Produkt enthaltene API können ohne Abonnementschlüssel gestellt werden. Wenn die Eigenschaft beim Erstellen eines neuen Produkts ausgelassen wird, wird davon ausgegangen, dass der Wert true ist.
properties.subscriptionsLimit	integer	Gibt an, wie viele Abonnements ein Benutzer für dieses Produkt gleichzeitig haben kann. Legen Sie auf NULL fest oder lassen Sie aus, um unbegrenzte Anzahl pro Benutzerabonnement zuzulassen. Kann nur vorhanden sein, wenn die subscriptionRequired-Eigenschaft vorhanden ist und den Wert false aufweist.
properties.terms	string	Nutzungsbedingungen für das Produkt. Diese Bedingungen werden Entwicklern angezeigt, die das Produkt abonnieren möchten. Sie müssen die Bedingungen akzeptieren, um den Abonnementvorgang abschließen zu können.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

ProductState

ob das Produkt veröffentlicht wird oder nicht. Veröffentlichte Produkte können von Benutzern des Entwicklerportals gefunden werden. Nicht veröffentlichte Produkte sind nur für Administratoren sichtbar. Der Standardstatus des Produkts ist nichtVeröffentlicht.

Name	Typ	Beschreibung
notPublished	string
published	string