다음을 통해 공유

API Management 정책 정의에서 정책 구성 재사용

  • 아티클

적용 대상: 모든 API Management 계층

이 문서에서는 API Management 정책 정의에서 정책 조각을 만들고 사용하는 방법을 보여 줍니다. 정책 조각은 하나 이상의 API Management 정책 구성을 포함하는 중앙에서 관리되고 재사용 가능한 XML 코드 조각입니다.

정책 조각을 사용하면 XML 코드를 반복하거나 다시 입력할 필요 없이 정책을 일관되게 구성하고 정책 정의를 유지 관리할 수 있습니다.

정책 조각:

  • 하나 이상의 정책 구성을 포함하는 유효한 XML이어야 합니다.
  • 참조된 정책이 지원하는 경우 정책 식을 포함할 수 있습니다.
  • include-fragment 정책을 사용하여 정책 정의에 있는 그대로 삽입됩니다.

제한 사항:

  • 정책 조각에는 정책 섹션 식별자(<inbound>, <outbound> 등) 또는 <base/> 요소가 포함될 수 없습니다.
  • 현재 정책 조각은 다른 정책 조각을 중첩할 수 없습니다.
  • 정책 조각의 최대 크기는 32KB입니다.

필수 조건

API Management 인스턴스 및 백 엔드 API가 아직 없는 경우 다음을 참조하세요.

필수는 아니지만 하나 이상의 정책 정의를 구성할 수 있습니다. 정책 조각을 만들 때 이러한 정의에서 정책 요소를 복사할 수 있습니다.

API Management 인스턴스로 이동

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

    API Management Services 선택

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

    API Management 인스턴스 선택

정책 조각 만들기

  1. API Management 인스턴스의 왼쪽 탐색 메뉴에 있는 API에서 정책 조각>+ 만들기를 선택합니다.

  2. 새 정책 조각 만들기 창에서 정책 조각의 이름과 선택 사항인 설명을 입력합니다. 이름은 API Management 인스턴스 내에서 고유해야 합니다.

    이름 예: ForwardContext

  3. XML 정책 조각 편집기에서 <fragment> 및 </fragment> 태그 사이에 하나 이상의 정책 XML 요소를 입력하거나 붙여넣습니다.

    새 정책 조각 양식 만들기를 보여 주는 스크린샷.

    예를 들어 다음 조각에는 컨텍스트 정보를 백 엔드 서비스로 전달하기 위한 set-header 정책 구성이 포함되어 있습니다. 이 조각은 인바운드 정책 섹션에 포함됩니다. 이 예의 정책 식은 기본 제공 context 변수에 액세스합니다.

    <fragment>
    <set-header name="x-request-context-data" exists-action="override">
      <value>@(context.User.Id)</value>
      <value>@(context.Deployment.Region)</value>
    </set-header>
</fragment>

  4. 만들기를 실행합니다. 조각이 정책 조각 목록에 추가됩니다.

정책 정의에 조각 포함

정책 정의에 정책 조각을 삽입하도록 include-fragment 정책을 구성합니다. 정책 정의에 대한 자세한 내용은 정책 설정 또는 편집을 참조하세요.

  • 조각의 기본 정책이 해당 사용을 지원하는 한 모든 범위와 정책 섹션에 조각을 포함할 수 있습니다.
  • 정책 정의에 여러 정책 조각을 포함할 수 있습니다.

예를 들어 인바운드 정책 섹션에 ForwardContext라는 정책 조각을 삽입합니다.

<policies>
    <inbound>
        <include-fragment fragment-id="ForwardContext" />
        <base />
    </inbound>
[...]

팁

정책 정의에 표시된 포함된 조각의 콘텐츠를 보려면 정책 편집기에서 실제 정책 계산을 선택합니다.

정책 조각 관리

정책 조각을 만든 후 정책 조각의 속성을 보고 업데이트하거나 언제든지 정책 단편을 삭제할 수 있습니다.

정책 조각의 속성을 보려면:

  1. API Management 인스턴스의 왼쪽 탐색 영역에 있는 API에서 정책 조각을 선택합니다. 조각의 이름을 선택합니다.
  2. 개요 페이지에서 정책 문서 참조를 검토하여 단편을 포함하는 정책 정의를 확인합니다.
  3. 속성 페이지에서 정책 조각의 이름과 설명을 검토합니다. 이름은 변경할 수 없습니다.

정책 조각을 편집하려면:

  1. API Management 인스턴스의 왼쪽 탐색 영역에 있는 API에서 정책 조각을 선택합니다. 조각의 이름을 선택합니다.
  2. 정책 편집기를 선택합니다.
  3. 조각의 문을 업데이트한 다음 적용을 선택합니다.

참고 항목

업데이트는 조각이 포함된 모든 정책 정의에 영향을 줍니다.

정책 조각을 삭제하려면:

  1. API Management 인스턴스의 왼쪽 탐색 영역에 있는 API에서 정책 조각을 선택합니다. 조각의 이름을 선택합니다.
  2. 조각을 포함하는 정책 정의는 정책 문서 참조를 검토합니다. 조각을 삭제하려면 먼저 모든 정책 정의에서 조각 참조를 제거해야 합니다.
  3. 모든 참조를 제거한 후 삭제를 선택합니다.

관련 콘텐츠

정책 작업에 대한 자세한 내용은 다음을 참조하세요.