Api Issue Attachment - List By Service

Service:

API Management

API-versie:

2021-08-01

Een lijst met alle bijlagen voor het probleem dat is gekoppeld aan de opgegeven API.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments?api-version=2021-08-01

Met optionele 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=2021-08-01

URI-parameters

Name	In	Vereist	Type	Description
apiId	path	True	string	API-id. Moet uniek zijn in het huidige API Management service-exemplaar.
issueId	path	True	string	Id van probleem. Moet uniek zijn in het huidige API Management service-exemplaar. Regex-patroon: ^[^*#&+:<>?]+$
resourceGroupName	path	True	string	De naam van de resourcegroep.
serviceName	path	True	string	De naam van de API Management service. Regex-patroon: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Abonnementsreferenties waarmee het Microsoft Azure-abonnement uniek wordt geïdentificeerd. De abonnements-id maakt deel uit van de URI voor elke service-aanroep.
api-version	query	True	string	Versie van de API die moet worden gebruikt met de clientaanvraag.
$filter	query		string	| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies | |-------------|-------------|-------------|-------------| | naam | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begint met, eindigtmet | | userId | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begintmet, eindigtmet |
$skip	query		integer int32	Aantal records dat moet worden overgeslagen.
$top	query		integer int32	Het aantal te retourneren records.

Antwoorden

Name	Type	Description
200 OK	IssueAttachmentCollection	Paged Resultaatantwoord van probleembijlagen voor de API.
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	uw gebruikersaccount imiteren

Voorbeelden

ApiManagementListApiIssueAttachments

Voorbeeldaanvraag

HTTP

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/attachments?api-version=2021-08-01

Java

import com.azure.core.util.Context;

/** Samples for ApiIssueAttachment ListByService. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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,
                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

Python

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/2021-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

Go

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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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

JavaScript

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/2021-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

dotnet

using System;
using System.Threading.Tasks;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementListApiIssueAttachments.json
// this example is just showing the usage of "ApiIssueAttachment_ListByService" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiIssueResource created on azure
// for more information of creating ApiIssueResource, please refer to the document of ApiIssueResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string apiId = "57d1f7558aa04f15146d9d8a";
string issueId = "57d2ef278aa04f0ad01d6cdc";
ResourceIdentifier apiIssueResourceId = ApiIssueResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, apiId, issueId);
ApiIssueResource apiIssue = client.GetApiIssueResource(apiIssueResourceId);

// get the collection of this ApiIssueAttachmentResource
ApiIssueAttachmentCollection collection = apiIssue.GetApiIssueAttachments();

// invoke the operation and iterate over the result
await foreach (ApiIssueAttachmentResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    ApiIssueAttachmentData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

Console.WriteLine($"Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Voorbeeldrespons

Statuscode:

200

{
  "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": ""
}

Definities

Name	Description
ErrorFieldContract	Fout Veldcontract.
ErrorResponse	Foutreactie.
IssueAttachmentCollection	Weergave van lijst met pagina's met bijlagen met pagina's.
IssueAttachmentContract	Details van bijlagecontract uitgeven.

ErrorFieldContract

Fout Veldcontract.

Name	Type	Description
code	string	Foutcode op eigenschapsniveau.
message	string	Door mensen leesbare weergave van fout op eigenschapsniveau.
target	string	Naam van eigenschap.

ErrorResponse

Foutreactie.

Name	Type	Description
error.code	string	Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details	ErrorFieldContract[]	De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
error.message	string	Door mensen leesbare weergave van de fout.

IssueAttachmentCollection

Weergave van lijst met pagina's met bijlagen met pagina's.

Name	Type	Description
count	integer	Totaal aantal records voor alle pagina's.
nextLink	string	Koppeling naar volgende pagina, indien aanwezig.
value	IssueAttachmentContract[]	Bijlagewaarden uitgeven.

IssueAttachmentContract

Details van bijlagecontract uitgeven.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.content	string	Een HTTP-koppeling of met Base64 gecodeerde binaire gegevens.
properties.contentFormat	string	Ofwel 'koppeling' als inhoud wordt geleverd via een HTTP-koppeling of het MIME-type van de met Base64 gecodeerde binaire gegevens die zijn opgegeven in de eigenschap 'content'.
properties.title	string	Bestandsnaam waarmee de binaire gegevens worden opgeslagen.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'