次の方法で共有


ApiResource.GetApiTagDescriptionAsync(String, CancellationToken) メソッド

定義

API のスコープでタグの説明を取得する

  • 要求パス/サブスクリプション/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/tagDescriptions/{tagDescriptionId}
  • 操作IdApiTagDescription_Get
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>> GetApiTagDescriptionAsync (string tagDescriptionId, System.Threading.CancellationToken cancellationToken = default);
abstract member GetApiTagDescriptionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>>
override this.GetApiTagDescriptionAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.ResourceManager.ApiManagement.ApiTagDescriptionResource>>
Public Overridable Function GetApiTagDescriptionAsync (tagDescriptionId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of ApiTagDescriptionResource))

パラメーター

tagDescriptionId
String

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

cancellationToken
CancellationToken

使用する取り消しトークン。

戻り値

例外

tagDescriptionId は空の文字列であり、空でないと予想されていました。

tagDescriptionId が null です。

適用対象