共用方式為

Logger - Create Or Update

  • 參考
服務:
API Management
API 版本:
2024-05-01

建立或更新記錄器。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2024-05-01

URI 參數

名稱 位於 必要 類型 Description
loggerId
 path True

string

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

記錄器標識碼。 API 管理服務實例中必須是唯一的。
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

資源群組的名稱。 名稱不區分大小寫。
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API 管理服務的名稱。
subscriptionId
 path True

string (uuid)

目標訂用帳戶的標識碼。 此值必須是 UUID。
api-version
 query True

string

minLength: 1

要用於這項作業的 API 版本。

要求標頭

名稱 必要 類型 Description
If-Match

string

實體的 ETag。 建立實體時不需要，但在更新實體時則為必要專案。

要求本文

名稱 必要 類型 Description
properties.loggerType True

LoggerType

記錄器類型。
properties.credentials

object

azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。 applicationInsights 記錄器檢測密鑰。
properties.description

string

maxLength: 256

記錄器描述。
properties.isBuffered

boolean

在發佈之前，記錄是否會在記錄器中緩衝處理。 默認值假設為 true。
properties.resourceId

string

記錄目標的 Azure 資源識別碼（Azure 事件中樞資源或 Azure Application Insights 資源）。

回應

名稱 類型 Description
200 OK

LoggerContract

已成功更新現有的記錄器。

標題

ETag: string
201 Created

LoggerContract

已成功建立記錄器。

標題

ETag: string
Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

ApiManagementCreateAILogger
ApiManagementCreateEHLogger

ApiManagementCreateAILogger

範例要求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2024-05-01

{
  "properties": {
    "loggerType": "applicationInsights",
    "description": "adding a new logger",
    "credentials": {
      "instrumentationKey": "11................a1"
    }
  }
}

範例回覆

狀態碼:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false,
    "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
  }
}
狀態碼:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "loggerId",
  "properties": {
    "loggerType": "applicationInsights",
    "description": null,
    "credentials": {
      "instrumentationKey": "{{5a.......2a}}"
    },
    "isBuffered": false
  }
}

ApiManagementCreateEHLogger

範例要求

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2024-05-01

{
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "name": "hydraeventhub",
      "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="
    }
  }
}

範例回覆

狀態碼:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}
狀態碼:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1",
  "type": "Microsoft.ApiManagement/service/loggers",
  "name": "eh1",
  "properties": {
    "loggerType": "azureEventHub",
    "description": "adding a new logger",
    "credentials": {
      "connectionString": "{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"
    },
    "isBuffered": true
  }
}

定義

名稱 Description
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
LoggerContract

記錄器詳細數據。
LoggerType

記錄器類型。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

LoggerContract

Object

記錄器詳細數據。

名稱 類型 Description
id

string

資源的完整資源標識碼。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

資源的名稱
properties.credentials

object

azureEventHub 記錄器事件中樞的名稱和 SendRule 連接字串。 applicationInsights 記錄器檢測密鑰。
properties.description

string

maxLength: 256

記錄器描述。
properties.isBuffered

boolean

在發佈之前，記錄是否會在記錄器中緩衝處理。 默認值假設為 true。
properties.loggerType

LoggerType

記錄器類型。
properties.resourceId

string

記錄目標的 Azure 資源識別碼（Azure 事件中樞資源或 Azure Application Insights 資源）。
type

string

資源的型別。 例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

LoggerType

列舉型別

記錄器類型。

值 Description
applicationInsights

Azure Application Insights 作為記錄目的地。
azureEventHub

Azure 事件中樞作為記錄目的地。
azureMonitor

Azure 監視器