TagProduct - List By Tags

Service:

API Management

API Version:

2024-05-01

Lists a collection of products associated with tags.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags?api-version=2024-05-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/productsByTags?$filter={$filter}&$top={$top}&$skip={$skip}&includeNotTaggedProducts={includeNotTaggedProducts}&api-version=2024-05-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	The name of the API Management service.
subscriptionId	path	True	string (uuid)	The ID of the target subscription. The value must be an UUID.
api-version	query	True	string minLength: 1	The API version to use for this operation.
$filter	query		string	| Field | Usage | Supported operators | Supported functions | |-------------|-------------|-------------|-------------| | name | 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 | | terms | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | filter | eq | substringof, contains, startswith, endswith |
$skip	query		integer (int32) minimum: 0	Number of records to skip.
$top	query		integer (int32) minimum: 1	Number of records to return.
includeNotTaggedProducts	query		boolean	Include not tagged Products.

Responses

Name	Type	Description
200 OK	TagResourceCollection	Lists a collection of TagResource entities.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

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	impersonate your user account

Examples

ApiManagementListProductsByTags

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/productsByTags?api-version=2024-05-01

Java

/**
 * Samples for Product ListByTags.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementListProductsByTags.json
     */
    /**
     * Sample code: ApiManagementListProductsByTags.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementListProductsByTags(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.products().listByTags("rg1", "apimService1", null, 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_products_by_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="00000000-0000-0000-0000-000000000000",
    )

    response = client.product.list_by_tags(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListProductsByTags.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/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListProductsByTags.json
func ExampleProductClient_NewListByTagsPager() {
	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.NewProductClient().NewListByTagsPager("rg1", "apimService1", &armapimanagement.ProductClientListByTagsOptions{Filter: nil,
		Top:                      nil,
		Skip:                     nil,
		IncludeNotTaggedProducts: 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.TagResourceCollection = armapimanagement.TagResourceCollection{
		// 	Count: to.Ptr[int64](1),
		// 	Value: []*armapimanagement.TagResourceContract{
		// 		{
		// 			Product: &armapimanagement.ProductTagResourceContractProperties{
		// 				Description: to.Ptr("Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week."),
		// 				ApprovalRequired: to.Ptr(false),
		// 				State: to.Ptr(armapimanagement.ProductStatePublished),
		// 				SubscriptionRequired: to.Ptr(true),
		// 				SubscriptionsLimit: to.Ptr[int32](1),
		// 				Terms: to.Ptr(""),
		// 				Name: to.Ptr("Starter"),
		// 				ID: to.Ptr("/products/starter"),
		// 			},
		// 			Tag: &armapimanagement.TagResourceContractProperties{
		// 				Name: to.Ptr("awesomeTag"),
		// 				ID: to.Ptr("/tags/apitag123"),
		// 			},
		// 	}},
		// }
	}
}

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");
require("dotenv/config");

/**
 * This sample demonstrates how to Lists a collection of products associated with tags.
 *
 * @summary Lists a collection of products associated with tags.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListProductsByTags.json
 */
async function apiManagementListProductsByTags() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.product.listByTags(resourceGroupName, serviceName)) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementListProductsByTags.json
// this example is just showing the usage of "Product_ListByTags" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// invoke the operation and iterate over the result
await foreach (TagResourceContractDetails item in apiManagementService.GetProductsByTagsAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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": [
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "product": {
        "id": "/products/starter",
        "name": "Starter",
        "description": "Subscribers will be able to run 5 calls/minute up to a maximum of 100 calls/week.",
        "terms": "",
        "subscriptionRequired": true,
        "approvalRequired": false,
        "subscriptionsLimit": 1,
        "state": "published"
      }
    }
  ],
  "count": 1
}

Definitions

Name	Description
ApiContactInformation	API contact information
ApiLicenseInformation	API license information
ApiTagResourceContractProperties	API contract properties for the Tag Resources.
ApiType	Type of API.
AuthenticationSettingsContract	API Authentication Settings.
bearerTokenSendingMethods	How to send token to the server.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
OAuth2AuthenticationSettingsContract	API OAuth2 Authentication settings details.
OpenIdAuthenticationSettingsContract	API OAuth2 Authentication settings details.
OperationTagResourceContractProperties	Operation Entity contract Properties.
ProductState	whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
ProductTagResourceContractProperties	Product profile.
Protocol	Describes on which protocols the operations in this API can be invoked.
SubscriptionKeyParameterNamesContract	Subscription key parameter names details.
TagResourceCollection	Paged Tag list representation.
TagResourceContract	TagResource contract properties.
TagTagResourceContractProperties	Contract defining the Tag property in the Tag Resource Contract

ApiContactInformation

Object

API contact information

