Sdílet prostřednictvím

Logger - List By Service

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

Vypíše kolekci protokolovačů v zadané instanci služby.

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 identifikátoru URI

Name V Vyžadováno Typ Description
resourceGroupName
 path True

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.
serviceName
 path True

string

Název služby API Management.

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

string

ID cílového předplatného.
api-version
 query True

string

Verze rozhraní API, která se má použít pro tuto operaci.
$filter
 query

string

| Pole | Využití | Podporované operátory | Podporované funkce |
|-------------|-------------|-------------|-------------|
| name | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
| popis | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná, končí s |
| loggerType | filtr | eq | |
| id prostředku | filtr | ge, le, eq, ne, gt, lt | podřetězc, obsahuje, začíná s, končí |
$skip
 query

integer

int32

Počet záznamů, které se mají přeskočit
$top
 query

integer

int32

Počet vrácených záznamů.

Odpovědi

Name Typ Description
200 OK

LoggerCollection

Vypíše kolekci entit protokolovacího nástroje.
Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok Azure Active Directory OAuth2

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

Scopes

Name Description
user_impersonation zosobnění uživatelského účtu

Příklady

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

Definice

Name Description
ErrorFieldContract

Chyba Kontrakt pole.
ErrorResponse

Odpověď na chybu.
LoggerCollection

Reprezentace seznamu stránkovacího protokolovacího nástroje.
LoggerContract

Podrobnosti o protokolovacím nástroji
LoggerType

Typ protokolovacího nástroje.

ErrorFieldContract

Chyba Kontrakt pole.

Name Typ Description
code

string

Kód chyby na úrovni vlastnosti.
message

string

Čitelné znázornění chyby na úrovni vlastností.
target

string

Název vlastnosti.

ErrorResponse

Odpověď na chybu.

Name Typ Description
error.code

string

Kód chyby definované službou Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi.
error.details

ErrorFieldContract[]

Seznam neplatných polí se odešle v žádosti v případě chyby ověření.
error.message

string

Znázornění chyby čitelné pro člověka

LoggerCollection

Reprezentace seznamu stránkovacího protokolovacího nástroje.

Name Typ Description
count

integer

Celkový počet záznamů na všech stránkách.
nextLink

string

Odkaz na další stránku, pokud existuje.
value

LoggerContract[]

Hodnoty protokolovacího nástroje.

LoggerContract

Podrobnosti o protokolovacím nástroji

Name Typ Description
id

string

Plně kvalifikované ID prostředku. Příklad – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Název prostředku
properties.credentials

object

Název a SendRule připojovací řetězec centra událostí pro protokolovací nástroj azureEventHub. Instrumentační klíč pro protokolovací nástroj applicationInsights.
properties.description

string

Popis protokolovacího nástroje.
properties.isBuffered

boolean

Určuje, jestli jsou záznamy v protokolovacím nástroji před publikováním uloženy do vyrovnávací paměti. Předpokládá se, že výchozí hodnota je true.
properties.loggerType

LoggerType

Typ protokolovacího nástroje.
properties.resourceId

string

ID prostředku Azure cíle protokolu (prostředek centra událostí Azure nebo prostředek Aplikace Azure Insights)
type

string

Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

LoggerType

Typ protokolovacího nástroje.

Name Typ Description
applicationInsights

string

Aplikace Azure Insights jako cíl protokolu.
azureEventHub

string

Azure Event Hub jako cíl protokolu.
azureMonitor

string

Azure Monitor