Visual Studio를 사용하여 Azure Digital Twins API에 요청을 보내는 방법

아티클
08/08/2024

Visual Studio 2022 는 애플리케이션에서 HTTP 요청을 구조화, 저장 및 직접 보내는 데 사용할 수 있는 파일에 대한 .http 지원을 제공합니다. Visual Studio의 이 기능을 사용하는 것은 HTTP 요청을 만들고 Azure Digital Twins REST API에 제출하는 한 가지 방법입니다. 이 문서에서는 Azure Digital Twins API .http 와 인터페이스할 수 있는 파일을 Visual Studio에서 설정하는 방법을 설명합니다.

이 문서에는 다음 단계에 대한 정보가 포함되어 있습니다.

Azure Digital Twins 인스턴스를 나타내는 변수를 사용하여 Visual Studio 프로젝트 및 .http 파일을 설정합니다.
Azure CLI를 사용하여 Visual Studio에서 API 요청을 만드는 데 사용할 수 있는 전달자 토큰 을 가져옵니다.
Azure Digital Twins REST API 설명서를 리소스로 사용하여 파일에서 .http 요청을 작성하고 Azure Digital Twins API로 보냅니다.

Azure Digital Twins에는 사용할 수 있는 두 가지 API 집합(데이터 평면 및 컨트롤 플레인)이 있습니다. 이러한 API 집합 간의 차이점에 대한 자세한 내용은 Azure Digital Twins API 및 SDK를 참조 하세요. 이 문서에는 두 API 집합에 대한 지침이 포함되어 있습니다.

Visual Studio의 파일 지원에 대한 .http 자세한 내용은 Visual Studio 2022에서 .http 파일 사용을 참조하세요.

필수 조건

Visual Studio를 사용하여 Azure Digital Twins API를 요청하려면 Azure Digital Twins 인스턴스를 설정하고 Visual Studio 2022를 다운로드해야 합니다. 이 섹션은 다음 단계를 위한 것입니다.

Azure Digital Twins 인스턴스 설정

이 문서에서 Azure Digital Twins로 작업하려면 Azure Digital Twins 인스턴스와 이를 사용하는 데 필요한 권한이 필요합니다. 이미 Azure Digital Twins 인스턴스를 설정한 경우 해당 인스턴스를 사용하고 다음 섹션으로 건너뛸 수 있습니다. 그렇지 않으면 인스턴스 및 인증 설정의 지침을 따릅니다. 지침에는 각 단계를 성공적으로 완료했는지 확인하는 데 도움이 되는 정보가 포함되어 있습니다.

인스턴스가 설정되면 인스턴스의 호스트 이름을 적어 둡니다. Azure Portal에서 호스트 이름을 찾을 수 있습니다.

Visual Studio 2022 다운로드

다음으로 Visual Studio 2022를 다운로드합니다. 설치에 ASP.NET 및 웹 개발 워크로드를 포함해야 합니다.

Visual Studio 프로젝트 설정

이 섹션에서는 HTTP 요청을 만드는 데 사용할 프로젝트를 Visual Studio에서 설정합니다.

머신에서 Visual Studio를 열고 새 프로젝트를 만듭니다. ASP.NET Core Empty 프로젝트 템플릿을 사용합니다.

.http 파일 만들기의 지침에 따라 프로젝트에 새 .http 파일을 만듭니다.

변수 추가

다음으로, Azure Digital Twins 리소스에 연결하는 데 사용할 일부 변수를 파일 맨 위에 .http 추가합니다.

필요한 변수 집합은 사용 중인 API 집합에 따라 달라지므로 아래 탭을 사용하여 데이터 평면과 컨트롤 플레 인 API 중에서 선택합니다.

데이터 평면
제어 평면

데이터 평면 요청에 대해 다음 변수를 추가합니다. Azure Digital Twins 인스턴스의 호스트 이름에 대한 자리 표시자가 하나 있습니다(digitaltwins.azure.net 종료됨).

@hostName=<host-name-of-your-Azure-Digital-Twins-instance>
@DPversion=2023-10-31

컨트롤 플레인 요청에 대해 다음 변수를 추가합니다. 리소스 값에 대한 자리 표시자를 포함합니다.

@instance=<name-of-your-Azure-Digital-Twins-instance>
@subscription=<ID-of-your-Azure-subscription>
@resourceGroup=<resource-group>
@CPversion=2023-01-31

전달자 토큰 추가

이제 Azure Digital Twins 인스턴스 및 Visual Studio 프로젝트를 설정했으므로 HTTP 요청이 Azure Digital Twins API에 대해 권한을 부여하는 데 사용할 수 있는 전달자 토큰을 가져와야 합니다.

이 토큰을 가져오는 방법에는 여러 가지가 있습니다. 이 문서에서는 Azure CLI를 사용하여 Azure 계정에 로그인하고 이러한 방식으로 토큰을 가져옵니다.

Azure CLI를 로컬로 설치한 경우 머신에서 명령 프롬프트를 시작하여 다음 명령을 실행할 수 있습니다. 아니면 브라우저에서 Azure Cloud Shell 창을 열고 여기에서 명령을 실행할 수 있습니다.