Name	Type	Description
email	string	The email address of the contact person/organization. MUST be in the format of an email address
name	string	The identifying name of the contact person/organization
url	string	The URL pointing to the contact information. MUST be in the format of a URL

ApiLicenseInformation

Object

API license information

Name	Type	Description
name	string	The license name used for the API
url	string	A URL to the license used for the API. MUST be in the format of a URL

ApiTagResourceContractProperties

Object

API contract properties for the Tag Resources.

Name	Type	Description
apiRevision	string minLength: 1 maxLength: 100	Describes the revision of the API. If no value is provided, default revision 1 is created
apiRevisionDescription	string maxLength: 256	Description of the API Revision.
apiVersion	string maxLength: 100	Indicates the version identifier of the API if the API is versioned
apiVersionDescription	string maxLength: 256	Description of the API Version.
apiVersionSetId	string	A resource identifier for the related ApiVersionSet.
authenticationSettings	AuthenticationSettingsContract	Collection of authentication settings included into this API.
contact	ApiContactInformation	Contact information for the API.
description	string	Description of the API. May include HTML formatting tags.
id	string	API identifier in the form /apis/{apiId}.
isCurrent	boolean	Indicates if API revision is current api revision.
isOnline	boolean	Indicates if API revision is accessible via the gateway.
license	ApiLicenseInformation	License information for the API.
name	string minLength: 1 maxLength: 300	API name.
path	string minLength: 0 maxLength: 400	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
protocols	Protocol[]	Describes on which protocols the operations in this API can be invoked.
serviceUrl	string minLength: 1 maxLength: 2000	Absolute URL of the backend service implementing this API.
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	Protocols over which API is made available.
subscriptionRequired	boolean	Specifies whether an API or Product subscription is required for accessing the API.
termsOfServiceUrl	string	A URL to the Terms of Service for the API. MUST be in the format of a URL.
type	ApiType	Type of API.

ApiType

Enumeration

Type of API.

Value	Description
http
soap
websocket
graphql
odata
grpc

AuthenticationSettingsContract

Object

API Authentication Settings.

Name	Type	Description
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 Authentication settings
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	Collection of OAuth2 authentication settings included into this API.
openid	OpenIdAuthenticationSettingsContract	OpenID Connect Authentication Settings
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	Collection of Open ID Connect authentication settings included into this API.

bearerTokenSendingMethods

Enumeration

How to send token to the server.

Value	Description
authorizationHeader	Access token will be transmitted in the Authorization header using Bearer schema
query	Access token will be transmitted as query parameters.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

OAuth2AuthenticationSettingsContract

Object

API OAuth2 Authentication settings details.

Name	Type	Description
authorizationServerId	string	OAuth authorization server identifier.
scope	string	operations scope.

OpenIdAuthenticationSettingsContract

Object

API OAuth2 Authentication settings details.

Name	Type	Description
bearerTokenSendingMethods	bearerTokenSendingMethods[]	How to send token to the server.
openidProviderId	string	OAuth authorization server identifier.

OperationTagResourceContractProperties

Object

Operation Entity contract Properties.

Name	Type	Description
apiName	string	API Name.
apiRevision	string	API Revision.
apiVersion	string	API Version.
description	string	Operation Description.
id	string	Identifier of the operation in form /operations/{operationId}.
method	string	A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.
name	string	Operation name.
urlTemplate	string	Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}

ProductState

Enumeration

whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.

Value	Description
notPublished
published

ProductTagResourceContractProperties

Object

Product profile.

Name	Type	Description
approvalRequired	boolean	whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of false.
description	string minLength: 0 maxLength: 1000	Product description. May include HTML formatting tags.
id	string	Identifier of the product in the form of /products/{productId}
name	string minLength: 1 maxLength: 300	Product name.
state	ProductState	whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is notPublished.
subscriptionRequired	boolean	Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true.
subscriptionsLimit	integer (int32)	Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of false.
terms	string	Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process.

Protocol

Enumeration

Describes on which protocols the operations in this API can be invoked.

Value	Description
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

Subscription key parameter names details.

Name	Type	Description
header	string	Subscription key header name.
query	string	Subscription key query string parameter name.

TagResourceCollection

Object

Paged Tag list representation.

Name	Type	Description
count	integer (int64)	Total record count number across all pages.
nextLink	string	Next page link if any.
value	TagResourceContract[]	Page values.

TagResourceContract

Object

TagResource contract properties.

Name	Type	Description
api	ApiTagResourceContractProperties	API associated with the tag.
operation	OperationTagResourceContractProperties	Operation associated with the tag.
product	ProductTagResourceContractProperties	Product associated with the tag.
tag	TagTagResourceContractProperties	Tag associated with the resource.

TagTagResourceContractProperties

Object

Contract defining the Tag property in the Tag Resource Contract

Name	Type	Description
id	string	Tag identifier
name	string minLength: 1 maxLength: 160	Tag Name