ApiIssue interface

パッケージ:: @azure/arm-apimanagement

ApiIssue を表すインターフェイス。

メソッド

createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)	API の新しいイシューを作成するか、既存の問題を更新します。
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)	指定した Issue を API から削除します。
get(string, string, string, string, ApiIssueGetOptionalParams)	識別子で指定された API の問題の詳細を取得します。
getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)	識別子で指定された API の Issue のエンティティ状態 (Etag) バージョンを取得します。
listByService(string, string, string, ApiIssueListByServiceOptionalParams)	指定した API に関連付けられているすべての問題を一覧表示します。
update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)	API の既存の問題を更新します。

メソッドの詳細

createOrUpdate(string, string, string, string, IssueContract, ApiIssueCreateOrUpdateOptionalParams)

API の新しいイシューを作成するか、既存の問題を更新します。

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, parameters: IssueContract, options?: ApiIssueCreateOrUpdateOptionalParams): Promise<ApiIssueCreateOrUpdateResponse>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。

issueId: string

問題識別子。現在の API Management サービスインスタンスで一意である必要があります。

parameters: IssueContract

パラメーターを作成します。

options: ApiIssueCreateOrUpdateOptionalParams

オプションパラメーター。

戻り値

Promise<ApiIssueCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)

指定した Issue を API から削除します。

function delete(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, options?: ApiIssueDeleteOptionalParams): Promise<void>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。

issueId: string

問題識別子。現在の API Management サービスインスタンスで一意である必要があります。

ifMatch: string

エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

options: ApiIssueDeleteOptionalParams

オプションパラメーター。

戻り値

Promise<void>

get(string, string, string, string, ApiIssueGetOptionalParams)

識別子で指定された API の問題の詳細を取得します。

function get(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetOptionalParams): Promise<ApiIssueGetResponse>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。

issueId: string

問題識別子。現在の API Management サービスインスタンスで一意である必要があります。

options: ApiIssueGetOptionalParams

オプションパラメーター。

戻り値

Promise<ApiIssueGetResponse>

getEntityTag(string, string, string, string, ApiIssueGetEntityTagOptionalParams)

識別子で指定された API の Issue のエンティティ状態 (Etag) バージョンを取得します。

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, options?: ApiIssueGetEntityTagOptionalParams): Promise<ApiIssueGetEntityTagHeaders>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。

issueId: string

問題識別子。現在の API Management サービスインスタンスで一意である必要があります。

options: ApiIssueGetEntityTagOptionalParams

オプションパラメーター。

戻り値

Promise<ApiIssueGetEntityTagHeaders>

listByService(string, string, string, ApiIssueListByServiceOptionalParams)

指定した API に関連付けられているすべての問題を一覧表示します。

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiIssueListByServiceOptionalParams): PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。

options: ApiIssueListByServiceOptionalParams

オプションパラメーター。

戻り値

PagedAsyncIterableIterator<IssueContract, IssueContract[], PageSettings>

update(string, string, string, string, string, IssueUpdateContract, ApiIssueUpdateOptionalParams)

API の既存の問題を更新します。

function update(resourceGroupName: string, serviceName: string, apiId: string, issueId: string, ifMatch: string, parameters: IssueUpdateContract, options?: ApiIssueUpdateOptionalParams): Promise<ApiIssueUpdateResponse>

パラメーター

resourceGroupName: string

リソースグループの名前。名前では大文字と小文字が区別されません。

serviceName: string

API Management サービスの名前。

apiId: string

API 識別子。現在の API Management サービスインスタンスで一意である必要があります。

issueId: string

問題識別子。現在の API Management サービスインスタンスで一意である必要があります。

ifMatch: string

parameters: IssueUpdateContract

パラメーターを更新します。

options: ApiIssueUpdateOptionalParams

オプションパラメーター。

戻り値

Promise<ApiIssueUpdateResponse>