다음을 통해 공유


자습서: ASP.NET Core 앱에서 Key Vault 참조 사용

이 자습서에서는 Azure App Configuration 서비스를 Azure Key Vault와 함께 사용합니다. App Configuration 및 Key Vault는 대부분의 애플리케이션 배포에서 함께 사용되는 보완 서비스입니다.

애플리케이션은 App Configuration에 저장된 다른 키와 마찬가지로 App Configuration 클라이언트 공급자를 사용하여 Key Vault 참조를 검색할 수 있습니다. App Configuration에 Key Vault 참조를 추가하면 App Configuration은 Key Vault에 저장된 값을 참조하는 키를 만듭니다. App Configuration에서 저장하는 값은 Key Vault 값 또는 자격 증명이 아닙니다. 대신 Key Vault의 값을 참조하는 URI입니다. 클라이언트 공급자는 키를 Key Vault 참조로 인식하므로 Key Vault를 사용하여 해당 값을 검색합니다.

애플리케이션은 App Configuration 및 Key Vault 모두에 대해 제대로 인증할 책임이 있습니다. 두 서비스는 직접 통신하지 않습니다.

이 자습서에서는 코드로 Key Vault 참조를 구현하는 방법을 보여 줍니다. 필수 구성 요소에 나열된 ASP.NET Core 빠른 시작에 도입된 웹앱을 기반으로 합니다. 계속하기 전에 빠른 시작을 완료하세요.

이 자습서의 단계는 임의의 코드 편집기를 사용하여 수행할 수 있습니다. 예를 들어 Visual Studio Code는 Windows, macOS 및 Linux 운영 체제에서 사용할 수 있는 크로스 플랫폼 코드 편집기입니다.

이 자습서에서는 다음을 수행합니다.

  • Key Vault에 저장된 값을 참조하는 App Configuration 키 만들기
  • ASP.NET Core 웹 애플리케이션에서 이 키의 값에 액세스

필수 구성 요소

App Configuration을 사용한 ASP.NET Core 앱 만들기 빠른 시작를 완료합니다.

키 저장소 만들기

  1. Azure Portal로 이동한 다음 리소스 만들기를 선택합니다.

    Azure Portal의 스크린샷. Azure 서비스에서 리소스 만들기가 강조 표시되고 여러 리소스 종류에 대한 아이콘이 그려집니다.

  2. 검색 상자에 Key Vault를 입력합니다. 결과 목록에서 Key Vault를 선택합니다.

  3. Key Vault 페이지에서 만들기를 선택합니다.

  4. 키 자격 증명 보관소 만들기 페이지에서 다음 정보를 입력합니다.

    • 구독의 경우: 구독을 선택합니다.
    • 리소스 그룹의 경우: 기존 리소스 그룹의 이름을 입력하거나 새로 만들기를 선택하고 리소스 그룹 이름을 입력합니다.
    • 키 볼트 이름: 고유한 이름을 입력합니다.
    • 지역: 위치를 선택합니다.
  5. 다른 옵션의 경우 기본값을 사용합니다.

  6. Review + create를 선택합니다.

  7. 시스템에서 입력의 유효성을 검사하고 표시한 후 만들기를 선택합니다.

이때 사용자의 Azure 계정은 이 새 자격 증명 모음에 액세스할 권한이 있는 유일한 계정입니다.

Key Vault에 비밀 추가

앱에서 Key Vault에서의 검색을 테스트하려면 먼저 다음 단계를 수행하여 Key Vault에 시크릿을 추가합니다. 추가하는 비밀을 Message라고 하며 해당 값은 "Key Vault의 Hello"입니다.

  1. Key Vault 리소스 메뉴에서 개체>비밀을 선택합니다.

  2. 생성/가져오기를 선택합니다.

  3. 비밀 만들기 대화 상자에서 다음 값을 입력합니다.

    • 업로드 옵션의 경우: 수동을 입력합니다.
    • 이름: 메시지를 입력합니다.
    • 비밀 값: Key Vault에서 Hello를 입력합니다.
  4. 다른 옵션의 경우 기본값을 사용합니다.

  5. 만들기를 선택합니다.

