Logger - Create Or Update

참조

Service:: API Management

API Version:: 2022-08-01

로거를 만들거나 업데이트합니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
loggerId	path	True	string	로거 식별자입니다. API Management 서비스 instance 고유해야 합니다. Regex pattern: `^[^*#&+:<>?]+$`
resourceGroupName	path	True	string	리소스 그룹의 이름. 이름은 대소문자를 구분하지 않습니다.
serviceName	path	True	string	API Management 서비스의 이름입니다. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	대상 구독의 ID입니다.
api-version	query	True	string	이 작업에 사용할 API 버전입니다.

요청 헤더

Name	필수	형식	Description
If-Match		string	엔터티의 ETag입니다. 엔터티를 만들 때는 필요하지 않지만 엔터티를 업데이트할 때 필요합니다.

요청 본문

Name	필수	형식	Description
properties.loggerType	True	LoggerType	로거 형식입니다.
properties.credentials		object	azureEventHub 로거에 대한 이벤트 허브의 이름 및 SendRule 연결 문자열. applicationInsights 로거에 대한 계측 키입니다.
properties.description		string	로거 설명.
properties.isBuffered		boolean	게시하기 전에 로거에서 레코드가 버퍼링되는지 여부입니다. 기본값은 true로 간주됩니다.
properties.resourceId		string	로그 대상의 Azure 리소스 ID(Azure Event Hub 리소스 또는 Azure 애플리케이션 Insights 리소스)입니다.

응답

Name	형식	Description
200 OK	LoggerContract	기존 로거가 성공적으로 업데이트되었습니다. Headers ETag: string
201 Created	LoggerContract	로거가 성공적으로 만들어졌습니다. Headers ETag: string
Other Status Codes	ErrorResponse	작업이 실패한 이유를 설명하는 오류 응답입니다.

Name

형식

Description

200 OK

LoggerContract

기존 로거가 성공적으로 업데이트되었습니다.

Headers

ETag: string

201 Created

LoggerContract

로거가 성공적으로 만들어졌습니다.

Headers

ETag: string

Other Status Codes

ErrorResponse

작업이 실패한 이유를 설명하는 오류 응답입니다.

보안

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	사용자 계정 가장

예제

ApiManagementCreateAILogger

ApiManagementCreateEHLogger

ApiManagementCreateAILogger

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId?api-version=2022-08-01

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

import com.azure.resourcemanager.apimanagement.models.LoggerType;
import java.util.HashMap;
import java.util.Map;

/** Samples for Logger CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAILogger.json
     */
    /**
     * Sample code: ApiManagementCreateAILogger.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateAILogger(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .loggers()
            .define("loggerId")
            .withExistingService("rg1", "apimService1")
            .withLoggerType(LoggerType.APPLICATION_INSIGHTS)
            .withDescription("adding a new logger")
            .withCredentials(mapOf("instrumentationKey", "fakeTokenPlaceholder"))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_ai_logger.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.logger.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        logger_id="loggerId",
        parameters={
            "properties": {
                "credentials": {"instrumentationKey": "11................a1"},
                "description": "adding a new logger",
                "loggerType": "applicationInsights",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAILogger.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAILogger.json
func ExampleLoggerClient_CreateOrUpdate_apiManagementCreateAiLogger() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLoggerClient().CreateOrUpdate(ctx, "rg1", "apimService1", "loggerId", armapimanagement.LoggerContract{
		Properties: &armapimanagement.LoggerContractProperties{
			Description: to.Ptr("adding a new logger"),
			Credentials: map[string]*string{
				"instrumentationKey": to.Ptr("11................a1"),
			},
			LoggerType: to.Ptr(armapimanagement.LoggerTypeApplicationInsights),
		},
	}, &armapimanagement.LoggerClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LoggerContract = armapimanagement.LoggerContract{
	// 	Name: to.Ptr("loggerId"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/loggers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/loggerId"),
	// 	Properties: &armapimanagement.LoggerContractProperties{
	// 		Credentials: map[string]*string{
	// 			"instrumentationKey": to.Ptr("{{5a.......2a}}"),
	// 		},
	// 		IsBuffered: to.Ptr(false),
	// 		LoggerType: to.Ptr(armapimanagement.LoggerTypeApplicationInsights),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or Updates a logger.
 *
 * @summary Creates or Updates a logger.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateAILogger.json
 */
