Issue - List By Service

  • Riferimento
Service:
API Management
API Version:
2022-08-01

Elenca una raccolta di problemi nell'istanza del servizio specificata.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/issues?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01

Parametri dell'URI

Nome In Necessario Tipo Descrizione
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.

Regex pattern: ^[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 |
| apiId | filtro | ge, le, eq, ne, gt, lt | substringof, contiene, startswith, endwith |
| titolo | filtro | ge, le, eq, ne, gt, lt | substringof, contiene, startswith, endwith |
| descrizione | filtro | ge, le, eq, ne, gt, lt | substringof, contiene, startswith, endwith |
| authorName | filtro | ge, le, eq, ne, gt, lt | substringof, contiene, startswith, endwith |
| stato | filtro | eq | |
$skip
 query

integer

int32

Numero di record da ignorare.
$top
 query

integer

int32

Numero di record da restituire.

Risposte

Nome Tipo Descrizione
200 OK

IssueCollection

Elenca una raccolta di entità Problema.
Other Status Codes

ErrorResponse

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

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome Descrizione
user_impersonation rappresentare l'account utente

Esempio

ApiManagementListIssues

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/issues/57d2ef278aa04f0ad01d6cdc",
      "type": "Microsoft.ApiManagement/service/issues",
      "name": "57d2ef278aa04f0ad01d6cdc",
      "properties": {
        "title": "New API issue",
        "description": "New API issue description",
        "createdDate": "2018-02-01T22:21:20.467Z",
        "state": "open",
        "userId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
        "apiId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a"
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

Definizioni

Nome Descrizione
ErrorFieldContract

Contratto campo errore.
ErrorResponse

Risposta errore.
IssueCollection

Rappresentazione dell'elenco dei problemi con pagina.
IssueContract

Dettagli del contratto di problema.
State

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

IssueCollection

Rappresentazione dell'elenco dei problemi con pagina.

Nome Tipo Descrizione
count

integer

Numero totale di record in tutte le pagine.
nextLink

string

Collegamento alla pagina successiva se disponibile.
value

IssueContract[]

Valori di problema.

IssueContract

Dettagli del contratto di 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.apiId

string

Identificatore di risorsa per l'API per cui è stato creato il problema.
properties.createdDate

string

Data e ora in cui è stato creato il problema.
properties.description

string

Testo che descrive il problema.
properties.state

State

Stato del problema.
properties.title

string

Titolo del problema.
properties.userId

string

Identificatore di risorsa per l'utente ha creato il problema.
type

string

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

State

Stato del problema.

Nome Tipo Descrizione
closed

string

Il problema è stato chiuso.
open

string

Il problema viene aperto.
proposed

string

Il problema è proposto.
removed

string

Il problema è stato rimosso.
resolved

string

Il problema è ora risolto.