App Configuration에 Key Vault 참조 추가

  1. Azure Portal에 로그인합니다. 모든 리소스를 선택한 다음, 빠른 시작에서 만든 App Configuration 저장소를 선택합니다.

  2. 구성 탐색기를 선택합니다.

  3. > 를 선택한 다음, 다음 값을 입력합니다.

    • 에 대해: TestApp:Settings:KeyVaultMessage를 입력합니다.
    • 레이블의 경우: 값을 비워 둡니다.
    • 구독, 리소스 그룹, 및 키 볼트에 이전 자습서에서 키 볼트를 생성할 때 사용한 값을 입력하십시오.
    • 비밀: 이전 섹션에서 만든 메시지라는 비밀을 선택합니다.

    Key Vault 참조를 만들기 위한 대화 상자의 스크린샷. 키, 구독, 리소스 그룹, Key Vault 및 비밀 필드가 채워집니다.

Key Vault 참조를 사용하도록 코드 업데이트

  1. 빠른 시작에서 만든 ASP.NET Core 웹앱 프로젝트가 포함된 폴더로 이동합니다.

  2. 명령 프롬프트에서 다음 명령을 실행합니다. 이 명령은 프로젝트 파일에 NuGet 패키지 참조를 추가 Azure.Identity 하거나 업데이트합니다.

    dotnet add package Azure.Identity
    
  3. Program.cs를 엽니다. using 지시문 섹션에서 Azure.Identity 네임스페이스의 형식을 가져오기 위해 다음 줄을 추가합니다.

    using Azure.Identity;
    
  4. Program.cs 메서드 호출을 AddAzureAppConfiguration 다음 코드의 호출로 바꿉 있습니다. 업데이트된 호출에는 ConfigureKeyVault 옵션이 포함됩니다. 이 옵션은 SetCredential 메서드를 사용하여 키 자격 증명 모음을 인증하는 데 필요한 자격 증명을 전달합니다.

    var builder = WebApplication.CreateBuilder(args);
    
    // Retrieve the App Configuration endpoint.
    string endpoint = builder.Configuration.GetValue<string>("Endpoints:AppConfiguration")
    
    // Load the configuration from App Configuration.
    builder.Configuration.AddAzureAppConfiguration(options =>
    {
        options.Connect(new Uri(endpoint), new DefaultAzureCredential());
    
        options.ConfigureKeyVault(keyVaultOptions =>
        {
            keyVaultOptions.SetCredential(new DefaultAzureCredential());
        });
    });
    

    여러 키 자격 증명 저장소가 있는 경우 시스템은 모든 저장소에 대해 동일한 자격 증명을 사용합니다. Key Vault에 다른 자격 증명이 필요한 경우 AzureAppConfigurationKeyVaultOptions 클래스의 Register 또는 SetSecretResolver 메서드를 사용하여 설정할 수 있습니다.

  5. 코드에서 Key Vault 참조의 값에 액세스하려면 프로젝트의 Pages 폴더로 이동합니다. Index.cshtml을 열고 해당 내용을 다음 코드로 바꿉니다. 이전 블록의 코드는 App Configuration 연결을 초기화하고 Key Vault 연결을 설정합니다. 따라서 Index.cshtml에서 일반 App Configuration 키의 값에 액세스하는 것과 동일한 방식으로 Key Vault 참조의 값에 액세스할 수 있습니다.

    @page
    @using Microsoft.Extensions.Configuration
    @inject IConfiguration Configuration
    
    <style>
        body {
            background-color: @Configuration["TestApp:Settings:BackgroundColor"]
        }
        h1 {
            color: @Configuration["TestApp:Settings:FontColor"];
            font-size: @Configuration["TestApp:Settings:FontSize"]px;
        }
    </style>
    
    <h1>@Configuration["TestApp:Settings:Message"]
        and @Configuration["TestApp:Settings:KeyVaultMessage"]</h1>
    

    이 코드는 구성 값에 액세스하는 것과 동일한 방식으로 Key Vault 참조 TestApp:Settings:KeyVaultMessageTestApp:Settings:Message값에 액세스합니다.

Key Vault에 앱 액세스 권한 부여

App Configuration은 키 자격 증명 모음에 액세스하지 않습니다. 대신, 앱은 Key Vault에서 직접 읽기 때문에 키 자격 증명 모음의 비밀에 대한 액세스 권한을 앱에 부여해야 합니다. 이러한 방식으로 비밀은 항상 앱과 함께 유지됩니다. Key Vault 액세스 정책 또는 Azure 역할 기반 액세스 제어를 사용하여 액세스 권한을 부여할 수 있습니다.

