指定された API に関連付けられている問題のすべての添付ファイルを一覧表示します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments?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}/attachments?$filter={$filter}&$top={$top}&$skip={$skip}&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 バージョン。
|
$filter
|
query |
|
string
|
|フィールド |使用法 |サポートされている演算子 |サポートされている関数 | |-------------|-------------|-------------|-------------| |name |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith | |userId |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|
$skip
|
query |
|
integer
int32
|
スキップするレコードの数。
|
$top
|
query |
|
integer
int32
|
返されるレコードの数。
|
応答
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー。
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名前 |
説明 |
user_impersonation
|
ユーザー アカウントの借用
|
例
ApiManagementListApiIssueAttachments
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments?api-version=2022-08-01
/** Samples for ApiIssueAttachment ListByService. */
public final class Main {
/*
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiIssueAttachments.json
*/
/**
* Sample code: ApiManagementListApiIssueAttachments.
*
* @param manager Entry point to ApiManagementManager.
*/
public static void apiManagementListApiIssueAttachments(
com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
manager
.apiIssueAttachments()
.listByService(
"rg1",
"apimService1",
"57d1f7558aa04f15146d9d8a",
"57d2ef278aa04f0ad01d6cdc",
null,
null,
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_list_api_issue_attachments.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_attachment.list_by_service(
resource_group_name="rg1",
service_name="apimService1",
api_id="57d1f7558aa04f15146d9d8a",
issue_id="57d2ef278aa04f0ad01d6cdc",
)
for item in response:
print(item)
# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiIssueAttachments.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/ApiManagementListApiIssueAttachments.json
func ExampleAPIIssueAttachmentClient_NewListByServicePager() {
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)
}
pager := clientFactory.NewAPIIssueAttachmentClient().NewListByServicePager("rg1", "apimService1", "57d1f7558aa04f15146d9d8a", "57d2ef278aa04f0ad01d6cdc", &armapimanagement.APIIssueAttachmentClientListByServiceOptions{Filter: nil,
Top: nil,
Skip: nil,
})
for pager.More() {
page, err := pager.NextPage(ctx)
if err != nil {
log.Fatalf("failed to advance page: %v", err)
}
for _, v := range page.Value {
// You could use page here. We use blank identifier for just demo purposes.
_ = v
}
// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
// page.IssueAttachmentCollection = armapimanagement.IssueAttachmentCollection{
// Count: to.Ptr[int64](1),
// Value: []*armapimanagement.IssueAttachmentContract{
// {
// Name: to.Ptr("57d2ef278aa04f0888cba3f3"),
// Type: to.Ptr("Microsoft.ApiManagement/service/apis/issues/attachments"),
// ID: to.Ptr("/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3"),
// Properties: &armapimanagement.IssueAttachmentContractProperties{
// Content: to.Ptr("https://.../image.jpg"),
// ContentFormat: to.Ptr("link"),
// Title: to.Ptr("Issue attachment."),
// },
// }},
// }
}
}
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 Lists all attachments for the Issue associated with the specified API.
*
* @summary Lists all attachments for the Issue associated with the specified API.
* x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementListApiIssueAttachments.json
*/
async function apiManagementListApiIssueAttachments() {
const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
const serviceName = "apimService1";
const apiId = "57d1f7558aa04f15146d9d8a";
const issueId = "57d2ef278aa04f0ad01d6cdc";
const credential = new DefaultAzureCredential();
const client = new ApiManagementClient(credential, subscriptionId);
const resArray = new Array();
for await (let item of client.apiIssueAttachment.listByService(
resourceGroupName,
serviceName,
apiId,
issueId
)) {
resArray.push(item);
}
console.log(resArray);
}
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
{
"value": [
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments/57d2ef278aa04f0888cba3f3",
"type": "Microsoft.ApiManagement/service/apis/issues/attachments",
"name": "57d2ef278aa04f0888cba3f3",
"properties": {
"title": "Issue attachment.",
"contentFormat": "link",
"content": "https://.../image.jpg"
}
}
],
"count": 1,
"nextLink": ""
}
定義
ErrorFieldContract
エラー フィールド コントラクト。
名前 |
型 |
説明 |
code
|
string
|
プロパティ レベルのエラー コード。
|
message
|
string
|
プロパティ レベルエラーの人間が判読できる表現。
|
target
|
string
|
プロパティ名。
|
ErrorResponse
エラー応答。
名前 |
型 |
説明 |
error.code
|
string
|
サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
|
error.details
|
ErrorFieldContract[]
|
検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
|
error.message
|
string
|
人が判読できるエラーの表現。
|
IssueAttachmentCollection
Paged Issue Attachment list representation. (ページ発行の添付ファイルの一覧の表現)。
名前 |
型 |
説明 |
count
|
integer
|
すべてのページの合計レコード数。
|
nextLink
|
string
|
次のページ リンク (存在する場合)。
|
value
|
IssueAttachmentContract[]
|
添付ファイルの値を発行します。
|
IssueAttachmentContract
添付ファイル契約の詳細を発行します。
名前 |
型 |
説明 |
id
|
string
|
リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
|
name
|
string
|
リソースの名前
|
properties.content
|
string
|
HTTP リンクまたは Base64 でエンコードされたバイナリ データ。
|
properties.contentFormat
|
string
|
コンテンツが HTTP リンクを介して提供される場合は 'link' か、'content' プロパティで提供される Base64 でエンコードされたバイナリ データの MIME の種類のいずれかです。
|
properties.title
|
string
|
バイナリ データを保存するファイル名。
|
type
|
string
|
リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"
|