Share via


Diagnostic - Create Or Update

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=2022-08-01

URI-parameters

Name In Vereist Type Description
diagnosticId
path True

string

Diagnostische id. Moet uniek zijn in het huidige API Management service-exemplaar.

Regex pattern: ^[^*#&+:<>?]+$

resourceGroupName
path True

string

De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.

serviceName
path True

string

De naam van de API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

De id van het doelabonnement.

api-version
query True

string

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 doellogboekregistratie.

properties.alwaysLog

AlwaysLog

Hiermee geeft u op voor welk type berichten steekproefinstellingen 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 diagnostische gegevens van Application Insights.

properties.logClientIp

boolean

Registreer de ClientIP. De standaardinstelling is onwaar.

properties.metrics

boolean

Aangepaste metrische gegevens verzenden via 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

Steekproefinstellingen 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

Headers

ETag: string

201 Created

DiagnosticContract

De diagnose is gemaakt.

Headers

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

Azure Active Directory OAuth2-stroom.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation uw gebruikersaccount imiteren

Voorbeelden

ApiManagementCreateDiagnostic

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/diagnostics/applicationinsights?api-version=2022-08-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
        }
      }
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/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
        }
      }
    }
  }
}
{
  "id": "/subscriptions/subid/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 voor welk type berichten steekproefinstellingen niet van toepassing moeten zijn.

BodyDiagnosticSettings

Instellingen voor logboekregistratie van lichamen.

DataMasking
DataMaskingEntity
DataMaskingMode

Gegevensmaskeringsmodus.

DiagnosticContract

Diagnostische gegevens.

ErrorFieldContract

Fout Veldcontract.

ErrorResponse

Foutreactie.

HttpCorrelationProtocol

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

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

Steekproefinstellingen voor Diagnostische gegevens.

SamplingType

Steekproeftype.

Verbosity

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

AlwaysLog

Hiermee geeft u op voor welk type berichten steekproefinstellingen niet van toepassing moeten zijn.

Name Type Description
allErrors

string

Meld altijd alle onjuiste aanvragen, ongeacht de steekproefinstellingen.

BodyDiagnosticSettings

Instellingen voor logboekregistratie van lichamen.

Name Type Description
bytes

integer

Aantal bytes van de aanvraagbody dat moet worden geregistreerd.

DataMasking

Name Type Description
headers

DataMaskingEntity[]

Maskeringsinstellingen voor kopteksten

queryParams

DataMaskingEntity[]

Maskeringsinstellingen voor URL-queryparameters

DataMaskingEntity

Name Type Description
mode

DataMaskingMode

Gegevensmaskeringsmodus.

value

string

De naam van een entiteit die moet worden gemaskeerd (bijvoorbeeld een naam van een header of een queryparameter).

DataMaskingMode

Gegevensmaskeringsmodus.

Name Type Description
Hide

string

De aanwezigheid van een entiteit verbergen.

Mask

string

Masker de waarde van een entiteit.

DiagnosticContract

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 voor welk type berichten steekproefinstellingen 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 diagnostische gegevens van Application Insights.

properties.logClientIp

boolean

Registreer de ClientIP. De standaardinstelling is onwaar.

properties.loggerId

string

Resource-id van een doellogboekregistratie.

properties.metrics

boolean

Aangepaste metrische gegevens verzenden via 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

Steekproefinstellingen 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'

ErrorFieldContract

Fout Veldcontract.

Name Type Description
code

string

Foutcode op eigenschapsniveau.

message

string

Door mensen leesbare weergave van fout op eigenschapsniveau.

target

string

Naam van eigenschap.

ErrorResponse

Foutreactie.

Name Type Description
error.code

string

Door de service gedefinieerde foutcode. Deze code fungeert als een substatus voor de HTTP-foutcode die is opgegeven in het antwoord.

error.details

ErrorFieldContract[]

De lijst met ongeldige velden verzenden in aanvraag, in het geval van een validatiefout.

error.message

string

Door mensen leesbare weergave van de fout.

HttpCorrelationProtocol

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

Name Type Description
Legacy

string

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

string

Lees en injecteer geen correlatieheaders.

W3C

string

Contextheaders voor traceren injecteren. Zie https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Diagnostische instellingen voor HTTP-berichten.

Name Type Description
body

BodyDiagnosticSettings

Instellingen voor logboekregistratie van lichamen.

dataMasking

DataMasking

Instellingen voor gegevensmaskering.

headers

string[]

Matrix van HTTP-headers om te registreren.

OperationNameFormat

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

Name Type Description
Name

string

API_NAME; rev=API_REVISION - OPERATION_NAME

Url

string

HTTP_VERB URL

PipelineDiagnosticSettings

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

Steekproefinstellingen voor Diagnostische gegevens.

Name Type Description
percentage

number

Frequentie van steekproeven voor steekproeven met vaste frequentie.

samplingType

SamplingType

Steekproeftype.

SamplingType

Steekproeftype.

Name Type Description
fixed

string

Steekproeven met vaste frequentie.

Verbosity

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

Name Type Description
error

string

Alleen traceringen met 'ernst' ingesteld op 'fout' worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar.

information

string

Traceringen met 'ernst' ingesteld op 'information' en 'error' worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar.

verbose

string

Alle traceringen die door traceringsbeleid worden verzonden, worden verzonden naar de logboekregistratie die is gekoppeld aan dit diagnostische exemplaar.