Servizio Microsoft.ApiManagement/diagnostica 2019-01-01
- più recenti
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
-
09-09-2022 - 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
Definizione di risorsa Bicep
Il tipo di risorsa service/diagnostics può essere distribuito con operazioni destinate a:
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@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/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 |
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' |
Esempi di avvio rapido
Gli esempi di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Bicep File | Descrizione |
---|---|
gateway applicazione con gestione API interna e app Web | 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. |
Creare Gestione API nella rete virtuale interna con il gateway app | Questo modello illustra come creare un'istanza di Gestione API di Azure in una rete privata protetta dal gateway applicazione di Azure. |
Definizione di risorsa del modello di Resource Manager
Il tipo di risorsa service/diagnostics può essere distribuito con operazioni destinate a:
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": "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/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/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' |
Modelli di avvio rapido
I modelli di avvio rapido seguenti distribuiscono questo tipo di risorsa.
Sagoma | Descrizione |
---|---|
gateway applicazione con gestione API interna e app Web |
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. |
Creare Gestione API nella rete virtuale interna con il gateway app |
Questo modello illustra come creare un'istanza di Gestione API di Azure in una rete privata protetta dal gateway applicazione 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@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/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 |
proprietà | Proprietà del contratto di entità di diagnostica. | DiagnosticContractProperties |
digitare | Tipo di risorsa | "Microsoft.ApiManagement/service/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' |