ProductTag - List By Product

Service:

API Management

API Version:

2022-08-01

Elenca tutti i tag associati al prodotto.

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

With optional parameters:

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
productId	path	True	string	Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName	path	True	string	Nome del servizio di Gestione API. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.
$filter	query		string	| Campo | Utilizzo | Operatori supportati | Funzioni supportate | |-------------|-------------|-------------|-------------| | displayName | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | name | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip	query		integer int32	Numero di record da ignorare.
$top	query		integer int32	Numero di record da restituire.

Risposte

Nome	Tipo	Descrizione
200 OK	TagCollection	L'operazione restituisce una raccolta di tag associati all'entità Product.
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementListProductTags

Sample Request

HTTP

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

Java

/** Samples for Tag ListByProduct. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductTags.json
     */
    /**
     * Sample code: ApiManagementListProductTags.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListProductTags(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .tags()
            .listByProduct(
                "rg1", "apimService1", "57d2ef278aa04f0888cba3f1", 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_tags.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.tag.list_by_product(
        resource_group_name="rg1",
        service_name="apimService1",
        product_id="57d2ef278aa04f0888cba3f1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductTags.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/ApiManagementListProductTags.json
func ExampleTagClient_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.NewTagClient().NewListByProductPager("rg1", "apimService1", "57d2ef278aa04f0888cba3f1", &armapimanagement.TagClientListByProductOptions{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.TagCollection = armapimanagement.TagCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.TagContract{
		// 		{
		// 			Name: to.Ptr("5600b539c53f5b0062060002"),
		// 			Type: to.Ptr("Microsoft.ApiManagement/service/tags"),
		// 			ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002"),
		// 			Properties: &armapimanagement.TagContractProperties{
		// 				DisplayName: to.Ptr("tag1"),
		// 			},
		// 	}},
		// }
	}
}

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 all Tags associated with the Product.
 *
 * @summary Lists all Tags associated with the Product.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListProductTags.json
 */
async function apiManagementListProductTags() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const productId = "57d2ef278aa04f0888cba3f1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.tag.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/tags/5600b539c53f5b0062060002",
      "type": "Microsoft.ApiManagement/service/tags",
      "name": "5600b539c53f5b0062060002",
      "properties": {
        "displayName": "tag1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definizioni

Nome	Descrizione
ErrorFieldContract	Contratto campo di errore.
ErrorResponse	Risposta errore.
TagCollection	Rappresentazione dell'elenco di tag di paging.
TagContract	Dettagli contratto tag.

ErrorFieldContract

Contratto campo di errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

TagCollection

Rappresentazione dell'elenco di tag di paging.

Nome	Tipo	Descrizione
count	integer	Numero totale di conteggio record in tutte le pagine.
nextLink	string	Collegamento alla pagina successiva, se disponibile.
value	TagContract[]	Valori di pagina.

TagContract

Dettagli contratto tag.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.displayName	string	Nome tag.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"