Condividi tramite

Servizio Microsoft.ApiManagement/diagnostica

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/diagnostics può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/diagnostics, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-09-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'
  }
}

Valori delle proprietà

service/diagnostics

Nome Descrizione Valore
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in Bicep.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
genitore In Bicep è possibile specificare la risorsa padre per una risorsa figlio. È necessario aggiungere questa proprietà solo quando la risorsa figlio viene dichiarata all'esterno della risorsa padre.

Per altre informazioni, vedere risorsa figlio all'esterno della risorsa padre.		 Nome simbolico per la risorsa di tipo: servizio
proprietà Proprietà del contratto di entità di diagnostica. DiagnosticContractProperties

DiagnosticContractProperties

Nome Descrizione Valore
alwaysLog Specifica il tipo di impostazioni di campionamento dei messaggi che non devono essere applicate. 'allErrors'
back-end Impostazioni di diagnostica per i messaggi HTTP in ingresso/in uscita nel back-end pipelineDiagnosticSettings
front-end Impostazioni di diagnostica per i messaggi HTTP in ingresso/in uscita nel gateway. pipelineDiagnosticSettings
httpCorrelationProtocol Imposta il protocollo di correlazione da usare per la diagnostica di Application Insights. 'Legacy'
'Nessuno'
'W3C'
logClientIp Registrare ClientIP. Il valore predefinito è false. Bool
loggerId ID risorsa di un logger di destinazione. stringa (obbligatorio)
Metriche Creare metriche personalizzate tramite criteri di metrica di emissione. Applicabile solo alle impostazioni di diagnostica di Application Insights. Bool
operationNameFormat Formato del nome dell'operazione per le telemetrie di Application Insights. Il valore predefinito è Name. 'Name'
'URL'
campionamento Impostazioni di campionamento per Diagnostica. SamplingSettings
prolissità Livello di dettaglio applicato alle tracce generate dai criteri di traccia. 'error'
'information'
'verbose'

PipelineDiagnosticSettings

Nome Descrizione Valore
richiesta Impostazioni di diagnostica per la richiesta. HttpMessageDiagnostic
risposta Impostazioni di diagnostica per la risposta. HttpMessageDiagnostic

HttpMessageDiagnostic

Nome Descrizione Valore
corpo Impostazioni di registrazione del corpo. BodyDiagnosticSettings
mascheramento dei dati Impostazioni di maschera dati. maschera dati
Intestazioni Matrice di intestazioni HTTP da registrare. string[]

BodyDiagnosticSettings

Nome Descrizione Valore
Byte Numero di byte del corpo della richiesta da registrare. Int

Vincoli:
Valore massimo = 8192

Maschera dati

Nome Descrizione Valore
Intestazioni Impostazioni di maschera per le intestazioni DataMaskingEntity[]
queryParams Impostazioni di maschera per i parametri di query url DataMaskingEntity[]

DataMaskingEntity

Nome Descrizione Valore
modo Modalità maschera dati. 'Nascondi'
'Mask'
valore Nome di un'entità da mascherare, ad esempio un nome di un'intestazione o di un parametro di query. corda

SamplingSettings

Nome Descrizione Valore
percentuale Frequenza di campionamento per il campionamento a frequenza fissa. Int

Vincoli:
Valore minimo = 0
Valore massimo = 100
samplingType Tipo di campionamento. 'fixed'

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma Descrizione
Creare Gestione API nella rete virtuale interna con il gateway app

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure in una rete privata protetta dal gateway applicazione di Azure.
gateway applicazione con gestione API interna e app Web

Distribuire in Azure 		Il gateway applicazione instrada il traffico Internet a un'istanza di Gestione API di rete virtuale (modalità interna) che supporta un'API Web ospitata in un'app Web di Azure.

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/diagnostics può essere distribuito con operazioni destinate a:

  • gruppi di risorse - Vedere i comandi di distribuzione del gruppo di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/diagnostics, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2023-09-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"
  }
}

Valori delle proprietà

service/diagnostics

Nome Descrizione Valore
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/diagnostics'
apiVersion Versione dell'API della risorsa '2023-09-01-preview'
nome Nome della risorsa

Vedere come impostare nomi e tipi per le risorse figlio in modelli DI Resource Manager JSON.		 stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
proprietà Proprietà del contratto di entità di diagnostica. DiagnosticContractProperties

DiagnosticContractProperties

Nome Descrizione Valore
alwaysLog Specifica il tipo di impostazioni di campionamento dei messaggi che non devono essere applicate. 'allErrors'
back-end Impostazioni di diagnostica per i messaggi HTTP in ingresso/in uscita nel back-end pipelineDiagnosticSettings
front-end Impostazioni di diagnostica per i messaggi HTTP in ingresso/in uscita nel gateway. pipelineDiagnosticSettings
httpCorrelationProtocol Imposta il protocollo di correlazione da usare per la diagnostica di Application Insights. 'Legacy'
'Nessuno'
'W3C'
logClientIp Registrare ClientIP. Il valore predefinito è false. Bool
loggerId ID risorsa di un logger di destinazione. stringa (obbligatorio)
Metriche Creare metriche personalizzate tramite criteri di metrica di emissione. Applicabile solo alle impostazioni di diagnostica di Application Insights. Bool
operationNameFormat Formato del nome dell'operazione per le telemetrie di Application Insights. Il valore predefinito è Name. 'Name'
'URL'
campionamento Impostazioni di campionamento per Diagnostica. SamplingSettings
prolissità Livello di dettaglio applicato alle tracce generate dai criteri di traccia. 'error'
'information'
'verbose'

