Logger - List By Service

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

Hiermee wordt een verzameling logboekregistraties in het opgegeven service-exemplaar weergegeven.

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-parameters

Name In Vereist Type Description
resourceGroupName
 path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName
 path True

string

De naam van de API Management service.

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

string

De id van het doelabonnement.
api-version
 query True

string

De API-versie die voor deze bewerking moet worden gebruikt.
$filter
 query

string

| Veld | Gebruik | Ondersteunde operators | Ondersteunde functies |
|-------------|-------------|-------------|-------------|
| naam | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begint met, eindigtmet |
| beschrijving | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begint met, eindigtmet |
| loggerType | filteren | eq | |
| resourceId | filteren | ge, le, eq, ne, gt, lt | subtekenreeks, bevat, begintmet, eindigtmet |
$skip
 query

integer

int32

Aantal records dat moet worden overgeslagen.
$top
 query

integer

int32

Het aantal te retourneren records.

Antwoorden

Name Type Description
200 OK

LoggerCollection

Een lijst met logboekentiteiten.
Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

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

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

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

Definities

Name Description
ErrorFieldContract

Fout Veldcontract.
ErrorResponse

Foutreactie.
LoggerCollection

Weergave van de lijst paged logger.
LoggerContract

Details van de logboekregistratie.
LoggerType

Type logger.

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.
message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.
target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.
error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.
error.message

string

Door mensen leesbare weergave van de fout.

LoggerCollection

Weergave van de lijst paged logger.

Name Type Description
count

integer

Totaal aantal records voor alle pagina's.
nextLink

string

Koppeling naar volgende pagina, indien aanwezig.
value

LoggerContract[]

Logboekregistratiewaarden.

LoggerContract

Details van de logboekregistratie.

Name Type Description
id

string

Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

De naam van de resource
properties.credentials

object

De naam en SendRule verbindingsreeks van de Event Hub voor azureEventHub-logboekregistratie. Instrumentatiesleutel voor applicationInsights-logboekregistratie.
properties.description

string

Beschrijving van logboekregistratie.
properties.isBuffered

boolean

Hiermee wordt aangegeven of records in de logboekregistratie worden gebufferd voordat ze worden gepubliceerd. Standaard wordt ervan uitgegaan dat deze waar is.
properties.loggerType

LoggerType

Type logger.
properties.resourceId

string

Azure-resource-id van een logboekdoel (Azure Event Hub-resource of Azure-toepassing Insights-resource).
type

string

Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

LoggerType

Type logger.

Name Type Description
applicationInsights

string

Azure-toepassing Insights als logboekbestemming.
azureEventHub

string

Azure Event Hub als logboekbestemming.
azureMonitor

string

Azure Monitor