Api Tag Description - Create Or Update

API のスコープ内のタグの記述を作成または更新します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}?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 の一部を生じさせます。

tagDescriptionId
path True
  • string

タグの説明の識別子。 API/タグの関連付けにタグ説明を作成するときに使用されます。 API 名とタグ名に基づいています。

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

api-version
query True
  • string

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

要求ヘッダー

Name Required Type Description
If-Match
  • string

エンティティの ETag。 エンティティの作成時には必須ではありませんが、エンティティを更新する場合は必須です。

要求本文

Name Type Description
properties.description
  • string

タグの説明。

properties.externalDocsDescription
  • string

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

properties.externalDocsUrl
  • string

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

応答

Name Type Description
200 OK

Api のタグの説明が更新されました。

Headers

  • ETag: string
201 Created

Api 用にタグの説明が作成されました。

Headers

  • ETag: string
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 ユーザー アカウントを偽装する

ApiManagementCreateApiTagDescription

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1?api-version=2019-12-01
{
  "properties": {
    "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    "externalDocsUrl": "http://some.url/additionaldoc",
    "externalDocsDescription": "Description of the external docs resource"
  }
}

Sample Response

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "name": "tagId1",
  "properties": {
    "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
    "displayName": "tag1",
    "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    "externalDocsDescription": "some additional info",
    "externalDocsUrl": "http://some_url.com"
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b/tagDescriptions/tagId1",
  "type": "Microsoft.ApiManagement/service/apis/tagDescriptions",
  "name": "tagId1",
  "properties": {
    "tagId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tags/tagId1",
    "displayName": "tag1",
    "description": "Some description that will be displayed for operation's tag if the tag is assigned to operation of the API",
    "externalDocsDescription": "some additional info",
    "externalDocsUrl": "http://some_url.com"
  }
}

定義

ErrorFieldContract

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

ErrorResponse

エラー応答。

TagDescriptionContract

契約の詳細。

TagDescriptionCreateParameters

タグ記述の作成操作に指定されたパラメーター。

ErrorFieldContract

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

Name Type Description
code
  • string

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

message
  • string

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

target
  • string

プロパティ名。

ErrorResponse

エラー応答。

Name Type Description
error.code
  • string

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

error.details

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

error.message
  • string

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

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 管理リソースのリソースの種類。

TagDescriptionCreateParameters

タグ記述の作成操作に指定されたパラメーター。

Name Type Description
properties.description
  • string

タグの説明。

properties.externalDocsDescription
  • string

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

properties.externalDocsUrl
  • string

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