async function apiManagementCreateAiLogger() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const loggerId = "loggerId";
  const parameters = {
    description: "adding a new logger",
    credentials: { instrumentationKey: "11................a1" },
    loggerType: "applicationInsights",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.logger.createOrUpdate(
    resourceGroupName,
    serviceName,
    loggerId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 201

{
  "id": "/subscriptions/subid/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/subid/resourceGroups/rg1/providers/microsoft.insights/components/airesource"
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid/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

Sample Request

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1?api-version=2022-08-01

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

import com.azure.resourcemanager.apimanagement.models.LoggerType;
import java.util.HashMap;
import java.util.Map;

/** Samples for Logger CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateEHLogger.json
     */
    /**
     * Sample code: ApiManagementCreateEHLogger.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateEHLogger(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .loggers()
            .define("eh1")
            .withExistingService("rg1", "apimService1")
            .withLoggerType(LoggerType.AZURE_EVENT_HUB)
            .withDescription("adding a new logger")
            .withCredentials(
                mapOf(
                    "name",
                    "hydraeventhub",
                    "connectionString",
                    "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="))
            .create();
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_eh_logger.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.logger.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        logger_id="eh1",
        parameters={
            "properties": {
                "credentials": {
                    "connectionString": "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=",
                    "name": "hydraeventhub",
                },
                "description": "adding a new logger",
                "loggerType": "azureEventHub",
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateEHLogger.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateEHLogger.json
func ExampleLoggerClient_CreateOrUpdate_apiManagementCreateEhLogger() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewLoggerClient().CreateOrUpdate(ctx, "rg1", "apimService1", "eh1", armapimanagement.LoggerContract{
		Properties: &armapimanagement.LoggerContractProperties{
			Description: to.Ptr("adding a new logger"),
			Credentials: map[string]*string{
				"name":             to.Ptr("hydraeventhub"),
				"connectionString": to.Ptr("Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********="),
			},
			LoggerType: to.Ptr(armapimanagement.LoggerTypeAzureEventHub),
		},
	}, &armapimanagement.LoggerClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.LoggerContract = armapimanagement.LoggerContract{
	// 	Name: to.Ptr("eh1"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/loggers"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/loggers/eh1"),
	// 	Properties: &armapimanagement.LoggerContractProperties{
	// 		Description: to.Ptr("adding a new logger"),
	// 		Credentials: map[string]*string{
	// 			"connectionString": to.Ptr("{{Logger-Credentials-5f28745bbebeeb13cc3f7301}}"),
	// 		},
	// 		IsBuffered: to.Ptr(true),
	// 		LoggerType: to.Ptr(armapimanagement.LoggerTypeAzureEventHub),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or Updates a logger.
 *
 * @summary Creates or Updates a logger.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementCreateEHLogger.json
 */
async function apiManagementCreateEhLogger() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const loggerId = "eh1";
  const parameters = {
    description: "adding a new logger",
    credentials: {
      name: "hydraeventhub",
      connectionString:
        "Endpoint=sb://hydraeventhub-ns.servicebus.windows.net/;SharedAccessKeyName=RootManageSharedAccessKey;SharedAccessKey=********=",
    },
    loggerType: "azureEventHub",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.logger.createOrUpdate(
    resourceGroupName,
    serviceName,
    loggerId,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:: 201

{
  "id": "/subscriptions/subid/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
  }
}

Status code:: 200

{
  "id": "/subscriptions/subid/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
  }
}

정의

Name	Description
ErrorFieldContract	오류 필드 계약.
ErrorResponse	오류 응답.
LoggerContract	로거 세부 정보.
LoggerType	로거 형식입니다.

ErrorFieldContract

오류 필드 계약.

Name	형식	Description
code	string	속성 수준 오류 코드입니다.
message	string	사람이 읽을 수 있는 속성 수준 오류 표현입니다.
target	string	속성 이름입니다.

ErrorResponse

오류 응답.

Name	형식	Description
error.code	string	서비스에서 정의한 오류 코드입니다. 이 코드는 응답에 지정된 HTTP 오류 코드의 하위 상태로 사용됩니다.
error.details	ErrorFieldContract[]	유효성 검사 오류가 발생한 경우 요청에 잘못된 필드가 전송됩니다.
error.message	string	사람이 읽을 수 있는 오류 표현입니다.

LoggerContract

로거 세부 정보.

Name	형식	Description
id	string	리소스에 대한 정규화된 리소스 ID입니다. 예 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	리소스의 이름입니다.
properties.credentials	object	azureEventHub 로거에 대한 이벤트 허브의 이름 및 SendRule 연결 문자열. applicationInsights 로거에 대한 계측 키입니다.
properties.description	string	로거 설명.
properties.isBuffered	boolean	게시하기 전에 로거에서 레코드가 버퍼링되는지 여부입니다. 기본값은 true로 간주됩니다.
properties.loggerType	LoggerType	로거 형식입니다.
properties.resourceId	string	로그 대상의 Azure 리소스 ID(Azure Event Hub 리소스 또는 Azure 애플리케이션 Insights 리소스)입니다.
type	string	리소스 형식입니다. 예: "Microsoft.Compute/virtualMachines" 또는 "Microsoft.Storage/storageAccounts"

LoggerType

로거 형식입니다.

Name	형식	Description
applicationInsights	string	로그 대상으로 Insights를 Azure 애플리케이션.
azureEventHub	string	Azure Event Hub를 로그 대상으로 지정합니다.
azureMonitor	string	Azure Monitor

Logger - Create Or Update

URI 매개 변수

요청 헤더

요청 본문

응답

보안

azure_auth

Scopes

예제

ApiManagementCreateAILogger

Sample Request

Sample Response

ApiManagementCreateEHLogger

Sample Request

Sample Response

정의

ErrorFieldContract

ErrorResponse

LoggerContract

LoggerType

추가 리소스