Tag Resource - List By Service

Service:

API Management

API Version:

2022-08-01

タグに関連付けられているリソースのコレクションを一覧表示します。

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

With optional parameters:

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

URI パラメーター

名前	/	必須	型	説明
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。
$filter	query		string	|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |-------------|-------------|-------------|-------------| |aid |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |displayName |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |apiName |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |apiRevision |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |path |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 | |メソッド |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |urlTemplate |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 | | |isCurrent |filter |eq | |
$skip	query		integer int32	スキップするレコードの数。
$top	query		integer int32	返されるレコードの数。

応答

名前	型	説明
200 OK	TagResourceCollection	TagResource エンティティのコレクションを一覧表示します。
Other Status Codes	ErrorResponse	操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ApiManagementListTagResources

Sample Request

HTTP

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

Java

/** Samples for TagResource ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTagResources.json
     */
    /**
     * Sample code: ApiManagementListTagResources.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementListTagResources(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.tagResources().listByService("rg1", "apimService1", 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_tag_resources.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_resource.list_by_service(
        resource_group_name="rg1",
        service_name="apimService1",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTagResources.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/ApiManagementListTagResources.json
func ExampleTagResourceClient_NewListByServicePager() {
	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.NewTagResourceClient().NewListByServicePager("rg1", "apimService1", &armapimanagement.TagResourceClientListByServiceOptions{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.TagResourceCollection = armapimanagement.TagResourceCollection{
		// 	Value: []*armapimanagement.TagResourceContract{
		// 		{
		// 			Operation: &armapimanagement.OperationTagResourceContractProperties{
		// 				Name: to.Ptr("Create resource"),
		// 				Method: to.Ptr("POST"),
		// 				Description: to.Ptr("A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."),
		// 				APIName: to.Ptr("Echo API"),
		// 				APIRevision: to.Ptr("1"),
		// 				ID: to.Ptr("/apis/echo-api/operations/create-resource"),
		// 				URLTemplate: to.Ptr("/resource"),
		// 			},
		// 			Tag: &armapimanagement.TagResourceContractProperties{
		// 				Name: to.Ptr("awesomeTag"),
		// 				ID: to.Ptr("/tags/apitag123"),
		// 			},
		// 		},
		// 		{
		// 			API: &armapimanagement.APITagResourceContractProperties{
		// 				APIRevision: to.Ptr("1"),
		// 				IsCurrent: to.Ptr(true),
		// 				Name: to.Ptr("Echo API"),
		// 				Path: to.Ptr("echo"),
		// 				ID: to.Ptr("/apis/echo-api"),
		// 				ServiceURL: to.Ptr("http://echoapi.cloudapp.net/api"),
		// 			},
		// 			Tag: &armapimanagement.TagResourceContractProperties{
		// 				Name: to.Ptr("awesomeTag"),
		// 				ID: to.Ptr("/tags/apitag123"),
		// 			},
		// 		},
		// 		{
		// 			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");

/**
 * This sample demonstrates how to Lists a collection of resources associated with tags.
 *
 * @summary Lists a collection of resources associated with tags.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListTagResources.json
 */
async function apiManagementListTagResources() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  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 (let item of client.tagResource.listByService(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

Sample Response

Status code:

200

{
  "value": [
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "operation": {
        "id": "/apis/echo-api/operations/create-resource",
        "apiName": "Echo API",
        "apiRevision": "1",
        "name": "Create resource",
        "method": "POST",
        "urlTemplate": "/resource",
        "description": "A demonstration of a POST call based on the echo backend above. The request body is expected to contain JSON-formatted data (see example below). A policy is used to automatically transform any request sent in JSON directly to XML. In a real-world scenario this could be used to enable modern clients to speak to a legacy backend."
      }
    },
    {
      "tag": {
        "id": "/tags/apitag123",
        "name": "awesomeTag"
      },
      "api": {
        "id": "/apis/echo-api",
        "name": "Echo API",
        "apiRevision": "1",
        "serviceUrl": "http://echoapi.cloudapp.net/api",
        "path": "echo",
        "isCurrent": true
      }
    },
    {
      "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"
      }
    }
  ]
}

定義

名前	説明
ApiContactInformation	API の連絡先情報
ApiLicenseInformation	API ライセンス情報
ApiTagResourceContractProperties	タグ リソースの API コントラクト プロパティ。
ApiType	API の種類。
AuthenticationSettingsContract	API 認証の設定。
bearerTokenSendingMethods	サーバーにトークンを送信する方法。
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
OAuth2AuthenticationSettingsContract	API OAuth2 認証設定の詳細。
OpenIdAuthenticationSettingsContract	API OAuth2 認証設定の詳細。
OperationTagResourceContractProperties	操作エンティティ コントラクトのプロパティ。
ProductState	製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。
ProductTagResourceContractProperties	製品プロファイル。
Protocol	この API の操作を呼び出すことができるプロトコルを記述します。
SubscriptionKeyParameterNamesContract	サブスクリプション キー パラメーター名の詳細。
TagResourceCollection	ページ タグリスト表現。
TagResourceContract	TagResource コントラクトプロパティ。
TagTagResourceContractProperties	タグ リソース コントラクトの Tag プロパティを定義するコントラクト

ApiContactInformation

API の連絡先情報

