Diagnostic - Create Or Update

Szolgáltatás:: API Management

API-verzió:: 2024-05-01

Létrehoz egy új diagnosztikát, vagy frissít egy meglévőt.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Diagnosztikai azonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match		string	Az entitás ETagje. Entitás létrehozásakor nem kötelező, de egy entitás frissítésekor kötelező.

Kérelem törzse

Name	Kötelező	Típus	Description
properties.loggerId	True	string	A célnaplózó erőforrás-azonosítója.
properties.alwaysLog		AlwaysLog	Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai ne legyenek érvényesek.
properties.backend		PipelineDiagnosticSettings	Diagnosztikai beállítások a háttérrendszerbe érkező/kimenő HTTP-üzenetekhez
properties.frontend		PipelineDiagnosticSettings	Diagnosztikai beállítások az átjáróba irányuló bejövő/kimenő HTTP-üzenetekhez.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Beállítja az Application Insights-diagnosztikához használandó korrelációs protokollt.
properties.logClientIp		boolean	Naplózza a ClientIP-t. Az alapértelmezett érték hamis.
properties.metrics		boolean	Egyéni metrikák kibocsátása kibocsátó metrikaszabályzaton keresztül. Csak az Application Insights diagnosztikai beállításaira alkalmazható.
properties.operationNameFormat		OperationNameFormat	Az Application Insights telemetriai műveletnevének formátuma. Az alapértelmezett név a Név.
properties.sampling		SamplingSettings	Mintavételezési beállítások a diagnosztika számára.
properties.verbosity		Verbosity	A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint.

Válaszok

Name	Típus	Description
200 OK	DiagnosticContract	A diagnosztika sikeresen frissítve Fejlécek ETag: string
201 Created	DiagnosticContract	A diagnosztikát sikeresen létrehozták. Fejlécek ETag: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Name

Típus

Description

200 OK

DiagnosticContract

A diagnosztika sikeresen frissítve

Fejlécek

ETag: string

201 Created

DiagnosticContract

A diagnosztikát sikeresen létrehozták.

Fejlécek

ETag: string

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory Oauth2-folyamat.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementCreateDiagnostic

Mintakérelem

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
        }
      }
    }
  }
}

Mintaválasz

Állapotkód:: 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
        }
      }
    }
  }
}

Állapotkód:: 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
        }
      }
    }
  }
}

Definíciók

Name	Description
AlwaysLog	Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai ne legyenek érvényesek.
BodyDiagnosticSettings	Törzsnaplózási beállítások.
DataMasking
DataMaskingEntity
DataMaskingMode	Adatmaszkolás mód.
DiagnosticContract	Diagnosztikai adatok.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
HttpCorrelationProtocol	Beállítja az Application Insights-diagnosztikához használandó korrelációs protokollt.
HttpMessageDiagnostic	Http-üzenet diagnosztikai beállításai.
OperationNameFormat	Az Application Insights telemetriai műveletnevének formátuma. Az alapértelmezett név a Név.
PipelineDiagnosticSettings	Diagnosztikai beállítások az átjáróba irányuló bejövő/kimenő HTTP-üzenetekhez.
SamplingSettings	Mintavételezési beállítások a diagnosztika számára.
SamplingType	Mintavételezési típus.
Verbosity	A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint.

AlwaysLog

Enumerálás

Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai ne legyenek érvényesek.

Érték	Description
allErrors	A mintavételezési beállításoktól függetlenül mindig naplózza az összes hibás kérést.

BodyDiagnosticSettings

Objektum

Törzsnaplózási beállítások.

Name	Típus	Description
bytes	integer (int32) maximum: 8192	A naplózandó kérelem törzsbájtjainak száma.

DataMasking

Objektum

Name	Típus	Description
headers	DataMaskingEntity[]	Fejlécek maszkolásának beállításai
queryParams	DataMaskingEntity[]	Az URL-lekérdezés paramétereinek maszkolási beállításai

DataMaskingEntity

Objektum