이 자습서의 코드는 인증에 클래스를 DefaultAzureCredential 사용합니다. 이 집계된 토큰 자격 증명은 EnvironmentCredential, ManagedIdentityCredential, SharedTokenCacheCredential, VisualStudioCredential와 같은 여러 자격 증명 형식을 자동으로 시도합니다. 자세한 내용은 DefaultAzureCredential 클래스를 참조하세요.

DefaultAzureCredential을(를) 명시적 자격 증명 유형으로 교체할 수 있습니다. 그러나 사용하는 DefaultAzureCredential경우 로컬 및 Azure 환경에서 코드를 실행할 수 있습니다. 예를 들어, 앱이 Azure에서 실행되는 경우 DefaultAzureCredentialManagedIdentityCredential을 사용합니다. 그러나 로컬 개발에 Visual Studio를 사용하는 경우 DefaultAzureCredential은/는 자동으로 SharedTokenCacheCredential이나 VisualStudioCredential로 전환됩니다.

또는 AZURE_TENANT_ID, AZURE_CLIENT_ID, 및 AZURE_CLIENT_SECRET 환경 변수를 설정할 수 있습니다. 이렇게 하면 DefaultAzureCredentialEnvironmentCredential 변수를 사용하여 키 보관소에 인증합니다.

Azure App Service, Azure Kubernetes Service 또는 Azure Container Instance와 같은 관리 ID를 사용하도록 설정된 Azure 서비스에 앱을 배포한 후에는 키 자격 증명 모음에 액세스할 수 있는 Azure 서비스의 관리 ID 권한을 부여합니다. 앱이 Azure에서 실행되는 경우 DefaultAzureCredential은 자동으로 ManagedIdentityCredential을 사용합니다. 동일한 관리 ID를 사용하여 App Configuration과 Key Vault로 둘 다 인증할 수 있습니다. 자세한 내용은 관리 ID를 사용하여 App Configuration에 액세스를 참조하세요.

로컬로 앱 빌드 및 실행

  1. .NET CLI를 사용하여 앱을 빌드하려면 명령 프롬프트에서 다음 명령을 실행합니다.

    dotnet build
    
  2. 빌드가 완료된 후 다음 명령을 사용하여 웹앱을 로컬로 실행합니다.

    dotnet run
    
  3. 명령의 dotnet run 출력에서 웹앱이 수신 대기하는 URL(예: http://localhost:5292.)을 찾습니다. 브라우저를 열고 해당 URL로 이동합니다.

    localhost:5292에 열려 있는 브라우저의 스크린샷. 페이지의 텍스트에는 Azure App Configuration의 데이터와 Key Vault의 Hello가 표시됩니다.

    웹 페이지의 텍스트에는 다음 구성 요소가 포함됩니다.

    • App Configuration 저장소에서 TestApp:Settings:Message 키와 연결된 값입니다.
    • 키 자격 증명 모음에 저장된 메시지 암호의 값입니다.

리소스 정리

이 문서에서 만든 리소스를 계속 사용하지 않으려면 여기서 만든 리소스 그룹을 삭제하여 요금이 부과되지 않도록 합니다.

중요

리소스 그룹을 삭제하면 다시 되돌릴 수 없습니다. 리소스 그룹 및 포함된 모든 리소스가 영구적으로 삭제됩니다. 잘못된 리소스 그룹 또는 리소스를 자동으로 삭제하지 않도록 합니다. 유지하려는 다른 리소스가 포함된 리소스 그룹 내에서 이 문서에 대한 리소스를 만든 경우 리소스 그룹을 삭제하는 대신 해당 창에서 각 리소스를 개별적으로 삭제합니다.

  1. Azure Portal에 로그인하고 리소스 그룹을 선택합니다.
  2. 이름으로 필터링 상자에서 리소스 그룹의 이름을 입력합니다.
  3. 결과 목록에서 리소스 그룹 이름을 선택하여 개요를 확인합니다.
  4. 리소스 그룹 삭제를 선택합니다.
  5. 리소스 그룹 삭제를 확인하는 메시지가 표시됩니다. 리소스 그룹의 이름을 입력하여 확인하고 삭제를 선택합니다.

잠시 후, 리소스 그룹 및 모든 해당 리소스가 삭제됩니다.

다음 단계