名前	型	説明
email	string	連絡先/organizationのメール アドレス。 電子メール アドレスの形式にする必要があります
name	string	連絡先/organizationの識別名
url	string	連絡先情報を指す URL。 URL の形式にする必要があります

ApiLicenseInformation

API ライセンス情報

名前	型	説明
name	string	API に使用されるライセンス名
url	string	API に使用されるライセンスの URL。 URL の形式にする必要があります

ApiTagResourceContractProperties

タグ リソースの API コントラクト プロパティ。

名前	型	説明
apiRevision	string	API のリビジョンについて説明します。 値が指定されていない場合は、既定のリビジョン 1 が作成されます
apiRevisionDescription	string	API リビジョンの説明。
apiVersion	string	API がバージョン管理されている場合に API のバージョン識別子を示します
apiVersionDescription	string	API バージョンの説明。
apiVersionSetId	string	関連する ApiVersionSet のリソース識別子。
authenticationSettings	AuthenticationSettingsContract	この API に含まれる認証設定のコレクション。
contact	ApiContactInformation	API の連絡先情報。
description	string	API の説明。 HTML 書式設定タグを含めることができます。
id	string	/apis/{apiId} という形式の API 識別子。
isCurrent	boolean	API リビジョンが現在の API リビジョンであるかどうかを示します。
isOnline	boolean	API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。
license	ApiLicenseInformation	API のライセンス情報。
name	string	API 名。
path	string	API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
protocols	Protocol[]	この API の操作を呼び出すことができるプロトコルを記述します。
serviceUrl	string	この API を実装するバックエンド サービスの絶対 URL。
subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API を使用できるようにするプロトコル。
subscriptionRequired	boolean	API にアクセスするために API サブスクリプションと Product サブスクリプションのどちらを必要とするかを指定します。
termsOfServiceUrl	string	API の利用規約への URL。 URL の形式にする必要があります。
type	ApiType	API の種類。

ApiType

API の種類。

名前	型	説明
graphql	string
http	string
soap	string
websocket	string

AuthenticationSettingsContract

API 認証の設定。

名前	型	説明
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 認証設定
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	この API に含まれる OAuth2 認証設定のコレクション。
openid	OpenIdAuthenticationSettingsContract	OpenID Connect 認証設定
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	この API に含まれる Open ID Connect 認証設定のコレクション。

bearerTokenSendingMethods

サーバーにトークンを送信する方法。

名前	型	説明
authorizationHeader	string	アクセス トークンは、Bearer スキーマを使用して Authorization ヘッダーで送信されます
query	string	アクセス トークンはクエリ パラメーターとして送信されます。

ErrorFieldContract

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前	型	説明
authorizationServerId	string	OAuth 承認サーバーの識別子。
scope	string	操作スコープ。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前	型	説明
bearerTokenSendingMethods	bearerTokenSendingMethods[]	サーバーにトークンを送信する方法。
openidProviderId	string	OAuth 承認サーバーの識別子。

OperationTagResourceContractProperties

操作エンティティ コントラクトのプロパティ。

名前	型	説明
apiName	string	API 名。
apiRevision	string	API リビジョン。
apiVersion	string	API バージョン。
description	string	操作の説明。
id	string	/operations/{operationId} 形式の操作の識別子。
method	string	有効な HTTP 操作メソッド。 GET、PUT、POST などの一般的な Http メソッドですが、それらに限定されません。
name	string	操作の名前。
urlTemplate	string	この操作のターゲット リソースを識別する相対 URL テンプレート。 パラメーターを含めることができます。 例: /customers/{cid}/orders/{oid}/?date={date}

ProductState

製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。

名前	型	説明
notPublished	string
published	string

ProductTagResourceContractProperties

製品プロファイル。

名前	型	説明
approvalRequired	boolean	サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、開発者はサブスクライブ直後に製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
description	string	製品の説明。 HTML 書式設定タグを含めることができます。
id	string	/products/{productId} の形式の製品の識別子
name	string	製品名。
state	ProductState	製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。
subscriptionRequired	boolean	この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "protected" と呼ばれ、製品に含まれる API への要求が成功するには有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときにプロパティを省略すると、値は true と見なされます。
subscriptionsLimit	integer	ユーザーがこの製品に対して同時に持ち込むことができるサブスクリプションの数かどうか。 ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。
terms	string	製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。

Protocol

この API の操作を呼び出すことができるプロトコルを記述します。

名前	型	説明
http	string
https	string
ws	string
wss	string

SubscriptionKeyParameterNamesContract

サブスクリプション キー パラメーター名の詳細。

名前	型	説明
header	string	サブスクリプション キーヘッダー名。
query	string	サブスクリプション キークエリ文字列パラメーター名。

TagResourceCollection

ページ タグリスト表現。

名前	型	説明
count	integer	すべてのページの合計レコード数。
nextLink	string	次のページリンク (存在する場合)。
value	TagResourceContract[]	ページ値。

TagResourceContract

TagResource コントラクトプロパティ。

名前	型	説明
api	ApiTagResourceContractProperties	タグに関連付けられている API。
operation	OperationTagResourceContractProperties	タグに関連付けられている操作。
product	ProductTagResourceContractProperties	タグに関連付けられている製品。
tag	TagTagResourceContractProperties	リソースに関連付けられているタグ。

TagTagResourceContractProperties

タグ リソース コントラクトの Tag プロパティを定義するコントラクト

名前	型	説明
id	string	タグ識別子
name	string	タグ名