PipelineDiagnosticSettings

Nome Descrizione Valore
richiesta Impostazioni di diagnostica per la richiesta. HttpMessageDiagnostic
risposta Impostazioni di diagnostica per la risposta. HttpMessageDiagnostic

HttpMessageDiagnostic

Nome Descrizione Valore
corpo Impostazioni di registrazione del corpo. BodyDiagnosticSettings
mascheramento dei dati Impostazioni di maschera dati. maschera dati
Intestazioni Matrice di intestazioni HTTP da registrare. string[]

BodyDiagnosticSettings

Nome Descrizione Valore
Byte Numero di byte del corpo della richiesta da registrare. Int

Vincoli:
Valore massimo = 8192

Maschera dati

Nome Descrizione Valore
Intestazioni Impostazioni di maschera per le intestazioni DataMaskingEntity[]
queryParams Impostazioni di maschera per i parametri di query url DataMaskingEntity[]

DataMaskingEntity

Nome Descrizione Valore
modo Modalità maschera dati. 'Nascondi'
'Mask'
valore Nome di un'entità da mascherare, ad esempio un nome di un'intestazione o di un parametro di query. corda

SamplingSettings

Nome Descrizione Valore
percentuale Frequenza di campionamento per il campionamento a frequenza fissa. Int

Vincoli:
Valore minimo = 0
Valore massimo = 100
samplingType Tipo di campionamento. 'fixed'

Modelli di avvio rapido

I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.

Sagoma Descrizione
Creare Gestione API nella rete virtuale interna con il gateway app

Distribuire in Azure 		Questo modello illustra come creare un'istanza di Gestione API di Azure in una rete privata protetta dal gateway applicazione di Azure.
gateway applicazione con gestione API interna e app Web

Distribuire in Azure 		Il gateway applicazione instrada il traffico Internet a un'istanza di Gestione API di rete virtuale (modalità interna) che supporta un'API Web ospitata in un'app Web di Azure.

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/diagnostics può essere distribuito con operazioni destinate a:

  • gruppi di risorse

Per un elenco delle proprietà modificate in ogni versione dell'API, vedere log delle modifiche.

Formato risorsa

Per creare una risorsa Microsoft.ApiManagement/service/diagnostics, aggiungere il codice Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/diagnostics@2023-09-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"
    }
  })
}

Valori delle proprietà

service/diagnostics

Nome Descrizione Valore
digitare Tipo di risorsa "Microsoft.ApiManagement/service/diagnostics@2023-09-01-preview"
nome Nome della risorsa stringa (obbligatorio)

Limite di caratteri: 1-80

Caratteri validi:
Caratteri alfanumerici e trattini.

Inizia con la lettera e termina con alfanumerico.
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio
proprietà Proprietà del contratto di entità di diagnostica. DiagnosticContractProperties

DiagnosticContractProperties

Nome Descrizione Valore
alwaysLog Specifica il tipo di impostazioni di campionamento dei messaggi che non devono essere applicate. "allErrors"
back-end Impostazioni di diagnostica per i messaggi HTTP in ingresso/in uscita nel back-end pipelineDiagnosticSettings
front-end Impostazioni di diagnostica per i messaggi HTTP in ingresso/in uscita nel gateway. pipelineDiagnosticSettings
httpCorrelationProtocol Imposta il protocollo di correlazione da usare per la diagnostica di Application Insights. "Legacy"
"Nessuno"
"W3C"
logClientIp Registrare ClientIP. Il valore predefinito è false. Bool
loggerId ID risorsa di un logger di destinazione. stringa (obbligatorio)
Metriche Creare metriche personalizzate tramite criteri di metrica di emissione. Applicabile solo alle impostazioni di diagnostica di Application Insights. Bool
operationNameFormat Formato del nome dell'operazione per le telemetrie di Application Insights. Il valore predefinito è Name. "Name"
"URL"
campionamento Impostazioni di campionamento per Diagnostica. SamplingSettings
prolissità Livello di dettaglio applicato alle tracce generate dai criteri di traccia. "error"
"informazioni"
"dettagliato"

PipelineDiagnosticSettings

Nome Descrizione Valore
richiesta Impostazioni di diagnostica per la richiesta. HttpMessageDiagnostic
risposta Impostazioni di diagnostica per la risposta. HttpMessageDiagnostic

HttpMessageDiagnostic

Nome Descrizione Valore
corpo Impostazioni di registrazione del corpo. BodyDiagnosticSettings
mascheramento dei dati Impostazioni di maschera dati. maschera dati
Intestazioni Matrice di intestazioni HTTP da registrare. string[]

BodyDiagnosticSettings

Nome Descrizione Valore
Byte Numero di byte del corpo della richiesta da registrare. Int

Vincoli:
Valore massimo = 8192

Maschera dati

Nome Descrizione Valore
Intestazioni Impostazioni di maschera per le intestazioni DataMaskingEntity[]
queryParams Impostazioni di maschera per i parametri di query url DataMaskingEntity[]

DataMaskingEntity

Nome Descrizione Valore
modo Modalità maschera dati. "Nascondi"
"Maschera"
valore Nome di un'entità da mascherare, ad esempio un nome di un'intestazione o di un parametro di query. corda

SamplingSettings

Nome Descrizione Valore
percentuale Frequenza di campionamento per il campionamento a frequenza fissa. Int

Vincoli:
Valore minimo = 0
Valore massimo = 100
samplingType Tipo di campionamento. "fixed"