Diagnostic - Create Or Update

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
diagnosticId
path True

string

Identyfikator diagnostyczny. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

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

resourceGroupName
path True

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName
path True

string

Nazwa usługi API Management.

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

subscriptionId
path True

string

Identyfikator subskrypcji docelowej.

api-version
query True

string

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
If-Match

string

ETag jednostki. Nie jest 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, który ma być używany do diagnostyki usługi Application Insights.

properties.logClientIp

boolean

Zarejestruj element ClientIP. Wartość domyślna to false.

properties.metrics

boolean

Emituj metryki niestandardowe za pomocą zasad metryki emitowania. Dotyczy tylko ustawień diagnostycznych usługi Application Insights.

properties.operationNameFormat

OperationNameFormat

Format nazwy operacji 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ę

Headers

ETag: string

201 Created

DiagnosticContract

Diagnostyka została pomyślnie utworzona.

Headers

ETag: string

Other Status Codes

ErrorResponse

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

Zabezpieczenia

azure_auth

Przepływ OAuth2 usługi Azure Active Directory.

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

Scopes

Nazwa Opis
user_impersonation personifikacja konta użytkownika

Przykłady

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

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.

ErrorFieldContract

Błąd Kontrakt pola.

ErrorResponse

Odpowiedź na błąd.

HttpCorrelationProtocol

Ustawia protokół korelacji, który ma być używany do diagnostyki usługi Application Insights.

HttpMessageDiagnostic

Ustawienia diagnostyczne komunikatów HTTP.

OperationNameFormat

Format nazwy operacji 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

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

Nazwa Typ Opis
allErrors

string

Zawsze rejestruje wszystkie błędne żądanie niezależnie od ustawień próbkowania.

BodyDiagnosticSettings

Ustawienia rejestrowania treści.

Nazwa Typ Opis
bytes

integer

Liczba bajtów treści żądania do zalogowania.

DataMasking

Nazwa Typ Opis
headers

DataMaskingEntity[]

Ustawienia maskowania nagłówków

queryParams

DataMaskingEntity[]

Ustawienia maskowania parametrów zapytania adresu URL

DataMaskingEntity

Nazwa Typ Opis
mode

DataMaskingMode

Tryb maskowania danych.

value

string

Nazwa jednostki do maskowania (np. nazwa nagłówka lub parametru zapytania).

DataMaskingMode

Tryb maskowania danych.

Nazwa Typ Opis
Hide

string

Ukryj obecność jednostki.

Mask

string

Maskuj wartość jednostki.

DiagnosticContract

Szczegóły diagnostyczne.

Nazwa Typ Opis
id

string

W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex — /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, który ma być używany do diagnostyki usługi Application Insights.

properties.logClientIp

boolean

Zarejestruj element ClientIP. Wartość domyślna to false.

properties.loggerId

string

Identyfikator zasobu docelowego rejestratora.

properties.metrics

boolean

Emituj metryki niestandardowe za pomocą zasad metryki emitowania. Dotyczy tylko ustawień diagnostycznych usługi Application Insights.

properties.operationNameFormat

OperationNameFormat

Format nazwy operacji 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"

ErrorFieldContract

Błąd Kontrakt pola.

Nazwa Typ Opis
code

string

Kod błędu poziomu właściwości.

message

string

Czytelna dla człowieka reprezentacja błędu na poziomie właściwości.

target

string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Nazwa Typ Opis
error.code

string

Kod błędu zdefiniowany przez usługę. Ten kod służy jako podstan kodu błędu HTTP określonego w odpowiedzi.

error.details

ErrorFieldContract[]

Lista nieprawidłowych pól wysyłanych w żądaniu w przypadku błędu walidacji.

error.message

string

Czytelna dla człowieka reprezentacja błędu.

HttpCorrelationProtocol

Ustawia protokół korelacji, który ma być używany do diagnostyki usługi Application Insights.

Nazwa Typ Opis
Legacy

string

Wstrzykiwanie nagłówków Request-Id i Request-Context przy użyciu danych korelacji żądania. Zobacz: .

None

string

Nie odczytuj i wstrzykiwaj nagłówki korelacji.

W3C

string

Wstrzykiwanie nagłówków kontekstu śledzenia. Zobacz: .

HttpMessageDiagnostic

Ustawienia diagnostyczne komunikatów 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

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

Nazwa Typ Opis
Name

string

API_NAME; rev=API_REVISION — OPERATION_NAME

Url

string

HTTP_VERB URL

PipelineDiagnosticSettings

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

Nazwa Typ Opis
request

HttpMessageDiagnostic

Ustawienia diagnostyczne żądania.

response

HttpMessageDiagnostic

Ustawienia diagnostyczne odpowiedzi.

SamplingSettings

Ustawienia próbkowania dla diagnostyki.

Nazwa Typ Opis
percentage

number

Częstotliwość próbkowania dla próbkowania o stałej szybkości.

samplingType

SamplingType

Typ próbkowania.

SamplingType

Typ próbkowania.

Nazwa Typ Opis
fixed

string

Próbkowanie o stałej szybkości.

Verbosity

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

Nazwa Typ Opis
error

string

Do rejestratora dołączonego do tego wystąpienia diagnostycznego będą wysyłane tylko ślady z ustawioną ważnością na wartość "error".

information

string

Ślady z ustawioną ważnością na "informacje" i "błąd" zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.

verbose

string

Wszystkie ślady emitowane przez zasady śledzenia zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostycznego.