Azure API Management에서 작업 영역 만들기 및 관리

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

API 팀이 자체 API를 관리하고 제품화할 수 있도록 작업 영역을 설정하는 동시에 API 플랫폼 팀에 API Management 플랫폼을 관찰, 제어 및 유지 관리할 수 있는 도구를 제공합니다. 작업 영역을 만들고 권한을 할당하면 작업 영역 공동 작업자는 자체 API, 제품, 구독 및 관련 리소스를 만들고 관리할 수 있습니다.

이 문서의 단계에 따라 다음을 수행합니다.

• 인스턴스의 기본 관리 게이트웨이와 연결되거나 새 작업 영역 또는 기존 작업 영역 게이트웨이와 연결된 API Management 작업 영역을 만듭니다.
• 필요에 따라 Azure 가상 네트워크에서 작업 영역 게이트웨이를 격리합니다.
• 작업 영역에 권한을 할당합니다.

Prerequisites

• API Management 인스턴스. 필요한 경우 지원되는 계층에서 만듭니 다.
• API Management 인스턴스가 배포된 리소스 그룹에 대한 소유자 또는 기여자 역할, 또는 리소스 그룹에서 리소스를 만들 수 있는 동등한 권한
• (선택 사항) 작업 영역 게이트웨이의 인바운드 및 아웃바운드 트래픽을 격리하기 위한 새 또는 기존 Azure 가상 네트워크의 서브넷입니다. 구성 옵션 및 요구 사항은 영역 게이트웨이에 대한 네트워크 리소스 요구 사항을 참조하세요.
• (기본 관리 게이트웨이를 작업 영역과 연결하기 위한 선택 사항) API Management REST API를 호출하는 REST 클라이언트입니다.

작업 영역 만들기 및 기본 관리 게이트웨이 연결 - REST API

작업 영역 게이트웨이 대신 서비스의 기본 관리 게이트웨이를 통해 API 트래픽을 라우팅하는 작업 영역을 만들 수 있습니다. 이 옵션은 별도의 게이트웨이 리소스의 추가 비용 및 복잡성을 방지합니다. API 트래픽은 서비스의 기본 호스트 이름(예: <service-name>.azure-api.net)을 통해 라우팅됩니다.

작업 영역 사용 - REST API를 만들거나 업데이트하여 작업 영역을 만듭니다.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/workspaces/{workspaceId}?api-version=2024-05-01
Authorization: Bearer {token}
Content-Type: application/json

{
  "properties": {
    "displayName": "my workspace",
    "description": "Workspace using default managed gateway",
    "serveOn": "workspaceAndDefault"
  }
}

교체하십시오

• {subscriptionId} Azure 구독 ID와 함께
• {resourceGroupName} API Management 인스턴스의 리소스 그룹 이름으로
• {serviceName}를 API Management 인스턴스의 이름으로
• {workspaceId} 고유한 작업 영역 식별자 사용(영숫자, 하이픈 허용)

성공적인 응답은 작업 영역 리소스를 사용하여 HTTP 201 Created 를 반환합니다. 기본적으로 작업 영역은 서비스의 기본 호스트 이름을 통해 API 트래픽을 라우팅합니다.

작업 영역을 만든 후 액세스 권한을 구성하려면 작업 영역에 사용자 할당 - 포털로 이동합니다.

작업 영역 만들기 및 작업 영역 게이트웨이 연결 - 포털

1. Azure Portal에 로그인하고 API Management 인스턴스로 이동합니다.

2. 왼쪽 메뉴의 API 아래에서 작업 영역>+ 추가를 선택합니다.

3. 기본 사항 탭에서 작업 영역에 대한 설명적인 표시 이름, 리소스 이름 및 선택적 설명을 입력합니다. 다음을 선택합니다.

