API Management 인스턴스에서 API 동기화

이 문서에서는 API Center 인벤토리에서 인스턴스의 API를 지속적으로 최신 상태로 유지할 수 있도록 API Management 인스턴스에 대한 링크를 만드는 방법을 보여 줍니다.

API Management 인스턴스 연결 정보

Azure CLI를 사용하여 Azure API Management에서 Azure API Center로 요청 시 API를 가져올 수 있지만 API Management 인스턴스를 연결하면 API 인벤토리가 최신 상태로 유지되도록 지속적인 동기화가 가능합니다.

API Management 인스턴스를 API 원본으로 연결하면 다음이 발생합니다.

1. API Management 인스턴스의 모든 API 및 선택적으로 API 정의(사양)가 API 센터 인벤토리에 추가됩니다.
2. API 센터에서 Azure API Management 유형의 환경을 구성합니다.
3. API Management에서 동기화된 각 API 정의에 대해 연결된 배포 가 만들어집니다.

API Management API는 기존 API의 설정이 변경되거나(예: 새 버전이 추가됨), 새 API가 생성되거나 API가 삭제될 때마다 API 센터에 자동으로 동기화됩니다. 이 동기화는 API Management에서 Azure API 센터로의 단방향이므로 API 센터의 API 업데이트가 API Management 인스턴스로 다시 동기화되지 않습니다.

참고 항목

• 연결된 API Management 인스턴스 수(API 원본)에 대한 제한이 있습니다.
• API Management의 API 업데이트는 일반적으로 몇 분 내에 API 센터에 동기화되지만 동기화에는 최대 24시간이 걸릴 수 있습니다.

API Management에서 동기화된 엔터티

API 센터에서 메타데이터 속성 및 설명서를 추가하거나 업데이트하여 관련자가 동기화된 API를 검색, 이해 및 사용할 수 있도록 할 수 있습니다. Azure API Center의 기본 제공 및 사용자 지정 메타데이터 속성에 대해 자세히 알아봅니다.

다음 표에서는 Azure API 센터에서 수정할 수 있는 엔터티 속성과 연결된 Azure API Management 인스턴스의 값에 따라 결정되는 속성을 보여 줍니다. 또한 Azure API Center의 엔터티 리소스 또는 시스템 식별자는 자동으로 생성되며 수정할 수 없습니다.

Entity	API 센터에서 구성할 수 있는 속성	API Management에서 결정된 속성
API	요약 lifecycleStage termsOfService license externalDocumentation customProperties	title description kind
API 버전	lifecycleStage	title
Environment	title description kind server.managementPortalUri 온보딩 customProperties	server.type
배포	title description server state customProperties	server.runtimeUri

속성 세부 정보는 Azure API 센터 REST API 참조를 참조하세요.

필수 조건

• Azure 구독의 API 센터입니다. 아직 API 센터를 만들지 않았다면 빠른 시작: API 센터 만들기를 참조하세요.

• Azure API Management 인스턴스는 동일하거나 다른 구독에 있습니다. 인스턴스는 동일한 디렉터리에 있어야 합니다.

• Azure CLI의 경우:

  • Azure Cloud Shell에서 Bash 환경을 사용합니다. 자세한 내용은 Azure Cloud Shell의 Bash에 대한 빠른 시작을 참조하세요.

    

  • CLI 참조 명령을 로컬에서 실행하려면 Azure CLI를 설치합니다. Windows 또는 macOS에서 실행 중인 경우 Docker 컨테이너에서 Azure CLI를 실행하는 것이 좋습니다. 자세한 내용은 Docker 컨테이너에서 Azure CLI를 실행하는 방법을 참조하세요.

    • 로컬 설치를 사용하는 경우 az login 명령을 사용하여 Azure CLI에 로그인합니다. 인증 프로세스를 완료하려면 터미널에 표시되는 단계를 수행합니다. 다른 로그인 옵션은 Azure CLI를 사용하여 로그인을 참조하세요.

    • 메시지가 표시되면 처음 사용할 때 Azure CLI 확장을 설치합니다. 확장에 대한 자세한 내용은 Azure CLI에서 확장 사용을 참조하세요.

    • az version을 실행하여 설치된 버전과 종속 라이브러리를 찾습니다. 최신 버전으로 업그레이드하려면 az upgrade를 실행합니다.

  참고 항목

  az apic 명령에는 apic-extension Azure CLI 확장이 필요합니다. az apic 명령을 사용하지 않은 경우 첫 번째 az apic 명령을 실행할 때 확장을 동적으로 설치하거나 확장을 수동으로 설치할 수 있습니다. Azure CLI 확장에 대해 자세히 알아보세요.

  apic-extension의 최신 변경 내용 및 업데이트는 릴리스 정보를 참조하세요.

  참고 항목

  이 문서의 Azure CLI 명령 예제는 PowerShell 또는 bash 셸에서 실행할 수 있습니다. 변수 구문이 다르기 때문에 필요한 경우 두 셸에 대해 별도의 명령 예가 제공됩니다.

API 센터에서 관리 ID 추가

이 시나리오의 경우 API 센터는 관리 ID를 사용하여 API Management 인스턴스의 API에 액세스합니다. 필요에 따라 시스템 할당 또는 하나 이상의 사용자 할당 관리 ID를 구성합니다.

