Dela via

Logger - List By Service

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

Visar en samling loggare i den angivna tjänstinstansen.

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

URI-parametrar

Name I Obligatorisk Typ Description
resourceGroupName
 path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName
 path True

string

Namnet på API Management-tjänsten.

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

string

ID för målprenumerationen.
api-version
 query True

string

Den API-version som ska användas för den här åtgärden.
$filter
 query

string

| Fält | Användning | Operatorer som stöds | Funktioner som stöds |
|-------------|-------------|-------------|-------------|
| namn | 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

Antal poster att hoppa över.
$top
 query

integer

int32

Antal poster som ska returneras.

Svar

Name Typ Description
200 OK

LoggerCollection

Visar en samling loggningsentiteter.
Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

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

Scopes

Name Description
user_impersonation personifiera ditt användarkonto

Exempel

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

Definitioner

Name Description
ErrorFieldContract

Fel Fältkontrakt.
ErrorResponse

Felsvar.
LoggerCollection

Paged Logger list representation.
LoggerContract

Loggningsinformation.
LoggerType

Loggningstyp.

ErrorFieldContract

Fel Fältkontrakt.

Name Typ Description
code

string

Felkod på egenskapsnivå.
message

string

Mänsklig läsbar representation av fel på egenskapsnivå.
target

string

Egenskapsnamn.

ErrorResponse

Felsvar.

Name Typ Description
error.code

string

Tjänstdefinierad felkod. Den här koden fungerar som en understatus för HTTP-felkoden som anges i svaret.
error.details

ErrorFieldContract[]

Listan över ogiltiga fält som skickas i begäran, om verifieringsfel uppstår.
error.message

string

Mänsklig läsbar representation av felet.

LoggerCollection

Paged Logger list representation.

Name Typ Description
count

integer

Totalt antal poster på alla sidor.
nextLink

string

Om det finns någon länk till nästa sida.
value

LoggerContract[]

Loggningsvärden.

LoggerContract

Loggningsinformation.

Name Typ Description
id

string

Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Namnet på resursen
properties.credentials

object

Namnet och SendRule-anslutningssträng för händelsehubben för azureEventHub-loggaren. Instrumentationsnyckel för applicationInsights-logger.
properties.description

string

Beskrivning av loggare.
properties.isBuffered

boolean

Om poster buffrads i loggaren före publicering. Standardvärdet antas vara sant.
properties.loggerType

LoggerType

Loggningstyp.
properties.resourceId

string

Azure-resurs-ID för ett loggmål (antingen Azure Event Hub-resurs eller Azure Application Insights-resurs).
type

string

Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

LoggerType

Loggningstyp.

Name Typ Description
applicationInsights

string

Azure Application Insights som loggmål.
azureEventHub

string

Azure Event Hub som loggmål.
azureMonitor

string

Azure Monitor