Condividi tramite


Api Issue Comment - List By Service

Elenca tutti i commenti per il problema associato all'API specificata.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments?api-version=2022-08-01
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=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
apiId
path True

string

Identificatore API. Deve essere univoco nell'istanza corrente del servizio Gestione API.

issueId
path True

string

Identificatore del problema. Deve essere univoco nell'istanza corrente del servizio Gestione API.

Criterio di espressione regolare: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName
path True

string

Nome del servizio Gestione API.

Criterio di espressione regolare: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID della sottoscrizione di destinazione.

api-version
query True

string

Versione dell'API da usare per questa operazione.

$filter
query

string

| Campo | Utilizzo | Operatori supportati | Funzioni supportate |
|-------------|-------------|-------------|-------------|
| nome | filtro | ge, le, eq, ne, gt, lt | substringof, contiene, startswith, endwith |
| userId | filtro | ge, le, eq, ne, gt, lt | substringof, contiene, startswith, endwith |

$skip
query

integer

int32

Numero di record da ignorare.

$top
query

integer

int32

Numero di record da restituire.

Risposte

Nome Tipo Descrizione
200 OK

IssueCommentCollection

Risposta del risultato della pagina dei commenti dei problemi per l'API.

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementListApiIssueComments

Esempio di richiesta

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

Risposta di esempio

{
  "value": [
    {
      "id": "/subscriptions/subid/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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definizioni

Nome Descrizione
ErrorFieldContract

Contratto campo errore.

ErrorResponse

Risposta errore.

IssueCommentCollection

Rappresentazione dell'elenco dei commenti del problema a pagina.

IssueCommentContract

Dettagli del contratto di commento del problema.

ErrorFieldContract

Contratto campo errore.

Nome Tipo Descrizione
code

string

Codice di errore a livello di proprietà.

message

string

Rappresentazione leggibile dell'errore a livello di proprietà.

target

string

Nome della proprietà.

ErrorResponse

Risposta errore.

Nome Tipo Descrizione
error.code

string

Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.

error.details

ErrorFieldContract[]

Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.

error.message

string

Rappresentazione leggibile dell'errore.

IssueCommentCollection

Rappresentazione dell'elenco dei commenti del problema a pagina.

Nome Tipo Descrizione
count

integer

Numero totale di record in tutte le pagine.

nextLink

string

Collegamento alla pagina successiva se disponibile.

value

IssueCommentContract[]

Rilasciare i valori commento.

IssueCommentContract

Dettagli del contratto di commento del problema.

Nome Tipo Descrizione
id

string

ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

nome della risorsa.

properties.createdDate

string

Data e ora della creazione del commento.

properties.text

string

Testo commento.

properties.userId

string

Identificatore di risorsa per l'utente che ha lasciato il commento.

type

string

Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"