教學課程：使用 Service 連線 or 連線 Web 應用程式 Azure 應用程式組態

發行項
01/06/2024

瞭解如何使用下列其中一種方法，將 Azure App 服務上執行的 ASP.NET Core 應用程式連線到 Azure 應用程式組態：

系統指派的受控識別（SMI）
使用者指派的受控識別（UMI）
服務主體
Connection string

在本教學課程中，使用 Azure CLI 來完成下列工作：

設定 Azure 資源
建立 Web 應用程式與應用程式組態之間的連線
建置並部署您的應用程式以 Azure App 服務

必要條件

具有有效訂用帳戶的 Azure 帳戶。訂用帳戶內的存取角色必須是「參與者」或「擁有者」。免費建立帳戶。
Azure CLI。您可以在 Azure Cloud Shell 中使用，或將其安裝在本機。
Git

在 Azure CLI 中執行 az login 以登入 Azure。

設定 Azure 資源

從建立 Azure 資源開始。

複製下列範例存放庫：

git clone https://github.com/Azure-Samples/serviceconnector-webapp-appconfig-dotnet.git

將 Web 應用程式部署至 Azure

請遵循下列步驟來建立App Service並部署範例應用程式。請確定您有訂用帳戶參與者或擁有者角色。

建立應用程式服務，並部署使用系統指派的受控識別來與應用程式組態互動的範例應用程式。

# Change directory to the SMI sample
cd serviceconnector-webapp-appconfig-dotnet\system-managed-identity

# Create a web app

LOCATION='eastus'
RESOURCE_GROUP_NAME='service-connector-tutorial-rg'
APP_SERVICE_NAME='webapp-appconfig-smi'

az webapp up --location $LOCATION --resource-group $RESOURCE_GROUP_NAME --name $APP_SERVICE_NAME

參數	描述	範例
Location	選擇與您接近的位置。用來 `az account list-locations --output table` 列出位置。	eastus
資源群組名稱	您將使用此資源群組來組織完成本教學課程所需的所有 Azure 資源。	service-connector-tutorial-rg
App Service 名稱	應用程式服務名稱會作為 Azure 中的資源名稱，並以伺服器端點 `https://<app-service-name>.azurewebsites.com`的形式形成應用程式的完整功能變數名稱。此名稱在所有 Azure 中都必須是唯一的，且唯一允許的字元為 `A`-`Z`、-`09` 和。`-`	webapp-appconfig-smi

建立應用程式服務，並部署使用使用者指派的受控識別來與應用程式組態互動的範例應用程式。

# Change directory to the UMI sample
cd serviceconnector-webapp-appconfig-dotnet\user-assigned-managed-identity

# Create a web app

LOCATION='eastus'
RESOURCE_GROUP_NAME='service-connector-tutorial-rg'
APP_SERVICE_NAME='webapp-appconfig-umi'

az webapp up --location $LOCATION --resource-group $RESOURCE_GROUP_NAME --name $APP_SERVICE_NAME

參數	描述	範例
Location	選擇與您接近的位置。用來 `az account list-locations --output table` 列出位置。	eastus
資源群組名稱	您將使用此資源群組來組織完成本教學課程所需的所有 Azure 資源。	service-connector-tutorial-rg
App Service 名稱	應用程式服務名稱會作為 Azure 中的資源名稱，並以伺服器端點 `https://<app-service-name>.azurewebsites.com`的形式形成應用程式的完整功能變數名稱。此名稱在所有 Azure 中都必須是唯一的，且唯一允許的字元為 `A`-`Z`、-`09` 和。`-`	webapp-appconfig-umi

建立使用者指派的受控識別。將輸出儲存到暫時記事本。

az identity create --resource-group $RESOURCE_GROUP_NAME -n "myIdentity"

建立應用程式服務，並部署使用服務主體與應用程式組態互動的範例應用程式。

# Change directory to the service principal sample
cd serviceconnector-webapp-appconfig-dotnet\service-principal

# Create a web app

LOCATION='eastus'
RESOURCE_GROUP_NAME='service-connector-tutorial-rg'
APP_SERVICE_NAME='webapp-appconfig-sp'

az webapp up --location $LOCATION --resource-group $RESOURCE_GROUP_NAME --name $APP_SERVICE_NAME

參數	描述	範例
Location	選擇與您接近的位置。用來 `az account list-locations --output table` 列出位置。	eastus
資源群組名稱	您將使用此資源群組來組織完成本教學課程所需的所有 Azure 資源。	service-connector-tutorial-rg
App Service 名稱	應用程式服務名稱會作為 Azure 中的資源名稱，並以伺服器端點 `https://<app-service-name>.azurewebsites.com`的形式形成應用程式的完整功能變數名稱。此名稱在所有 Azure 中都必須是唯一的，且唯一允許的字元為 `A`-`Z`、-`09` 和。`-`	webapp-appconfig-sp

建立服務主體，請務必將取代 yourSubscriptionID 為您的實際訂用帳戶標識符。將輸出儲存到暫時記事本。

