Condividi tramite

Servizio Microsoft.ApiManagement/apis/diagnostics 2019-01-01

  • Articolo

Definizione di risorsa Bicep

Il tipo di risorsa service/apis/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/apis/diagnostics, aggiungere il bicep seguente al modello.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01' = {
  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'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Valori delle proprietà

BodyDiagnosticSettings

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

Vincoli:
Valore massimo = 8192

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
enableHttpCorrelationHeaders Indica se elaborare le intestazioni di correlazione in arrivo nel servizio Gestione API. Applicabile solo alla diagnostica di Application Insights. Il valore predefinito è true. Bool
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'
loggerId ID risorsa di un logger di destinazione. stringa (obbligatorio)
campionamento Impostazioni di campionamento per Diagnostica. SamplingSettings
prolissità Livello di dettaglio applicato alle tracce generate dai criteri di traccia. 'error'
'information'
'verbose'

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
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/API
proprietà Proprietà del contratto di entità di diagnostica. DiagnosticContractProperties

PipelineDiagnosticSettings

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

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'

Definizione di risorsa del modello di Resource Manager

Il tipo di risorsa service/apis/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/apis/diagnostics, aggiungere il codice JSON seguente al modello.

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2019-01-01",
  "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" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Valori delle proprietà

BodyDiagnosticSettings

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

Vincoli:
Valore massimo = 8192

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
enableHttpCorrelationHeaders Indica se elaborare le intestazioni di correlazione in arrivo nel servizio Gestione API. Applicabile solo alla diagnostica di Application Insights. Il valore predefinito è true. Bool
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'
loggerId ID risorsa di un logger di destinazione. stringa (obbligatorio)
campionamento Impostazioni di campionamento per Diagnostica. SamplingSettings
prolissità Livello di dettaglio applicato alle tracce generate dai criteri di traccia. 'error'
'information'
'verbose'

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

Nome Descrizione Valore
apiVersion Versione dell'API '2019-01-01'
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
proprietà Proprietà del contratto di entità di diagnostica. DiagnosticContractProperties
digitare Tipo di risorsa 'Microsoft.ApiManagement/service/apis/diagnostics'

PipelineDiagnosticSettings

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

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'

Definizione di risorsa Terraform (provider AzAPI)

Il tipo di risorsa service/apis/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/apis/diagnostics, aggiungere il file Terraform seguente al modello.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"
  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"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

Valori delle proprietà

BodyDiagnosticSettings

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

Vincoli:
Valore massimo = 8192

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
enableHttpCorrelationHeaders Indica se elaborare le intestazioni di correlazione in arrivo nel servizio Gestione API. Applicabile solo alla diagnostica di Application Insights. Il valore predefinito è true. Bool
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'
loggerId ID risorsa di un logger di destinazione. stringa (obbligatorio)
campionamento Impostazioni di campionamento per Diagnostica. SamplingSettings
prolissità Livello di dettaglio applicato alle tracce generate dai criteri di traccia. 'error'
'information'
'verbose'

HttpMessageDiagnostic

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

Microsoft.ApiManagement/service/apis/diagnostics

Nome Descrizione Valore
nome Nome della risorsa corda

Vincoli:
Lunghezza minima = 1
Lunghezza massima = 1
Pattern = ^[^*#&+:<>?]+$ (obbligatorio)
parent_id ID della risorsa padre per questa risorsa. ID per la risorsa di tipo: servizio/API
proprietà Proprietà del contratto di entità di diagnostica. DiagnosticContractProperties
digitare Tipo di risorsa "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"

PipelineDiagnosticSettings

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

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'