識別子で指定された API の Issue の詳細を取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}?api-version=2022-08-01
With optional parameters:
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}?expandCommentsAttachments={expandCommentsAttachments}&api-version=2022-08-01
URI パラメーター
名前 |
/ |
必須 |
型 |
説明 |
apiId
|
path |
True
|
string
|
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
|
issueId
|
path |
True
|
string
|
問題識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
Regex pattern: ^[^*#&+:<>?]+$
|
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 バージョン。
|
expandCommentsAttachments
|
query |
|
boolean
|
コメントの添付ファイルを展開します。
|
応答
名前 |
型 |
説明 |
200 OK
|
IssueContract
|
応答本文には、指定された Issue エンティティが含まれています。
Headers
ETag: string
|
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
|
ユーザー アカウントの借用
|
例
ApiManagementGetApiIssue
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d2ef278aa04f0888cba3f3/issues/57d2ef278aa04f0ad01d6cdc?api-version=2022-08-01
/** Samples for ApiIssue Get. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiIssue.json
*/
/**
* Sample code: ApiManagementGetApiIssue.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementGetApiIssue(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager
.apiIssues()
.getWithResponse(
"rg1",
"apimService1",
"57d2ef278aa04f0888cba3f3",
"57d2ef278aa04f0ad01d6cdc",
null,
com.azure.core.util.Context.NONE);
}
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
from azure.identity import DefaultAzureCredential
from azure.mgmt.apimanagement import ApiManagementClient
"""
# PREREQUISITES
pip install azure-identity
pip install azure-mgmt-apimanagement
# USAGE
python api_management_get_api_issue.py
Before run the sample, please set the values of the client ID, tenant ID and client secret
of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""
def main():
client = ApiManagementClient(
credential=DefaultAzureCredential(),
subscription_id="subid",
)
response = client.api_issue.get(
resource_group_name="rg1",
service_name="apimService1",
api_id="57d2ef278aa04f0888cba3f3",
issue_id="57d2ef278aa04f0ad01d6cdc",
)
print(response)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiIssue.json
if __name__ == "__main__":
main()
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
package armapimanagement_test
import (
"context"
"log"
"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiIssue.json
func ExampleAPIIssueClient_Get() {
cred, err := azidentity.NewDefaultAzureCredential(nil)
if err != nil {
log.Fatalf("failed to obtain a credential: %v", err)
}
ctx := context.Background()
clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
if err != nil {
log.Fatalf("failed to create client: %v", err)
}
res, err := clientFactory.NewAPIIssueClient().Get(ctx, "rg1", "apimService1", "57d2ef278aa04f0888cba3f3", "57d2ef278aa04f0ad01d6cdc", &armapimanagement.APIIssueClientGetOptions{ExpandCommentsAttachments: nil})
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
// You could use response here. We use blank identifier for just demo purposes.
_ = res
// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// res.IssueContract = armapimanagement.IssueContract{
// Name: to.Ptr("57d2ef278aa04f0ad01d6cdc"),
// Type: to.Ptr("Microsoft.ApiManagement/service/apis/issues"),
// ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc"),
// Properties: &armapimanagement.IssueContractProperties{
// APIID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"),
// CreatedDate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2018-02-01T22:21:20.467Z"); return t}()),
// State: to.Ptr(armapimanagement.StateOpen),
// Description: to.Ptr("New API issue description"),
// Title: to.Ptr("New API issue"),
// UserID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"),
// },
// }
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
/**
* This sample demonstrates how to Gets the details of the Issue for an API specified by its identifier.
*
* @summary Gets the details of the Issue for an API specified by its identifier.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementGetApiIssue.json
*/
async function apiManagementGetApiIssue() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const apiId = "57d2ef278aa04f0888cba3f3";
const issueId = "57d2ef278aa04f0ad01d6cdc";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const result = await client.apiIssue.get(resourceGroupName, serviceName, apiId, issueId);
console.log(result);
}
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Sample Response
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc",
"type": "Microsoft.ApiManagement/service/apis/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"
}
}
定義
ErrorFieldContract
エラー フィールド コントラクト。
名前 |
型 |
説明 |
code
|
string
|
プロパティ レベルのエラー コード。
|
message
|
string
|
プロパティ レベルエラーの人間が判読できる表現。
|
target
|
string
|
プロパティ名。
|
ErrorResponse
エラー応答。
名前 |
型 |
説明 |
error.code
|
string
|
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
|
error.details
|
ErrorFieldContract[]
|
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
|
error.message
|
string
|
人が判読できるエラーの表現。
|
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
|
この問題は解決されました。
|