Servizio Microsoft.ApiManagement/apis/diagnostics 2022-08-01
Definizione di risorsa Bicep
Il tipo di risorsa service/apis/diagnostics può essere distribuito con operazioni destinate:
- Gruppi di risorse - Vedere i comandi di distribuzione dei 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/apis/diagnostics, aggiungere il bicep seguente al modello.
resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2022-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/apis/diagnostics
Nome | Descrizione | valore |
---|---|---|
name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio in Bicep. |
stringa (obbligatorio) |
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: apis |
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 al 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 (obbligatorio) |
Metriche | Generare metriche personalizzate tramite criteri di generazione e metrica. 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 |
verbosity | 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 |
response | Impostazioni di diagnostica per la risposta. | HttpMessageDiagnostic |
HttpMessageDiagnostic
Nome | Descrizione | Valore |
---|---|---|
Corpo | Impostazioni di registrazione del corpo. | BodyDiagnosticSettings |
dataMasking | Impostazioni di maschera 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' |
Definizione della risorsa modello di Resource Manager
Il tipo di risorsa service/apis/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/apis/diagnostics, aggiungere il codice JSON seguente al modello.
{
"type": "Microsoft.ApiManagement/service/apis/diagnostics",
"apiVersion": "2022-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/apis/diagnostics
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di risorsa | 'Microsoft.ApiManagement/service/apis/diagnostics' |
apiVersion | Versione dell'API risorsa | '2022-08-01' |
name | Nome della risorsa Vedere come impostare nomi e tipi per le risorse figlio nei modelli di RESOURCE JSON. |
stringa (obbligatoria) |
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 dettaglio 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 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 | Mascheramento delle 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 |
SamplingSettings
Nome | Descrizione | Valore |
---|---|---|
percentuale | Frequenza di campionamento per il campionamento a frequenza fissa. | INT |
samplingType | Tipo di campionamento. | 'fixed' |
Definizione della risorsa Terraform (provider AzAPI)
Il tipo di risorsa service/apis/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/apis/diagnostics, aggiungere il codice Terraform seguente al modello.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/diagnostics@2022-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/apis/diagnostics
Nome | Descrizione | Valore |
---|---|---|
tipo | Tipo di risorsa | "Microsoft.ApiManagement/service/apis/diagnostics@2022-08-01" |
name | Nome della risorsa | stringa (obbligatorio) |
parent_id | ID della risorsa padre per questa risorsa. | ID per la risorsa di tipo: api |
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" |