Logger - Create Or Update
创建或更新记录器。
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerId}?api-version=2024-05-01
		URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 | 
|---|---|---|---|---|
| 
						 logger 
					 | 
					path | True | 
			 string maxLength: 256pattern: ^[^*#&+:<>?]+$  | 
					
						 记录器标识符。 API 管理服务实例中必须是唯一的。  | 
				
| 
						 resource 
					 | 
					path | True | 
			 string minLength: 1maxLength: 90  | 
					
						 资源组的名称。 名称不区分大小写。  | 
				
| 
						 service 
					 | 
					path | True | 
			 string minLength: 1maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$  | 
					
						 API 管理服务的名称。  | 
				
| 
						 subscription 
					 | 
					path | True | 
			 string (uuid)  | 
					
						 目标订阅的 ID。 该值必须是 UUID。  | 
				
| 
						 api-version 
					 | 
					query | True | 
			 string minLength: 1 | 
					
						 用于此操作的 API 版本。  | 
				
请求头
| 名称 | 必需 | 类型 | 说明 | 
|---|---|---|---|
| If-Match | 
			 string  | 
	
		 实体的 ETag。 创建实体时不需要,但在更新实体时是必需的。  | 
请求正文
| 名称 | 必需 | 类型 | 说明 | 
|---|---|---|---|
| properties.loggerType | True | 
		 记录器类型。  | 
|
| properties.credentials | 
			 object  | 
	
		 azureEventHub 记录器的事件中心的名称和 SendRule 连接字符串。 applicationInsights 记录器检测密钥。  | 
|
| properties.description | 
			 string maxLength: 256 | 
	
		 记录器说明。  | 
|
| properties.isBuffered | 
			 boolean  | 
	
		 是否在发布前缓冲记录器中的记录。 默认值假定为 true。  | 
|
| properties.resourceId | 
			 string  | 
	
		 日志目标的 Azure 资源 ID(Azure 事件中心资源或 Azure Application Insights 资源)。  | 
响应
| 名称 | 类型 | 说明 | 
|---|---|---|
| 200 OK | 
		 已成功更新现有记录器。 标头 ETag: string  | 
|
| 201 Created | 
		 记录器已成功创建。 标头 ETag: string  | 
|
| Other Status Codes | 
		 描述操作失败的原因的错误响应。  | 
安全性
azure_auth
Azure Active Directory OAuth2 Flow。
					类型: 
					oauth2
					流向: 
					implicit
					授权 URL: 
					https://login.microsoftonline.com/common/oauth2/authorize
			
作用域
| 名称 | 说明 | 
|---|---|
| user_impersonation | 模拟用户帐户 | 
示例
| 
							Api | 
					
| 
							Api | 
					
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"
    }
  }
}
示例响应
{
  "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"
  }
}
						
							{
  "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=********="
    }
  }
}
示例响应
{
  "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
  }
}
						
							{
  "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
  }
}
				定义
| 名称 | 说明 | 
|---|---|
| 
							Error | 
						
							 资源管理错误附加信息。  | 
					
| 
							Error | 
						
							 错误详细信息。  | 
					
| 
							Error | 
						
							 错误响应  | 
					
| 
							Logger | 
						
							 记录器详细信息。  | 
					
| 
							Logger | 
						
							 记录器类型。  | 
					
ErrorAdditionalInfo  
			
			资源管理错误附加信息。
| 名称 | 类型 | 说明 | 
|---|---|---|
| info | 
			 object  | 
	
		 其他信息。  | 
| type | 
			 string  | 
	
		 其他信息类型。  | 
ErrorDetail 
			
			错误详细信息。
| 名称 | 类型 | 说明 | 
|---|---|---|
| additionalInfo | 
		 错误附加信息。  | 
|
| code | 
			 string  | 
	
		 错误代码。  | 
| details | 
		 错误详细信息。  | 
|
| message | 
			 string  | 
	
		 错误消息。  | 
| target | 
			 string  | 
	
		 错误目标。  | 
ErrorResponse 
			
			错误响应
| 名称 | 类型 | 说明 | 
|---|---|---|
| error | 
		 错误对象。  | 
LoggerContract 
			
			记录器详细信息。
| 名称 | 类型 | 说明 | 
|---|---|---|
| id | 
			 string  | 
	
		 资源的完全限定资源 ID。 示例 - /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 | 
		 记录器类型。  | 
|
| properties.resourceId | 
			 string  | 
	
		 日志目标的 Azure 资源 ID(Azure 事件中心资源或 Azure Application Insights 资源)。  | 
| type | 
			 string  | 
	
		 资源的类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”  | 
LoggerType 
			
			记录器类型。
| 值 | 说明 | 
|---|---|
| azureEventHub | 
		 Azure 事件中心作为日志目标。  | 
| applicationInsights | 
		 Azure Application Insights 作为日志目标。  | 
| azureMonitor | 
		 Azure Monitor  |