Delen via

Api Issue Comment - List By Service

  • Referentie
Service:
API Management
API-versie:
2024-05-01

Bevat alle opmerkingen 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}/comments?api-version=2024-05-01
Met optionele parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI-parameters

Name In Vereist Type Description
apiId
 path True

string

minLength: 1
maxLength: 80

API-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
issueId
 path True

string

minLength: 1
maxLength: 256
pattern: ^[^*#&+:<>?]+$

Probleem-id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

De naam van de API Management-service.
subscriptionId
 path True

string (uuid)

De id van het doelabonnement. De waarde moet een UUID zijn.
api-version
 query True

string

minLength: 1

De API-versie die voor deze bewerking moet worden gebruikt.
$filter
 query

string

| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies |
|-------------|-------------|-------------|-------------|
| naam | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith |
| userId | filter | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, startswith, endswith |
$skip
 query

integer (int32)

minimum: 0

Het aantal records dat moet worden overgeslagen.
$top
 query

integer (int32)

minimum: 1

Aantal records dat moet worden geretourneerd.

Antwoorden

Name Type Description
200 OK

IssueCommentCollection

Gepaginad resultaatantwoord van opmerkingen bij problemen voor de API.
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

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

Bereiken

Name Description
user_impersonation Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementListApiIssueComments

Voorbeeldaanvraag

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments?api-version=2024-05-01

Voorbeeldrespons

Statuscode:
200 
{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc/comments/599e29ab193c3c0bd0b3e2fb",
      "type": "Microsoft.ApiManagement/service/apis/issues/comments",
      "name": "599e29ab193c3c0bd0b3e2fb",
      "properties": {
        "text": "Issue comment.",
        "createdDate": "2018-02-01T22:21:20.467Z",
        "userId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definities

Name Description
ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.
ErrorDetail

De foutdetails.
ErrorResponse

Foutreactie
IssueCommentCollection

Weergave van lijst met opmerkingen bij pagina's.
IssueCommentContract

Probleem met contractgegevens van opmerking.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

object

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoel.

ErrorResponse

Object

Foutreactie

Name Type Description
error

ErrorDetail

Het foutobject.

IssueCommentCollection

Object

Weergave van lijst met opmerkingen bij pagina's.

Name Type Description
count

integer (int64)

Totaal aantal records voor alle pagina's.
nextLink

string

Koppeling naar volgende pagina indien aanwezig.
value

IssueCommentContract[]

Opmerkingswaarden uitgeven.

IssueCommentContract

Object

Probleem met contractgegevens van opmerking.

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.createdDate

string (date-time)

Datum en tijd waarop de opmerking is gemaakt.
properties.text

string

Opmerkingstekst.
properties.userId

string

Een resource-id voor de gebruiker die de opmerking heeft achtergelaten.
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'