Microsoft.ApiManagement service/apis/Diagnose 2021-08-01
Bicep-Ressourcendefinition
Der Ressourcentyp service/apis/Diagnose kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen – Siehe Bereitstellungsbefehle für Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/Diagnose-Ressource zu erstellen, fügen Sie ihrer Vorlage den folgenden Bicep hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/apis/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'
}
}
Eigenschaftswerte
service/apis/diagnostics
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep. |
Zeichenfolge (erforderlich) |
| parent | In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird. Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource. |
Symbolischer Name für Ressource vom Typ: apis |
| properties | Eigenschaften des Diagnoseentitätsvertrags. | DiagnosticContractProperties |
DiagnosticContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| alwaysLog | Gibt an, für welche Art von Nachrichten Samplingeinstellungen nicht gelten sollen. | "allErrors" |
| Back-End | Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Back-End | PipelineDiagnosticSettings |
| Frontend | Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Legt das Korrelationsprotokoll fest, das für Application Insights Diagnose verwendet werden soll. | "Legacy" "Keine" "W3C" |
| logClientIp | Protokollieren Sie clientIP. Der Standardwert ist "false". | bool |
| loggerId | Ressourcen-ID einer Zielprotokollierung. | Zeichenfolge (erforderlich) |
| metrics | Geben Sie benutzerdefinierte Metriken über eine Ausgabemetrikrichtlinie aus. Gilt nur für Application Insights-Diagnoseeinstellungen. | bool |
| operationNameFormat | Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name. | "Name" "URL" |
| Sampling | Samplingeinstellungen für Diagnose. | SamplingSettings |
| Ausführlichkeit | Die Ausführlichkeitsstufe, die auf ablaufverfolgungsrichtlinien ausgegebene Ablaufverfolgungen angewendet wird. | "Fehler" "Informationen" "ausführlich" |
PipelineDiagnosticSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| request | Diagnoseeinstellungen für die Anforderung. | HttpMessageDiagnostic |
| Antwort | Diagnoseeinstellungen für die Antwort. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| body | Einstellungen für die Textprotokollierung. | BodyDiagnosticSettings |
| dataMasking | Datenmaskierungseinstellungen. | DataMasking |
| headers | Array der zu protokollierenden HTTP-Header. | string[] |
BodyDiagnosticSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Byte | Anzahl der zu protokollierenden Anforderungstextbytes. | INT |
DataMasking
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| headers | Maskierungseinstellungen für Kopfzeilen | DataMaskingEntity[] |
| queryParams | Maskierungseinstellungen für URL-Abfrageparameter | DataMaskingEntity[] |
DataMaskingEntity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Modus | Datenmaskierungsmodus. | "Ausblenden" "Maske" |
| value | Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters). | Zeichenfolge |
SamplingSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Prozentwert | Stichprobenrate für Stichprobenentnahme mit fester Rate. | INT |
| samplingType | Stichprobentyp. | "behoben" |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/apis/Diagnose kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen : Siehe Ressourcengruppenbereitstellungsbefehle
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/Diagnose-Ressource zu erstellen, fügen Sie Der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/apis/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"
}
}
Eigenschaftswerte
service/apis/diagnostics
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Ressourcentyp | "Microsoft.ApiManagement/service/apis/Diagnose" |
| apiVersion | Die Ressourcen-API-Version | '2021-08-01' |
| name | Der Ressourcenname Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen. |
Zeichenfolge (erforderlich) |
| properties | Eigenschaften des Diagnoseentitätsvertrags. | DiagnosticContractProperties |
DiagnosticContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| alwaysLog | Gibt an, für welchen Typ von Nachrichten Samplingeinstellungen nicht gelten sollen. | "allErrors" |
| Back-End | Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Back-End | PipelineDiagnosticSettings |
| Frontend | Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Legt das Korrelationsprotokoll fest, das für Application Insights Diagnose verwendet werden soll. | "Legacy" "Keine" "W3C" |
| logClientIp | Protokollieren Sie die ClientIP. Der Standardwert ist "false". | bool |
| loggerId | Ressourcen-ID einer Zielprotokollierung. | Zeichenfolge (erforderlich) |
| metrics | Geben Sie benutzerdefinierte Metriken über eine emit-Metrikrichtlinie aus. Gilt nur für Application Insights-Diagnoseeinstellungen. | bool |
| operationNameFormat | Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name. | "Name" 'URL' |
| Sampling | Samplingeinstellungen für Diagnose. | SamplingSettings |
| Ausführlichkeit | Die Ausführlichkeitsstufe, die auf ablaufverfolgungsrichtlinien ausgegebene Ablaufverfolgungen angewendet wird. | "Fehler" "Informationen" "ausführlich" |
PipelineDiagnosticSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| request | Diagnoseeinstellungen für die Anforderung. | HttpMessageDiagnostic |
| Antwort | Diagnoseeinstellungen für die Antwort. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| body | Einstellungen für die Textprotokollierung. | BodyDiagnosticSettings |
| dataMasking | Datenmaskierungseinstellungen. | DataMasking |
| headers | Array der zu protokollierenden HTTP-Header. | string[] |
BodyDiagnosticSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Byte | Anzahl der zu protokollierenden Anforderungstextbytes. | INT |
DataMasking
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| headers | Maskierungseinstellungen für Kopfzeilen | DataMaskingEntity[] |
| queryParams | Maskierungseinstellungen für URL-Abfrageparameter | DataMaskingEntity[] |
DataMaskingEntity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Modus | Datenmaskierungsmodus. | "Ausblenden" "Maske" |
| value | Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters). | Zeichenfolge |
SamplingSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Prozentwert | Rate der Stichprobenentnahme für die Stichprobenentnahme mit festem Satz. | INT |
| samplingType | Samplingtyp. | "behoben" |
Terraform-Ressourcendefinition (AzAPI-Anbieter)
Der Ressourcentyp service/apis/Diagnose kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/apis/Diagnose-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/apis/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"
}
})
}
Eigenschaftswerte
service/apis/diagnostics
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| type | Der Ressourcentyp | "Microsoft.ApiManagement/service/apis/Diagnose@2021-08-01" |
| name | Der Ressourcenname | Zeichenfolge (erforderlich) |
| parent_id | Die ID der Ressource, die das übergeordnete Element für diese Ressource ist. | ID für Ressource vom Typ apis |
| properties | Eigenschaften des Diagnoseentitätsvertrags. | DiagnosticContractProperties |
DiagnosticContractProperties
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| alwaysLog | Gibt an, für welche Art von Nachrichten Samplingeinstellungen nicht gelten sollen. | "allErrors" |
| Back-End | Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Back-End | PipelineDiagnosticSettings |
| Frontend | Diagnoseeinstellungen für eingehende/ausgehende HTTP-Nachrichten an das Gateway. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Legt das Korrelationsprotokoll fest, das für Application Insights Diagnose verwendet werden soll. | "Legacy" "None" "W3C" |
| logClientIp | Protokollieren Sie die ClientIP. Der Standardwert ist "false". | bool |
| loggerId | Ressourcen-ID einer Zielprotokollierung. | Zeichenfolge (erforderlich) |
| metrics | Geben Sie benutzerdefinierte Metriken über eine emit-Metrikrichtlinie aus. Gilt nur für Application Insights-Diagnoseeinstellungen. | bool |
| operationNameFormat | Das Format des Vorgangsnamens für Application Insights-Telemetriedaten. Der Standardwert ist Name. | "Name" "URL" |
| Sampling | Samplingeinstellungen für Diagnose. | SamplingSettings |
| Ausführlichkeit | Die Ausführlichkeitsebene, die auf Ablaufverfolgungen angewendet wird, die von Ablaufverfolgungsrichtlinien ausgegeben werden. | "Fehler" "Informationen" "ausführlich" |
PipelineDiagnosticSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| request | Diagnoseeinstellungen für die Anforderung. | HttpMessageDiagnostic |
| Antwort | Diagnoseeinstellungen für die Antwort. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| body | Einstellungen für die Textprotokollierung. | BodyDiagnosticSettings |
| dataMasking | Datenmaskierungseinstellungen. | DataMasking |
| headers | Array von zu protokollierenden HTTP-Headern. | string[] |
BodyDiagnosticSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Byte | Anzahl der zu protokollierenden Anforderungstextbytes. | INT |
DataMasking
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| headers | Maskierungseinstellungen für Kopfzeilen | DataMaskingEntity[] |
| queryParams | Maskierungseinstellungen für URL-Abfrageparameter | DataMaskingEntity[] |
DataMaskingEntity
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Modus | Datenmaskierungsmodus. | "Ausblenden" "Mask" |
| value | Der Name einer zu maskierenden Entität (z. B. ein Name eines Headers oder eines Abfrageparameters). | Zeichenfolge |
SamplingSettings
| Name | BESCHREIBUNG | Wert |
|---|---|---|
| Prozentwert | Stichprobenrate für Stichprobenentnahme mit fester Rate. | INT |
| samplingType | Stichprobentyp. | "behoben" |