Diagnostic - Create Or Update

Referentie

Service:: API Management

API-versie:: 2024-05-01

Hiermee maakt u een nieuwe diagnose of werkt u een bestaande diagnose bij.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/diagnostics/{diagnosticId}?api-version=2024-05-01

URI-parameters

Name	In	Vereist	Type	Description
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Diagnostische id. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match		string	ETag van de entiteit. Niet vereist bij het maken van een entiteit, maar vereist bij het bijwerken van een entiteit.

Aanvraagbody

Name	Vereist	Type	Description
properties.loggerId	True	string	Resource-id van een doellogger.
properties.alwaysLog		AlwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.
properties.backend		PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end
properties.frontend		PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.
properties.logClientIp		boolean	Registreer de ClientIP. De standaardwaarde is onwaar.
properties.metrics		boolean	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.
properties.operationNameFormat		OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
properties.sampling		SamplingSettings	Sampling-instellingen voor Diagnostische gegevens.
properties.verbosity		Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

Antwoorden

Name	Type	Description
200 OK	DiagnosticContract	Diagnostische gegevens zijn bijgewerkt Kopteksten ETag: string
201 Created	DiagnosticContract	Diagnostische gegevens zijn gemaakt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

DiagnosticContract

Diagnostische gegevens zijn bijgewerkt

Kopteksten

ETag: string

201 Created

DiagnosticContract

Diagnostische gegevens zijn gemaakt.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateDiagnostic

Voorbeeldaanvraag

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights?api-version=2024-05-01

{
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/azuremonitor",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 50
    },
    "frontend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    },
    "backend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    }
  }
}

Voorbeeldrespons

Statuscode:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/azuremonitor",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 50
    },
    "frontend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    },
    "backend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    }
  }
}

Statuscode:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights",
  "type": "Microsoft.ApiManagement/service/diagnostics",
  "name": "applicationinsights",
  "properties": {
    "alwaysLog": "allErrors",
    "loggerId": "/loggers/applicationinsights",
    "sampling": {
      "samplingType": "fixed",
      "percentage": 50
    },
    "frontend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    },
    "backend": {
      "request": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      },
      "response": {
        "headers": [
          "Content-type"
        ],
        "body": {
          "bytes": 512
        }
      }
    }
  }
}

Definities

Name	Description
AlwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.
BodyDiagnosticSettings	Instellingen voor logboekregistratie van hoofdteksten.
DataMasking
DataMaskingEntity
DataMaskingMode	Modus voor gegevensmaskering.
DiagnosticContract	Diagnostische gegevens.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.
HttpMessageDiagnostic	Diagnostische instellingen voor HTTP-berichten.
OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
SamplingSettings	Sampling-instellingen voor Diagnostische gegevens.
SamplingType	Steekproeftype.
Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

AlwaysLog

Inventarisatie

Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.

Waarde	Description
allErrors	Registreer altijd alle onjuiste aanvragen, ongeacht de sampling-instellingen.

BodyDiagnosticSettings

Object

Instellingen voor logboekregistratie van hoofdteksten.

Name	Type	Description
bytes	integer (int32) maximum: 8192	Aantal aanvraagbodybytes dat moet worden geregistreerd.

DataMasking

Object

Name	Type	Description
headers	DataMaskingEntity[]	Maskeringsinstellingen voor kopteksten
queryParams	DataMaskingEntity[]	Maskeringsinstellingen voor URL-queryparameters

DataMaskingEntity

Object

Name	Type	Description
mode	DataMaskingMode	Modus voor gegevensmaskering.
value	string	De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).

DataMaskingMode

Inventarisatie

Modus voor gegevensmaskering.

Waarde	Description
Hide	De aanwezigheid van een entiteit verbergen.
Mask	Masker de waarde van een entiteit.

DiagnosticContract

Object

Diagnostische gegevens.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.alwaysLog	AlwaysLog	Hiermee geeft u op welk type instellingen voor het nemen van berichten niet van toepassing moeten zijn.
properties.backend	PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de back-end
properties.frontend	PipelineDiagnosticSettings	Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.
properties.logClientIp	boolean	Registreer de ClientIP. De standaardwaarde is onwaar.
properties.loggerId	string	Resource-id van een doellogger.
properties.metrics	boolean	Aangepaste metrische gegevens verzenden via het beleid voor metrische gegevens verzenden. Alleen van toepassing op diagnostische instellingen van Application Insights.
properties.operationNameFormat	OperationNameFormat	De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.
properties.sampling	SamplingSettings	Sampling-instellingen voor Diagnostische gegevens.
properties.verbosity	Verbosity	Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

HttpCorrelationProtocol

Inventarisatie

Hiermee stelt u het correlatieprotocol in dat moet worden gebruikt voor Application Insights-diagnostische gegevens.

Waarde	Description
Legacy	Injecteer Request-Id en Request-Context headers met aanvraagcorrelatiegegevens. Zie https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
None	Lees en injecteer correlatieheaders niet.
W3C	Traceringscontextheaders injecteren. Zie https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Object

Diagnostische instellingen voor HTTP-berichten.

Name	Type	Description
body	BodyDiagnosticSettings	Instellingen voor logboekregistratie van hoofdteksten.
dataMasking	DataMasking	Instellingen voor gegevensmaskering.
headers	string[]	Matrix van HTTP-headers die moeten worden vastgelegd.

OperationNameFormat

Inventarisatie

De indeling van de bewerkingsnaam voor Application Insights-telemetrieën. De standaardwaarde is Naam.

Waarde	Description
Name	API_NAME; rev=API_REVISION - OPERATION_NAME
Url	HTTP_VERB URL

PipelineDiagnosticSettings

Object

Diagnostische instellingen voor inkomende/uitgaande HTTP-berichten naar de gateway.

Name	Type	Description
request	HttpMessageDiagnostic	Diagnostische instellingen voor aanvraag.
response	HttpMessageDiagnostic	Diagnostische instellingen voor antwoord.

SamplingSettings

Object

Sampling-instellingen voor Diagnostische gegevens.

Name	Type	Description
percentage	number (double) minimum: 0 maximum: 100	De steekproeffrequentie voor steekproeven met vaste frequentie.
samplingType	SamplingType	Steekproeftype.

SamplingType

Inventarisatie

Steekproeftype.

Waarde	Description
fixed	Steekproeven met vaste snelheid.

Verbosity

Inventarisatie

Het uitgebreidheidsniveau dat wordt toegepast op traceringen die worden verzonden door traceringsbeleid.

Waarde	Description
error	Alleen traceringen waarvoor ernst is ingesteld op 'fout' worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar.
information	Traceringen met 'ernst' ingesteld op 'informatie' en 'fout' worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar.
verbose	Alle traceringen die door traceringsbeleid worden verzonden, worden verzonden naar de logger die is gekoppeld aan dit diagnostische exemplaar.

Delen via

Diagnostic - Create Or Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementCreateDiagnostic

Voorbeeldaanvraag

Voorbeeldrespons

Definities

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity

Aanvullende resources