Name	Típus	Description
mode	DataMaskingMode	Adatmaszkolás mód.
value	string	A maszkolandó entitás neve (például egy fejléc vagy egy lekérdezési paraméter neve).

DataMaskingMode

Enumerálás

Adatmaszkolás mód.

Érték	Description
Mask	Egy entitás értékének maszkolása.
Hide	Entitás jelenlétének elrejtése.

DiagnosticContract

Objektum

Diagnosztikai adatok.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.alwaysLog	AlwaysLog	Meghatározza, hogy milyen típusú üzenetek mintavételezési beállításai ne legyenek érvényesek.
properties.backend	PipelineDiagnosticSettings	Diagnosztikai beállítások a háttérrendszerbe érkező/kimenő HTTP-üzenetekhez
properties.frontend	PipelineDiagnosticSettings	Diagnosztikai beállítások az átjáróba irányuló bejövő/kimenő HTTP-üzenetekhez.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Beállítja az Application Insights-diagnosztikához használandó korrelációs protokollt.
properties.logClientIp	boolean	Naplózza a ClientIP-t. Az alapértelmezett érték hamis.
properties.loggerId	string	A célnaplózó erőforrás-azonosítója.
properties.metrics	boolean	Egyéni metrikák kibocsátása kibocsátó metrikaszabályzaton keresztül. Csak az Application Insights diagnosztikai beállításaira alkalmazható.
properties.operationNameFormat	OperationNameFormat	Az Application Insights telemetriai műveletnevének formátuma. Az alapértelmezett név a Név.
properties.sampling	SamplingSettings	Mintavételezési beállítások a diagnosztika számára.
properties.verbosity	Verbosity	A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

HttpCorrelationProtocol

Enumerálás

Beállítja az Application Insights-diagnosztikához használandó korrelációs protokollt.

Érték	Description
None	Ne olvassa be és ne szúrja be a korrelációs fejléceket.
Legacy	Szúrja be Request-Id és Request-Context fejléceket a kérelem korrelációs adataival. Lásd: https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
W3C	Nyomkövetési környezet fejléceinek beszúrása. Lásd: https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Objektum

Http-üzenet diagnosztikai beállításai.

Name	Típus	Description
body	BodyDiagnosticSettings	Törzsnaplózási beállítások.
dataMasking	DataMasking	Adatmaszkolás beállításai.
headers	string[]	A naplózandó HTTP-fejlécek tömbje.

OperationNameFormat

Enumerálás

Az Application Insights telemetriai műveletnevének formátuma. Az alapértelmezett név a Név.

Érték	Description
Name	API_NAME; rev=API_REVISION – OPERATION_NAME
Url	HTTP_VERB URL-címe

PipelineDiagnosticSettings

Objektum

Diagnosztikai beállítások az átjáróba irányuló bejövő/kimenő HTTP-üzenetekhez.

Name	Típus	Description
request	HttpMessageDiagnostic	Diagnosztikai beállítások a kéréshez.
response	HttpMessageDiagnostic	Diagnosztikai beállítások a válaszhoz.

SamplingSettings

Objektum

Mintavételezési beállítások a diagnosztika számára.

Name	Típus	Description
percentage	number (double) minimum: 0 maximum: 100	Rögzített sebességű mintavételezés mintavételezési sebessége.
samplingType	SamplingType	Mintavételezési típus.

SamplingType

Enumerálás

Mintavételezési típus.

Érték	Description
fixed	Rögzített gyakoriságú mintavételezés.

Verbosity

Enumerálás

A nyomkövetési szabályzatok által kibocsátott nyomkövetésekre alkalmazott részletességi szint.

Érték	Description
verbose	A nyomkövetési szabályzatok által kibocsátott összes nyomkövetést a rendszer elküldi a diagnosztikai példányhoz csatolt naplózónak.
information	Az "információ" és a "hiba" értékű "súlyosságú" nyomkövetéseket a rendszer elküldi a diagnosztikai példányhoz csatolt naplózónak.
error	A rendszer csak a "súlyosság" beállítású nyomkövetéseket küldi el a diagnosztikai példányhoz csatolt naplózónak.