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=2021-01-01-preview

Parametry identyfikatora URI

Name In Required Type Description
diagnosticId
path True
  • string

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

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

resourceGroupName
path True
  • string

Nazwa grupy zasobów.

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

Poświadczenia subskrypcji, które jednoznacznie identyfikują subskrypcję Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora URI dla każdego wywołania usługi.

api-version
query True
  • string

Wersja interfejsu API, która ma być używana z żądaniem klienta.

Nagłówek żądania

Name Required Type Description
If-Match
  • string

Element ETag obiektu. Niewymagane podczas tworzenia jednostki, ale wymagane w przypadku aktualizowania jednostki.

Treść żądania

Name Required Type Description
properties.loggerId True
  • string

Identyfikator zasobu rejestratora docelowego.

properties.alwaysLog

Określa typ ustawień próbkowania komunikatów, które nie powinny być stosowane.

properties.backend

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

properties.frontend

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

properties.httpCorrelationProtocol

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

properties.logClientIp
  • boolean

Rejestruj ClientIP. Wartość domyślna to false.

properties.operationNameFormat

Format nazwy operacji dla Application Insights telemetrii. Wartość domyślna to Name.

properties.sampling

Ustawienia próbkowania dla diagnostyki.

properties.verbosity

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

Odpowiedzi

Name Type Description
200 OK

Diagnostyka została pomyślnie zaktualizowana

Headers

  • ETag: string
201 Created

Diagnostyka została pomyślnie utworzona.

Headers

  • ETag: string
Other Status Codes

Odpowiedź na błąd z opisem przyczyny niepowodzenia operacji.

Zabezpieczenia

azure_auth

Azure Active Directory przepływ OAuth2.

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

Scopes

Name Description
user_impersonation Personifikuj konto 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=2021-01-01-preview
{
  "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

AlwaysLog

Określa typ ustawień próbkowania komunikatów, które nie powinny być stosowane.

BodyDiagnosticSettings

Ustawienia rejestrowania treści.

DataMasking
DataMaskingEntity
DataMaskingMode

Tryb maskowania danych.

DiagnosticContract

Szczegóły diagnostyki.

ErrorFieldContract

Umowa pola błędu.

ErrorResponse

Odpowiedź na błąd.

HttpCorrelationProtocol

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

HttpMessageDiagnostic

Ustawienia diagnostyczne wiadomości HTTP.

OperationNameFormat

Format nazwy operacji dla Application Insights telemetrii. Wartość domyślna to Name.

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 stosowany do śladów emitowanych przez zasady śledzenia.

AlwaysLog

Określa typ ustawień próbkowania komunikatów, które nie powinny być stosowane.

Name Type Description
allErrors
  • string

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

BodyDiagnosticSettings

Ustawienia rejestrowania treści.

Name Type Description
bytes
  • integer

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

DataMasking

Name Type Description
headers

Ustawienia maskowania dla nagłówków

queryParams

Ustawienia maskowania dla parametrów zapytania URL

DataMaskingEntity

Name Type Description
mode

Tryb maskowania danych.

value
  • string

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

DataMaskingMode

Tryb maskowania danych.

Name Type Description
Hide
  • string

Ukryj obecność jednostki.

Mask
  • string

Maskowanie wartości jednostki.

DiagnosticContract

Szczegóły diagnostyki.

Name Type Description
id
  • string

Identyfikator zasobu.

name
  • string

Nazwa zasobu.

properties.alwaysLog

Określa typ ustawień próbkowania komunikatów, które nie powinny być stosowane.

properties.backend

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

properties.frontend

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

properties.httpCorrelationProtocol

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

properties.logClientIp
  • boolean

Rejestruj ClientIP. Wartość domyślna to false.

properties.loggerId
  • string

Identyfikator zasobu rejestratora docelowego.

properties.operationNameFormat

Format nazwy operacji dla Application Insights telemetrii. Wartość domyślna to Name.

properties.sampling

Ustawienia próbkowania dla diagnostyki.

properties.verbosity

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

type
  • string

Typ zasobu dla API Management zasobu.

ErrorFieldContract

Umowa pola błędu.

Name Type Description
code
  • string

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

message
  • string

Czytelna dla człowieka Reprezentacja błędu poziomu właściwości.

target
  • string

Nazwa właściwości.

ErrorResponse

Odpowiedź na błąd.

Name Type Description
error.code
  • string

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

error.details

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 do użycia na potrzeby diagnostyki Application Insights.

Name Type Description
Legacy
  • string

Wsuń Request-Id i Request-Context nagłówki za pomocą danych korelacji żądania. Zobacz: https://github.com/dotnet/corefx/blob/master/src/System.Diagnostics.DiagnosticSource/src/HttpCorrelationProtocol.md.

None
  • string

Nie Odczytuj i wstrzyknąć nagłówków korelacji.

W3C
  • string

Wsuń nagłówki kontekstu śledzenia. Zobacz: https://w3c.github.io/trace-context.

HttpMessageDiagnostic

Ustawienia diagnostyczne wiadomości HTTP.

Name Type Description
body

Ustawienia rejestrowania treści.

dataMasking

Ustawienia maskowania danych.

headers
  • string[]

Tablica nagłówków HTTP do zarejestrowania.

OperationNameFormat

Format nazwy operacji dla Application Insights telemetrii. Wartość domyślna to Name.

Name Type Description
Name
  • string

API_NAME; Rev = API_REVISION OPERATION_NAME

Url
  • string

ADRES URL HTTP_VERB

PipelineDiagnosticSettings

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

Name Type Description
request

Ustawienia diagnostyczne dla żądania.

response

Ustawienia diagnostyczne dla odpowiedzi.

SamplingSettings

Ustawienia próbkowania dla diagnostyki.

Name Type Description
percentage
  • number

Częstotliwość próbkowania do próbkowania o stałym tempie.

samplingType

Typ próbkowania.

SamplingType

Typ próbkowania.

Name Type Description
fixed
  • string

Próbkowanie ustalonej stawki.

Verbosity

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

Name Type Description
error
  • string

Tylko ślady o ważności "Error" są wysyłane do rejestratora dołączonego do tego wystąpienia diagnostyki.

information
  • string

Ślady o ważności "Information" i "Error" zostaną wysłane do rejestratora dołączonego do tego wystąpienia diagnostyki.

verbose
  • string

Wszystkie ślady emitowane przez zasady śledzenia będą wysyłane do rejestratora dołączonego do tego wystąpienia diagnostyki.