ApiCenter온보딩플러그인

앱에 사용되는 API가 지정된 Azure API 센터 인스턴스에 등록되어 있는지 확인합니다.

플러그 인 인스턴스 정의

{
  "name": "ApiCenterOnboardingPlugin",
  "enabled": true,
  "pluginPath": "~appFolder/plugins/DevProxy.Plugins.dll",
  "configSection": "apiCenterOnboardingPlugin"
}

구성 예제

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "aaaa0a0a-bb1b-cc2c-dd3d-eeeeee4e4e4e",
    "resourceGroupName": "resource-group-name",
    "serviceName": "apic-instance",
    "workspaceName": "default",
    "createApicEntryForNewApis": true
  }
}

구성 속성

재산	묘사	기본값
createApicEntryForNewApis	개발자 프록시가 검색되고 아직 API 센터에 등록되지 않은 API에 대한 새 API 항목을 만들도록 true 설정합니다. false 개발 프록시로 설정된 경우 명령 프롬프트에 등록되지 않은 API만 나열됩니다.	true
resourceGroupName	Azure API 센터가 있는 리소스 그룹의 이름입니다.	없음
serviceName	개발자 프록시가 앱에서 사용되는 API가 등록되어 있는지 확인하는 데 사용해야 하는 Azure API 센터 인스턴스의 이름입니다.	없음
subscriptionId	Azure API Center 인스턴스가 있는 Azure 구독의 ID입니다.	없음
workspace	사용할 Azure API Center 작업 영역의 이름입니다.	default

명령줄 옵션

없음

발언

ApiCenterOnboardingPlugin 플러그 인은 앱에 사용되는 API가 지정된 Azure API 센터 인스턴스에 등록되어 있는지 확인합니다. API가 등록되지 않은 경우 플러그 인은 API 센터 인스턴스에 새 API 항목을 만들 수 있습니다.

Azure API Center에 연결하기 위해 플러그 인은 Azure 자격 증명(이 순서대로)을 사용합니다.

• 환경
• 워크로드 ID
• 관리 ID
• 비주얼 스튜디오
• 비주얼 스튜디오 코드
• Azure 커맨드 라인 인터페이스 (CLI)
• Azure PowerShell
• Azure 개발자 CLI

플러그 인이 Azure에 액세스하기 위한 액세스 토큰을 가져오지 못하면 오류가 표시되고 개발자 프록시가 이를 사용하지 않도록 설정합니다. 이러한 도구 중 하나를 사용하여 Azure에 로그인하고 dev Proxy를 다시 시작하여 ApiCenterOnboardingPlugin 플러그 인을 사용합니다.

CI/CD 파이프라인에서 개발 프록시를 사용하는 경우 subscriptionId, resourceGroupName, serviceName및 workspaceName 속성에 대한 값을 환경 변수로 전달할 수 있습니다. 환경 변수를 사용하려면 값 이름 앞에 @추가합니다. 예를 들면 다음과 같습니다.

{
  "apiCenterOnboardingPlugin": {
    "$schema": "https://raw.githubusercontent.com/dotnet/dev-proxy/main/schemas/v1.0.0/apicenteronboardingplugin.schema.json",
    "subscriptionId": "@AZURE_SUBSCRIPTION_ID",
    "resourceGroupName": "@AZURE_RESOURCE_GROUP_NAME",
    "serviceName": "@AZURE_APIC_INSTANCE_NAME",
    "workspaceName": "@AZURE_APIC_WORKSPACE_NAME",
    "createApicEntryForNewApis": true
  }
}

이 예제에서 ApiCenterOnboardingPlugin 플러그 인은 subscriptionId, resourceGroupName, serviceName및 workspaceName 속성을 각각 AZURE_SUBSCRIPTION_ID, AZURE_RESOURCE_GROUP_NAME, AZURE_APIC_INSTANCE_NAME및 AZURE_APIC_WORKSPACE_NAME 환경 변수의 값으로 설정합니다.

다음 단계

섀도 API를 찾는 방법