Synapse Analythics REST API를 사용하여 파이프라인 시작, 모니터링 방법

다음은 REST API를 사용하여 Synapse Analythics 파이프라인을 시작 및 모니터링하는 방법에 대해 설명합니다.Azure Data Factory의 API도 같은 기능을 사용하므로 사용 방법이 다릅니다.

Azure Active Directory를 통해 어플리케이션 등록

클라이언트가 Synapse Analythics API에 액세스할 수 있도록 하려면 Azure Active Directory에 애플리케이션을 등록하고 클라이언트 기밀을 설정해야 합니다.다음 문서의 등록 및 설정

어플리케이션 등록

클라이언트 기밀 추가

를 참고하십시오.이 단계는 URL 리디렉션을 사용하지 않으므로 설정할 필요가 없습니다.
https://docs.microsoft.com/ja-jp/azure/active-directory/develop/quickstart-register-app
임차인 ID, 적용 ID, 기밀 값은 이후에 사용할 수 있으니 제어하세요.

Synapse RBAC 설정

파이프라인 작업을 위해 Azure AD 응용 프로그램을 사용하려면 다음 Synapse RBAC 역할을 응용 프로그램에 할당하십시오.

Synapse 사용자

Synapse 정보 사용자

Synapse 성과 사용자

다른 작업을 수행하는 RREAST API를 사용하는 경우 필요한 역할을 추가로 할당하십시오.

Azure Active Directory에서 액세스 토큰 가져오기

Azure Active Directory에서 액세스 토큰을 받으려면 다음 REST API를 호출하십시오.

https://login.microsoftonline.com/<テナントID>/oauth2/token

リクエストメソッド：POST
ヘッダー：
Content-Type：application/x-www-form-urlencoded
本文：
client_id=<アプリケーションID>&client_secret=<シークレット値>&grant_type=client_credentials&resource=https://dev.azuresynapse.net/

아래 응답을 받을 수 있기 때문에accessToken의 값을 방문 영패 값으로 보존합니다.

{
    "token_type": "Bearer",
    "expires_in": "3599",
    "ext_expires_in": "3599",
    "expires_on": "1649843102",
    "not_before": "1649839202",
    "resource": "https://dev.azuresynapse.net/",
    "access_token": "xxx"
}

Synapse 파이프라인 시작

다음 REST API를 호출하여 파이프를 시작합니다.

https://<ワークスペース名>.dev.azuresynapse.net/pipelines/<パイプライン名>/createRun?api-version=2020-12-01

リクエストメソッド：POST
ヘッダー：
Authorization：Bearer <アクセストークン値>
Content-Type：application/json
本文：(パイプライン起動時に指定するパラメータがある場合は指定)

다음 응답을 받을 수 있기 때문에runId의 값을 실행 ID로 보존합니다.

{
    "runId": "xxx"
}

REST API에 대한 요청/응답에 대한 자세한 내용은 다음 문서를 참조하십시오.
https://docs.microsoft.com/ja-jp/rest/api/synapse/data-plane/pipeline/create-pipeline-run

시작 파이프 모니터링

다음 REST API를 호출하여 파이프를 모니터링합니다.

https://<ワークスペース名>.dev.azuresynapse.net/pipelines/<パイプライン名>/pipelineruns/<ランId>/queryActivityruns?api-version=api-version=2020-12-01

リクエストメソッド：POST
ヘッダー：
Authorization：Bearer <アクセストークン値>
Content-Type：application/json
本文：(絞り込み条件を指定する場合は指定)

파이프라인의 실행 상황을 JSON으로 가져올 수 있습니다.
REST API에 대한 요청/응답에 대한 자세한 내용은 다음 문서를 참조하십시오.
https://docs.microsoft.com/ja-jp/rest/api/synapse/data-plane/pipeline-run/query-activity-runs