4. 게이트웨이 탭에서 작업 영역 게이트웨이에 대한 설정을 구성합니다.

   

   • 새로 만들기를 선택하여 새 작업 영역 게이트웨이를 만들거나 기존 작업 영역 사용을 선택하여 다른 작업 영역이 배포된 기존 게이트웨이와 작업 영역을 연결합니다.

   • 새 게이트웨이를 만들도록 선택한 경우:

     • 게이트웨이 세부 정보에 새 게이트웨이 이름을 입력하고 배율 단위 수를 선택합니다. 게이트웨이 비용은 단위 수를 기준으로 합니다. 자세한 내용은 API Management 가격을 참조하세요.

     • 네트워크에서 작업 영역 게이트웨이에 대한 네트워크 구성을 선택합니다.

       Important

       작업 영역의 네트워크 구성을 신중하게 계획합니다. 작업 영역을 만든 후에는 네트워크 구성을 변경할 수 없습니다.

     • 인바운드 공용 액세스, 아웃바운드 프라이빗 액세스(가상 네트워크 통합) 또는 인바운드 프라이빗 액세스, 아웃바운드 프라이빗 액세스(가상 네트워크 삽입) 중 하나를 선택하는 경우 가상 네트워크 및 서브넷을 선택하여 작업 영역 게이트웨이를 격리하거나 새 게이트웨이를 만듭니다. 네트워크 요구 사항은 작업 영역 게이트웨이에 대한 네트워크 리소스 요구 사항을 참조하세요.

5. 다음을 선택합니다. 유효성 검사가 완료되면 만들기를 선택합니다.

   Note

   새 작업 영역 게이트웨이를 만드는 경우 완료하는 데 최대 몇 시간이 걸릴 수 있습니다. Azure Portal에서 배포 진행률을 추적하려면 게이트웨이의 리소스 그룹으로 이동합니다. 왼쪽 메뉴의 설정 아래에서 배포를 선택합니다.

배포가 완료되면 작업 영역 페이지의 목록에 새 작업 영역이 표시됩니다. 작업 영역을 선택하여 설정 및 리소스를 관리합니다.

작업 영역에 사용자 할당 - 포털

작업 영역을 만든 후 사용자에게 작업 영역의 리소스를 관리할 수 있는 권한을 할당합니다. 각 작업 영역 사용자는 서비스 범위 작업 영역 RBAC 역할과 작업 영역 범위 RBAC 역할을 모두 할당받거나 사용자 지정 역할을 사용하여 동등한 권한을 부여받아야 합니다.

작업 영역에서 작업 영역 게이트웨이 리소스를 사용하는 경우 작업 영역 사용자에게 작업 영역 게이트웨이로 범위가 지정된 Azure 제공 RBAC 역할도 할당합니다.

• 기본 제공 작업 영역 역할 목록은 API Management에서 역할 기반 액세스 제어를 사용하는 방법을 참조하세요.
• 역할을 할당하는 단계는 포털을 사용하여 Azure 역할 할당을 참조하세요.

서비스에 한정된 역할 할당

1. Azure Portal에 로그인하고 API Management 인스턴스로 이동합니다.

2. 왼쪽 메뉴에서 액세스 제어(IAM)>+ 추가를 선택합니다.

3. 작업 영역의 각 멤버에게 다음 서비스 범위 역할 중 하나를 할당합니다.

   • API 관리 서비스 워크스페이스 API 개발자
   • API Management 서비스 작업 영역 API 제품 관리자

작업 공간 전체에 해당하는 역할 할당

1. API Management 인스턴스 메뉴의 API 아래에서 만든 작업 영역의 이름인 작업 영역>을 선택합니다.

2. 작업 영역 창에서 액세스 제어(IAM)>+ 추가를 선택합니다.

3. 작업 영역 API 및 기타 리소스를 관리할 수 있도록 다음 작업 영역 범위 역할 중 하나를 작업 영역 멤버에 할당합니다.

   • API Management 작업 영역 읽기 권한자
   • API Management 작업 영역 기여자
   • API 관리 워크스페이스 API 개발자
   • API Management 작업 영역 API 제품 관리자

게이트웨이 범위 역할 할당

1. Azure Portal에 로그인하고 API Management 인스턴스로 이동합니다.

2. 왼쪽 메뉴의 API에서 작업 영역>을 선택하고 작업 영역의 이름을 입력합니다.

3. 작업 영역의 왼쪽 메뉴에서 게이트웨이를 선택하고 작업 영역 게이트웨이를 선택합니다.

4. 왼쪽 메뉴에서 액세스 제어(IAM)>+ 추가를 선택합니다.

