Microsoft.Web sites/config 'authsettings' 2022-03-01
Bicep 資源定義
月臺/設定資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。
name 屬性的選項
月臺/設定資源會根據 name 屬性的值接受不同的屬性。
本文說明設定 name: 'authsettings'時可用的屬性。
如需其他選項，請參閱：
- appsettings
- authsettingsV2
- azurestorageaccounts
- 備份
- connectionstrings
- 記錄
- 中繼資料
- pushsettings
- slotConfigNames
- Web
資源格式
若要建立 Microsoft.Web/sites/config 資源，請將下列 Bicep 新增至您的範本。
resource symbolicname 'Microsoft.Web/sites/config@2022-03-01' = {
name: 'authsettings'
kind: 'string'
parent: resourceSymbolicName
properties: {
aadClaimsAuthorization: 'string'
additionalLoginParams: [
'string'
]
allowedAudiences: [
'string'
]
allowedExternalRedirectUrls: [
'string'
]
authFilePath: 'string'
clientId: 'string'
clientSecret: 'string'
clientSecretCertificateThumbprint: 'string'
clientSecretSettingName: 'string'
configVersion: 'string'
defaultProvider: 'string'
enabled: bool
facebookAppId: 'string'
facebookAppSecret: 'string'
facebookAppSecretSettingName: 'string'
facebookOAuthScopes: [
'string'
]
gitHubClientId: 'string'
gitHubClientSecret: 'string'
gitHubClientSecretSettingName: 'string'
gitHubOAuthScopes: [
'string'
]
googleClientId: 'string'
googleClientSecret: 'string'
googleClientSecretSettingName: 'string'
googleOAuthScopes: [
'string'
]
isAuthFromFile: 'string'
issuer: 'string'
microsoftAccountClientId: 'string'
microsoftAccountClientSecret: 'string'
microsoftAccountClientSecretSettingName: 'string'
microsoftAccountOAuthScopes: [
'string'
]
runtimeVersion: 'string'
tokenRefreshExtensionHours: int
tokenStoreEnabled: bool
twitterConsumerKey: 'string'
twitterConsumerSecret: 'string'
twitterConsumerSecretSettingName: 'string'
unauthenticatedClientAction: 'string'
validateIssuer: bool
}
}
屬性值
sites/config-authsettings
| 名稱 | 描述 | 值 |
|---|---|---|
| NAME | 資源名稱 瞭解如何在 Bicep 中設定子資源的名稱和類型。 |
'authsettings' |
| kind | 資源種類。 | 字串 |
| 父系 (parent) | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型資源的符號名稱： sites |
| properties | SiteAuthSettings 資源特定屬性 | SiteAuthSettingsProperties |
SiteAuthSettingsProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| aadClaimsAuthorization | 取得包含 Azure AD Acl 設定的 JSON 字串。 | 字串 |
| additionalLoginParams | 登入參數，以在何時傳送至 OpenID Connect 授權端點 使用者登入。 每個參數的格式都必須是 「key=value」。。 |
string[] |
| allowedAudiences | 允許的物件值在驗證所發出的 JWT 時考慮 Azure Active Directory。 請注意，值 ClientID 一律視為允許的物件，不論此設定為何。 |
string[] |
| allowedExternalRedirectUrls | 可在登入或註銷應用程式時重新導向至 的外部URL。 請注意，會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意，目前網域內的URL一律會隱含允許。 |
string[] |
| authFilePath | 包含驗證設定的組態檔路徑。 如果路徑是相對的，基底將會是月臺的根目錄。 |
字串 |
| clientId | 此信賴憑證者應用程式的用戶端標識碼，稱為client_id。 若要使用 Azure Active Directory 啟用 OpenID 連線驗證，需要此設定或 其他第三方 OpenID Connect 提供者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html |
字串 |
| clientSecret | Azure Active Directory 中此信賴憑證者應用程式的用戶端密碼 (，也稱為密鑰) 。 這個設定是選擇性的。 如果未設定任何客戶端密碼，則會使用 OpenID Connect 隱含驗證流程來驗證終端使用者。 否則，OpenID Connect 授權碼流程會用來驗證使用者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html |
字串 |
| clientSecretCertificateThumbprint | 客戶端密碼的替代方案，這是用於簽署之憑證的指紋。 這個屬性的作用是 取代客戶端密碼。 它也是選擇性的。 |
字串 |
| clientSecretSettingName | 包含信賴憑證者應用程式用戶端密碼的應用程式設定名稱。 | 字串 |
| configVersion | 用於目前應用程式的驗證/授權功能的 ConfigVersion。 此值中的設定可以控制驗證/授權的控制平面行為。 |
字串 |
| defaultProvider | 設定多個提供者時要使用的預設驗證提供者。 只有在已設定多個提供者和未經驗證的用戶端時，才需要此設定 action 設定為 「RedirectToLoginPage」。。 |
'AzureActiveDirectory' 'Facebook' 'Github' 'Google' 'MicrosoftAccount' 'Twitter' |
| 已啟用 | true 如果目前應用程式已啟用驗證/授權功能，則為 ;否則為 false。 |
bool |
| facebookAppId | 用於登入之 Facebook 應用程式的應用程式標識碼。 啟用 Facebook Login 需要此設定。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
字串 |
| facebookAppSecret | 用於 Facebook 登入之 Facebook 應用程式的應用程式密碼。 啟用 Facebook Login 需要此設定。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
字串 |
| facebookAppSecretSettingName | 應用程式設定名稱，其中包含用於 Facebook 登入的應用程式密碼。 | 字串 |
| facebookOAuthScopes | 將作為 Facebook 登入驗證一部分要求的 OAuth 2.0 範圍。 這個設定是選擇性的。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
string[] |
| gitHubClientId | 用於登入之 GitHub 應用程式的用戶端識別碼。 啟用 Github 登入需要此設定 |
字串 |
| gitHubClientSecret | GitHub 應用程式用於 Github 登入的客戶端密碼。 啟用 Github 登入需要此設定。 |
字串 |
| gitHubClientSecretSettingName | 包含 Github 用戶端密碼的應用程式設定名稱 用於 GitHub 登入的應用程式。 |
字串 |
| gitHubOAuthScopes | 將作為 GitHub 登入驗證一部分要求的 OAuth 2.0 範圍。 此設定是選擇性的 |
string[] |
| googleClientId | Google Web 應用程式的 OpenID Connect 用戶端識別碼。 啟用Google登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
字串 |
| googleClientSecret | 與Google Web 應用程式相關聯的客戶端密碼。 啟用Google登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
字串 |
| googleClientSecretSettingName | 包含與相關聯之用戶端密碼的應用程式設定名稱 Google Web 應用程式。 |
字串 |
| googleOAuthScopes | 將會在Google Sign-In 驗證中要求OAuth 2.0範圍。 這個設定是選擇性的。 如果未指定，則會使用 「openid」、“profile」 和 「email」 作為預設範圍。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
string[] |
| isAuthFromFile | 如果應該從檔案讀取驗證組態設定，則為 “true” 否則為 “false” |
字串 |
| 簽發者 | OpenID Connect 簽發者 URI，代表發出此應用程式存取令牌的實體。 使用 Azure Active Directory 時，此值是目錄租使用者的 URI，例如 https://sts.windows.net/{tenant-guid}/.此 URI 是令牌簽發者的區分大小寫標識碼。 OpenID Connect 探索的詳細資訊： http://openid.net/specs/openid-connect-discovery-1_0.html |
字串 |
| microsoftAccountClientId | 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端識別碼。 啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm |
字串 |
| microsoftAccountClientSecret | 針對用於驗證的應用程式所建立的 OAuth 2.0 客戶端密碼。 啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm |
字串 |
| microsoftAccountClientSecretSettingName | 應用程式設定名稱，其中包含針對 建立的 OAuth 2.0 用戶端密碼 用於驗證的應用程式。 |
字串 |
| microsoftAccountOAuthScopes | 將作為 Microsoft 帳戶驗證一部分要求的 OAuth 2.0 範圍。 這個設定是選擇性的。 如果未指定，則會使用 「wl.basic」 作為預設範圍。 Microsoft 帳戶範圍和許可權檔： https://msdn.microsoft.com/library/dn631845.aspx |
string[] |
| runtimeVersion | 用於目前應用程式的 Authentication /Authorization 功能的 RuntimeVersion。 此值中的設定可以控制驗證/授權模組中特定功能的行為。 |
字串 |
| tokenRefreshExtensionHours | 會話令牌到期后的時數，會話令牌可用來 呼叫令牌重新整理 API。 預設值為 72 小時。 |
int |
| tokenStoreEnabled | true 可永久儲存登入流程期間取得的平臺特定安全性令牌;否則為 false。預設值為 false。 |
bool |
| twitterConsumerKey | 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密鑰。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in |
字串 |
| twitterConsumerSecret | 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密碼。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in |
字串 |
| twitterConsumerSecretSettingName | 包含 Twitter OAuth 1.0a 消費者密碼的應用程式設定名稱 用於登入的應用程式。 |
字串 |
| unauthenticatedClientAction | 未驗證客戶端嘗試存取應用程式時要採取的動作。 | 'AllowAnonymous' 'RedirectToLoginPage' |
| validateIssuer | 取得值，指出簽發者是否應該是有效的 HTTPS URL，並驗證如下。 | bool |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
在 App Services 上使用 PostgreSQL 資料庫的 Airflow Web 應用程式 |
在 App Services 上使用 PostgreSQL 資料庫部署 Airflow Web 應用程式的範本 |
| Azure 中的 EPiserverCMS |
此範本可讓您在 Azure 中建立 EpiServerCMS 部署所需的資源 |
| 使用 Jenkins 和 Azure Web Apps 的 Java CI/CD |
這是使用 Jenkins 和 Azure Web Apps 的 Java CI/CD 範例。 |
| Orchard CMS 影片入口網站 Web 應用程式 |
此範本提供一種簡單的方式，可在已啟用和設定 Azure 媒體服務模組的 Azure App 服務 Web Apps 上部署 Orchard CMS。 |
| 適用於 Azure 事件中樞的 PubNub 即時閘道 |
適用於 Azure 的 PubNub 即時閘道提供 PubNub 資料流網路與 Azure 事件中樞 之間的實時數據流網橋。 -- 將其視為 PubNub 與 Azure 之間的雙向網橋！ |
| 可調整的 Umbraco CMS Web 應用程式 |
此範本提供在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式的簡單方式。 |
| 簡單 Umbraco CMS Web 應用程式 |
此範本提供在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式的簡單方式。 |
| 在應用程式中搭配 MySQL App Service 上的 WordPress |
此範本會在具有 MySQL 的 Windows App Service 上部署 WordPress Web 應用程式 |
| Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook |
企業或大型的雲端採用需要負責任且有效率的治理模型，才能從其雲端部署衍生價值。 CloudWise (解決方案) 的程式代碼名稱，是 Azure 合作夥伴快速入門中提供的複合解決方案，是客戶、系統整合者和合作夥伴的採用啟用者，可提供自助式、自動化的治理和作業解決方案，著重於優化成本、改善應用程式 () 可靠性、降低商務風險。 此解決方案強調可見度和控制的核心治理要素。 |
| 取用 Azure SQL 私人端點的 WebApp |
此範本示範如何建立 Web 應用程式，以取用指向 Azure SQL Server 的私人端點 |
| Moesif API 分析和獲利 |
此範本會將來自 Azure API 管理 的 API 呼叫記錄到 Moesif API 分析和獲利平臺 |
| 從 Azure Logic Apps 呼叫自定義 API |
雖然 Logic Apps 為各種服務提供數百個連接器，但您可能想要呼叫執行您自己的程式代碼的 API。 裝載您自己的 Web API 的最簡單且最可調整方式之一，就是使用 Azure App 服務。 此範本會為您的自訂 API 部署 Web 應用程式，並使用 Azure Active Directory 驗證保護該 API。 |
| 具有IP限制的Web應用程式 應用程式閘道 |
此範本會在 Azure Web 應用程式前面建立應用程式閘道，並在 Web 應用程式上啟用 IP 限制。 |
| 使用 Azure SQL 後端 App Service 環境 |
此範本會建立 App Service 環境 與 Azure SQL 後端以及私人端點，以及通常用於私人/隔離環境中的相關聯資源。 |
| 布建在 App Service 方案上執行的函式應用程式 |
此範本會在專用主控方案上布建函式應用程式，這表示它會執行並計費，就像任何 App Service 網站一樣。 |
| 具有事件中樞和受控識別的 Azure 函式應用程式 |
他的範本會在Linux取用方案上布建 Azure 函式應用程式，以及事件中樞、Azure 記憶體和 Application Insights。 函式應用程式能夠使用受控識別來連線到事件中樞和記憶體帳戶 |
| 使用 vnet 整合部署 Azure Function Premium 方案 |
此範本可讓您將已啟用區域虛擬網路整合的 Azure Function Premium 方案部署到新建立的虛擬網路。 |
| 使用 SQL Database 布建行動應用程式 |
此範本會布建行動應用程式、SQL Database和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定 連接字串。 |
| 具有私人端點的 Web 應用程式 |
此範本可讓您建立 Web 應用程式，並透過私人端點公開 |
| 使用內部 API 管理和 Web 應用程式 應用程式閘道 |
應用程式閘道 將因特網流量路由傳送至虛擬網路 (內部模式) API 管理 實例，其服務裝載於 Azure Web 應用程式中的 Web API。 |
| 使用 Blob 記憶體建立 Azure Web 應用程式 連接字串 |
使用 Blob 記憶體建立 Azure Web 應用程式 連接字串，此範本最初由 Microsoft Jeff 的 Jeff 一文撰寫 |
| 使用診斷記錄至 Blob 容器的 Web 應用程式 |
使用診斷記錄將 Web 應用程式部署至已啟用記憶體帳戶 Blob 容器。 |
| 在已啟用 Java 13 和 Tomcat 9 的 Azure 上建立 Web 應用程式 |
此範本會在已啟用 Java 13 和 Tomcat 9 的 Azure 上建立 Web 應用程式，讓您能夠在 Azure 中執行 Java 應用程式。 範本是由 Microsoft Donovan Brown 所撰寫。 |
| Web 應用程式 w/ Application Insights 傳送至 Log Analytics |
此範本將協助支援 microsoft.insights/components 的新 API 版本。 從 2020-02-02-preview WorkspaceID 開始，建立 Application Inisghts 時將會需要此範本。此範本會部署 App Service 方案、App Service、Application Insights、Log Analytics 工作區，並將其全部連結在一起。 |
| 具有受控識別、SQL Server和 ΑΙ 的 Web 應用程式 |
為應用程式 + 資料 + 受控識別 + 監視部署 Azure 基礎結構的簡單範例 |
| 使用範本建立 Web 應用程式 + Redis 快取 + SQL DB |
此範本會建立具有 Redis 快取和 SQL Database 的 Azure Web 應用程式。 |
| 使用 SQL Database 布建 Web 應用程式 |
此範本會布建 Web 應用程式、SQL Database、自動調整設定、警示規則和 App Insights。 它會在資料庫的 Web 應用程式中設定 連接字串。 |
| 使用範本建立 Web 應用程式和 Redis 快取 |
此範本會建立具有 Redis 快取的 Azure Web 應用程式。 |
| 具有自定義部署位置的 Web 應用程式 |
此範本可讓您輕鬆地在 Azure Web Apps 上使用自訂部署位置來部署 Web 應用程式。 |
| Linux 上的 Airflow Docker Web 應用程式與 PostgreSQL |
此範本可讓您輕鬆地在 Linux Web 應用程式上使用適用於 PostgreSQL 的 Azure 資料庫部署 puckel/docker-airflow 映射 (最新的標籤) |
| 使用 Azure SQL 在 Linux 上使用 Sonarqube Docker Web 應用程式 |
此範本會使用官方 Sonarqube 映像，並將 Sonarqube 部署在 Azure App 服務 Web 應用程式 Linux 容器中，並由 Azure SQL Server 支援。 |
| 使用 MySQL 在 Linux 上的 Sonarqube Docker Web 應用程式 |
此範本可讓您輕鬆地在 Linux Web 應用程式中部署 Sonarqube docker 映射， (alpine 卷標) 與適用於 MySQL 的 Azure 資料庫 |
| 使用 PostgreSQL 在 Linux 上的 Sonarqube Docker Web 應用程式 |
此範本可讓您輕鬆地在 Linux Web 應用程式上部署 Sonarqube docker 映射， (alpine 卷標) 與適用於 PostgreSQL 的 Azure 資料庫 (Preview) |
| 適用於 MySQL 的 Azure 資料庫 Web 應用程式 |
此範本可讓您輕鬆地在適用於 MySQL 的 Azure 資料庫 Azure App 服務 Web Apps 上部署 Web 應用程式。 |
| Linux 上的 Web 應用程式與 PostgreSQL |
此範本提供簡單的方法，可讓您使用適用於 PostgreSQL 的 Azure 資料庫在 Linux 上部署 Web 應用程式。 |
| 具有 VNet 插入和私人端點的 Web 應用程式 |
此範本可讓您建立具有兩個 Web 應用程式、前端和後端的安全端對端解決方案，前端會透過 VNet 插入和私人端點安全地取用後端 |
ARM 範本資源定義
月臺/組態資源類型可以使用目標作業進行部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
name 屬性的選項
sites/config 資源會根據 name 屬性的值接受不同的屬性。
本文說明當您設定 name: 'authsettings'時可用的屬性。
如需其他選項，請參閱：
- appsettings
- authsettingsV2
- azurestorageaccounts
- 備份
- connectionstrings
- 記錄
- 中繼資料
- pushsettings
- slotConfigNames
- Web
資源格式
若要建立 Microsoft.Web/sites/config 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.Web/sites/config",
"apiVersion": "2022-03-01",
"name": "authsettings",
"kind": "string",
"properties": {
"aadClaimsAuthorization": "string",
"additionalLoginParams": [ "string" ],
"allowedAudiences": [ "string" ],
"allowedExternalRedirectUrls": [ "string" ],
"authFilePath": "string",
"clientId": "string",
"clientSecret": "string",
"clientSecretCertificateThumbprint": "string",
"clientSecretSettingName": "string",
"configVersion": "string",
"defaultProvider": "string",
"enabled": "bool",
"facebookAppId": "string",
"facebookAppSecret": "string",
"facebookAppSecretSettingName": "string",
"facebookOAuthScopes": [ "string" ],
"gitHubClientId": "string",
"gitHubClientSecret": "string",
"gitHubClientSecretSettingName": "string",
"gitHubOAuthScopes": [ "string" ],
"googleClientId": "string",
"googleClientSecret": "string",
"googleClientSecretSettingName": "string",
"googleOAuthScopes": [ "string" ],
"isAuthFromFile": "string",
"issuer": "string",
"microsoftAccountClientId": "string",
"microsoftAccountClientSecret": "string",
"microsoftAccountClientSecretSettingName": "string",
"microsoftAccountOAuthScopes": [ "string" ],
"runtimeVersion": "string",
"tokenRefreshExtensionHours": "int",
"tokenStoreEnabled": "bool",
"twitterConsumerKey": "string",
"twitterConsumerSecret": "string",
"twitterConsumerSecretSettingName": "string",
"unauthenticatedClientAction": "string",
"validateIssuer": "bool"
}
}
屬性值
sites/config-authsettings
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | 'Microsoft.Web/sites/config' |
| apiVersion | 資源 API 版本 | '2022-03-01' |
| NAME | 資源名稱 瞭解如何在 JSON ARM 範本中設定子資源的名稱和類型。 |
'authsettings' |
| kind | 資源種類。 | 字串 |
| properties | SiteAuthSettings 資源特定屬性 | SiteAuthSettingsProperties |
SiteAuthSettingsProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| aadClaimsAuthorization | 取得包含 Azure AD Acl 設定的 JSON 字串。 | 字串 |
| additionalLoginParams | 登入參數，以在何時傳送至 OpenID Connect 授權端點 使用者登入。 每個參數的格式都必須是 「key=value」。。 |
string[] |
| allowedAudiences | 允許的物件值在驗證所發出的 JWT 時考慮 Azure Active Directory。 請注意， ClientID 值一律會被視為允許的物件，不論此設定為何。 |
string[] |
| allowedExternalRedirectUrls | 可重新導向至 作為登入或註銷應用程式之一部分的外部URL。 請注意，會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意，目前網域中的URL一律是隱含允許的。 |
string[] |
| authFilePath | 包含驗證設定的組態檔路徑。 如果路徑相對，基底會是月臺的根目錄。 |
字串 |
| clientId | 此信賴憑證者應用程式的用戶端標識碼，稱為client_id。 若要使用 Azure Active Directory 啟用 OpenID 連線驗證，需要此設定或 其他第三方 OpenID Connect 提供者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html |
字串 |
| clientSecret | Azure Active Directory 中此信賴憑證者應用程式的用戶端密碼 (，也稱為密鑰) 。 這個設定是選擇性的。 如果未設定任何客戶端密碼，則會使用 OpenID Connect 隱含驗證流程來驗證終端使用者。 否則，會使用 OpenID Connect 授權碼流程來驗證終端使用者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html |
字串 |
| clientSecretCertificateThumbprint | 客戶端密碼的替代方案，也就是用於簽署之憑證的指紋。 這個屬性會做為 取代客戶端密碼。 它也是選擇性的。 |
字串 |
| clientSecretSettingName | 包含信賴憑證者應用程式用戶端密碼的應用程式設定名稱。 | 字串 |
| configVersion | 用於目前應用程式的驗證/授權功能的 ConfigVersion。 此值中的設定可以控制驗證/授權的控制平面行為。 |
字串 |
| defaultProvider | 設定多個提供者時要使用的預設驗證提供者。 只有在已設定多個提供者和未經驗證的用戶端時，才需要此設定 action 設定為 「RedirectToLoginPage」。。 |
'AzureActiveDirectory' 'Facebook' 'Github' 'Google' 'MicrosoftAccount' 'Twitter' |
| 已啟用 | true 如果目前應用程式已啟用驗證/授權功能，則為 ;否則為 false。 |
bool |
| facebookAppId | 用於登入之 Facebook 應用程式的應用程式標識碼。 啟用 Facebook 登入需要此設定。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
字串 |
| facebookAppSecret | 用於Facebook 登入 Facebook 應用程式的應用程式密碼。 啟用 Facebook 登入需要此設定。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
字串 |
| facebookAppSecretSettingName | 應用程式設定名稱，其中包含用於 Facebook 登入的應用程式密碼。 | 字串 |
| facebookOAuthScopes | 將作為 Facebook 登入驗證一部分要求的 OAuth 2.0 範圍。 這個設定是選擇性的。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
string[] |
| gitHubClientId | 用於登入之 GitHub 應用程式的用戶端識別碼。 啟用 Github 登入需要此設定 |
字串 |
| gitHubClientSecret | GitHub 應用程式用於 Github 登入的客戶端密碼。 啟用 Github 登入需要此設定。 |
字串 |
| gitHubClientSecretSettingName | 包含 Github 用戶端密碼的應用程式設定名稱 用於 GitHub 登入的應用程式。 |
字串 |
| gitHubOAuthScopes | 將作為 GitHub 登入驗證一部分要求的 OAuth 2.0 範圍。 此設定是選擇性的 |
string[] |
| googleClientId | Google Web 應用程式的 OpenID Connect 用戶端識別碼。 啟用Google登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
字串 |
| googleClientSecret | 與Google Web 應用程式相關聯的客戶端密碼。 啟用Google登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
字串 |
| googleClientSecretSettingName | 應用程式設定名稱，其中包含與相關聯的客戶端密碼 Google Web 應用程式。 |
字串 |
| googleOAuthScopes | 將作為Google Sign-In 驗證一部分要求的OAuth 2.0範圍。 這個設定是選擇性的。 如果未指定，則會使用 「openid」、“profile」 和 「email」 作為預設範圍。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
string[] |
| isAuthFromFile | 如果應該從檔案讀取驗證組態設定，則為 “true” 否則為 “false” |
字串 |
| 簽發者 | OpenID Connect 簽發者 URI，代表發出此應用程式存取令牌的實體。 使用 Azure Active Directory 時，此值是目錄租使用者的 URI，例如 https://sts.windows.net/{tenant-guid}/.此 URI 是令牌簽發者的區分大小寫標識碼。 OpenID Connect 探索的詳細資訊： http://openid.net/specs/openid-connect-discovery-1_0.html |
字串 |
| microsoftAccountClientId | 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端識別碼。 啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm |
字串 |
| microsoftAccountClientSecret | 針對用於驗證的應用程式所建立的 OAuth 2.0 客戶端密碼。 啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm |
字串 |
| microsoftAccountClientSecretSettingName | 應用程式設定名稱，其中包含為 建立的 OAuth 2.0 客戶端密碼 用於驗證的應用程式。 |
字串 |
| microsoftAccountOAuthScopes | 將作為 Microsoft 帳戶驗證一部分要求的 OAuth 2.0 範圍。 這個設定是選擇性的。 如果未指定，則會使用 「wl.basic」 作為預設範圍。 Microsoft 帳戶範圍和許可權檔： https://msdn.microsoft.com/library/dn631845.aspx |
string[] |
| runtimeVersion | 用於目前應用程式的 Authentication /Authorization 功能的 RuntimeVersion。 此值中的設定可以控制驗證/授權模組中特定功能的行為。 |
字串 |
| tokenRefreshExtensionHours | 會話令牌到期后的小時數，會話令牌可用來 呼叫令牌重新整理 API。 預設值為 72 小時。 |
int |
| tokenStoreEnabled | true 若要永久儲存在登入流程期間取得的平臺特定安全性令牌;否則為 false。預設值為 false。 |
bool |
| twitterConsumerKey | 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密鑰。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in |
字串 |
| twitterConsumerSecret | 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者秘密。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in |
字串 |
| twitterConsumerSecretSettingName | 包含 Twitter OAuth 1.0a 消費者密碼的應用程式設定名稱 用於登入的應用程式。 |
字串 |
| unauthenticatedClientAction | 當未經驗證的用戶端嘗試存取應用程式時，要採取的動作。 | 'AllowAnonymous' 'RedirectToLoginPage' |
| validateIssuer | 取得值，指出簽發者是否應該是有效的 HTTPS URL，並驗證如下。 | bool |
快速入門範本
下列快速入門範本會部署此資源類型。
| 範本 | 描述 |
|---|---|
| 在 App Services 上使用 PostgreSQL 資料庫的 Airflow Web 應用程式 |
在 App Services 上使用 PostgreSQL 資料庫部署 Airflow Web 應用程式的範本 |
| Azure 中的 EPiserverCMS |
此範本可讓您在 Azure 中建立 EpiServerCMS 部署所需的資源 |
| 使用 Jenkins 和 Azure Web Apps 的 Java CI/CD |
這是使用 Jenkins 和 Azure Web Apps 的 Java CI/CD 範例。 |
| Orchard CMS 影片入口網站 Web 應用程式 |
此範本提供一種簡單的方式，可讓您在已啟用和設定 Azure 媒體服務模組的 Azure App 服務 Web Apps 上部署一個 Factory CMS。 |
| 適用於 Azure 事件中樞的 PubNub 即時閘道 |
適用於 Azure 的 PubNub 即時閘道提供 PubNub 資料流網路與 Azure 事件中樞 之間的實時數據流網橋。 -- 將其視為 PubNub 與 Azure 之間的雙向網橋！ |
| 可調整的 Umbraco CMS Web 應用程式 |
此範本可讓您輕鬆地在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式。 |
| 簡單 Umbraco CMS Web 應用程式 |
此範本可讓您輕鬆地在 Azure App 服務 Web Apps 上部署 umbraco CMS Web 應用程式。 |
| 在應用程式中搭配 MySQL App Service 上的 WordPress |
此範本會在應用程式中使用 MySQL 在 Windows App Service 上部署 WordPress Web 應用程式 |
| Enterprise Governance-AppService、SQL DB、AD、OMS、Runbook |
企業或大型的雲端採用需要負責任且有效率的治理模型，才能從其雲端部署衍生價值。 CloudWise (解決方案) 的程式代碼名稱，是 Azure 合作夥伴快速入門中提供的複合解決方案，是客戶、系統整合者和合作夥伴的採用啟用者，可提供自助式、自動化的治理和作業解決方案，著重於優化成本、改善應用程式 () 可靠性、降低商務風險。 此解決方案強調可見度和控制的核心治理要素。 |
| 使用 Azure SQL 私人端點的 WebApp |
此範本示範如何建立 Web 應用程式，以取用指向 Azure SQL Server 的私人端點 |
| Moesif API 分析和獲利 |
範本會將來自 Azure API 管理 的 API 呼叫記錄到 Moesif API 分析和獲利平臺 |
| 從 Azure Logic Apps 呼叫自定義 API |
雖然 Logic Apps 為各種服務提供數百個連接器，但您可能想要呼叫執行您自己的程式代碼的 API。 裝載您自己的 Web API 的最簡單且最可調整方式之一，就是使用 Azure App 服務。 此範本會為您的自訂 API 部署 Web 應用程式，並使用 Azure Active Directory 驗證保護該 API。 |
| 具有IP限制的Web應用程式 應用程式閘道 |
此範本會在 Azure Web 應用程式前面建立應用程式閘道，並在 Web 應用程式上啟用 IP 限制。 |
| 使用 Azure SQL 後端 App Service 環境 |
此範本會建立具有 Azure SQL 後端以及私人端點以及通常用於私人/隔離環境中的相關聯資源 App Service 環境。 |
| 布建在 App Service 方案上執行的函式應用程式 |
此範本會在專用主控方案上布建函式應用程式，這表示它會執行並計費，就像任何 App Service 網站一樣。 |
| 具有事件中樞和受控識別的 Azure 函式應用程式 |
他的範本會在Linux取用方案上布建 Azure 函式應用程式，以及事件中樞、Azure 記憶體和 Application Insights。 函式應用程式能夠使用受控識別來連線到事件中樞和記憶體帳戶 |
| 使用 vnet 整合部署 Azure Function Premium 方案 |
此範本可讓您將已啟用區域虛擬網路整合的 Azure Function Premium 方案部署到新建立的虛擬網路。 |
| 使用 SQL Database 布建行動應用程式 |
此範本會布建行動應用程式、SQL Database和通知中樞。 它會在資料庫和通知中樞的行動應用程式中設定 連接字串。 |
| 具有私人端點的 Web 應用程式 |
此範本可讓您建立 Web 應用程式，並透過私人端點公開 |
| 使用內部 API 管理和 Web 應用程式 應用程式閘道 |
應用程式閘道 將因特網流量路由傳送至虛擬網路 (內部模式) API 管理 實例，其服務裝載於 Azure Web 應用程式中的 Web API。 |
| 使用 Blob 記憶體建立 Azure Web 應用程式 連接字串 |
使用 Blob 記憶體建立 Azure Web 應用程式 連接字串，此範本最初由 Microsoft Jeff 的 Jeff 一文撰寫 |
| 使用診斷記錄至 Blob 容器的 Web 應用程式 |
使用診斷記錄將 Web 應用程式部署至已啟用記憶體帳戶 Blob 容器。 |
| 在已啟用 Java 13 和 Tomcat 9 的 Azure 上建立 Web 應用程式 |
此範本會在已啟用 Java 13 和 Tomcat 9 的 Azure 上建立 Web 應用程式，讓您能夠在 Azure 中執行 Java 應用程式。 範本是由 Microsoft Donovan Brown 所撰寫。 |
| Web 應用程式 w/ Application Insights 傳送至 Log Analytics |
此範本將協助支援 microsoft.insights/components 的新 API 版本。 從 2020-02-02-preview WorkspaceID 開始，建立 Application Inisghts 時將會需要此範本。此範本會部署 App Service 方案、App Service、Application Insights、Log Analytics 工作區，並將其全部連結在一起。 |
| 具有受控識別、SQL Server和 ΑΙ 的 Web 應用程式 |
為應用程式 + 資料 + 受控識別 + 監視部署 Azure 基礎結構的簡單範例 |
| 使用範本建立 Web 應用程式 + Redis 快取 + SQL DB |
此範本會建立具有 Redis 快取和 SQL Database 的 Azure Web 應用程式。 |
| 使用 SQL Database 布建 Web 應用程式 |
此範本會布建 Web 應用程式、SQL Database、自動調整設定、警示規則和 App Insights。 它會在資料庫的 Web 應用程式中設定 連接字串。 |
| 使用範本建立 Web 應用程式和 Redis 快取 |
此範本會建立具有 Redis 快取的 Azure Web 應用程式。 |
| 具有自定義部署位置的 Web 應用程式 |
此範本可讓您輕鬆地在 Azure Web Apps 上使用自訂部署位置來部署 Web 應用程式。 |
| Linux 上的 Airflow Docker Web 應用程式與 PostgreSQL |
此範本可讓您輕鬆地在 Linux Web 應用程式上使用適用於 PostgreSQL 的 Azure 資料庫部署 puckel/docker-airflow 映射 (最新的標籤) |
| 使用 Azure SQL 在 Linux 上使用 Sonarqube Docker Web 應用程式 |
此範本會使用官方 Sonarqube 映像，並在 Azure SQL Server 支援 Azure App 服務 Web 應用程式 Linux 容器中部署 Sonarqube。 |
| 使用 MySQL 在 Linux 上的 Sonarqube Docker Web 應用程式 |
此範本可讓您輕鬆地在 Linux Web 應用程式中部署 Sonarqube docker 映射， (alpine 卷標) 與適用於 MySQL 的 Azure 資料庫 |
| 使用 PostgreSQL 在 Linux 上的 Sonarqube Docker Web 應用程式 |
此範本可讓您輕鬆地在 Linux Web 應用程式上部署 Sonarqube docker 映射， (alpine 卷標) 與適用於 PostgreSQL 的 Azure 資料庫 (Preview) |
| 適用於 MySQL 的 Azure 資料庫 Web 應用程式 |
此範本可讓您輕鬆地在適用於 MySQL 的 Azure 資料庫 Azure App 服務 Web Apps 上部署 Web 應用程式。 |
| Linux 上的 Web 應用程式與 PostgreSQL |
此範本提供簡單的方法，可讓您使用適用於 PostgreSQL 的 Azure 資料庫在 Linux 上部署 Web 應用程式。 |
| 具有 VNet 插入和私人端點的 Web 應用程式 |
此範本可讓您建立具有兩個 Web 應用程式、前端和後端的安全端對端解決方案，前端會透過 VNet 插入和私人端點安全地取用後端 |
Terraform (AzAPI 提供者) 資源定義
月臺/組態資源類型可以使用目標作業進行部署：
- 資源群組
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
name 屬性的選項
sites/config 資源會根據 name 屬性的值接受不同的屬性。
本文說明當您設定 name: 'authsettings'時可用的屬性。
如需其他選項，請參閱：
- appsettings
- authsettingsV2
- azurestorageaccounts
- 備份
- connectionstrings
- 記錄
- 中繼資料
- pushsettings
- slotConfigNames
- Web
資源格式
若要建立 Microsoft.Web/sites/config 資源，請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/sites/config@2022-03-01"
name = "authsettings"
parent_id = "string"
body = jsonencode({
properties = {
aadClaimsAuthorization = "string"
additionalLoginParams = [
"string"
]
allowedAudiences = [
"string"
]
allowedExternalRedirectUrls = [
"string"
]
authFilePath = "string"
clientId = "string"
clientSecret = "string"
clientSecretCertificateThumbprint = "string"
clientSecretSettingName = "string"
configVersion = "string"
defaultProvider = "string"
enabled = bool
facebookAppId = "string"
facebookAppSecret = "string"
facebookAppSecretSettingName = "string"
facebookOAuthScopes = [
"string"
]
gitHubClientId = "string"
gitHubClientSecret = "string"
gitHubClientSecretSettingName = "string"
gitHubOAuthScopes = [
"string"
]
googleClientId = "string"
googleClientSecret = "string"
googleClientSecretSettingName = "string"
googleOAuthScopes = [
"string"
]
isAuthFromFile = "string"
issuer = "string"
microsoftAccountClientId = "string"
microsoftAccountClientSecret = "string"
microsoftAccountClientSecretSettingName = "string"
microsoftAccountOAuthScopes = [
"string"
]
runtimeVersion = "string"
tokenRefreshExtensionHours = int
tokenStoreEnabled = bool
twitterConsumerKey = "string"
twitterConsumerSecret = "string"
twitterConsumerSecretSettingName = "string"
unauthenticatedClientAction = "string"
validateIssuer = bool
}
kind = "string"
})
}
屬性值
sites/config-authsettings
| 名稱 | 描述 | 值 |
|---|---|---|
| 類型 | 資源類型 | “Microsoft.Web/sites/config@2022-03-01” |
| NAME | 資源名稱 | “authsettings” |
| parent_id | 此資源父系之資源的標識碼。 | 類型資源的標識碼： 網站 |
| kind | 資源種類。 | 字串 |
| properties | SiteAuthSettings 資源特定屬性 | SiteAuthSettingsProperties |
SiteAuthSettingsProperties
| 名稱 | 描述 | 值 |
|---|---|---|
| aadClaimsAuthorization | 取得包含 Azure AD Acl 設定的 JSON 字串。 | 字串 |
| additionalLoginParams | 登入參數，以在何時傳送至 OpenID Connect 授權端點 使用者登入。 每個參數的格式都必須是 「key=value」。。 |
string[] |
| allowedAudiences | 允許的物件值在驗證所發出的 JWT 時考慮 Azure Active Directory。 請注意， ClientID 值一律會被視為允許的物件，不論此設定為何。 |
string[] |
| allowedExternalRedirectUrls | 可重新導向至 作為登入或註銷應用程式之一部分的外部URL。 請注意，會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意，目前網域中的URL一律是隱含允許的。 |
string[] |
| authFilePath | 包含驗證設定的組態檔路徑。 如果路徑相對，基底會是月臺的根目錄。 |
字串 |
| clientId | 此信賴憑證者應用程式的用戶端標識碼，稱為client_id。 若要使用 Azure Active Directory 啟用 OpenID 連線驗證，需要此設定或 其他第三方 OpenID Connect 提供者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html |
字串 |
| clientSecret | Azure Active Directory 中此信賴憑證者應用程式的用戶端密碼 (，也稱為密鑰) 。 這個設定是選擇性的。 如果未設定任何客戶端密碼，則會使用 OpenID Connect 隱含驗證流程來驗證終端使用者。 否則，會使用 OpenID Connect 授權碼流程來驗證終端使用者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html |
字串 |
| clientSecretCertificateThumbprint | 客戶端密碼的替代方案，也就是用於簽署之憑證的指紋。 這個屬性會做為 取代客戶端密碼。 它也是選擇性的。 |
字串 |
| clientSecretSettingName | 包含信賴憑證者應用程式用戶端密碼的應用程式設定名稱。 | 字串 |
| configVersion | 用於目前應用程式的驗證/授權功能的 ConfigVersion。 此值中的設定可以控制驗證/授權的控制平面行為。 |
字串 |
| defaultProvider | 設定多個提供者時要使用的預設驗證提供者。 只有在已設定多個提供者和未經驗證的用戶端時，才需要此設定 action 設定為 「RedirectToLoginPage」。。 |
“AzureActiveDirectory” “Facebook” “Github” “Google” “MicrosoftAccount” “Twitter” |
| 已啟用 | true 如果目前應用程式已啟用驗證/授權功能，則為 ;否則為 false。 |
bool |
| facebookAppId | 用於登入之 Facebook 應用程式的應用程式標識碼。 啟用 Facebook 登入需要此設定。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
字串 |
| facebookAppSecret | 用於 Facebook 登入之 Facebook 應用程式的應用程式密碼。 啟用 Facebook 登入需要此設定。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
字串 |
| facebookAppSecretSettingName | 應用程式設定名稱，其中包含用於 Facebook 登入的應用程式密碼。 | 字串 |
| facebookOAuthScopes | 將作為 Facebook 登入驗證一部分要求的 OAuth 2.0 範圍。 這個設定是選擇性的。 Facebook 登入檔案： https://developers.facebook.com/docs/facebook-login |
string[] |
| gitHubClientId | 用於登入之 GitHub 應用程式的用戶端識別碼。 啟用 Github 登入需要此設定 |
字串 |
| gitHubClientSecret | GitHub 應用程式用於 Github 登入的客戶端密碼。 啟用 Github 登入需要此設定。 |
字串 |
| gitHubClientSecretSettingName | 包含 Github 用戶端密碼的應用程式設定名稱 用於 GitHub 登入的應用程式。 |
字串 |
| gitHubOAuthScopes | 將作為 GitHub 登入驗證一部分要求的 OAuth 2.0 範圍。 此設定是選擇性的 |
string[] |
| googleClientId | Google Web 應用程式的 OpenID Connect 用戶端識別碼。 啟用Google登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
字串 |
| googleClientSecret | 與Google Web 應用程式相關聯的客戶端密碼。 啟用Google登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
字串 |
| googleClientSecretSettingName | 包含與相關聯之用戶端密碼的應用程式設定名稱 Google Web 應用程式。 |
字串 |
| googleOAuthScopes | 將會在Google Sign-In 驗證中要求OAuth 2.0範圍。 這個設定是選擇性的。 如果未指定，則會使用 「openid」、“profile」 和 「email」 作為預設範圍。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ |
string[] |
| isAuthFromFile | 如果應該從檔案讀取驗證組態設定，則為 “true” 否則為 “false” |
字串 |
| 簽發者 | OpenID Connect 簽發者 URI，代表發出此應用程式存取令牌的實體。 使用 Azure Active Directory 時，此值是目錄租使用者的 URI，例如 https://sts.windows.net/{tenant-guid}/.此 URI 是令牌簽發者的區分大小寫標識碼。 OpenID Connect 探索的詳細資訊： http://openid.net/specs/openid-connect-discovery-1_0.html |
字串 |
| microsoftAccountClientId | 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端識別碼。 啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm |
字串 |
| microsoftAccountClientSecret | 針對用於驗證的應用程式所建立的 OAuth 2.0 客戶端密碼。 啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm |
字串 |
| microsoftAccountClientSecretSettingName | 應用程式設定名稱，其中包含針對 建立的 OAuth 2.0 用戶端密碼 用於驗證的應用程式。 |
字串 |
| microsoftAccountOAuthScopes | 將作為 Microsoft 帳戶驗證一部分要求的 OAuth 2.0 範圍。 這個設定是選擇性的。 如果未指定，則會使用 「wl.basic」 作為預設範圍。 Microsoft 帳戶範圍和許可權檔： https://msdn.microsoft.com/library/dn631845.aspx |
string[] |
| runtimeVersion | 用於目前應用程式的 Authentication /Authorization 功能的 RuntimeVersion。 此值中的設定可以控制驗證/授權模組中特定功能的行為。 |
字串 |
| tokenRefreshExtensionHours | 會話令牌到期后的小時數，會話令牌可用來 呼叫令牌重新整理 API。 預設值為 72 小時。 |
int |
| tokenStoreEnabled | true 若要永久儲存在登入流程期間取得的平臺特定安全性令牌;否則為 false。預設值為 false。 |
bool |
| twitterConsumerKey | 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密鑰。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in |
字串 |
| twitterConsumerSecret | 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者秘密。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in |
字串 |
| twitterConsumerSecretSettingName | 包含 Twitter OAuth 1.0a 消費者密碼的應用程式設定名稱 用於登入的應用程式。 |
字串 |
| unauthenticatedClientAction | 當未經驗證的用戶端嘗試存取應用程式時，要採取的動作。 | “AllowAnonymous” “RedirectToLoginPage” |
| validateIssuer | 取得值，指出簽發者是否應該是有效的 HTTPS URL，並驗證如下。 | bool |