Azure API Management Policy Assistant

It's your friendly assistant to generate Azure API Management policy documents, using Azure OpenAI Service.

Readings

• English:
  • GitHub Copilot for Azure API Management Policies
• 한국어:
  • GitHub 코파일럿으로 손쉽게 APIM 정책 문서 작성하기

Prerequisites

• Azure Subscription
• Azure OpenAI Service
• Azure CLI
• Azure Developer CLI
• GitHub CLI
• Azure Static Web Apps CLI

Getting Started

Provisioning Azure Resources

1. Fork this repository to your GitHub account, {{GITHUB_USERNAME}}.

2. Run the commands below to set up a resource names:

   # PowerShell
   $AZURE_ENV_NAME="assistant$(Get-Random -Max 9999)"
   $GITHUB_USERNAME="{{GITHUB_USERNAME}}"
   
   # Bash
   AZURE_ENV_NAME="assistant$RANDOM"
   GITHUB_USERNAME="{{GITHUB_USERNAME}}"

3. Run the commands below to provision Azure resources:

   azd auth login
   azd init -e $AZURE_ENV_NAME
   azd up

   You might be asked to input your GitHub username and repository name.

Deploying Applications to Azure

1. Run the commands below to deploy apps to Azure:

   az login
   gh auth login
   azd pipeline config
   gh workflow run "Azure Dev" --repo $GITHUB_USERNAME/apim-policy-assistant

Deprovisioning Azure Resources

1. To avoid unexpected billing shock, run the commands below to deprovision Azure resources:

   azd down --force --purge --no-prompt

Local Development

• On Windows, use ApimPolicyAssistant.Win.sln to open the solution that contains WebForm, WinForm and WPF apps.
• On other platforms, use ApimPolicyAssistant.sln.

local.settings.json - ApimPolicyAssistant.ApiApp

1. Copy local.settings.sample.json to local.settings.json.

2. Substitute the following values in the local.settings.json with the actual values:

   "OpenAIApi__Endpoint": "https://aoai-{{AZURE_ENV_NAME}}.openai.azure.com/",
   "OpenAIApi__AuthKey": "{{AOAI_API_KEY}}",
   "OpenAIApi__DeploymentId": "{{DEPLOYMENT_ID}}",

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{AOAI_API_KEY}}: API Key of Azure OpenAI Service.
   • {{DEPLOYMENT_ID}}: Azure OpenAI Service deployment ID. It looks like model-gpt35turbo16k.

local.settings.json - ApimPolicyAssistant.ApiApp.SwaFacade

1. Copy local.settings.sample.json to local.settings.json.

2. Substitute the following values in the local.settings.json with the actual values:

   "Apim__BaseUrl": "https://apim-{{AZURE_ENV_NAME}}.azure-api.net/aoai",
   "Apim__SubscriptionKey": "{{APIM_SUBSCRIPTION_KEY}}",

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{APIM_SUBSCRIPTION_KEY}}: Subscription Key of Azure API Management.

appsettings.Development.json - ApimPolicyAssistant.WebApp.WebForm

1. Copy appsettings.json to appsettings.Development.json.

2. Substitute the following sections with the actual values:

   "Apim": {
     "BaseUrl": "https://apim-{{AZURE_ENV_NAME}}.azure-api.net/aoai",
     "SubscriptionKey": "{{APIM_SUBSCRIPTION_KEY}}"
   }

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{APIM_SUBSCRIPTION_KEY}}: Subscription Key of Azure API Management.

appsettings.Development.json - ApimPolicyAssistant.WebApp.BlazorServer

1. Copy appsettings.json to appsettings.Development.json.

2. Substitute the following sections with the actual values:

   "Apim": {
     "BaseUrl": "https://apim-{{AZURE_ENV_NAME}}.azure-api.net/aoai",
     "SubscriptionKey": "{{APIM_SUBSCRIPTION_KEY}}"
   }

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{APIM_SUBSCRIPTION_KEY}}: Subscription Key of Azure API Management.

appsettings.Development.json - ApimPolicyAssistant.HybridApp.BlazorMaui

1. Copy appsettings.json to appsettings.Development.json.

2. Substitute the following sections with the actual values:

   "Apim": {
     "BaseUrl": "https://apim-{{AZURE_ENV_NAME}}.azure-api.net/aoai",
     "SubscriptionKey": "{{APIM_SUBSCRIPTION_KEY}}"
   }

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{APIM_SUBSCRIPTION_KEY}}: Subscription Key of Azure API Management.

appsettings.Development.json - ApimPolicyAssistant.HybridApp.BlazorWinForm

1. Copy appsettings.json to appsettings.Development.json.

2. Substitute the following sections with the actual values:

   "Apim": {
     "BaseUrl": "https://apim-{{AZURE_ENV_NAME}}.azure-api.net/aoai",
     "SubscriptionKey": "{{APIM_SUBSCRIPTION_KEY}}"
   }

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{APIM_SUBSCRIPTION_KEY}}: Subscription Key of Azure API Management.

appsettings.Development.json - ApimPolicyAssistant.HybridApp.BlazorWpf

1. Copy appsettings.json to appsettings.Development.json.

2. Substitute the following sections with the actual values:

   "Apim": {
     "BaseUrl": "https://apim-{{AZURE_ENV_NAME}}.azure-api.net/aoai",
     "SubscriptionKey": "{{APIM_SUBSCRIPTION_KEY}}"
   }

   • {{AZURE_ENV_NAME}}: Azure environment name. It looks like assistant**** where **** is a random number.
   • {{APIM_SUBSCRIPTION_KEY}}: Subscription Key of Azure API Management.

TO-DO

• Script for local development configuration
• Microsoft Graph integration
• Microsoft Teams integration