빠른 시작: REST API를 사용하여 첫 번째 Resource Graph 쿼리 실행

아티클
02/23/2024

REST API와 함께 Azure Resource Graph를 사용하는 첫 번째 단계는 사용 가능한 REST API를 호출하기 위한 도구가 준비되어 있는지 확인하는 것입니다. 그런 다음, 이 빠른 시작에서는 Azure Resource Graph REST API 엔드포인트를 호출하여 쿼리를 실행하고 결과를 검색하는 과정을 안내합니다.

이 과정이 끝나면 REST API 엔드포인트를 호출하기 위한 도구가 준비되어 첫 번째 Resource Graph 쿼리를 실행할 수 있습니다.

필수 조건

Azure 구독이 없는 경우 시작하기 전에 체험 계정을 만듭니다.

Azure Cloud Shell

Azure는 브라우저를 통해 사용할 수 있는 대화형 셸 환경인 Azure Cloud Shell을 호스트합니다. Cloud Shell에서 Bash 또는 PowerShell을 사용하여 Azure 서비스 작업을 수행할 수 있습니다. 로컬 환경에 아무 것도 설치할 필요 없이 Azure Cloud Shell의 미리 설치된 명령을 사용하여 이 문서의 코드를 실행할 수 있습니다.

Azure Cloud Shell을 시작하려면 다음을 수행합니다.

옵션	예제/링크
코드 또는 명령 블록의 오른쪽 상단에서 시도를 선택합니다. 시도를 선택해도 코드 또는 명령이 Cloud Shell에 자동으로 복사되지 않습니다.
https://shell.azure.com으로 이동하거나 Cloud Shell 시작 단추를 선택하여 브라우저에서 Cloud Shell을 엽니다.
Azure Portal의 오른쪽 위에 있는 메뉴 모음에서 Cloud Shell 단추를 선택합니다.

Azure Cloud Shell을 사용하려면:

Cloud Shell을 시작합니다.
코드 블록(또는 명령 블록)에서 복사 단추를 선택하여 코드 또는 명령을 복사합니다.
Windows 및 Linux에서 Ctrl+Shift+V를 선택하거나 macOS에서 Cmd+Shift+V를 선택하여 코드 또는 명령을 Cloud Shell 세션에 붙여넣습니다.
Enter를 선택하여 코드 또는 명령을 실행합니다.

REST API 사용 시작

REST API에 대해 잘 모르는 경우에는 REST API에 대한 일반적인 이해, 특히 요청 URI 및 요청 본문에 대한 일반적인 이해가 가능하도록 Azure REST API 참조를 검토하는 단계부터 시작합니다. 이 문서에서는 이러한 개념을 사용하여 Azure Resource Graph를 사용하는 작업에 대한 지침을 제공하며 이에 대한 실무 지식이 있다고 가정합니다. ARMClient 등과 같은 도구는 인증을 자동으로 처리할 수 있으며 초보자가 사용하면 좋습니다.

Azure Resource Graph 사양은 Azure Resource Graph REST API를 참조하세요.

REST API 및 PowerShell

REST API 호출을 만드는 도구가 없는 경우 지침에 대해 PowerShell을 사용하는 것이 좋습니다. 다음 코드 샘플은 Azure로 인증하기 위한 헤더를 가져옵니다. 인증 헤더(다른 이름: 전달자 토큰)를 생성하고 모든 매개 변수 또는 요청 본문에 연결할 REST API URI를 제공합니다.

# Log in first with Connect-AzAccount if not using Cloud Shell

$azContext = Get-AzContext
$azProfile = [Microsoft.Azure.Commands.Common.Authentication.Abstractions.AzureRmProfileProvider]::Instance.Profile
$profileClient = New-Object -TypeName Microsoft.Azure.Commands.ResourceManager.Common.RMProfileClient -ArgumentList ($azProfile)
$token = $profileClient.AcquireAccessToken($azContext.Subscription.TenantId)
$authHeader = @{
    'Content-Type'='application/json'
    'Authorization'='Bearer ' + $token.AccessToken
}