먼저 다음 명령을 실행하여 올바른 자격 증명으로 Azure에 로그인했는지 확인합니다.
```
az login
```
다음으로, az account get-access-token 명령을 사용하여 Azure Digital twins 서비스에 대한 액세스 권한이 있는 전달자 토큰을 가져옵니다. 이 명령에서는 Azure Digital Twins 리소스에 액세스할 수 있는 액세스 토큰을 가져오기 위해 Azure Digital Twins 서비스 엔드포인트에 대한 리소스 ID를 전달합니다.

토큰에 필요한 컨텍스트는 사용 중인 API 집합에 따라 달라지므로 아래 탭을 사용하여 데이터 평면과 컨트롤 플레 인 API 중에서 선택합니다.
- 데이터 평면
- 제어 평면
데이터 평면 API에서 사용할 토큰을 가져오려면 토큰 컨텍스트에 대해 다음 정적 값을 사용합니다. 0b07f429-9f4b-4714-9392-cc5e8e80c8b0 이 값은 Azure Digital Twins 서비스 엔드포인트에 대한 리소스 ID입니다.
```
az account get-access-token --resource 0b07f429-9f4b-4714-9392-cc5e8e80c8b0
```
컨트롤 플레인 API에서 사용할 토큰을 가져오려면 토큰 컨텍스트에 대해 다음 정적 값을 사용합니다. https://management.azure.com/
```
az account get-access-token --resource https://management.azure.com/
```
참고 항목

인스턴스와 다른 Microsoft Entra 테넌트에 속하는 서비스 주체 또는 사용자 계정을 사용하여 Azure Digital Twins 인스턴스에 액세스해야 하는 경우 Azure Digital Twins 인스턴스의 "홈" 테넌트에서 토큰을 요청해야 합니다. 이 프로세스에 대한 자세한 내용은 앱 인증 코드 작성을 참조하세요.
결과의 값을 accessToken 복사합니다. 이 값은 Visual Studio에 붙여넣어 요청에 권한을 부여하는 토큰 값 입니다.

팁

이 토큰은 5분 이상, 최대 60분 동안 유효합니다. 현재 토큰에 대해 할당된 시간을 초과하는 경우 이 섹션의 단계를 반복하여 새 토큰을 가져올 수 있습니다.

파일에 토큰 `.http` 추가

.http Visual Studio의 파일에서 토큰 값을 보유하는 다른 변수를 추가합니다.

데이터 평면
제어 평면

@token=<paste-data-plane-token>

이제 변수는 다음과 같이 표시됩니다.

@token=<paste-control-plane-token>

이제 변수는 다음과 같이 표시됩니다.

요청 추가

.http 이제 파일이 설정되었으므로 Azure Digital Twin API에 요청을 추가할 수 있습니다.

Azure Digital Twins REST API 참조를 열어 시작합니다. 이 설명서에는 API에서 다루는 모든 작업에 대한 세부 정보가 포함되어 있습니다. 실행하려는 요청의 참조 페이지로 이동합니다.

이 문서에서는 데이터 평면의 DigitalTwins 업데이트 API 를 예로 사용합니다.

요청 템플릿 추가: 참조 설명서에 표시된 HTTP 요청을 복사합니다.

Visual Studio에서 파일의 변수 아래에 새 줄에 요청을 붙여넣습니다 .http .
매개 변수 추가: 참조 설명서의 URI 매개 변수 섹션을 확인하여 요청에 필요한 매개 변수 값을 확인합니다. 일부 변수를 이전에 만든 변수로 바꾸고 다른 매개 변수 값을 적절하게 채울 수 있습니다. 변수를 참조하려면 변수 이름을 이중 중괄호(예: {{variable}}이중 중괄호)에 넣습니다. 자세한 내용은 변수를 참조 하세요.

참고 항목

데이터 평면 요청의 digitaltwins-hostname 경우 매개 변수이기도 합니다. 호스트 이름 변수의 값을 사용하려면 이 {{hostName}} 값을 바꿉다.

다음은 이 단계가 예제 요청에서 보이는 방식입니다.
권한 부여 추가: 요청 바로 아래에 다음 줄을 추가하여 전달자 토큰 변수로 인증을 지정합니다.
```
Authorization: Bearer {{token}}
```
다음은 이 단계가 예제 요청에서 보이는 방식입니다.
추가 헤더 추가: 참조 설명서의 요청 헤더 섹션을 확인하여 요청에 수반할 수 있는 헤더 값을 확인합니다. 와 같은 Content-Type기존 HTTP 헤더를 포함할 수도 있습니다. 각 헤더를 고유한 줄에 형식으로 추가합니다 HeaderName: Value. 자세한 내용은 요청 헤더를 참조 하세요.

다음은 이 단계가 예제 요청에서 보이는 방식입니다.
본문 추가: 참조 설명서의 요청 본문 섹션을 확인하여 요청에 필요한 본문 정보를 확인합니다. 빈 줄 뒤의 요청 본문을 추가합니다. 자세한 내용은 요청 본문을 참조 하세요.

다음은 이 단계가 예제 요청에서 보이는 방식입니다.
요청이 준비되면 요청 위의 요청 보내기를 선택하여 보냅니다.