ApiIssue interface
ApiIssue を表すインターフェイス。
メソッド
| create |
API の新しい問題を作成するか、既存のものを更新します。 |
| delete(string, string, string, string, string, Api |
指定された問題を API から削除します。 |
| get(string, string, string, string, Api |
識別子で指定された API の Issue の詳細を取得します。 |
| get |
識別子で指定された API の Issue のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定された API に関連付けられているすべての問題を一覧表示します。 |
| update(string, string, string, string, string, Issue |
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 パラメーター。
戻り値
Promise<ApiIssueCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiIssueDeleteOptionalParams)
指定された問題を 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
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ApiIssueGetOptionalParams)
識別子で指定された API の Issue の詳細を取得します。
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
options パラメーター。
戻り値
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 パラメーター。
戻り値
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 パラメーター。
戻り値
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
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- IssueUpdateContract
パラメーターを更新します。
- options
- ApiIssueUpdateOptionalParams
options パラメーター。
戻り値
Promise<ApiIssueUpdateResponse>