Udostępnij za pośrednictwem

Microsoft.ApiManagement service/apis/diagnostics 2019-01-01

  • Artykuł

Definicja zasobu Bicep

Typ zasobu service/apis/diagnostics można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/apis/diagnostics, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alwaysLog: 'string'
    backend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    enableHttpCorrelationHeaders: bool
    frontend: {
      request: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
      response: {
        body: {
          bytes: int
        }
        headers: [
          'string'
        ]
      }
    }
    httpCorrelationProtocol: 'string'
    loggerId: 'string'
    sampling: {
      percentage: int
      samplingType: 'string'
    }
    verbosity: 'string'
  }
}

Wartości właściwości

BodyDiagnosticSettings

Nazwa Opis Wartość
Bajtów Liczba bajtów treści żądania do zarejestrowania. Int

Ograniczenia:
Wartość maksymalna = 8192

DiagnosticContractProperties

Nazwa Opis Wartość
alwaysLog Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane. "allErrors"
zaplecze Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do zaplecza PipelineDiagnosticSettings
enableHttpCorrelationHeaders Czy należy przetwarzać nagłówki korelacji przychodzące do usługi Api Management. Dotyczy tylko diagnostyki usługi Application Insights. Wartość domyślna to true. Bool
fronton Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy. PipelineDiagnosticSettings
httpCorrelationProtocol Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights. "Starsza wersja"
"Brak"
"W3C"
loggerId Identyfikator zasobu docelowego rejestratora. ciąg (wymagany)
pobieranie próbek Ustawienia próbkowania dla diagnostyki. SamplingSettings
Szczegółowości Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia. "błąd"
"informacje"
"Pełne"

HttpMessageDiagnostic

Nazwa Opis Wartość
ciało Ustawienia rejestrowania treści. BodyDiagnosticSettings
Nagłówki Tablica nagłówków HTTP do rejestrowania. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: service/apis
Właściwości Właściwości kontraktu jednostki diagnostycznej. DiagnosticContractProperties

PipelineDiagnosticSettings

Nazwa Opis Wartość
prosić Ustawienia diagnostyczne dla żądania. HttpMessageDiagnostic
odpowiedź Ustawienia diagnostyczne odpowiedzi. HttpMessageDiagnostic

SamplingSettings

Nazwa Opis Wartość
procent Częstotliwość próbkowania dla próbkowania o stałej szybkości. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 100
samplingType Typ próbkowania. "naprawiono"

Definicja zasobu szablonu usługi ARM

Typ zasobu service/apis/diagnostics można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/apis/diagnostics, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.ApiManagement/service/apis/diagnostics",
  "apiVersion": "2019-01-01",
  "name": "string",
  "properties": {
    "alwaysLog": "string",
    "backend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "enableHttpCorrelationHeaders": "bool",
    "frontend": {
      "request": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      },
      "response": {
        "body": {
          "bytes": "int"
        },
        "headers": [ "string" ]
      }
    },
    "httpCorrelationProtocol": "string",
    "loggerId": "string",
    "sampling": {
      "percentage": "int",
      "samplingType": "string"
    },
    "verbosity": "string"
  }
}

Wartości właściwości

BodyDiagnosticSettings

Nazwa Opis Wartość
Bajtów Liczba bajtów treści żądania do zarejestrowania. Int

Ograniczenia:
Wartość maksymalna = 8192

DiagnosticContractProperties

Nazwa Opis Wartość
alwaysLog Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane. "allErrors"
zaplecze Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do zaplecza PipelineDiagnosticSettings
enableHttpCorrelationHeaders Czy należy przetwarzać nagłówki korelacji przychodzące do usługi Api Management. Dotyczy tylko diagnostyki usługi Application Insights. Wartość domyślna to true. Bool
fronton Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy. PipelineDiagnosticSettings
httpCorrelationProtocol Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights. "Starsza wersja"
"Brak"
"W3C"
loggerId Identyfikator zasobu docelowego rejestratora. ciąg (wymagany)
pobieranie próbek Ustawienia próbkowania dla diagnostyki. SamplingSettings
Szczegółowości Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia. "błąd"
"informacje"
"Pełne"

