Servicio Microsoft.ApiManagement/diagnostics 2023-05-01-preview

• más reciente
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01

Definición de recursos de Bicep

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

• grupos de recursos: consulte comandos de implementación de grupos de recursos

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/diagnostics, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
    }
    frontend: {
      request: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        dataMasking: {
          headers: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
          queryParams: [
            {
              mode: 'string'
              value: 'string'
            }
          ]
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    logClientIp: bool
    loggerId: 'string'
    metrics: bool
    operationNameFormat: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: '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

DataMasking

Nombre	Descripción	Valor
Encabezados	Configuración de enmascaramiento de encabezados	DataMaskingEntity []
queryParams	Configuración de enmascaramiento para parámetros de consulta url	DataMaskingEntity []

DataMaskingEntity

Nombre	Descripción	Valor
modo	Modo de enmascaramiento de datos.	'Ocultar' 'Mask'
valor	Nombre de una entidad que se va a enmascarar (por ejemplo, un nombre de un encabezado o un parámetro de consulta).	cuerda

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
front-end	Configuración de diagnóstico para los mensajes HTTP entrantes y salientes a la puerta de enlace.	pipelineDiagnosticSettings
httpCorrelationProtocol	Establece el protocolo de correlación que se usará para los diagnósticos de Application Insights.	'Heredado' 'Ninguno' 'W3C'
logClientIp	Registre clientIP. El valor predeterminado es false.	Bool
loggerId	Identificador de recurso de un registrador de destino.	string (obligatorio)
Métricas	Emita métricas personalizadas a través de la directiva de métricas de emisión. Solo se aplica a la configuración de diagnóstico de Application Insights.	Bool
operationNameFormat	El formato del nombre de la operación para los datos de telemetría de Application Insights. El valor predeterminado es Name.	'Name' 'Url'
muestreo	Configuración de muestreo para Diagnóstico.	samplingSettings
verbosidad	Nivel de detalle aplicado a seguimientos emitidos por directivas de seguimiento.	'error' 'information' 'verbose'

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/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: de servicio de
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'

Ejemplos de inicio rápido

En los ejemplos de inicio rápido siguientes se implementa este tipo de recurso.

Archivo de Bicep	Descripción
Application Gateway con API Management interno y Web App	Application Gateway enruta el tráfico de Internet a una instancia de API Management de red virtual (modo interno) que proporciona servicios a una API web hospedada en una aplicación web de Azure.
Creación de API Management en una red virtual interna con App Gateway	En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.

Definición de recursos de plantilla de ARM

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

• grupos de recursos: consulte comandos de implementación de grupos de recursos

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/diagnostics, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      }
    },
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "dataMasking": {
          "headers": [
            {
              "mode": "string",
              "value": "string"
            }
          ],
          "queryParams": [
            {
              "mode": "string",
              "value": "string"
            }
          ]
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "logClientIp": "bool",
    "loggerId": "string",
    "metrics": "bool",
    "operationNameFormat": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "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

DataMasking

Nombre	Descripción	Valor
Encabezados	Configuración de enmascaramiento de encabezados	DataMaskingEntity []
queryParams	Configuración de enmascaramiento para parámetros de consulta url	DataMaskingEntity []

DataMaskingEntity

Nombre	Descripción	Valor
modo	Modo de enmascaramiento de datos.	'Ocultar' 'Mask'
valor	Nombre de una entidad que se va a enmascarar (por ejemplo, un nombre de un encabezado o un parámetro de consulta).	cuerda

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
front-end	Configuración de diagnóstico para los mensajes HTTP entrantes y salientes a la puerta de enlace.	pipelineDiagnosticSettings
httpCorrelationProtocol	Establece el protocolo de correlación que se usará para los diagnósticos de Application Insights.	'Heredado' 'Ninguno' 'W3C'
logClientIp	Registre clientIP. El valor predeterminado es false.	Bool
loggerId	Identificador de recurso de un registrador de destino.	string (obligatorio)
Métricas	Emita métricas personalizadas a través de la directiva de métricas de emisión. Solo se aplica a la configuración de diagnóstico de Application Insights.	Bool
operationNameFormat	El formato del nombre de la operación para los datos de telemetría de Application Insights. El valor predeterminado es Name.	'Name' 'Url'
muestreo	Configuración de muestreo para Diagnóstico.	samplingSettings
verbosidad	Nivel de detalle aplicado a seguimientos emitidos por directivas de seguimiento.	'error' 'information' 'verbose'

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/diagnostics

Nombre	Descripción	Valor
apiVersion	La versión de api	'2023-05-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/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'

Plantillas de inicio rápido

Las siguientes plantillas de inicio rápido implementan este tipo de recurso.

Plantilla	Descripción
Application Gateway con API Management interno y Web App	Application Gateway enruta el tráfico de Internet a una instancia de API Management de red virtual (modo interno) que proporciona servicios a una API web hospedada en una aplicación web de Azure.
Creación de API Management en una red virtual interna con App Gateway	En esta plantilla se muestra cómo crear una instancia de Azure API Management en una red privada protegida por Azure Application Gateway.

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/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/diagnostics, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
      }
      frontend = {
        request = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          dataMasking = {
            headers = [
              {
                mode = "string"
                value = "string"
              }
            ]
            queryParams = [
              {
                mode = "string"
                value = "string"
              }
            ]
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      logClientIp = bool
      loggerId = "string"
      metrics = bool
      operationNameFormat = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "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

DataMasking

Nombre	Descripción	Valor
Encabezados	Configuración de enmascaramiento de encabezados	DataMaskingEntity []
queryParams	Configuración de enmascaramiento para parámetros de consulta url	DataMaskingEntity []

DataMaskingEntity

Nombre	Descripción	Valor
modo	Modo de enmascaramiento de datos.	'Ocultar' 'Mask'
valor	Nombre de una entidad que se va a enmascarar (por ejemplo, un nombre de un encabezado o un parámetro de consulta).	cuerda

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
front-end	Configuración de diagnóstico para los mensajes HTTP entrantes y salientes a la puerta de enlace.	pipelineDiagnosticSettings
httpCorrelationProtocol	Establece el protocolo de correlación que se usará para los diagnósticos de Application Insights.	'Heredado' 'Ninguno' 'W3C'
logClientIp	Registre clientIP. El valor predeterminado es false.	Bool
loggerId	Identificador de recurso de un registrador de destino.	string (obligatorio)
Métricas	Emita métricas personalizadas a través de la directiva de métricas de emisión. Solo se aplica a la configuración de diagnóstico de Application Insights.	Bool
operationNameFormat	El formato del nombre de la operación para los datos de telemetría de Application Insights. El valor predeterminado es Name.	'Name' 'Url'
muestreo	Configuración de muestreo para Diagnóstico.	samplingSettings
verbosidad	Nivel de detalle aplicado a seguimientos emitidos por directivas de seguimiento.	'error' 'information' 'verbose'

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/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: de servicio de
Propiedades	Propiedades del contrato de entidad de diagnóstico.	DiagnosticContractProperties
tipo	El tipo de recurso	"Microsoft.ApiManagement/service/diagnostics@2023-05-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'