Microsoft.ApiManagement service/Diagnose 2023-05-01-preview
Bicep-Ressourcendefinition
Der Ressourcentyp service/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/Diagnose-Ressource zu erstellen, fügen Sie der Vorlage die folgende Bicep-Ressource hinzu.
resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview' = {
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/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) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
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: Dienst |
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 | Rate der Stichprobenentnahme für die Stichprobenentnahme mit festem Satz. | INT |
samplingType | Samplingtyp. | "behoben" |
Schnellstartvorlagen
In den folgenden Schnellstartvorlagen wird dieser Ressourcentyp bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen API Management im internen VNET mit App Gateway |
Diese Vorlage veranschaulicht, wie Sie eine instance von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt wird. |
Application Gateway mit internen API Management und Web-App |
Application Gateway Das Weiterleiten von Internetdatenverkehr an ein virtuelles Netzwerk (interner Modus) API Management instance, welche Dienste eine Web-API in einer Azure-Web-App hostet. |
Ressourcendefinition mit einer ARM-Vorlage
Der Ressourcentyp service/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/Diagnose-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.
{
"type": "Microsoft.ApiManagement/service/diagnostics",
"apiVersion": "2023-05-01-preview",
"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/diagnostics
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Der Ressourcentyp | "Microsoft.ApiManagement/service/Diagnose" |
apiVersion | Die Version der Ressourcen-API | "2023-05-01-preview" |
name | Der Ressourcenname Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen. |
Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
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 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" "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" |
Schnellstartvorlagen
Diesen Ressourcentyp werden in den folgenden Schnellstartvorlagen bereitgestellt.
Vorlage | BESCHREIBUNG |
---|---|
Erstellen API Management im internen VNET mit App Gateway |
In dieser Vorlage wird veranschaulicht, wie Sie eine instance von Azure API Management in einem privaten Netzwerk erstellen, das durch Azure Application Gateway geschützt ist. |
Application Gateway mit internen API Management und Web-App |
Application Gateway Das Weiterleiten von Internetdatenverkehr an ein virtuelles Netzwerk (interner Modus) API Management instance welche Dienste eine Web-API in einer Azure-Web-App hostet. |
Terraform (AzAPI-Anbieter) Ressourcendefinition
Der Dienst/Diagnose-Ressourcentyp kann mit Vorgängen bereitgestellt werden, die Folgendes zum Ziel haben:
- Ressourcengruppen
Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.
Ressourcenformat
Um eine Microsoft.ApiManagement/service/Diagnose-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview"
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/diagnostics
Name | BESCHREIBUNG | Wert |
---|---|---|
type | Ressourcentyp | "Microsoft.ApiManagement/service/Diagnose@2023-05-01-preview" |
name | Der Ressourcenname | Zeichenfolge (erforderlich) Zeichenlimit: 1-80 Gültige Zeichen: Alphanumerische Zeichen und Bindestriche. Muss mit einem Buchstaben beginnen und mit einem alphanumerischen Zeichen enden. |
parent_id | Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. | ID für Ressource vom Typ: Dienst |
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" "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" "Maskierung" |
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" |