Api - List By Tags
タグに関連付けられている API のコレクションを一覧表示します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags?$filter={$filter}&$top={$top}&$skip={$skip}&includeNotTaggedApis={includeNotTaggedApis}&api-version=2022-08-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
resource
|
path | True |
string |
リソース グループの名前。 名前の大文字と小文字は区別されます。 |
service
|
path | True |
string |
API Management サービスの名前。 Regex pattern: |
subscription
|
path | True |
string |
ターゲット サブスクリプションの ID。 |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
$filter
|
query |
string |
|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |
|
$skip
|
query |
integer int32 |
スキップするレコードの数。 |
|
$top
|
query |
integer int32 |
返されるレコードの数。 |
|
include
|
query |
boolean |
タグ付けされていない API を含めます。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
TagResource エンティティのコレクションを一覧表示します。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
ApiManagementListApisByTags
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apisByTags?api-version=2022-08-01
Sample Response
{
"value": [
{
"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
}
}
],
"count": 1
}
定義
名前 | 説明 |
---|---|
Api |
API の連絡先情報 |
Api |
API ライセンス情報 |
Api |
タグ リソースの API コントラクト プロパティ。 |
Api |
API の種類。 |
Authentication |
API 認証の設定。 |
bearer |
サーバーにトークンを送信する方法。 |
Error |
エラー フィールド コントラクト。 |
Error |
エラー応答。 |
OAuth2Authentication |
API OAuth2 認証設定の詳細。 |
Open |
API OAuth2 認証設定の詳細。 |
Operation |
操作エンティティ コントラクトのプロパティ。 |
Product |
製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態はPublished ではありません。 |
Product |
製品プロファイル。 |
Protocol |
この API の操作を呼び出すことができるプロトコルを記述します。 |
Subscription |
サブスクリプション キー パラメーター名の詳細。 |
Tag |
ページ タグリスト表現。 |
Tag |
TagResource コントラクトプロパティ。 |
Tag |
タグ リソース コントラクトの Tag プロパティを定義するコントラクト |
ApiContactInformation
API の連絡先情報
名前 | 型 | 説明 |
---|---|---|
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 |
この API に含まれる認証設定のコレクション。 |
|
contact |
API の連絡先情報。 |
|
description |
string |
API の説明。 HTML 書式設定タグを含めることができます。 |
id |
string |
/apis/{apiId} という形式の API 識別子。 |
isCurrent |
boolean |
API リビジョンが現在の API リビジョンであるかどうかを示します。 |
isOnline |
boolean |
API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。 |
license |
API のライセンス情報。 |
|
name |
string |
API 名。 |
path |
string |
API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。 |
protocols |
Protocol[] |
この API の操作を呼び出すことができるプロトコルを記述します。 |
serviceUrl |
string |
この API を実装するバックエンド サービスの絶対 URL。 |
subscriptionKeyParameterNames |
API を使用できるようにするプロトコル。 |
|
subscriptionRequired |
boolean |
API にアクセスするために API サブスクリプションと Product サブスクリプションのどちらを必要とするかを指定します。 |
termsOfServiceUrl |
string |
API の利用規約への URL。 URL の形式にする必要があります。 |
type |
API の種類。 |
ApiType
API の種類。
名前 | 型 | 説明 |
---|---|---|
graphql |
string |
|
http |
string |
|
soap |
string |
|
websocket |
string |
AuthenticationSettingsContract
API 認証の設定。
名前 | 型 | 説明 |
---|---|---|
oAuth2 |
OAuth2 認証設定 |
|
oAuth2AuthenticationSettings |
この API に含まれる OAuth2 認証設定のコレクション。 |
|
openid |
OpenID Connect 認証設定 |
|
openidAuthenticationSettings |
この 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 |
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。 |
|
error.message |
string |
人が判読できるエラーの表現。 |
OAuth2AuthenticationSettingsContract
API OAuth2 認証設定の詳細。
名前 | 型 | 説明 |
---|---|---|
authorizationServerId |
string |
OAuth 承認サーバーの識別子。 |
scope |
string |
操作スコープ。 |
OpenIdAuthenticationSettingsContract
API OAuth2 認証設定の詳細。
名前 | 型 | 説明 |
---|---|---|
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 |
製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 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
TagResource コントラクトプロパティ。
名前 | 型 | 説明 |
---|---|---|
api |
タグに関連付けられている API。 |
|
operation |
タグに関連付けられている操作。 |
|
product |
タグに関連付けられている製品。 |
|
tag |
リソースに関連付けられているタグ。 |
TagTagResourceContractProperties
タグ リソース コントラクトの Tag プロパティを定義するコントラクト
名前 | 型 | 説明 |
---|---|---|
id |
string |
タグ識別子 |
name |
string |
タグ名 |