Servicio Microsoft.ApiManagement/diagnostics
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 los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
Para crear un recurso Microsoft.ApiManagement/service/diagnostics, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
alwaysLog: 'allErrors'
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: 'fixed'
}
verbosity: 'string'
}
}
Valores de propiedad
service/diagnostics
| Nombre | Descripción | Value |
|---|---|---|
| name | El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| primario | 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 más información, consulte Recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: servicio |
| properties | Propiedades del contrato de entidad de diagnóstico. | DiagnosticContractProperties |
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 |
| Frontend | Configuración de diagnóstico para los mensajes HTTP entrantes o 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 |
| detalle | Nivel de detalle aplicado a los seguimientos emitidos por las directivas de seguimiento. | 'error' 'information' 'verbose' |
PipelineDiagnosticSettings
| Nombre | Descripción | Valor |
|---|---|---|
| request | Configuración de diagnóstico para la solicitud. | HttpMessageDiagnostic |
| respuesta | Configuración de diagnóstico para la respuesta. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Nombre | Descripción | Valor |
|---|---|---|
| body | Configuración de registro del cuerpo. | BodyDiagnosticSettings |
| dataMasking | Configuración de enmascaramiento de datos. | DataMasking |
| headers | Matriz de encabezados HTTP que se van a registrar. | string[] |
BodyDiagnosticSettings
| Nombre | Descripción | Valor |
|---|---|---|
| bytes | Número de bytes del cuerpo de la solicitud que se van a registrar. | int |
DataMasking
| Nombre | Descripción | Valor |
|---|---|---|
| headers | Configuración de enmascaramiento para encabezados | DataMaskingEntity[] |
| queryParams | Configuración de enmascaramiento para parámetros de consulta url | DataMaskingEntity[] |
DataMaskingEntity
| Nombre | Descripción | Valor |
|---|---|---|
| mode | Modo de enmascaramiento de datos. | 'Ocultar' 'Máscara' |
| value | Nombre de una entidad que se va a enmascarar (por ejemplo, un nombre de un encabezado o un parámetro de consulta). | string |
SamplingSettings
| Nombre | Descripción | Valor |
|---|---|---|
| percentage | Frecuencia de muestreo para muestreo de frecuencia fija. | int |
| 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 |
|---|---|
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. |
| Application Gateway con API Management internos y aplicación web |
Application Gateway enrutar el tráfico de Internet a una red virtual (modo interno) API Management instancia que atiende una API web hospedada en una aplicación web de Azure. |
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 los comandos de implementación del grupo de recursos.
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
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": "allErrors",
"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": "fixed"
},
"verbosity": "string"
}
}
Valores de propiedad
service/diagnostics
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/diagnostics" |
| apiVersion | La versión de la API de recursos | "2023-05-01-preview" |
| name | El nombre del recurso Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json. |
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| properties | Propiedades del contrato de entidad de diagnóstico. | DiagnosticContractProperties |
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 |
| Frontend | Configuración de diagnóstico para los mensajes HTTP entrantes o 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 |
| detalle | Nivel de detalle aplicado a los seguimientos emitidos por las directivas de seguimiento. | 'error' 'information' 'verbose' |
PipelineDiagnosticSettings
| Nombre | Descripción | Valor |
|---|---|---|
| request | Configuración de diagnóstico para la solicitud. | HttpMessageDiagnostic |
| respuesta | Configuración de diagnóstico para la respuesta. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Nombre | Descripción | Valor |
|---|---|---|
| body | Configuración de registro del cuerpo. | BodyDiagnosticSettings |
| dataMasking | Configuración de enmascaramiento de datos. | DataMasking |
| headers | Matriz de encabezados HTTP que se van a registrar. | string[] |
BodyDiagnosticSettings
| Nombre | Descripción | Valor |
|---|---|---|
| bytes | Número de bytes del cuerpo de la solicitud que se van a registrar. | int |
DataMasking
| Nombre | Descripción | Valor |
|---|---|---|
| headers | Configuración de enmascaramiento para encabezados | DataMaskingEntity[] |
| queryParams | Configuración de enmascaramiento para parámetros de consulta url | DataMaskingEntity[] |
DataMaskingEntity
| Nombre | Descripción | Valor |
|---|---|---|
| mode | Modo de enmascaramiento de datos. | 'Ocultar' 'Máscara' |
| value | Nombre de una entidad que se va a enmascarar (por ejemplo, un nombre de un encabezado o un parámetro de consulta). | string |
SamplingSettings
| Nombre | Descripción | Valor |
|---|---|---|
| percentage | Frecuencia de muestreo para muestreo de frecuencia fija. | int |
| 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 |
|---|---|
| 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. |
| Application Gateway con API Management internos y aplicación web |
Application Gateway enrutar el tráfico de Internet a una red virtual (modo interno) API Management instancia que atiende una API web hospedada en una aplicación web de Azure. |
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
Para obtener una lista de las propiedades modificadas en cada versión de api, consulte registro de cambios.
Formato de los recursos
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"
parent_id = "string"
body = jsonencode({
properties = {
alwaysLog = "allErrors"
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 = "fixed"
}
verbosity = "string"
}
})
}
Valores de propiedad
service/diagnostics
| Nombre | Descripción | Value |
|---|---|---|
| type | Tipo de recurso | "Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview" |
| name | El nombre del recurso | string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico. |
| parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: servicio |
| properties | Propiedades del contrato de entidad de diagnóstico. | DiagnosticContractProperties |
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 mensajes HTTP entrantes o salientes en el back-end | PipelineDiagnosticSettings |
| Frontend | Configuración de diagnóstico para los mensajes HTTP entrantes o salientes en la puerta de enlace. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Establece el protocolo de correlación que se va a usar para el diagnóstico de Application Insights. | "Heredado" "None" "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étrica de emisión. Solo se aplica a la configuración de diagnóstico de Application Insights. | bool |
| operationNameFormat | Formato del nombre de la operación para los datos de telemetría de Application Insights. El valor predeterminado es Name. | "Nombre" "Url" |
| muestreo | Configuración de muestreo para Diagnóstico. | SamplingSettings |
| detalle | Nivel de detalle aplicado a los seguimientos emitidos por las directivas de seguimiento. | "error" "información" "detallado" |
PipelineDiagnosticSettings
| Nombre | Descripción | Valor |
|---|---|---|
| request | Configuración de diagnóstico para la solicitud. | HttpMessageDiagnostic |
| respuesta | Configuración de diagnóstico para la respuesta. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Nombre | Descripción | Valor |
|---|---|---|
| body | Configuración de registro del cuerpo. | BodyDiagnosticSettings |
| dataMasking | Configuración de enmascaramiento de datos. | DataMasking |
| headers | Matriz de encabezados HTTP que se van a registrar. | string[] |
BodyDiagnosticSettings
| Nombre | Descripción | Valor |
|---|---|---|
| bytes | Número de bytes del cuerpo de la solicitud que se van a registrar. | int |
DataMasking
| Nombre | Descripción | Valor |
|---|---|---|
| headers | Configuración de enmascaramiento de encabezados | DataMaskingEntity[] |
| queryParams | Configuración de enmascaramiento para parámetros de consulta url | DataMaskingEntity[] |
DataMaskingEntity
| Nombre | Descripción | Valor |
|---|---|---|
| mode | Modo de enmascaramiento de datos. | "Ocultar" "Máscara" |
| value | Nombre de una entidad que se va a enmascarar (por ejemplo, un nombre de un encabezado o un parámetro de consulta). | string |
SamplingSettings
| Nombre | Descripción | Valor |
|---|---|---|
| percentage | Frecuencia de muestreo para muestreo de frecuencia fija. | int |
| samplingType | Tipo de muestreo. | "fijo" |
Comentarios
Próximamente: A lo largo de 2024 iremos eliminando gradualmente GitHub Issues como mecanismo de comentarios sobre el contenido y lo sustituiremos por un nuevo sistema de comentarios. Para más información, vea: https://aka.ms/ContentUserFeedback.
Enviar y ver comentarios de