# Invoke the REST API
$restUri = "https://management.azure.com/subscriptions/$($azContext.Subscription.Id)?api-version=2020-01-01"
$response = Invoke-RestMethod -Uri $restUri -Method Get -Headers $authHeader

$response 변수는 ConvertFrom-Json과 같은 cmdlet으로 구문 분석할 수 있는 Invoke-RestMethod cmdlet의 결과를 보관합니다. REST API 서비스 엔드포인트에 요청 본문이 필요하면 JSON 형식의 변수를 Invoke-RestMethod의 -Body 매개 변수에 제공합니다.

첫 번째 Resource Graph 실행

원하는 환경에 REST API 도구가 추가되었으므로, 이제 간단한 구독 기반 Resource Graph 쿼리를 시도해 볼 수 있습니다. 쿼리는 각 리소스의 이름 및 리소스 형식과 함께 처음 5개 Azure 리소스를 반환합니다. 관리 그룹별로 쿼리하려면 subscriptions 대신 managementgroups를 사용하세요. 전체 테넌트를 쿼리하려면 요청 본문에서 managementgroups 및 subscriptions 속성을 모두 생략합니다.

각 REST API 호출의 요청 본문에는 사용자 고유의 값으로 바꿔야 하는 다음과 같은 변수가 있습니다.

{subscriptionID} - 사용자의 구독 ID로 대체

REST API 및 resources 엔드포인트를 사용하여 첫 번째 Azure Resource Graph 쿼리를 실행합니다.
- REST API URI
```
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
```
- 요청 본문
```
{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | limit 5"
}
```
참고 항목

이 쿼리 예에서는 order by와 같은 정렬 한정자를 제공하지 않으므로 이 쿼리를 여러 번 실행하면 요청마다 다른 리소스 세트가 생성될 수 있습니다.
다음과 같이 Name 속성을 기준으로 order by하도록 resouces 엔드포인트 호출을 업데이트하고 쿼리를 변경합니다.
- REST API URI
```
POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01
```
- 요청 본문
```
{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | limit 5 | order by name asc"
}
```
참고 항목

첫 번째 쿼리와 마찬가지로 이 쿼리를 여러 번 실행하면 요청마다 다른 리소스 집합이 생성될 수 있습니다. 쿼리 명령의 순서는 중요합니다. 이 예에서 order by는 limit 뒤에 옵니다. 이 명령 순서는 먼저 쿼리 결과를 제한한 다음, 정렬합니다.

다음과 같이 resources 엔드포인트 호출을 업데이트하고 쿼리를 변경하여 먼저 Name 속성을 기준으로 order by한 다음, 상위 5개 결과로 limit합니다.

REST API URI

POST https://management.azure.com/providers/Microsoft.ResourceGraph/resources?api-version=2021-03-01

요청 본문

{
    "subscriptions": [
        "{subscriptionID}"
    ],
    "query": "Resources | project name, type | order by name asc | limit 5"
}

최종 쿼리가 여러 번 실행될 때 환경이 전혀 변경되지 않는다고 가정하면 반환되는 결과는 Name 속성을 기준으로 일관되고 정렬되지만 여전히 상위 5개 결과로 제한됩니다.

Azure Resource Graph에 대한 REST API 호출 추가 예제는 Azure Resource Graph REST 예제를 참조하세요.

리소스 정리

REST API에는 제거할 라이브러리 또는 모듈이 없습니다. ARMClient와 같은 도구를 설치하여 호출을 수행하고 더 이상 필요하지 않은 경우 지금 도구를 제거할 수 있습니다.

다음 단계

이 빠른 시작에서는 Resource Graph REST API 엔드포인트를 호출하고 첫 번째 쿼리를 실행했습니다. 리소스 그래프 언어에 대한 자세한 내용을 보려면 쿼리 언어 정보 페이지로 이동하세요.

쿼리 언어에 대한 자세한 정보 가져오기

다음을 통해 공유