HttpMessageDiagnostic

Nazwa Opis Wartość
ciało Ustawienia rejestrowania treści. BodyDiagnosticSettings
Nagłówki Tablica nagłówków HTTP do rejestrowania. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nazwa Opis Wartość
apiVersion Wersja interfejsu API '2019-01-01'
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
Właściwości Właściwości kontraktu jednostki diagnostycznej. DiagnosticContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/apis/diagnostics"

PipelineDiagnosticSettings

Nazwa Opis Wartość
prosić Ustawienia diagnostyczne dla żądania. HttpMessageDiagnostic
odpowiedź Ustawienia diagnostyczne odpowiedzi. HttpMessageDiagnostic

SamplingSettings

Nazwa Opis Wartość
procent Częstotliwość próbkowania dla próbkowania o stałej szybkości. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 100
samplingType Typ próbkowania. "naprawiono"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/apis/diagnostics można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/apis/diagnostics, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      alwaysLog = "string"
      backend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      enableHttpCorrelationHeaders = bool
      frontend = {
        request = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
        response = {
          body = {
            bytes = int
          }
          headers = [
            "string"
          ]
        }
      }
      httpCorrelationProtocol = "string"
      loggerId = "string"
      sampling = {
        percentage = int
        samplingType = "string"
      }
      verbosity = "string"
    }
  })
}

Wartości właściwości

BodyDiagnosticSettings

Nazwa Opis Wartość
Bajtów Liczba bajtów treści żądania do zarejestrowania. Int

Ograniczenia:
Wartość maksymalna = 8192

DiagnosticContractProperties

Nazwa Opis Wartość
alwaysLog Określa, jakiego typu ustawienia próbkowania komunikatów nie powinny być stosowane. "allErrors"
zaplecze Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do zaplecza PipelineDiagnosticSettings
enableHttpCorrelationHeaders Czy należy przetwarzać nagłówki korelacji przychodzące do usługi Api Management. Dotyczy tylko diagnostyki usługi Application Insights. Wartość domyślna to true. Bool
fronton Ustawienia diagnostyczne dla przychodzących/wychodzących komunikatów HTTP do bramy. PipelineDiagnosticSettings
httpCorrelationProtocol Ustawia protokół korelacji do użycia na potrzeby diagnostyki usługi Application Insights. "Starsza wersja"
"Brak"
"W3C"
loggerId Identyfikator zasobu docelowego rejestratora. ciąg (wymagany)
pobieranie próbek Ustawienia próbkowania dla diagnostyki. SamplingSettings
Szczegółowości Poziom szczegółowości zastosowany do śladów emitowanych przez zasady śledzenia. "błąd"
"informacje"
"Pełne"

HttpMessageDiagnostic

Nazwa Opis Wartość
ciało Ustawienia rejestrowania treści. BodyDiagnosticSettings
Nagłówki Tablica nagłówków HTTP do rejestrowania. string[]

Microsoft.ApiManagement/service/apis/diagnostics

Nazwa Opis Wartość
nazwa Nazwa zasobu struna

Ograniczenia:
Minimalna długość = 1
Maksymalna długość = 80
Wzorzec = ^[^*#&+:<>?]+$ (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: service/apis
Właściwości Właściwości kontraktu jednostki diagnostycznej. DiagnosticContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/apis/diagnostics@2019-01-01"

PipelineDiagnosticSettings

Nazwa Opis Wartość
prosić Ustawienia diagnostyczne dla żądania. HttpMessageDiagnostic
odpowiedź Ustawienia diagnostyczne odpowiedzi. HttpMessageDiagnostic

SamplingSettings

Nazwa Opis Wartość
procent Częstotliwość próbkowania dla próbkowania o stałej szybkości. Int

Ograniczenia:
Minimalna wartość = 0
Wartość maksymalna = 100
samplingType Typ próbkowania. "naprawiono"