Issue - List By Service

  • リファレンス
Service:
API Management
API Version:
2022-08-01

指定されたサービス インスタンスにおける問題のコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する API バージョン。
$filter
 query

string

|フィールド |使用法 |サポートされている演算子 |サポートされている関数 |
|-------------|-------------|-------------|-------------|
|name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|apiId |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|title |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|description |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|authorName |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|state |filter |eq | |
$skip
 query

integer

int32

スキップするレコードの数。
$top
 query

integer

int32

返されるレコードの数。

応答

名前 型 説明
200 OK

IssueCollection

Issue エンティティのコレクションを一覧表示します。
Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

ApiManagementListIssues

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/issues",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "title": "New API issue",
        "description": "New API issue description",
        "createdDate": "2018-02-01T22:21:20.467Z",
        "state": "open",
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "apiId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

名前 説明
ErrorFieldContract

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

エラー応答。
IssueCollection

Paged Issue list representation.
IssueContract

契約の詳細を発行します。
State

問題の状態。

ErrorFieldContract

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

名前 型 説明
code

string

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

string

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

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

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

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

IssueCollection

Paged Issue list representation.

名前 型 説明
count

integer

すべてのページの合計レコード数。
nextLink

string

次のページリンク (存在する場合)。
value

IssueContract[]

問題の値。

IssueContract

契約の詳細を発行します。

名前 型 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

リソースの名前
properties.apiId

string

問題が作成された API のリソース識別子。
properties.createdDate

string

問題が作成された日時。
properties.description

string

問題を説明するテキスト。
properties.state

State

問題の状態。
properties.title

string

問題のタイトル。
properties.userId

string

ユーザーのリソース識別子が問題を作成しました。
type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

State

問題の状態。

名前 型 説明
closed

string

問題は終了しました。
open

string

問題が開きます。
proposed

string

この問題は提案されています。
removed

string

問題は削除されました。
resolved

string

この問題は解決されました。