5. 작업 영역의 각 멤버에게 다음 역할 중 하나를 할당합니다. 최소한 읽기 권한자 역할을 할당하여 게이트웨이의 설정을 봅니다. 소유자 및 참가자는 게이트웨이 크기 조정을 포함하여 게이트웨이의 설정을 관리할 수 있습니다.

   • Owner
   • Contributor
   • Reader

작업 영역 API 모니터링을 위한 진단 설정 사용

작업 영역에 대한 Azure Monitor 로그를 수집하고 Log Analytics 작업 영역으로 보내도록 설정을 구성합니다. 작업 영역 팀은 API 플랫폼 팀이 API Management 인스턴스에 대한 중앙 집중식 로그에 액세스할 수 있는 동안 자체 API를 모니터링할 수 있습니다. 다음 다이어그램을 참조하세요.

작업 영역에 대한 Azure Monitor 로그를 수집하려면 서비스 및 작업 영역 수준에서 진단 설정이 필요합니다.

1. 먼저 설정이 아직 활성화되지 않은 경우 API Management 게이트웨이 로그의 컬렉션에 대해 서비스 수준에서 진단 설정을 사용하도록 설정합니다. Log Analytics 작업 영역에 로그를 보냅니다. 자세한 내용은 API Management에 대한 진단 설정 구성을 참조하세요.

2. 그런 다음 workspace 수준 진단 설정을 사용하도록 설정하여 API Management 게이트웨이 로그를 동일한 Log Analytics 작업 영역으로 보냅니다. 이 설정은 작업 영역과 연결된 모든 작업 영역 게이트웨이에 대한 로그를 수집합니다.

   Important

   서비스 수준의 진단 설정은 작업 영역 수준 진단 설정을 사용하도록 설정된 작업 영역을 포함하여 API Management 인스턴스에서 로깅을 구성합니다. 작업 영역 수준 진단 설정을 사용하도록 설정하지 않으면 작업 영역의 게이트웨이 로그가 수집되거나 Log Analytics 집계되지 않습니다.

   Note

   기본적으로 기본 제공 작업 영역 RBAC 역할이 할당된 작업 영역 팀의 구성원은 작업 영역에서 진단 설정을 편집할 수 있는 권한이 없습니다. API 플랫폼 팀에는 이러한 권한이 있습니다.

작업 영역 수준 게이트웨이 로그의 컬렉션에 대한 작업 영역 진단 설정을 구성하려면 다음을 수행합니다.

1. Azure Portal에 로그인하고 API Management 인스턴스로 이동합니다.

2. 왼쪽 메뉴의 API에서 작업 영역>을 선택하고 작업 영역의 이름을 입력합니다.

3. 작업 영역의 왼쪽 메뉴에 있는 모니터링 아래에서 진단 설정>+ 진단 설정 추가를 선택합니다.

4. 진단 설정에서 설정에 대한 세부 정보를 입력하거나 선택합니다.

   1. 진단 설정 이름: 설명이 포함된 이름을 입력합니다.
   2. 범주 그룹: 필요에 따라 시나리오를 선택합니다.
   3. 범주에서 ApiManagement 게이트웨이와 관련된 로그를 선택하여 이 작업 영역에서 API에 대한 게이트웨이 로그를 수집합니다.
   4. 대상 세부 정보에서 서비스 수준 진단 설정 및 다른 작업 영역 수준 진단 설정에 지정된 동일한 Azure Log Analytics 작업 영역으로 로그를 보내도록 선택합니다.
   5. 저장을 선택합니다.

작업 영역 시작

작업 영역에서의 역할에 따라 사용자는 API, 제품, 구독 및 기타 리소스를 만들 수 있는 권한이 있거나 이러한 리소스의 일부 또는 전부에 대한 읽기 전용 액세스 권한이 있을 수 있습니다.

작업 영역에서 API 관리, 보호 및 게시를 시작하려면 다음 지침을 참조하세요.

관련 콘텐츠

• Azure API Management의 작업 영역에 대해 자세히 알아봅니다.
• 가상 네트워크를 사용하여 Azure API Management에 대한 인바운드 또는 아웃바운드 트래픽 보호