Azure API Management에서 알림 및 알림 템플릿을 구성하는 방법

적용 대상: 개발자 | 기본 | 기본 v2 | 표준 | 표준 v2 | 프리미엄

API Management는 특정 이벤트에 대한 이메일 알림을 구성하는 기능과 API Management 인스턴스의 관리자 및 개발자와 의사를 전달하는 데 사용되는 메일 템플릿을 구성하는 기능을 제공합니다. 이 아티클에서는 사용 가능한 이벤트에 대한 알림을 구성하는 방법을 보여주고 이러한 이벤트에 사용된 이메일 템플릿을 구성하는 개요를 제공합니다.

필수 조건

API Management 서비스 인스턴스가 없는 경우 Azure API Management 인스턴스 만들기 빠른 시작을 완료합니다.

API Management 인스턴스로 이동

1. Azure Portal에서 API Management 서비스를 검색하여 선택합니다.

   

2. API Management 서비스 페이지에서 API Management 인스턴스를 선택합니다.

   

포털에서 알림 구성

1. API Management 인스턴스의 왼쪽 탐색에서 알림을 선택하여 사용 가능한 알림을 봅니다.

   알림에 대해 다음 이벤트 목록을 구성할 수 있습니다.

   • 구독 요청(승인 필요) - 지정된 메일 받는 사람 및 사용자가 승인이 필요한 제품의 구독 요청에 대한 메일 알림을 받습니다.

   • 새 구독 - 지정된 메일 받는 사람 및 사용자가 새 제품 구독에 대한 메일 알림을 받습니다.

   • BCC - 지정된 메일 받는 사람 및 사용자가 개발자에게 전송된 모든 메일의 숨은 참조 복사본을 받습니다.

   • Close account message(계정 종료 메시지) - 계정이 종료되면 지정된 메일 받는 사람 및 사용자가 메일 알림을 받습니다.

   • 구독 할당량 한도 근접 - 구독 사용량이 사용 할당량에 근접하면 지정된 이메일 받는 사람 및 사용자가 메일 알림을 받습니다.

     참고 항목

     알림은 구독에 따른 할당량 정책에 의해 트리거됩니다. 키에 따른 할당량 정책은 알림을 생성하지 않습니다.

2. 알림을 선택하고 알림을 받을 이메일 주소를 하나 이상 지정합니다.

   • 관리자 이메일 주소를 추가하려면 + 관리자 추가를 선택합니다.
   • 다른 이메일 주소를 추가하려면 + 이메일 추가를 선택하고 이메일 주소를 입력한 다음 추가를 선택합니다.
   • 필요에 따라 이메일 주소를 계속 추가합니다.

   

알림 템플릿 구성

API Management는 개발자가 서비스에 액세스하고 사용할 때 자동으로 전송되는 관리 이메일 메시지에 대한 알림 템플릿을 제공합니다. 다음 알림 템플릿이 제공됩니다.

• 애플리케이션 갤러리 제출 승인됨(사용되지 않음)
• 개발자 인사 편지
• 개발자 할당량 한도 근접 알림
• 개발자 환영 편지
• 이메일 변경 알림
• 사용자 초대
• 문제에 새 설명이 추가됨(사용되지 않음)
• 새 개발자 계정 확인
• 새로운 문제 수신(사용되지 않음)
• 새 구독 활성화
• 암호 변경 확인
• 구독 요청이 거부됨
• 구독 요청 수신

각 메일 템플릿의 제목은 일반 텍스트이며 본문 정의는 HTML 형식입니다. 각 항목은 필요에 따라 사용자 지정할 수 있습니다.

참고 항목

템플릿의 HTML 콘텐츠는 올바른 형식이어야 하며 XML 사양을 준수해야 합니다.   문자는 허용되지 않습니다.

포털에서 알림 템플릿을 보고 구성하려면:

1. 왼쪽 메뉴에서 알림 템플릿을 선택합니다.

2. 알림 템플릿을 선택하고 편집기를 사용하여 템플릿을 구성합니다.

   

   • 매개 변수 목록에는 제목 또는 본문에 삽입되는 매개 변수 목록이 포함되며, 이러한 매개 변수는 메일이 전송될 때 지정된 값으로 바뀝니다.
   • 매개 변수를 삽입하려면 매개 변수를 이동할 위치에 커서를 놓고 매개 변수 이름을 선택합니다.

3. 이메일 템플릿에 대한 변경 내용을 저장하려면 저장을 선택하고, 변경 내용을 취소하려면 취소를 선택합니다.

메일 설정 구성

API Management 인스턴스에서 전송되는 알림에 대한 일반 메일 설정을 수정할 수 있습니다. 관리자 메일 주소, 알림을 보내는 조직의 이름 및 발신 메일 주소를 변경할 수 있습니다.

Important

원래 이메일 주소를 변경하면 수신자의 이메일 수신 기능에 영향을 미칠 수 있습니다. 다음 섹션의 고려 사항을 참조하세요.

이메일 설정을 수정하려면:

1. 왼쪽 메뉴에서 알림 템플릿을 선택합니다.
2. 이메일 설정을 선택합니다.
3. 일반 이메일 설정 페이지에서 다음 값을 입력합니다.

   • 관리자 이메일 - 모든 시스템 알림 및 기타 구성된 알림을 수신할 이메일 주소

   • 조직 이름 - 개발자 포털 및 알림에서 사용할 조직의 이름

   • 발신 이메일 주소 - API Management 인스턴스의 알림에 대한 From 헤더 값입니다. API Management는 이 발신 주소를 대신하여 알림을 보냅니다.

     

4. 저장을 선택합니다.

발신 이메일 주소 변경 시 고려 사항

발신 이메일 주소를 변경하면 API Management의 이메일 알림 수신자가 영향을 받을 수 있습니다.

• 보낸 사람 주소로 변경 - 발신 이메일 주소를 변경하면(예: no-reply@contoso.com으로) From 주소 헤더는 noreply@contoso.com apimgmt-noreply@mail.windowsazure.com이 됩니다. 이는 발신 이메일 주소의 이메일 서버가 아니라 API Management에서 이메일을 전송하기 때문입니다.

• 정크 또는 스팸 폴더로 설정된 이메일 - 일부 수신자는 API Management에서 이메일 알림을 받지 못하거나 이메일이 정크 또는 스팸 폴더로 전송될 수 있습니다. 이는 조직의 SPF 또는 DKIM 이메일 인증 설정에 따라 발생할 수 있습니다.

  • SPF 인증 - 발신 이메일 주소 도메인을 변경한 후 이메일이 더 이상 SPF 인증을 통과하지 못할 수 있습니다. 성공적인 SPF 인증 및 이메일 전달을 보장하려면 이메일 주소에 지정된 도메인의 DNS 데이터베이스에 다음 TXT 레코드를 만듭니다. 예를 들어 이메일 주소가 noreply@contoso.com인 경우 contoso.com 관리자에게 문의하여 "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all" TXT 레코드를 추가합니다.

  • DKIM 인증 - 이메일 인증을 위해 DKIM에 유효한 서명을 생성하려면 API Management에 발신 이메일 주소의 도메인과 연결된 프라이빗 키가 필요합니다. 그러나 현재 API Management에서 이 프라이빗 키를 업로드할 수 없습니다. 따라서 유효한 서명을 할당하기 위해 API Management는 mail.windowsazure.com 도메인과 연결된 프라이빗 키를 사용합니다.

다음 단계

• 개발자 포털 개요
• 개발자 계정을 관리하기 위해 그룹을 만들고 사용하는 방법