Udostępnij za pośrednictwem

Logger - List By Service

  • Odwołanie
Service:
API Management
API Version:
2022-08-01

Wyświetla listę kolekcji rejestratorów w określonym wystąpieniu usługi.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
resourceGroupName
 path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.
serviceName
 path True

string

Nazwa usługi API Management.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

Identyfikator subskrypcji docelowej.
api-version
 query True

string

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 |
| description | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
| loggerType | filter | eq | |
| resourceId | filter | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |
$skip
 query

integer

int32

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

integer

int32

Liczba rekordów do zwrócenia.

Odpowiedzi

Nazwa Typ Opis
200 OK

LoggerCollection

Wyświetla listę kolekcji jednostek rejestratora.
Other Status Codes

ErrorResponse

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

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

ApiManagementListLoggers

Sample Request

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

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/azuremonitor",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "azuremonitor",
      "properties": {
        "loggerType": "azureMonitor",
        "isBuffered": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/vvktest",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "vvktest",
      "properties": {
        "loggerType": "applicationInsights",
        "credentials": {
          "instrumentationKey": "{{Logger-Credentials-5b1a17ef2b3f91153004b10d}}"
        },
        "isBuffered": true
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/applicationinsights",
      "type": "Microsoft.ApiManagement/service/loggers",
      "name": "applicationinsights",
      "properties": {
        "loggerType": "applicationInsights",
        "description": "miaoappinsight",
        "credentials": {
          "instrumentationKey": "{{Logger-Credentials-5b2056062b3f911ae84a3069}}"
        },
        "isBuffered": true
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

Definicje

Nazwa Opis
ErrorFieldContract

Błąd Kontrakt pola.
ErrorResponse

Odpowiedź na błąd.
LoggerCollection

Reprezentacja listy stronicowanych rejestratorów.
LoggerContract

Szczegóły rejestratora.
LoggerType

Typ rejestratora.

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.
message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.
target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.
error.details

ErrorFieldContract[]

Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.
error.message

string

Czytelna dla człowieka reprezentacja błędu.

LoggerCollection

Reprezentacja listy stronicowanych rejestratorów.

Nazwa Typ Opis
count

integer

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

string

Jeśli istnieje, łącze następnej strony.
value

LoggerContract[]

Wartości rejestratora.

LoggerContract

Szczegóły rejestratora.

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

object

Nazwa i parametry połączenia SendRule centrum zdarzeń dla rejestratora azureEventHub. Klucz instrumentacji dla rejestratora applicationInsights.
properties.description

string

Opis rejestratora.
properties.isBuffered

boolean

Czy rekordy są buforowane w rejestratorze przed opublikowaniem. Przyjmuje się, że wartość domyślna ma wartość true.
properties.loggerType

LoggerType

Typ rejestratora.
properties.resourceId

string

Identyfikator zasobu platformy Azure docelowego dziennika (zasób usługi Azure Event Hub lub zasób usługi Aplikacja systemu Azure Insights).
type

string

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

LoggerType

Typ rejestratora.

Nazwa Typ Opis
applicationInsights

string

aplikacja systemu Azure Insights jako miejsce docelowe dziennika.
azureEventHub

string

Usługa Azure Event Hub jako miejsce docelowe dziennika.
azureMonitor

string

Azure Monitor