Microsoft.ApiManagement hizmeti/tanılama 2023-05-01-preview
Bicep kaynak tanımı
Hizmet/tanılama kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları - Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/diagnostics kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.
resource symbolicname 'Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
alwaysLog: 'allErrors'
backend: {
request: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
}
frontend: {
request: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
response: {
body: {
bytes: int
}
dataMasking: {
headers: [
{
mode: 'string'
value: 'string'
}
]
queryParams: [
{
mode: 'string'
value: 'string'
}
]
}
headers: [
'string'
]
}
}
httpCorrelationProtocol: 'string'
logClientIp: bool
loggerId: 'string'
metrics: bool
operationNameFormat: 'string'
sampling: {
percentage: int
samplingType: 'fixed'
}
verbosity: 'string'
}
}
Özellik değerleri
hizmet/tanılama
| Ad | Açıklama | Değer |
|---|---|---|
| name | Kaynak adı Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısal değerler ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
| Üst | Bicep'te bir alt kaynağın üst kaynağını belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir. Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak. |
Şu tür kaynak için sembolik ad: hizmet |
| properties | Tanılama varlığı sözleşme özellikleri. | DiagnosticContractProperties |
DiagnosticContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| alwaysLog | Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir. | 'allErrors' |
| arka uç | Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları | PipelineDiagnosticSettings |
| Frontend | Ağ Geçidine gelen/giden HTTP iletileri için tanılama ayarları. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar. | 'Eski' 'Yok' 'W3C' |
| logClientIp | ClientIP'yi günlüğe kaydetme. Varsayılan değer false’tur. | bool |
| günlükçü Kimliği | Hedef günlükçü kaynak kimliği. | dize (gerekli) |
| metrics | Yayma ölçümü ilkesi aracılığıyla özel ölçümleri yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir. | bool |
| operationNameFormat | Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır. | 'Ad' 'Url' |
| Örnekleme | Tanılama için örnekleme ayarları. | SamplingSettings |
| Ayrıntı | İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi. | 'error' 'bilgi' 'ayrıntılı' |
PipelineDiagnosticSettings
| Ad | Açıklama | Değer |
|---|---|---|
| istek | İstek için tanılama ayarları. | HttpMessageDiagnostic |
| yanıt | Yanıt için tanılama ayarları. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Ad | Açıklama | Değer |
|---|---|---|
| body | Gövde günlüğü ayarları. | BodyDiagnosticSettings |
| dataMasking | Veri maskeleme ayarları. | Veri Maskeleme |
| Üstbilgi | Günlüğe kaydedilecek HTTP Üst Bilgileri dizisi. | string[] |
BodyDiagnosticSettings
| Ad | Açıklama | Değer |
|---|---|---|
| Bayt | Günlüğe kaydedilecek istek gövdesi bayt sayısı. | int |
Veri Maskeleme
| Ad | Açıklama | Değer |
|---|---|---|
| Üstbilgi | Üst bilgiler için maskeleme ayarları | DataMaskingEntity[] |
| queryParams | Url sorgu parametreleri için maskeleme ayarları | DataMaskingEntity[] |
DataMaskingEntity
| Ad | Açıklama | Değer |
|---|---|---|
| mod | Veri maskeleme modu. | 'Gizle' 'Maske' |
| değer | Maskeleneceği varlığın adı (örneğin, üst bilgi veya sorgu parametresi adı). | string |
SamplingSettings
| Ad | Açıklama | Değer |
|---|---|---|
| percentage | Sabit oranlı örnekleme için örnekleme oranı. | int |
| samplingType | Örnekleme türü. | 'düzeltildi' |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
| Şablon | Description |
|---|---|
App Gateway ile İç VNet'te API Management oluşturma |
Bu şablon, Azure Application Gateway tarafından korunan özel bir ağda Azure API Management örneğinin nasıl oluşturulacağını gösterir. |
| İç API Management ve Web Uygulaması ile Application Gateway |
Application Gateway İnternet trafiğini Azure Web App'te barındırılan bir web API'sine hizmet veren bir sanal ağa (iç mod) API Management bir örneğe yönlendirme. |
ARM şablonu kaynak tanımı
Hizmet/tanılama kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları - Bkz. kaynak grubu dağıtım komutları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/diagnostics kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.
{
"type": "Microsoft.ApiManagement/service/diagnostics",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"alwaysLog": "allErrors",
"backend": {
"request": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
}
},
"frontend": {
"request": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
},
"response": {
"body": {
"bytes": "int"
},
"dataMasking": {
"headers": [
{
"mode": "string",
"value": "string"
}
],
"queryParams": [
{
"mode": "string",
"value": "string"
}
]
},
"headers": [ "string" ]
}
},
"httpCorrelationProtocol": "string",
"logClientIp": "bool",
"loggerId": "string",
"metrics": "bool",
"operationNameFormat": "string",
"sampling": {
"percentage": "int",
"samplingType": "fixed"
},
"verbosity": "string"
}
}
Özellik değerleri
hizmet/tanılama
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Kaynak türü | 'Microsoft.ApiManagement/service/diagnostics' |
| apiVersion | Kaynak API'sinin sürümü | '2023-05-01-preview' |
| name | Kaynak adı Bkz. JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlama. |
dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısal değerler ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
| properties | Tanılama varlığı sözleşme özellikleri. | DiagnosticContractProperties |
DiagnosticContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| alwaysLog | Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir. | 'allErrors' |
| arka uç | Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları | PipelineDiagnosticSettings |
| Frontend | Ağ Geçidine gelen/giden HTTP iletileri için tanılama ayarları. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar. | 'Eski' 'Yok' 'W3C' |
| logClientIp | ClientIP'yi günlüğe kaydetme. Varsayılan değer false’tur. | bool |
| günlükçü Kimliği | Hedef günlükçü kaynak kimliği. | dize (gerekli) |
| metrics | Yayma ölçümü ilkesi aracılığıyla özel ölçümleri yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir. | bool |
| operationNameFormat | Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır. | 'Ad' 'Url' |
| Örnekleme | Tanılama için örnekleme ayarları. | SamplingSettings |
| Ayrıntı | İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi. | 'error' 'bilgi' 'ayrıntılı' |
PipelineDiagnosticSettings
| Ad | Açıklama | Değer |
|---|---|---|
| istek | İstek için tanılama ayarları. | HttpMessageDiagnostic |
| yanıt | Yanıt için tanılama ayarları. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Ad | Açıklama | Değer |
|---|---|---|
| body | Gövde günlüğü ayarları. | BodyDiagnosticSettings |
| dataMasking | Veri maskeleme ayarları. | Veri Maskeleme |
| Üstbilgi | Günlüğe kaydedilecek HTTP Üst Bilgileri dizisi. | string[] |
BodyDiagnosticSettings
| Ad | Açıklama | Değer |
|---|---|---|
| Bayt | Günlüğe kaydedilecek istek gövdesi bayt sayısı. | int |
Veri Maskeleme
| Ad | Açıklama | Değer |
|---|---|---|
| Üstbilgi | Üst bilgiler için maskeleme ayarları | DataMaskingEntity[] |
| queryParams | Url sorgu parametreleri için maskeleme ayarları | DataMaskingEntity[] |
DataMaskingEntity
| Ad | Açıklama | Değer |
|---|---|---|
| mod | Veri maskeleme modu. | 'Gizle' 'Maske' |
| değer | Maskeleneceği varlığın adı (örneğin, üst bilgi veya sorgu parametresi adı). | string |
SamplingSettings
| Ad | Açıklama | Değer |
|---|---|---|
| percentage | Sabit oranlı örnekleme için örnekleme oranı. | int |
| samplingType | Örnekleme türü. | 'düzeltildi' |
Hızlı başlangıç şablonları
Aşağıdaki hızlı başlangıç şablonları bu kaynak türünü dağıtır.
| Şablon | Description |
|---|---|
| App Gateway ile İç VNet'te API Management oluşturma |
Bu şablon, Azure Application Gateway tarafından korunan özel bir ağda Azure API Management örneğinin nasıl oluşturulacağını gösterir. |
| İç API Management ve Web Uygulaması ile Application Gateway |
Application Gateway İnternet trafiğini Azure Web App'te barındırılan bir web API'sine hizmet veren bir sanal ağa (iç mod) API Management bir örneğe yönlendirme. |
Terraform (AzAPI sağlayıcısı) kaynak tanımı
Hizmet/tanılama kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:
- Kaynak grupları
Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.
Kaynak biçimi
Microsoft.ApiManagement/service/diagnostics kaynağı oluşturmak için şablonunuza aşağıdaki Terraform'u ekleyin.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
alwaysLog = "allErrors"
backend = {
request = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
}
frontend = {
request = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
response = {
body = {
bytes = int
}
dataMasking = {
headers = [
{
mode = "string"
value = "string"
}
]
queryParams = [
{
mode = "string"
value = "string"
}
]
}
headers = [
"string"
]
}
}
httpCorrelationProtocol = "string"
logClientIp = bool
loggerId = "string"
metrics = bool
operationNameFormat = "string"
sampling = {
percentage = int
samplingType = "fixed"
}
verbosity = "string"
}
})
}
Özellik değerleri
hizmet/tanılama
| Ad | Açıklama | Değer |
|---|---|---|
| tür | Kaynak türü | "Microsoft.ApiManagement/service/diagnostics@2023-05-01-preview" |
| name | Kaynak adı | dize (gerekli) Karakter sınırı: 1-80 Geçerli karakterler: Alfasayısal değerler ve kısa çizgiler. Harfle başlayın ve alfasayısal ile bitirin. |
| parent_id | Bu kaynağın üst öğesi olan kaynağın kimliği. | Kaynak türü: hizmet kimliği |
| properties | Tanılama varlığı sözleşme özellikleri. | DiagnosticContractProperties |
DiagnosticContractProperties
| Ad | Açıklama | Değer |
|---|---|---|
| alwaysLog | Ne tür ileti örnekleme ayarlarının uygulanmaması gerektiğini belirtir. | "allErrors" |
| arka uç | Arka uçtan gelen/giden HTTP iletileri için tanılama ayarları | PipelineDiagnosticSettings |
| Frontend | Ağ Geçidine gelen/giden HTTP iletileri için tanılama ayarları. | PipelineDiagnosticSettings |
| httpCorrelationProtocol | Application Insights tanılaması için kullanılacak bağıntı protokollerini ayarlar. | "Eski" "Hiçbiri" "W3C" |
| logClientIp | ClientIP'yi günlüğe kaydetme. Varsayılan değer false’tur. | bool |
| günlükçü Kimliği | Hedef günlükçü kaynak kimliği. | dize (gerekli) |
| metrics | Yayma ölçümü ilkesi aracılığıyla özel ölçümleri yayma. Yalnızca Application Insights tanılama ayarları için geçerlidir. | bool |
| operationNameFormat | Application Insights telemetrileri için İşlem Adı biçimi. Varsayılan Ad'dır. | "Ad" "Url" |
| Örnekleme | Tanılama için örnekleme ayarları. | SamplingSettings |
| Ayrıntı | İzleme ilkeleri tarafından yayılan izlemelere uygulanan ayrıntı düzeyi. | "error" "bilgi" "ayrıntılı" |
PipelineDiagnosticSettings
| Ad | Açıklama | Değer |
|---|---|---|
| istek | İstek için tanılama ayarları. | HttpMessageDiagnostic |
| yanıt | Yanıt için tanılama ayarları. | HttpMessageDiagnostic |
HttpMessageDiagnostic
| Ad | Açıklama | Değer |
|---|---|---|
| body | Gövde günlüğü ayarları. | BodyDiagnosticSettings |
| dataMasking | Veri maskeleme ayarları. | Veri Maskeleme |
| Üstbilgi | Günlüğe kaydedilecek HTTP Üst Bilgileri dizisi. | string[] |
BodyDiagnosticSettings
| Ad | Açıklama | Değer |
|---|---|---|
| Bayt | Günlüğe kaydedilecek istek gövdesi bayt sayısı. | int |
Veri Maskeleme
| Ad | Açıklama | Değer |
|---|---|---|
| Üstbilgi | Üst bilgiler için maskeleme ayarları | DataMaskingEntity[] |
| queryParams | Url sorgu parametreleri için maskeleme ayarları | DataMaskingEntity[] |
DataMaskingEntity
| Ad | Açıklama | Değer |
|---|---|---|
| mod | Veri maskeleme modu. | "Gizle" "Maske" |
| değer | Maskeleneceği varlığın adı (örneğin, bir üst bilgi veya sorgu parametresinin adı). | string |
SamplingSettings
| Ad | Açıklama | Değer |
|---|---|---|
| percentage | Sabit hızlı örnekleme için örnekleme oranı. | int |
| samplingType | Örnekleme türü. | "düzeltildi" |