Diagnostic - Create Or Update

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Tworzy nową diagnostykę lub aktualizuje istniejącą.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
diagnosticId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	Identyfikator diagnostyczny. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match		string	Element ETag jednostki. Nie jest to wymagane podczas tworzenia jednostki, ale wymagane podczas aktualizowania jednostki.

Treść żądania

Nazwa	Wymagane	Typ	Opis
properties.loggerId	True	string	Identyfikator zasobu docelowego rejestratora.
properties.alwaysLog		AlwaysLog	Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.
properties.backend		PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do zaplecza
properties.frontend		PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.
properties.httpCorrelationProtocol		HttpCorrelationProtocol	Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.
properties.logClientIp		boolean	Rejestrowanie elementu ClientIP. Wartość domyślna to false.
properties.metrics		boolean	Emituj metryki niestandardowe za pomocą zasad emisji metryk. Dotyczy tylko ustawień diagnostycznych usługi Application Insights.
properties.operationNameFormat		OperationNameFormat	Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.
properties.sampling		SamplingSettings	Ustawienia próbkowania dla diagnostyki.
properties.verbosity		Verbosity	Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	DiagnosticContract	Pomyślnie zaktualizowano diagnostykę Nagłówki ETag: string
201 Created	DiagnosticContract	Diagnostyka została pomyślnie utworzona. Nagłówki ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

DiagnosticContract

Pomyślnie zaktualizowano diagnostykę

Nagłówki

ETag: string

201 Created

DiagnosticContract

Diagnostyka została pomyślnie utworzona.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementCreateDiagnostic

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
        }
      }
    }
  }
}

Kod stanu:: 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
        }
      }
    }
  }
}

Definicje

Nazwa	Opis
AlwaysLog	Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.
BodyDiagnosticSettings	Ustawienia rejestrowania treści.
DataMasking
DataMaskingEntity
DataMaskingMode	Tryb maskowania danych.
DiagnosticContract	Szczegóły diagnostyczne.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
HttpCorrelationProtocol	Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.
HttpMessageDiagnostic	Ustawienia diagnostyczne komunikatu HTTP.
OperationNameFormat	Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.
PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.
SamplingSettings	Ustawienia próbkowania dla diagnostyki.
SamplingType	Typ próbkowania.
Verbosity	Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia.

AlwaysLog

Wyliczanie

Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.

Wartość	Opis
allErrors	Zawsze rejestruj wszystkie błędne żądanie niezależnie od ustawień próbkowania.

BodyDiagnosticSettings

Objekt

Ustawienia rejestrowania treści.

Nazwa	Typ	Opis
bytes	integer (int32) maximum: 8192	Liczba bajtów treści żądania do zarejestrowania.

DataMasking

Objekt

Nazwa	Typ	Opis
headers	DataMaskingEntity[]	Ustawienia maskowania nagłówków
queryParams	DataMaskingEntity[]	Ustawienia maskowania parametrów zapytania adresu URL

DataMaskingEntity

Objekt

Nazwa	Typ	Opis
mode	DataMaskingMode	Tryb maskowania danych.
value	string	Nazwa jednostki do maskowania (np. nazwa nagłówka lub parametru zapytania).

DataMaskingMode

Wyliczanie

Tryb maskowania danych.

Wartość	Opis
Mask	Maskuj wartość jednostki.
Hide	Ukryj obecność jednostki.

DiagnosticContract

Objekt

Szczegóły diagnostyczne.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Przykład - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.alwaysLog	AlwaysLog	Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane.
properties.backend	PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do zaplecza
properties.frontend	PipelineDiagnosticSettings	Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.
properties.httpCorrelationProtocol	HttpCorrelationProtocol	Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.
properties.logClientIp	boolean	Rejestrowanie elementu ClientIP. Wartość domyślna to false.
properties.loggerId	string	Identyfikator zasobu docelowego rejestratora.
properties.metrics	boolean	Emituj metryki niestandardowe za pomocą zasad emisji metryk. Dotyczy tylko ustawień diagnostycznych usługi Application Insights.
properties.operationNameFormat	OperationNameFormat	Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.
properties.sampling	SamplingSettings	Ustawienia próbkowania dla diagnostyki.
properties.verbosity	Verbosity	Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

HttpCorrelationProtocol

Wyliczanie

Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights.

Wartość	Opis
None	Nie odczytuj i wstrzykiwaj nagłówki korelacji.
Legacy	Wstrzykiwanie nagłówków Request-Id i Request-Context z danymi korelacji żądań. Zobacz https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.
W3C	Wstrzykiwanie nagłówków kontekstu śledzenia. Zobacz https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Objekt

Ustawienia diagnostyczne komunikatu HTTP.

Nazwa	Typ	Opis
body	BodyDiagnosticSettings	Ustawienia rejestrowania treści.
dataMasking	DataMasking	Ustawienia maskowania danych.
headers	string[]	Tablica nagłówków HTTP do rejestrowania.

OperationNameFormat

Wyliczanie

Format nazwy operacji dla telemetrii usługi Application Insights. Wartość domyślna to Nazwa.

Wartość	Opis
Name	API_NAME; rev=API_REVISION — OPERATION_NAME
Url	HTTP_VERB URL

PipelineDiagnosticSettings

Objekt

Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy.

Nazwa	Typ	Opis
request	HttpMessageDiagnostic	Ustawienia diagnostyczne dla żądania.
response	HttpMessageDiagnostic	Ustawienia diagnostyczne odpowiedzi.

SamplingSettings

Objekt

Ustawienia próbkowania dla diagnostyki.

Nazwa	Typ	Opis
percentage	number (double) minimum: 0 maximum: 100	Częstotliwość próbkowania dla próbkowania o stałej szybkości.
samplingType	SamplingType	Typ próbkowania.

SamplingType

Wyliczanie

Typ próbkowania.

Wartość	Opis
fixed	Próbkowanie o stałej szybkości.

Verbosity

Wyliczanie

Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia.

Wartość	Opis
verbose	Wszystkie ślady emitowane przez zasady śledzenia zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.
information	Ślady z ustawioną ważnością na wartość "information" i "error" zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.
error	Do rejestratora dołączonego do tego wystąpienia diagnostycznego będą wysyłane tylko ślady z ustawioną ważnością na wartość "error".

Udostępnij przez

Diagnostic - Create Or Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementCreateDiagnostic

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AlwaysLog

BodyDiagnosticSettings

DataMasking

DataMaskingEntity

DataMaskingMode

DiagnosticContract

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

HttpCorrelationProtocol

HttpMessageDiagnostic

OperationNameFormat

PipelineDiagnosticSettings

SamplingSettings

SamplingType

Verbosity