Compartir a través de


Microsoft.ApiManagement service/apis/diagnostics 2018-06-01-preview

Definición de recursos de Bicep

El tipo de recurso service/apis/diagnostics se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apis/diagnostics, agregue el siguiente bicep a la plantilla.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    enableHttpCorrelationHeaders: bool
    frontend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
  }
}

Valores de propiedad

BodyDiagnosticSettings

Nombre Descripción Valor
Bytes Número de bytes del cuerpo de la solicitud que se van a registrar. Int

Restricciones:
Valor máximo = 8192

DiagnosticContractProperties

Nombre Descripción Valor
alwaysLog Especifica para qué tipo de configuración de muestreo de mensajes no se debe aplicar. 'allErrors'
back-end Configuración de diagnóstico para los mensajes HTTP entrantes o salientes en el back-end pipelineDiagnosticSettings
enableHttpCorrelationHeaders Si se van a procesar los encabezados de correlación que llegan al servicio Api Management. Solo se aplica a los diagnósticos de Application Insights. El valor predeterminado es true. Bool
front-end Configuración de diagnóstico para los mensajes HTTP entrantes y salientes a la puerta de enlace. pipelineDiagnosticSettings
loggerId Identificador de recurso de un registrador de destino. string (obligatorio)
muestreo Configuración de muestreo para Diagnóstico. samplingSettings

HttpMessageDiagnostic

Nombre Descripción Valor
cuerpo Configuración de registro del cuerpo. BodyDiagnosticSettings
Encabezados Matriz de encabezados HTTP que se van a registrar. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.
Nombre simbólico del recurso de tipo: service/apis
Propiedades Propiedades del contrato de entidad de diagnóstico. DiagnosticContractProperties

PipelineDiagnosticSettings

Nombre Descripción Valor
pedir Configuración de diagnóstico para la solicitud. httpMessageDiagnostic
respuesta Configuración de diagnóstico para la respuesta. httpMessageDiagnostic

SamplingSettings

Nombre Descripción Valor
porcentaje Frecuencia de muestreo para el muestreo de frecuencia fija. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 100
samplingType Tipo de muestreo. 'fixed'

Definición de recursos de plantilla de ARM

El tipo de recurso service/apis/diagnostics se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apis/diagnostics, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2018-06-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "enableHttpCorrelationHeaders": "bool",
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    }
  }
}

Valores de propiedad

BodyDiagnosticSettings

Nombre Descripción Valor
Bytes Número de bytes del cuerpo de la solicitud que se van a registrar. Int

Restricciones:
Valor máximo = 8192

DiagnosticContractProperties

Nombre Descripción Valor
alwaysLog Especifica para qué tipo de configuración de muestreo de mensajes no se debe aplicar. 'allErrors'
back-end Configuración de diagnóstico para los mensajes HTTP entrantes o salientes en el back-end pipelineDiagnosticSettings
enableHttpCorrelationHeaders Si se van a procesar los encabezados de correlación que llegan al servicio Api Management. Solo se aplica a los diagnósticos de Application Insights. El valor predeterminado es true. Bool
front-end Configuración de diagnóstico para los mensajes HTTP entrantes y salientes a la puerta de enlace. pipelineDiagnosticSettings
loggerId Identificador de recurso de un registrador de destino. string (obligatorio)
muestreo Configuración de muestreo para Diagnóstico. samplingSettings

HttpMessageDiagnostic

Nombre Descripción Valor
cuerpo Configuración de registro del cuerpo. BodyDiagnosticSettings
Encabezados Matriz de encabezados HTTP que se van a registrar. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nombre Descripción Valor
apiVersion La versión de api '2018-06-01-preview'
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
Propiedades Propiedades del contrato de entidad de diagnóstico. DiagnosticContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis/diagnostics"

PipelineDiagnosticSettings

Nombre Descripción Valor
pedir Configuración de diagnóstico para la solicitud. httpMessageDiagnostic
respuesta Configuración de diagnóstico para la respuesta. httpMessageDiagnostic

SamplingSettings

Nombre Descripción Valor
porcentaje Frecuencia de muestreo para el muestreo de frecuencia fija. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 100
samplingType Tipo de muestreo. 'fixed'

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/apis/diagnostics se puede implementar con operaciones que tienen como destino:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/apis/diagnostics, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      enableHttpCorrelationHeaders = bool
      frontend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
    }
  })
}

Valores de propiedad

BodyDiagnosticSettings

Nombre Descripción Valor
Bytes Número de bytes del cuerpo de la solicitud que se van a registrar. Int

Restricciones:
Valor máximo = 8192

DiagnosticContractProperties

Nombre Descripción Valor
alwaysLog Especifica para qué tipo de configuración de muestreo de mensajes no se debe aplicar. 'allErrors'
back-end Configuración de diagnóstico para los mensajes HTTP entrantes o salientes en el back-end pipelineDiagnosticSettings
enableHttpCorrelationHeaders Si se van a procesar los encabezados de correlación que llegan al servicio Api Management. Solo se aplica a los diagnósticos de Application Insights. El valor predeterminado es true. Bool
front-end Configuración de diagnóstico para los mensajes HTTP entrantes y salientes a la puerta de enlace. pipelineDiagnosticSettings
loggerId Identificador de recurso de un registrador de destino. string (obligatorio)
muestreo Configuración de muestreo para Diagnóstico. samplingSettings

HttpMessageDiagnostic

Nombre Descripción Valor
cuerpo Configuración de registro del cuerpo. BodyDiagnosticSettings
Encabezados Matriz de encabezados HTTP que se van a registrar. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: service/apis
Propiedades Propiedades del contrato de entidad de diagnóstico. DiagnosticContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/apis/diagnostics@2018-06-01-preview"

PipelineDiagnosticSettings

Nombre Descripción Valor
pedir Configuración de diagnóstico para la solicitud. httpMessageDiagnostic
respuesta Configuración de diagnóstico para la respuesta. httpMessageDiagnostic

SamplingSettings

Nombre Descripción Valor
porcentaje Frecuencia de muestreo para el muestreo de frecuencia fija. Int

Restricciones:
Valor mínimo = 0
Valor máximo = 100
samplingType Tipo de muestreo. 'fixed'