Servizio Microsoft.ApiManagement/diagnostica 2021-08-01

Articolo
01/18/2024

Definizione di risorsa Bicep

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

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 di risorsa

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

resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2021-08-01' = {
  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
name	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep.	stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
padre	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 esterna alla risorsa padre.	Nome simbolico per la risorsa di tipo: servizio
properties	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
Frontend	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. L'impostazione predefinita è false.	bool
loggerId	ID risorsa di un logger di destinazione.	stringa (obbligatoria)
Metriche	Generare metriche personalizzate tramite criteri di metrica di emissione. Applicabile solo alle impostazioni di diagnostica di Application Insights.	bool
operationNameFormat	Formato dei dati di telemetri di Operation Name per Application Insights. Il valore predefinito è Name.	'Name' 'URL'
campionamento	Impostazioni di campionamento per Diagnostica.	CampionamentoSettings
verbosity	Livello di verbosità applicato alle tracce generate dai criteri di traccia.	'error' 'information' 'verbose'

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Nome	Descrizione	Valore
Corpo	Impostazioni di registrazione del corpo.	BodyDiagnosticSettings
dataMasking	Impostazioni di maschera dei dati.	Maschera dati
headers	Matrice di intestazioni HTTP da registrare.	string[]

BodyDiagnosticSettings

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

Maschera dati

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

DataMaskingEntity

Nome	Descrizione	Valore
mode	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.	string

CampionamentoSettings

Nome	Descrizione	Valore
percentuale	Frequenza di campionamento per il campionamento a frequenza fissa.	INT
campionamentoType	Tipo di campionamento.	'fisso'

Modelli di avvio rapido

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

Modello	Descrizione
Creare Gestione API nella rete virtuale interna con il gateway app	Questo modello illustra come creare un'istanza di Azure Gestione API in una rete privata protetta da gateway applicazione di Azure.
gateway applicazione con Gestione API e app Web interne	gateway applicazione instradare il traffico Internet a una rete virtuale (modalità interna) Gestione API'istanza che servizi un'API Web ospitata in un'app Web di Azure.

Definizione della risorsa modello di Resource Manager

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

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 di risorsa

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

{
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "apiVersion": "2021-08-01",
  "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
tipo	Tipo di risorsa	'Microsoft.ApiManagement/service/diagnostics'
apiVersion	Versione dell'API risorsa	'2021-08-01'
name	Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON.	stringa (obbligatoria) Limite di caratteri: 1-80 Caratteri validi: Caratteri alfanumerici e trattini. Inizia con la lettera e termina con alfanumerico.
properties	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
Frontend	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. L'impostazione predefinita è false.	bool
loggerId	ID risorsa di un logger di destinazione.	stringa (obbligatoria)
Metriche	Generare metriche personalizzate tramite criteri di metrica di emissione. Applicabile solo alle impostazioni di diagnostica di Application Insights.	bool
operationNameFormat	Formato dei dati di telemetri di Operation Name per Application Insights. Il valore predefinito è Name.	'Name' 'URL'
campionamento	Impostazioni di campionamento per Diagnostica.	CampionamentoSettings
verbosity	Livello di verbosità applicato alle tracce generate dai criteri di traccia.	'error' 'information' 'verbose'

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Nome	Descrizione	Valore
Corpo	Impostazioni di registrazione del corpo.	BodyDiagnosticSettings
dataMasking	Impostazioni di maschera dei dati.	Maschera dati
headers	Matrice di intestazioni HTTP da registrare.	string[]

BodyDiagnosticSettings

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

Maschera dati

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

DataMaskingEntity

Nome	Descrizione	Valore
mode	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.	string

CampionamentoSettings

Nome	Descrizione	Valore
percentuale	Frequenza di campionamento per il campionamento a frequenza fissa.	INT
campionamentoType	Tipo di campionamento.	'fisso'

Modelli di avvio rapido

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

Modello	Descrizione
Creare Gestione API nella rete virtuale interna con il gateway app	Questo modello illustra come creare un'istanza di Azure Gestione API in una rete privata protetta da gateway applicazione di Azure.
gateway applicazione con Gestione API e app Web interne	gateway applicazione instradare il traffico Internet a una rete virtuale (modalità interna) Gestione API'istanza che servizi un'API Web ospitata in un'app Web di Azure.

Definizione della risorsa Terraform (provider AzAPI)

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

Gruppi di risorse

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

Formato di 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@2021-08-01"
  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
tipo	Tipo di risorsa	"Microsoft.ApiManagement/service/diagnostics@2021-08-01"
name	Nome della risorsa	stringa (obbligatoria) 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
properties	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
Frontend	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" "None" "W3C"
logClientIp	Registrare clientIP. L'impostazione predefinita è false.	bool
loggerId	ID risorsa di un logger di destinazione.	stringa (obbligatoria)
Metriche	Generare metriche personalizzate tramite criteri di metrica di emissione. Applicabile solo alle impostazioni di diagnostica di Application Insights.	bool
operationNameFormat	Formato dei dati di telemetri di Operation Name per Application Insights. Il valore predefinito è Name.	"Nome" "Url"
campionamento	Impostazioni di campionamento per Diagnostica.	CampionamentoSettings
verbosity	Livello di verbosità applicato alle tracce generate dai criteri di traccia.	"errore" "informazioni" "dettagliato"

PipelineDiagnosticSettings

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

HttpMessageDiagnostic

Nome	Descrizione	Valore
Corpo	Impostazioni di registrazione del corpo.	BodyDiagnosticSettings
dataMasking	Impostazioni di maschera dei dati.	Maschera dati
headers	Matrice di intestazioni HTTP da registrare.	string[]

BodyDiagnosticSettings

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

Maschera dati

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

DataMaskingEntity

Nome	Descrizione	Valore
mode	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.	string

CampionamentoSettings

Nome	Descrizione	Valore
percentuale	Frequenza di campionamento per il campionamento a frequenza fissa.	INT
campionamentoType	Tipo di campionamento.	"correzione"

Condividi tramite

Servizio Microsoft.ApiManagement/diagnostica 2021-08-01

Definizione di risorsa Bicep

Formato di risorsa

Valori delle proprietà

service/diagnostics

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

Maschera dati

DataMaskingEntity

CampionamentoSettings

Modelli di avvio rapido

Definizione della risorsa modello di Resource Manager

Formato di risorsa

Valori delle proprietà

service/diagnostics

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

Maschera dati

DataMaskingEntity

CampionamentoSettings

Modelli di avvio rapido

Definizione della risorsa Terraform (provider AzAPI)

Formato di risorsa

Valori delle proprietà

service/diagnostics

DiagnosticContractProperties

PipelineDiagnosticSettings

HttpMessageDiagnostic

BodyDiagnosticSettings

Maschera dati

DataMaskingEntity

CampionamentoSettings

Risorse aggiuntive