az ad sp create-for-rbac --name myServicePrincipal --role Contributor --scopes /subscriptions/{yourSubscriptionID}/resourceGroups/$RESOURCE_GROUP_NAME

建立應用程式服務，並部署使用連接字串與應用程式組態互動的範例應用程式。

# Change directory to the service principal sample
cd serviceconnector-webapp-appconfig-dotnet\connection-string

# Create a web app

LOCATION='eastus'
RESOURCE_GROUP_NAME='service-connector-tutorial-rg'
APP_SERVICE_NAME='webapp-appconfig-cs'

az webapp up --location $LOCATION --resource-group $RESOURCE_GROUP_NAME --name $APP_SERVICE_NAME

參數	描述	範例
Location	選擇與您接近的位置。用來 `az account list-locations --output table` 列出位置。	eastus
資源群組名稱	您將使用此資源群組來組織完成本教學課程所需的所有 Azure 資源。	service-connector-tutorial-rg
App Service 名稱	應用程式服務名稱會作為 Azure 中的資源名稱，並以伺服器端點 `https://<app-service-name>.azurewebsites.com`的形式形成應用程式的完整功能變數名稱。此名稱在所有 Azure 中都必須是唯一的，且唯一允許的字元為 `A`-`Z`、-`09` 和。`-`	webapp-appconfig-cs

建立 Azure 應用程式組態存放區

APP_CONFIG_NAME='my-app-config'

az appconfig create -g $RESOURCE_GROUP_NAME -n $APP_CONFIG_NAME --sku Free -l eastus

將測試組態檔匯入至 Azure 應用程式組態。
- Smi
- UMI
- 服務主體
- 連接字串
使用系統指派的受控識別，將測試組態檔匯入 Azure 應用程式組態。
1. Cd 到資料夾 ServiceConnectorSample
2. 將 ./sampleconfigs.json 測試組態檔匯入應用程式組態存放區。如果您使用 Cloud Shell，請先上傳 sampleconfigs.json ，再執行命令。
```
az appconfig kv import -n $APP_CONFIG_NAME --source file --format json --path ./sampleconfigs.json --separator : --yes
```
使用使用者指派的受控識別，將測試組態檔匯入 Azure 應用程式組態。
1. Cd 到資料夾 ServiceConnectorSample
2. 將 ./sampleconfigs.json 測試組態檔匯入應用程式組態存放區。如果您使用 Cloud Shell，請先上傳 sampleconfigs.json ，再執行命令。
```
az appconfig kv import -n $APP_CONFIG_NAME --source file --format json --path ./sampleconfigs.json --separator : --yes
```
使用服務主體將測試組態檔匯入至 Azure 應用程式組態。
1. Cd 到資料夾 ServiceConnectorSample
2. 將 ./sampleconfigs.json 測試組態檔匯入應用程式組態存放區。如果您使用 Cloud Shell，請先上傳 sampleconfigs.json ，再執行命令。
```
az appconfig kv import -n $APP_CONFIG_NAME --source file --format json --path ./sampleconfigs.json --separator : --yes
```
使用連接字串將測試組態檔匯入至 Azure 應用程式組態。
1. Cd 到資料夾 ServiceConnectorSample
2. 將 ./sampleconfigs.json 測試組態檔匯入應用程式組態存放區。如果您使用 Cloud Shell，請先上傳 sampleconfigs.json ，再執行命令。
```
az appconfig kv import -n $APP_CONFIG_NAME --source file --format json --path ./sampleconfigs.json --separator : --yes
```

連線 Web 應用程式以應用程式組態

建立 Web 應用程式與應用程式組態存放區之間的連線。

使用系統指派的受控識別驗證，在 Web 應用程式與應用程式組態存放區之間建立連線。此連線是透過 Service 連線 or 來完成。

az webapp connection create appconfig -g $RESOURCE_GROUP_NAME -n $APP_SERVICE_NAME --app-config $APP_CONFIG_NAME --tg $RESOURCE_GROUP_NAME --connection "app_config_smi" --system-identity

system-identity 是指系統指派的受控識別（SMI）驗證類型。服務連線 or 也支援下列驗證：使用者指派的受控識別（UMI）、連接字串（秘密）和服務主體。

使用使用者指派的受控識別驗證，在 Web 應用程式與應用程式組態存放區之間建立連線。此連線是透過 Service 連線 or 來完成。

az webapp connection create appconfig -g $RESOURCE_GROUP_NAME -n $APP_SERVICE_NAME --app-config $APP_CONFIG_NAME --tg $RESOURCE_GROUP_NAME --connection "app_config_umi" --user-identity client-id=<myIdentityClientId> subs-id=<myTestSubsId>

user-identity 是指使用者指派的受控識別驗證類型。服務連線 or 也支援下列驗證：系統指派的受控識別、連接字串（秘密）和服務主體。

有兩種方式可以找到 client-id：

在 Azure CLI 中，輸入 az identity show -n "myIdentity" -g $RESOURCE_GROUP_NAME --query 'clientId'。
在 Azure 入口網站中，開啟稍早建立的受控識別，然後在 [概觀] 中取得 [用戶端標識符] 底下的值。

