Workspace Logger - Get

Servicio:

API Management

Versión de la API:

2024-05-01

Obtiene los detalles del registrador especificado por su identificador.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}/loggers/{loggerId}?api-version=2024-05-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
loggerId	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	Identificador del registrador. Debe ser único en la instancia del servicio API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
workspaceId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identificador del área de trabajo. Debe ser único en la instancia actual del servicio API Management.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Respuestas

Nombre	Tipo	Description
200 OK	LoggerContract	El cuerpo de la respuesta contiene la entidad Registrador especificada. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementGetWorkspaceLogger

Solicitud de ejemplo

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/templateLogger?api-version=2024-05-01

Respuesta de muestra

status code:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/workspaces/wks1/loggers/kloudapilogger1",
  "type": "Microsoft.ApiManagement/service/workspaces/loggers",
  "name": "kloudapilogger1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "testeventhub3again",
    "credentials": {
      "name": "testeventhub4",
      "connectionString": "Endpoint=sb://eventhubapim.servicebus.windows.net/;SharedAccessKeyName=Sender;SharedAccessKey=************"
    },
    "isBuffered": true,
    "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.EventHub/namespaces/eventhubapim"
  }
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
LoggerContract	Detalles del registrador.
LoggerType	Tipo de registrador.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

LoggerContract

Object

Detalles del registrador.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.credentials	object	El nombre y la cadena de conexión SendRule del centro de eventos para el registrador de azureEventHub. Clave de instrumentación para el registrador applicationInsights.
properties.description	string maxLength: 256	Descripción del registrador.
properties.isBuffered	boolean	Si los registros se almacenan en búfer en el registrador antes de publicarlos. Se supone que el valor predeterminado es true.
properties.loggerType	LoggerType	Tipo de registrador.
properties.resourceId	string	Identificador de recurso de Azure de un destino de registro (recurso de Azure Event Hubs o recurso de Azure Application Insights).
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

LoggerType

Enumeración

Tipo de registrador.

Valor	Description
applicationInsights	Azure Application Insights como destino de registro.
azureEventHub	Centro de eventos de Azure como destino de registro.
azureMonitor	Azure Monitor