다음 예에서는 Azure Portal 또는 Azure CLI를 사용하여 시스템 할당 관리 ID를 구성하는 방법을 보여 줍니다. 높은 수준에서 구성 단계는 사용자 할당 관리 ID와 유사합니다.

포털

1. 포털에서 API 센터로 이동합니다.
2. 왼쪽 메뉴의 보안 아래에서 관리 ID를 선택합니다.
3. 시스템 할당을 선택하고 상태를 켬으로 설정합니다.
4. 저장을 선택합니다.

Azure CLI

다음 az apic update 명령을 사용하여 API 센터에서 시스템 할당 ID를 설정합니다. API 센터 및 리소스 그룹의 이름을 대체합니다.

az apic update --name <api-center-name> --resource-group <resource-group-name> --identity '{"type": "SystemAssigned"}'

관리 ID에 API Management 서비스 읽기 권한자 역할 할당

API 가져오기를 허용하려면 API Management 인스턴스의 API Management 서비스 읽기 권한자 역할에 API 센터의 관리 ID를 할당합니다. 포털 또는 Azure CLI를 사용할 수 있습니다.

포털

1. 포털에서 API Management 인스턴스로 이동합니다.
2. 왼쪽 메뉴에서 액세스 제어(IAM)를 선택합니다.
3. + 역할 할당 추가를 선택합니다.
4. 역할 할당 추가 페이지에서 다음과 같이 값을 설정합니다.
   1. 역할 탭에서 - API Management 서비스 읽기 권한자를 선택합니다.
   2. 구성원 탭의 액세스 할당에서 관리 ID>+ 구성원 선택을 선택합니다.
   3. 관리 ID 선택 페이지에서 - 이전 섹션에서 추가한 API 센터의 시스템 할당 관리 ID를 선택합니다. 선택을 클릭합니다.
   4. 검토 + 할당을 선택합니다.

Azure CLI

1. ID의 보안 주체 ID를 가져옵니다. 시스템 할당 ID의 경우 az apic show 명령을 사용합니다.

   #! /bin/bash
   apicObjID=$(az apic show --name <api-center-name> \
       --resource-group <resource-group-name> \
       --query "identity.principalId" --output tsv)
   

   # Formatted for PowerShell
   $apicObjID=$(az apic show --name <api-center-name> `
       --resource-group <resource-group-name> `
       --query "identity.principalId" --output tsv)
   

2. az apim show 명령을 사용하여 API Management 인스턴스의 리소스 ID를 가져옵니다.

   #! /bin/bash
   apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

   # Formatted for PowerShell
   $apimID=$(az apim show --name <apim-name> --resource-group <resource-group-name> --query "id" --output tsv)
   

3. az role assignment create 명령을 사용하여 API Management 인스턴스에서 관리 ID에 API Management 서비스 읽기 권한자 역할을 할당합니다.

   #! /bin/bash
   scope="${apimID:1}"
   
   az role assignment create \
       --role "API Management Service Reader Role" \
       --assignee-object-id $apicObjID \
       --assignee-principal-type ServicePrincipal \
       --scope $scope 
   

   # Formatted for PowerShell
   $scope=$apimID.substring(1)
   
   az role assignment create `
       --role "API Management Service Reader Role" `
       --assignee-object-id $apicObjID `
       --assignee-principal-type ServicePrincipal `
       --scope $scope 
   

API Management 인스턴스 연결

포털을 사용하여 API Management 인스턴스를 연결할 수 있습니다.

1. 포털에서 API 센터로 이동합니다.
2. 자산 아래에서 환경을 선택합니다.
3. 링크(미리 보기)> + 새 링크를 선택합니다.
4. Azure API Management 서비스 연결 페이지에서 다음을 수행합니다.
   1. 연결하려는 구독, 리소스 그룹 및 Azure API Management 서비스를 선택합니다.
   2. 링크 세부 정보에 식별자를 입력합니다.
   3. 환경 세부 정보에 환경 제목(이름), 환경 유형 및 선택적 환경 설명을 입력합니다.
   4. API 세부 정보에서 동기화된 API에 대한 수명 주기 단계를 선택합니다. (API 센터에 API를 추가한 후 API에 대해 이 값을 업데이트할 수 있습니다.) 또한 API 정의를 동기화할지 여부를 선택합니다.
5. 만들기를 실행합니다.

환경이 API 센터에 추가됩니다. API Management API는 API 센터 인벤토리로 가져옵니다.

링크 삭제

API Management 인스턴스가 연결된 동안에는 API 센터에서 동기화된 API를 삭제할 수 없습니다. 필요한 경우 링크를 삭제할 수 있습니다. 링크를 삭제하는 경우:

• API 센터 인벤토리의 동기화된 API Management API가 삭제됩니다.
• API Management 인스턴스와 연결된 환경 및 배포가 삭제됩니다.

API Management 링크를 삭제하려면 다음을 수행합니다.

1. 포털에서 API 센터로 이동합니다.
2. 자산 아래에서 환경>링크(미리 보기)를 선택합니다.
3. 링크를 선택한 다음 삭제(휴지통 아이콘)를 선택합니다.

관련 콘텐츠

• Azure CLI 명령을 사용하여 API 인벤토리 관리
• API Management에서 Azure API 센터로 API 가져오기
• Azure API Management 설명서