Microsoft.ApiManagement service/diagnostics 2019-12-01-preview
- najnowsze
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
Definicja zasobu Bicep
Typ zasobu usługi/diagnostyki można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania 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/diagnostics, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2019-12-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
alwaysLog: 'string'
backend: {
request: {
body: {
bytes: int
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
headers: [
'string'
]
}
}
frontend: {
request: {
body: {
bytes: int
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
headers: [
'string'
]
}
}
httpCorrelationProtocol: 'string'
logClientIp: bool
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 |
| 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" |
| logClientIp | Rejestrowanie elementu ClientIP. Wartość domyślna to false. | Bool |
| 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/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: usługi |
| 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" |
Przykłady z przewodnika Szybki start
W poniższych przykładach szybkiego startu wdrożono ten typ zasobu.
| Plik Bicep | Opis |
|---|---|
| Application Gateway z wewnętrznymi usługami API Management i Web App | Usługa Application Gateway routingu ruchu internetowego do wystąpienia usługi API Management sieci wirtualnej (w trybie wewnętrznym), które obsługuje internetowy interfejs API hostowany w aplikacji internetowej platformy Azure. |
| tworzenie usługi API Management w wewnętrznej sieci wirtualnej przy użyciu usługi App Gateway | Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w sieci prywatnej chronionej przez usługę Azure Application Gateway. |
Definicja zasobu szablonu usługi ARM
Typ zasobu usługi/diagnostyki można wdrożyć przy użyciu operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania 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/diagnostics, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/diagnostics",
"apiVersion": "2019-12-01-preview",
"name": "string",
"properties": {
"alwaysLog": "string",
"backend": {
"request": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
}
},
"frontend": {
"request": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"headers": [ "string" ]
}
},
"httpCorrelationProtocol": "string",
"logClientIp": "bool",
"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 |
| 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" |
| logClientIp | Rejestrowanie elementu ClientIP. Wartość domyślna to false. | Bool |
| 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/diagnostics
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2019-12-01-preview" |
| 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/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" |
Szablony szybkiego startu
Następujące szablony szybkiego startu wdrażają ten typ zasobu.
| Szablon | Opis |
|---|---|
|
Application Gateway z wewnętrznymi usługami API Management i Web App wdrażanie  |
Usługa Application Gateway routingu ruchu internetowego do wystąpienia usługi API Management sieci wirtualnej (w trybie wewnętrznym), które obsługuje internetowy interfejs API hostowany w aplikacji internetowej platformy Azure. |
|
tworzenie usługi API Management w wewnętrznej sieci wirtualnej przy użyciu usługi App Gateway wdrażanie |
Ten szablon przedstawia sposób tworzenia wystąpienia usługi Azure API Management w sieci prywatnej chronionej przez usługę Azure Application Gateway. |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu usługi/diagnostyki 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/diagnostics, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/diagnostics@2019-12-01-preview"
name = "string"
body = jsonencode({
properties = {
alwaysLog = "string"
backend = {
request = {
body = {
bytes = int
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
headers = [
"string"
]
}
}
frontend = {
request = {
body = {
bytes = int
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
headers = [
"string"
]
}
}
httpCorrelationProtocol = "string"
logClientIp = bool
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 |
| 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" |
| logClientIp | Rejestrowanie elementu ClientIP. Wartość domyślna to false. | Bool |
| 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/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: usługi |
| Właściwości | Właściwości kontraktu jednostki diagnostycznej. | DiagnosticContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/diagnostics@2019-12-01-preview" |
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" |