ApiIssueComment interface
ApiIssueComment を表すインターフェイス。
メソッド
| create |
API で問題の新しいコメントを作成するか、既存のコメントを更新します。 |
| delete(string, string, string, string, string, string, Api |
問題から指定されたコメントを削除します。 |
| get(string, string, string, string, string, Api |
識別子で指定された API の問題コメントの詳細を取得します。 |
| get |
識別子で指定された API の問題コメントのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定した API に関連付けられている問題に関するすべてのコメントを一覧表示します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, string, IssueCommentContract, ApiIssueCommentCreateOrUpdateOptionalParams)
API で問題の新しいコメントを作成するか、既存のコメントを更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, parameters: IssueCommentContract, options?: ApiIssueCommentCreateOrUpdateOptionalParams): Promise<ApiIssueCommentCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- issueId
-
string
問題識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- commentId
-
string
問題内のコメント識別子。 現在の問題で一意である必要があります。
- parameters
- IssueCommentContract
パラメーターを作成します。
オプション パラメーター。
戻り値
delete(string, string, string, string, string, string, ApiIssueCommentDeleteOptionalParams)
問題から指定されたコメントを削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, ifMatch: string, options?: ApiIssueCommentDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- issueId
-
string
問題識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- commentId
-
string
問題内のコメント識別子。 現在の問題で一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。
オプション パラメーター。
戻り値
Promise<void>
get(string, string, string, string, string, ApiIssueCommentGetOptionalParams)
識別子で指定された API の問題コメントの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetOptionalParams): Promise<ApiIssueCommentGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- issueId
-
string
問題識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- commentId
-
string
問題内のコメント識別子。 現在の問題で一意である必要があります。
- options
- ApiIssueCommentGetOptionalParams
オプション パラメーター。
戻り値
Promise<ApiIssueCommentGetResponse>
getEntityTag(string, string, string, string, string, ApiIssueCommentGetEntityTagOptionalParams)
識別子で指定された API の問題コメントのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, commentId: string, options?: ApiIssueCommentGetEntityTagOptionalParams): Promise<ApiIssueCommentGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- issueId
-
string
問題識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- commentId
-
string
問題内のコメント識別子。 現在の問題で一意である必要があります。
オプション パラメーター。
戻り値
Promise<ApiIssueCommentGetEntityTagHeaders>
listByService(string, string, string, string, ApiIssueCommentListByServiceOptionalParams)
指定した API に関連付けられている問題に関するすべてのコメントを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueCommentListByServiceOptionalParams): PagedAsyncIterableIterator<IssueCommentContract, IssueCommentContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前では大文字と小文字が区別されません。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在の API Management サービス インスタンスで一意である必要があります。
- issueId
-
string
問題識別子。 現在の API Management サービス インスタンスで一意である必要があります。
オプション パラメーター。