Udostępnij za pośrednictwem

Api Issue Comment - List By Service

  • Odwołanie
Usługa:
API Management
Wersja interfejsu API:
2024-05-01

Wyświetla wszystkie komentarze dotyczące problemu skojarzonego z określonym interfejsem 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
Z parametrami opcjonalnymi: 
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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
apiId
 path True

string

minLength: 1
maxLength: 80

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
issueId
 path True

string

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

Identyfikator problemu. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName
 path True

string

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

Nazwa usługi API Management.
subscriptionId
 path True

string (uuid)

Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version
 query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.
$filter
 query

string

| Pole | Użycie | Obsługiwane operatory | Obsługiwane funkcje |
|-------------|-------------|-------------|-------------|
| 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)

minimum: 0

Liczba rekordów do pominięcia.
$top
 query

integer (int32)

minimum: 1

Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

IssueCommentCollection

Stronicowana odpowiedź na wyniki komentarzy dotyczących problemu dla interfejsu API.
Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementListApiIssueComments

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:
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": ""
}

Definicje

Nazwa Opis
ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail

Szczegóły błędu.
ErrorResponse

Odpowiedź na błąd
IssueCommentCollection

Reprezentacja listy stronicowanych komentarzy do problemów.
IssueCommentContract

Szczegóły kontraktu komentarza problemu.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

object

Dodatkowe informacje.
type

string

Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie.
code

string

Kod błędu.
details

ErrorDetail[]

Szczegóły błędu.
message

string

Komunikat o błędzie.
target

string

Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

IssueCommentCollection

Objekt

Reprezentacja listy stronicowanych komentarzy do problemów.

Nazwa Typ Opis
count

integer (int64)

Łączna liczba rekordów na wszystkich stronach.
nextLink

string

Jeśli istnieje, link następnej strony.
value

IssueCommentContract[]

Wartości komentarza problemu.

IssueCommentContract

Objekt

Szczegóły kontraktu komentarza problemu.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Nazwa zasobu
properties.createdDate

string (date-time)

Data i godzina utworzenia komentarza.
properties.text

string

Tekst komentarza.
properties.userId

string

Identyfikator zasobu użytkownika, który opuścił komentarz.
type

string

Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"