Api Tag Description - List By Service

API のスコープ内のすべてのタグの記述を一覧表示します。 スワッガーに似たモデル - タグ説明は API レベルで定義されていますが、タグはオペレーションに割り当てられる可能性があります

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions?api-version=2019-12-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2019-12-01

URI パラメーター

Name In Required Type Description
apiId
path True
  • string

API リビジョン識別子。 現在の API 管理サービス インスタンス内で一意である必要があります。 現在以外のリビジョンの場合、リビジョン番号を n にするサフィックスとして、;rev=n が付いています。

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True
  • string

リソース グループの名前。

serviceName
path True
  • string

API 管理サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Microsoft Azure サブスクリプションを一意に識別するサブスクリプション資格情報。 サブスクリプション ID は、全ての修理依頼についてURI の一部を生じさせます。

api-version
query True
  • string

クライアント要求で使用される API のバージョン。

$filter
query
  • string

| フィールド | 使用法 | サポートされている演算子 | サポートされている機能 |
|-------------|-------------|-------------|-------------|
|表示名 |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |
|名前 |フィルタ |ge, ル, eq, ネ, gt, lt |部分文字列、含む、で始まる、で終わる |

$skip
query
  • integer
int32

スキップするレコードの数。

$top
query
  • integer
int32

返されるレコードの数。

応答

Name Type Description
200 OK

この操作は、Api エンティティに関連付けられたタグ説明のコレクションを返します。

Other Status Codes

操作が失敗した理由を示すエラー応答です。

セキュリティ

azure_auth

Azure アクティブ ディレクトリ OAuth2 フロー。

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

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

ApiManagementListApiTagDescriptions

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/tagDescriptions?api-version=2019-12-01

Sample Response

{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tagDescriptions/5600b539c53f5b0062060002",
      "type": "Microsoft.ApiManagement/service/tags",
      "name": "5600b539c53f5b0062060002",
      "properties": {
        "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/5600b539c53f5b0062060002",
        "displayName": "tag1",
        "externalDocsDescription": "some additional info",
        "externalDocsUrl": "http://some_url.com"
      }
    }
  ],
  "nextLink": ""
}

定義

ErrorFieldContract

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

ErrorResponse

エラー応答。

TagDescriptionCollection

ページ付きタグ説明リスト表現。

TagDescriptionContract

契約の詳細。

ErrorFieldContract

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

Name Type Description
code
  • string

プロパティ レベルのエラー コード。

message
  • string

プロパティ レベルエラーの人間が判読できる表現。

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

検証エラーが発生した場合に、要求で送信される無効なフィールドのリスト。

error.message
  • string

エラーの人間が読み取り可能な表現。

TagDescriptionCollection

ページ付きタグ説明リスト表現。

Name Type Description
nextLink
  • string

次のページのリンクがある場合。

value

ページ値。

TagDescriptionContract

契約の詳細。

Name Type Description
id
  • string

リソースの ID

name
  • string

リソース名。

properties.description
  • string

タグの説明。

properties.displayName
  • string

タグ名。

properties.externalDocsDescription
  • string

タグを記述する外部リソースの説明。

properties.externalDocsUrl
  • string

タグを記述する外部リソースの絶対 URL。

properties.tagId
  • string

/タグ/{タグId} 形式のタグの識別子

type
  • string

API 管理リソースのリソースの種類。