Share via

Logger - List By Service

  • Referência
Service:
API Management
API Version:
2022-08-01

Lista uma coleção de agentes de log na instância de serviço especificada.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
resourceGroupName
 path True

string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
serviceName
 path True

string

O nome do serviço Gerenciamento de API.

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

string

A ID da assinatura de destino.
api-version
 query True

string

A versão da API a ser usada para esta operação.
$filter
 query

string

| Campo | Uso | Operadores com suporte | Funções com suporte |
|-------------|-------------|-------------|-------------|
| 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

Número de registros a serem ignorados.
$top
 query

integer

int32

Número de registros a serem retornados.

Respostas

Nome Tipo Description
200 OK

LoggerCollection

Lista uma coleção de entidades do Agente.
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Scopes

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

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

Definições

Nome Description
ErrorFieldContract

Contrato de Campo de Erro.
ErrorResponse

Resposta de erro.
LoggerCollection

Representação da lista de agentes paginado.
LoggerContract

Detalhes do agente.
LoggerType

Tipo de agente.

ErrorFieldContract

Contrato de Campo de Erro.

Nome Tipo Description
code

string

Código de erro no nível da propriedade.
message

string

Representação legível por humanos do erro no nível da propriedade.
target

string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Nome Tipo Description
error.code

string

Código de erro definido pelo serviço. Esse código atua como um substatus do código de erro HTTP especificado na resposta.
error.details

ErrorFieldContract[]

A lista de campos inválidos enviados na solicitação, em caso de erro de validação.
error.message

string

Representação legível ao olho humano do erro.

LoggerCollection

Representação da lista de agentes paginado.

Nome Tipo Description
count

integer

Número total de contagem de registros em todas as páginas.
nextLink

string

Link da próxima página, se houver.
value

LoggerContract[]

Valores do agente.

LoggerContract

Detalhes do agente.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.credentials

object

O nome e o cadeia de conexão SendRule do hub de eventos para o agente do azureEventHub. Chave de instrumentação para o agente applicationInsights.
properties.description

string

Descrição do agente.
properties.isBuffered

boolean

Se os registros são armazenados em buffer no agente antes da publicação. O padrão é considerado verdadeiro.
properties.loggerType

LoggerType

Tipo de agente.
properties.resourceId

string

ID de recurso do Azure de um destino de log (recurso do Hub de Eventos do Azure ou recurso do Aplicativo Azure Insights).
type

string

Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

LoggerType

Tipo de agente.

Nome Tipo Description
applicationInsights

string

Aplicativo Azure Insights como destino de log.
azureEventHub

string

Hub de Eventos do Azure como destino de log.
azureMonitor

string

Azure Monitor