使用服務主體，在 Web 應用程式與應用程式組態存放區之間建立連線。這是透過 Service 連線 or 來完成。

az webapp connection create appconfig -g $RESOURCE_GROUP_NAME -n $APP_SERVICE_NAME --app-config $APP_CONFIG_NAME --tg $RESOURCE_GROUP_NAME --connection "app_config_sp" --service-principal client-id=<mySPClientId>  secret=<mySPSecret>

service-principal 是指服務主體驗證類型。服務連線 or 也支援下列驗證：系統指派的受控識別（UMI）、使用者指派的受控識別（UMI）和連接字串（秘密）。

使用連接字串，在 Web 應用程式與應用程式組態存放區之間建立連線。此連線是透過 Service 連線 or 來完成。

az webapp connection create appconfig -g $RESOURCE_GROUP_NAME -n $APP_SERVICE_NAME --app-config $APP_CONFIG_NAME --tg $RESOURCE_GROUP_NAME --connection "app_config_cs" --secret

secret 是指連接字串驗證類型。服務連線 or 也支援下列驗證：系統指派的受控識別、使用者指派的受控識別和服務主體。

驗證連線

若要檢查連線是否正常運作，請從瀏覽器瀏覽至您的 Web 應用程式 https://<myWebAppName>.azurewebsites.net/ 。網站啟動之後，您會看到它顯示「Hello」。您的 Azure WebApp 已透過 Service 連線至應用程式組態連線或現在」。

運作方式

尋找下列服務連線或針對每個驗證類型在幕後管理的內容。

服務連線或為您管理聯機組態：

設定 Web 應用程式的 AZURE_APPCONFIGURATION_ENDPOINT ，讓應用程式存取它並取得應用程式組態端點。存取範例程序代碼。
啟用 Web 應用程式的系統指派受控驗證，並授與應用程式組態資料讀取器角色，讓應用程式使用 Azure.Identity 的 DefaultAzureCredential 向應用程式組態進行驗證。存取範例程序代碼。

服務連線或為您管理連線設定：

設定 Web 應用程式的 AZURE_APPCONFIGURATION_ENDPOINT，AZURE_APPCONFIGURATION_CLIENTID讓應用程式存取它，並在程式代碼中取得應用程式組態端點;
啟用 Web 應用程式的使用者指派受控驗證，並授與應用程式組態數據讀取者角色，讓應用程式使用 Azure.Identity 的 DefaultAzureCredential 向應用程式組態進行驗證。存取範例程序代碼。

服務連線或為您管理聯機組態：

設定 Web 應用程式的 AZURE_APPCONFIGURATION_ENDPOINT ，讓應用程式存取它並取得應用程式組態端點。存取範例程序代碼。
將服務主體認證儲存至 WebApp App 設定 AZURE_APPCONFIGURATION_CLIENTID。 AZURE_APPCONFIGURATION_TENANTID，AZURE_APPCONFIGURATION_CLIENTSECRET並將應用程式組態數據讀取者角色授與服務主體，讓應用程式可以使用 Azure.Identity 向程式碼ClientSecretCredential中的應用程式組態進行驗證。

服務連線或為您管理聯機組態：

設定 Web 應用程式的 AZURE_APPCONFIGURATION_CONNECTIONSTRING ，讓應用程式存取它並取得應用程式組態連接字串。存取範例程序代碼。
啟用 Web 應用程式的系統指派受控驗證，並授與應用程式組態資料讀取器角色，讓應用程式使用 Azure.Identity 的 DefaultAzureCredential 向應用程式組態進行驗證。存取範例程序代碼。

如需詳細資訊，請移至服務連線或內部。

測試（選擇性）

或者，執行下列測試：

更新應用程式組態 Store 中索引鍵SampleApplication:Settings:Messages的值。

az appconfig kv set -n <myAppConfigStoreName> --key SampleApplication:Settings:Messages --value hello --yes

移至並重新整理頁面，以流覽至 https://<myWebAppName>.azurewebsites.net/ 您的 Azure Web 應用程式。您會看到訊息已更新為「hello」。

清除資源

完成後，如果您不會再使用這些 Azure 資源，請執行 az group delete 命令加以刪除。此命令會刪除您的資源群組及其內的所有資源。

az group delete -n <myResourceGroupName> --yes

下一步

請遵循下列教學課程，深入瞭解 Service 連線 or。

瞭解服務連線或概念

Share via

教學課程：使用 Service 連線 or 連線 Web 應用程式 Azure 應用程式組態

必要條件

設定 Azure 資源

連線 Web 應用程式以應用程式組態

驗證連線

運作方式

測試（選擇性）

清除資源

下一步

其他資源

Share via

教學課程：使用 Service 連線 or 連線 Web 應用程式 Azure 應用程式組態

必要條件

登入 Azure

設定 Azure 資源

連線 Web 應用程式以 應用程式組態

驗證連線

運作方式

測試 （選擇性）

清除資源

下一步

其他資源

連線 Web 應用程式以應用程式組態

測試（選擇性）