你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.Web sites/config 'authsettings' 2022-09-01
Bicep 资源定义
可以使用针对以下操作部署站点/配置资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
名称属性的选项
sites/config 资源接受基于 name 属性的值的不同属性。
本文介绍设置 name: 'authsettings'时可用的属性。
有关其他选项，请参阅：
- appsettings
- authsettingsV2
- azurestorageaccounts
- backup
- connectionstrings
- logs
- metadata
- pushsettings
- slotConfigNames
- web
资源格式
若要创建 Microsoft.Web/sites/config 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.Web/sites/config@2022-09-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 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。 有关详细信息，请参阅 父资源之外的子资源。 |
类型为“站点”的资源的符号名称 |
| properties | SiteAuthSettings 资源特定的属性 | SiteAuthSettingsProperties |
SiteAuthSettingsProperties
| 名称 | 说明 | 值 |
|---|---|---|
| aadClaimsAuthorization | 获取包含 Azure AD Acl 设置的 JSON 字符串。 | string |
| additionalLoginParams | 在以下情况下发送到 OpenID Connect 授权终结点的登录参数 用户登录。 每个参数必须采用“key=value”格式。 |
string[] |
| allowedAudiences | 验证由 颁发 JSON Web 令牌时要考虑的允许访问群体值 Azure Active Directory。 请注意，该值 ClientID 始终被视为允许的受众，无论此设置如何。 |
string[] |
| allowedExternalRedirectUrls | 可在登录或注销应用时重定向到的外部 URL。 请注意，将忽略 URL 的查询字符串部分。 这是一种高级设置，通常只有 Windows 应用商店应用程序后端才需要。 请注意，始终隐式允许当前域中的 URL。 |
string[] |
| authFilePath | 包含身份验证设置的配置文件的路径。 如果路径是相对路径，则 base 将用于站点的根目录。 |
字符串 |
| clientId | 此信赖方应用程序的客户端 ID，称为 client_id。 若要使用 Azure Active Directory 或启用 OpenID 连接身份验证，需要此设置 其他第三方 OpenID Connect 提供程序。 有关 OpenID Connect 的详细信息： http://openid.net/specs/openid-connect-core-1_0.html |
string |
| clientSecret | 此信赖方应用程序的客户端密码在 Azure Active Directory 中 (，也称为密钥) 。 此设置是可选的。 如果未配置客户端密码，则 OpenID Connect 隐式身份验证流用于对最终用户进行身份验证。 否则，OpenID Connect 授权代码流用于对最终用户进行身份验证。 有关 OpenID Connect 的详细信息： http://openid.net/specs/openid-connect-core-1_0.html |
string |
| clientSecretCertificateThumbprint | 客户端密码的替代方法，即用于签名的证书的指纹。 此属性充当 客户端密码的替换。 这也是可选的。 |
字符串 |
| clientSecretSettingName | 包含信赖方应用程序的客户端密码的应用设置名称。 | 字符串 |
| configVersion | 当前应用使用的身份验证/授权功能的 ConfigVersion。 此值中的设置可以控制身份验证/授权的控制平面的行为。 |
字符串 |
| defaultProvider | 配置多个提供程序时使用的默认身份验证提供程序。 仅当配置了多个提供程序和未经身份验证的客户端时，才需要此设置 action 设置为“RedirectToLoginPage”。 |
“AzureActiveDirectory” “Facebook” “Github” “Google” “MicrosoftAccount” “Twitter” |
| enabled | true 如果为当前应用启用了身份验证/授权功能，则为 ;否则为 false。 |
bool |
| facebookAppId | 用于登录的 Facebook 应用的应用 ID。 启用Facebook登录名需要此设置。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
字符串 |
| facebookAppSecret | 用于Facebook登录的Facebook应用的应用机密。 启用Facebook登录名需要此设置。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string |
| facebookAppSecretSettingName | 包含用于Facebook登录的应用机密的应用设置名称。 | string |
| facebookOAuthScopes | 将在 Facebook 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string[] |
| gitHubClientId | 用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置 |
字符串 |
| gitHubClientSecret | 用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。 |
字符串 |
| gitHubClientSecretSettingName | 包含 Github 的客户端密码的应用设置名称 用于 GitHub 登录的应用。 |
字符串 |
| gitHubOAuthScopes | 将在 GitHub 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的 |
string[] |
| googleClientId | Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 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/ |
string |
| 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” |
string |
| 颁发者 | 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 客户端 ID。 此设置是启用 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 |
string |
| microsoftAccountClientSecretSettingName | 包含为 创建的 OAuth 2.0 客户端密码的应用设置名称 用于身份验证的应用。 |
字符串 |
| microsoftAccountOAuthScopes | 将在 Microsoft 帐户身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 如果未指定，则使用“wl.basic”作为默认范围。 Microsoft 帐户范围和权限文档： https://msdn.microsoft.com/library/dn631845.aspx |
string[] |
| runtimeVersion | 用于当前应用的身份验证/授权功能的 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 |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
在应用服务上使用 PostgreSQL 数据库的 Airflow Web 应用 |
用于在应用服务上使用 PostgreSQL 数据库部署 Airflow Web 应用的模板 |
| Azure 中的 EPiserverCMS |
此模板允许你在 Azure 中创建 EpiServerCMS 部署所需的资源 |
| 使用 Jenkins 和 Azure Web 应用实现 Java CI/CD |
这是使用 Jenkins 和 Azure Web 应用的 Java CI/CD 的示例。 |
| Orchard CMS 视频门户 Web 应用 |
此模板提供了一种在启用和配置 Azure 媒体服务模块的情况下在 Azure 应用服务 Web 应用 上部署 Orchard CMS 的简单方法。 |
| 适用于 Azure 事件中心 的 PubNub 实时网关 |
适用于 Azure 的 PubNub 实时网关在 PubNub 数据流网络和Azure 事件中心之间提供实时数据流网桥。 - 将其视为 PubNub 和 Azure 之间的双向桥梁！ |
| 可缩放的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| 简单的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| App 服务上的 WordPress 与 MySQL In App 配合使用 |
此模板使用应用中的 MySQL 在 Windows App 服务上部署 WordPress Web 应用 |
| 企业治理 -AppService，SQL DB，AD，OMS，Runbook |
企业（无论大小）的云采用都需要负责任且高效的治理模型才能从其云部署中获取价值。 CloudWise (解决方案) 的代码名称，是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用支持者，可提供可自助、自动化的治理和运营解决方案，专注于优化成本、改进应用程序 () 可靠性、降低业务风险。 该解决方案突出了可见性和控制的核心治理支柱。 |
| 使用Azure SQL专用终结点的 Web 应用 |
此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用 |
| Moesif API 分析和盈利 |
该模板会将 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台 |
| 从 Azure 逻辑应用调用自定义 API |
尽管逻辑应用为各种服务提供了数百个连接器，但你可能希望调用运行自己的代码的 API。 托管自己的 Web API 的最简单且最可缩放的方法之一是使用 Azure 应用服务。 此模板为自定义 API 部署 Web 应用，并使用 Azure Active Directory 身份验证保护该 API。 |
| 具有 IP 限制的 Web 应用的应用程序网关 |
此模板在 Azure Web 应用前面创建应用程序网关，并在 Web 应用上启用了 IP 限制。 |
| 使用Azure SQL后端应用服务环境 |
此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。 |
| 预配在App 服务计划上运行的函数应用 |
此模板在专用托管计划上预配函数应用，这意味着它将像任何App 服务站点一样运行和计费。 |
| 具有事件中心和托管标识的 Azure 函数应用 |
他的模板在 Linux 消耗计划上预配 Azure 函数应用，以及事件中心、Azure 存储和 Application Insights。 函数应用能够使用托管标识连接到事件中心和存储帐户 |
| 使用 vnet 集成部署 Azure Function Premium 计划 |
此模板允许将启用了区域虚拟网络集成的 Azure Function Premium 计划部署到新创建的虚拟网络。 |
| 使用SQL 数据库预配移动应用 |
此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。 |
| 具有专用终结点的 Web 应用 |
此模板允许创建 Web 应用并通过专用终结点公开它 |
| 使用内部API 管理和 Web 应用应用程序网关 |
应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。 |
| 使用 Blob 存储连接字符串创建 Azure Web 应用 |
使用 Blob 存储连接字符串创建 Azure Web 应用，模板最初由 Microsoft 的 Jeff Bowles 创作 |
| 将诊断日志记录到 Blob 容器的 Web 应用 |
将启用了诊断日志记录的 Web 应用部署到存储帐户 Blob 容器。 |
| 在启用了 Java 13 和 Tomcat 9 的 Azure 上创建 Web 应用 |
此模板在启用了 Java 13 和 Tomcat 9 的 Azure 上创建 Web 应用，使你可以在 Azure 中运行 Java 应用程序。 模板由 Microsoft 的 Donovan Brown 创作。 |
| 将 Application Insights 发送到 Log Analytics 的 Web 应用 |
此模板将帮助支持 microsoft.insights/components 的新 API 版本。 从 2020-02-02 开始，创建 Application Inisghts 时需要 WorkspaceID。此模板将部署App 服务计划、App 服务、Application Insights、Log Analytics 工作区并将其全部挂钩在一起。 |
| 具有托管标识、SQL Server和 ΑΙ 的 Web 应用 |
为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例 |
| 使用模板创建 Web 应用 + Redis 缓存 + SQL DB |
此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。 |
| 使用SQL 数据库预配 Web 应用 |
此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在 Web 应用中为数据库配置连接字符串。 |
| 使用模板创建 Web 应用和 Redis 缓存 |
此模板使用 Redis 缓存创建 Azure Web 应用。 |
| 具有自定义部署槽位的 Web 应用 |
此模板提供了一种在 Azure Web 应用 上使用自定义部署槽位部署 Web 应用的简单方法。 |
| 使用 PostgreSQL 的 Linux 上的 Airflow Docker Web 应用 |
此模板提供了一种在 Linux Web 应用上使用 Azure Database for PostgreSQL 部署 puckel/docker-airflow 映像 (最新标记) 的简单方法 |
| 具有 Azure SQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板使用官方 Sonarqube 映像并受 Azure SQL 服务器支持，在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube。 |
| 使用 MySQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板提供了一种在 Linux Web 应用上使用 Azure Database for MySQL 将 Sonarqube docker 映像 (alpine 标记) 部署的简单方法 |
| 使用 PostgreSQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板提供了一种在 Linux Web 应用上使用 Azure Database for PostgreSQL (预览版部署 Sonarqube docker 映像 (alpine 标记) 的简单方法) |
| 使用 Azure Database for MySQL 的 Web 应用 |
此模板提供了一种使用 Azure Database for MySQL 在 Azure 应用服务 Web 应用 上部署 Web 应用的简单方法。 |
| Linux 上的 Web 应用和 PostgreSQL |
此模板提供了一种使用 Azure Database for PostgreSQL 在 Linux 上部署 Web 应用的简单方法。 |
| 具有 VNet 注入和专用终结点的 Web 应用 |
此模板允许创建包含两个 Web 应用（前端和后端）的安全端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端 |
ARM 模板资源定义
可以使用面向以下操作部署站点/配置资源类型：
- 资源组 - 请参阅 资源组部署命令
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
名称属性的选项
sites/config 资源根据 name 属性的值接受不同的属性。
本文介绍设置 name: 'authsettings'时可用的属性。
有关其他选项，请参阅：
- appsettings
- authsettingsV2
- azurestorageaccounts
- backup
- connectionstrings
- logs
- metadata
- pushsettings
- slotConfigNames
- web
资源格式
若要创建 Microsoft.Web/sites/config 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.Web/sites/config",
"apiVersion": "2022-09-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
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.Web/sites/config” |
| apiVersion | 资源 API 版本 | '2022-09-01' |
| name | 资源名称 了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
“authsettings” |
| kind | 资源类型。 | string |
| properties | SiteAuthSettings 资源特定的属性 | SiteAuthSettingsProperties |
SiteAuthSettingsProperties
| 名称 | 说明 | 值 |
|---|---|---|
| aadClaimsAuthorization | 获取包含 Azure AD Acl 设置的 JSON 字符串。 | string |
| additionalLoginParams | 在以下情况下要发送到 OpenID Connect 授权终结点的登录参数 用户登录。 每个参数必须采用“key=value”格式。 |
string[] |
| allowedAudiences | 验证颁发者颁发的 JSON Web 令牌时，允许的受众值 Azure Active Directory。 请注意，该值 ClientID 始终被视为允许的访问群体，无论此设置如何。 |
string[] |
| allowedExternalRedirectUrls | 登录或注销应用时可重定向到的外部 URL。 请注意，将忽略 URL 的查询字符串部分。 这是通常只有 Windows 应用商店应用程序后端才需要的高级设置。 请注意，始终隐式允许当前域中的 URL。 |
string[] |
| authFilePath | 包含身份验证设置的配置文件的路径。 如果路径是相对路径，则 base 将作为站点的根目录。 |
字符串 |
| clientId | 此信赖方应用程序的客户端 ID，称为client_id。 若要使用 Azure Active Directory 或 启用 OpenID 连接身份验证，需要此设置 其他第三方 OpenID Connect 提供程序。 有关 OpenID Connect 的详细信息： http://openid.net/specs/openid-connect-core-1_0.html |
string |
| clientSecret | 此信赖方应用程序的客户端密码在 Azure Active Directory 中 (，也称为密钥) 。 此设置是可选的。 如果未配置客户端密码，则 OpenID Connect 隐式身份验证流用于对最终用户进行身份验证。 否则，OpenID Connect 授权代码流用于对最终用户进行身份验证。 有关 OpenID Connect 的详细信息： http://openid.net/specs/openid-connect-core-1_0.html |
string |
| clientSecretCertificateThumbprint | 客户端密码的替代方法，即用于签名的证书的指纹。 此属性充当 客户端密码的替代项。 这也是可选的。 |
字符串 |
| clientSecretSettingName | 包含信赖方应用程序的客户端密码的应用设置名称。 | string |
| configVersion | 当前应用使用的身份验证/授权功能的 ConfigVersion。 此值中的设置可以控制身份验证/授权的控制平面的行为。 |
字符串 |
| defaultProvider | 配置多个提供程序时使用的默认身份验证提供程序。 仅当配置了多个提供程序和未经身份验证的客户端时，才需要此设置 action 设置为“RedirectToLoginPage”。 |
“AzureActiveDirectory” “Facebook” “Github” “Google” “MicrosoftAccount” “Twitter” |
| enabled | true 如果为当前应用启用了身份验证/授权功能，则为 ;否则为 false。 |
bool |
| facebookAppId | 用于登录的 Facebook 应用的应用 ID。 启用Facebook登录名需要此设置。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
字符串 |
| facebookAppSecret | 用于Facebook登录的Facebook应用的应用机密。 启用Facebook登录名需要此设置。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string |
| facebookAppSecretSettingName | 包含用于Facebook登录的应用机密的应用设置名称。 | 字符串 |
| facebookOAuthScopes | 将在 Facebook 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string[] |
| gitHubClientId | 用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置 |
字符串 |
| gitHubClientSecret | 用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。 |
字符串 |
| gitHubClientSecretSettingName | 包含 Github 的客户端密码的应用设置名称 用于 GitHub 登录的应用。 |
string |
| gitHubOAuthScopes | 将在 GitHub 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的 |
string[] |
| googleClientId | Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 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/ |
string |
| googleClientSecretSettingName | 包含与 关联的客户端密码的应用设置名称 Google Web 应用程序。 |
string |
| 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 |
string |
| microsoftAccountClientId | 为用于身份验证的应用创建的 OAuth 2.0 客户端 ID。 此设置是启用 Microsoft 帐户身份验证所必需的。 Microsoft 帐户 OAuth 文档： https://dev.onedrive.com/auth/msa_oauth.htm |
string |
| 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 | 当前应用使用的身份验证/授权功能的 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 |
string |
| twitterConsumerSecret | 用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。 此设置是启用 Twitter 登录所必需的。 Twitter Sign-In 文档： https://dev.twitter.com/web/sign-in |
string |
| twitterConsumerSecretSettingName | 包含 Twitter 的 OAuth 1.0a 使用者机密的应用设置名称 用于登录的应用程序。 |
string |
| unauthenticatedClientAction | 未经身份验证的客户端尝试访问应用时要执行的操作。 | “AllowAnonymous” “RedirectToLoginPage” |
| validateIssuer | 获取一个值，该值指示颁发者是否应为有效的 HTTPS URL 并对其进行验证。 | bool |
快速入门模板
以下快速入门模板部署此资源类型。
| 模板 | 说明 |
|---|---|
| 在应用服务上使用 PostgreSQL 数据库的 Airflow Web 应用 |
用于在应用服务上使用 PostgreSQL 数据库部署 Airflow Web 应用的模板 |
| Azure 中的 EPiserverCMS |
此模板允许在 Azure 中创建 EpiServerCMS 部署所需的资源 |
| 使用 Jenkins 和 Azure Web 应用实现 Java CI/CD |
这是使用 Jenkins 和 Azure Web 应用的 Java CI/CD 的示例。 |
| Orchard CMS 视频门户 Web 应用 |
此模板提供了一种在启用和配置 Azure 媒体服务模块的情况下在 Azure 应用服务 Web 应用 上部署 Orchard CMS 的简单方法。 |
| 适用于 Azure 事件中心 的 PubNub 实时网关 |
适用于 Azure 的 PubNub 实时网关在 PubNub 数据流网络和Azure 事件中心之间提供实时数据流网桥。 - 将其视为 PubNub 和 Azure 之间的双向桥梁！ |
| 可缩放的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| 简单的 Umbraco CMS Web 应用 |
此模板提供了一种在 Azure 应用服务 Web 应用 上部署 umbraco CMS Web 应用的简单方法。 |
| App 服务上的 WordPress 与 MySQL In App 配合使用 |
此模板使用应用中的 MySQL 在 Windows App 服务上部署 WordPress Web 应用 |
| 企业治理 -AppService，SQL DB，AD，OMS，Runbook |
企业（无论大小）的云采用都需要负责任且高效的治理模型才能从其云部署中获取价值。 CloudWise (解决方案) 的代码名称，是 Azure 合作伙伴快速入门中提供的复合解决方案，是客户、系统集成商和合作伙伴的采用支持者，可提供可自助、自动化的治理和运营解决方案，专注于优化成本、改进应用程序 () 可靠性、降低业务风险。 该解决方案突出了可见性和控制的核心治理支柱。 |
| 使用Azure SQL专用终结点的 Web 应用 |
此模板演示如何创建使用指向 Azure SQL 服务器的专用终结点的 Web 应用 |
| Moesif API 分析和盈利 |
该模板会将 Azure API 管理的 API 调用记录到 Moesif API 分析和盈利平台 |
| 从 Azure 逻辑应用调用自定义 API |
尽管逻辑应用为各种服务提供了数百个连接器，但你可能希望调用运行自己的代码的 API。 托管自己的 Web API 的最简单且最可缩放的方法之一是使用 Azure 应用服务。 此模板为自定义 API 部署 Web 应用，并使用 Azure Active Directory 身份验证保护该 API。 |
| 具有 IP 限制的 Web 应用的应用程序网关 |
此模板在 Azure Web 应用前面创建应用程序网关，并在 Web 应用上启用了 IP 限制。 |
| 使用Azure SQL后端应用服务环境 |
此模板创建一个应用服务环境，其中包含Azure SQL后端、专用终结点以及通常在专用/隔离环境中使用的关联资源。 |
| 预配在App 服务计划上运行的函数应用 |
此模板在专用托管计划上预配函数应用，这意味着它将像任何App 服务站点一样运行和计费。 |
| 具有事件中心和托管标识的 Azure 函数应用 |
他的模板在 Linux 消耗计划上预配 Azure 函数应用，以及事件中心、Azure 存储和 Application Insights。 函数应用能够使用托管标识连接到事件中心和存储帐户 |
| 使用 vnet 集成部署 Azure Function Premium 计划 |
此模板允许将启用了区域虚拟网络集成的 Azure Function Premium 计划部署到新创建的虚拟网络。 |
| 使用SQL 数据库预配移动应用 |
此模板预配移动应用、SQL 数据库和通知中心。 它在移动应用中为数据库和通知中心配置连接字符串。 |
| 具有专用终结点的 Web 应用 |
此模板允许你创建 Web 应用并通过专用终结点公开它 |
| 使用内部API 管理和 Web 应用应用程序网关 |
应用程序网关将 Internet 流量路由到虚拟网络 (内部模式) API 管理 实例，该实例为 Azure Web 应用中托管的 Web API 提供服务。 |
| 使用 Blob 存储连接字符串创建 Azure Web 应用 |
使用 Blob 存储连接字符串创建 Azure Web 应用，模板最初由 Microsoft 的 Jeff Bowles 创作 |
| 将诊断日志记录到 Blob 容器的 Web 应用 |
将启用了诊断日志记录的 Web 应用部署到存储帐户 Blob 容器。 |
| 在已启用 Java 13 和 Tomcat 9 的 Azure 上创建 Web 应用 |
此模板在已启用 Java 13 和 Tomcat 9 的 Azure 上创建 Web 应用，使你可以在 Azure 中运行 Java 应用程序。 模板由 Microsoft 的 Donovan Brown 创作。 |
| Web 应用（带 Application Insights 发送到 Log Analytics） |
此模板将帮助支持 microsoft.insights/components 的新 API 版本。 从 2020-02-02-preview 开始，创建 Application Inisghts 时需要 WorkspaceID。此模板将部署App 服务计划、App 服务、Application Insights、Log Analytics 工作区，并将其全部挂钩在一起。 |
| 具有托管标识、SQL Server和 ΑΙ 的 Web 应用 |
为应用 + 数据 + 托管标识 + 监视部署 Azure 基础结构的简单示例 |
| 使用模板创建 Web 应用 + Redis 缓存 + SQL DB |
此模板使用 Redis 缓存和SQL 数据库创建 Azure Web 应用。 |
| 使用SQL 数据库预配 Web 应用 |
此模板预配 Web 应用、SQL 数据库、自动缩放设置、警报规则和 App Insights。 它在 Web 应用中为数据库配置连接字符串。 |
| 使用模板创建 Web 应用和 Redis 缓存 |
此模板使用 Redis 缓存创建 Azure Web 应用。 |
| 具有自定义部署槽位的 Web 应用 |
此模板提供了一种在 Azure Web 应用 上部署具有自定义部署槽位的 Web 应用的简单方法。 |
| 在 Linux 上使用 PostgreSQL 的 Airflow Docker Web 应用 |
此模板提供了一种在 Linux Web 应用上使用 Azure Database for PostgreSQL 部署 puckel/docker-airflow 映像 (最新标记) 的简单方法 |
| 具有 Azure SQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板使用官方 Sonarqube 映像在 Azure 应用服务 Web 应用 Linux 容器中部署 Sonarqube，并由 Azure SQL 服务器提供支持。 |
| 具有 MySQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板提供了一种在 Linux Web 应用上使用 Azure Database for MySQL 部署 Sonarqube docker 映像 (alpine 标记) 的简单方法 |
| 具有 PostgreSQL 的 Linux 上的 Sonarqube Docker Web 应用 |
此模板提供了一种在 Linux Web 应用上使用 Azure Database for PostgreSQL (预览版部署 Sonarqube docker 映像 (alpine 标记) 的简单方法) |
| 使用 Azure database for MySQL 的 Web 应用 |
此模板提供了一种使用 Azure Database for MySQL 在 Azure 应用服务 Web 应用 上部署 Web 应用的简单方法。 |
| Linux 上的 Web 应用和 PostgreSQL |
此模板提供了一种使用 Azure Database for PostgreSQL 在 Linux 上部署 Web 应用的简单方法。 |
| 具有 VNet 注入和专用终结点的 Web 应用 |
此模板允许创建包含两个 Web 应用（前端和后端）的安全端到端解决方案，前端将通过 VNet 注入和专用终结点安全地使用后端 |
Terraform (AzAPI 提供程序) 资源定义
可以使用面向以下操作部署站点/配置资源类型：
- 资源组
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
名称属性的选项
sites/config 资源根据 name 属性的值接受不同的属性。
本文介绍设置 name: 'authsettings'时可用的属性。
有关其他选项，请参阅：
- appsettings
- authsettingsV2
- azurestorageaccounts
- backup
- connectionstrings
- logs
- metadata
- pushsettings
- slotConfigNames
- web
资源格式
若要创建 Microsoft.Web/sites/config 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Web/sites/config@2022-09-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
| 名称 | 说明 | Value |
|---|---|---|
| type | 资源类型 | “Microsoft.Web/sites/config@2022-09-01” |
| name | 资源名称 | “authsettings” |
| parent_id | 此资源的父资源的 ID。 | 类型为的资源的 ID： 站点 |
| kind | 资源类型。 | string |
| properties | SiteAuthSettings 资源特定的属性 | SiteAuthSettingsProperties |
SiteAuthSettingsProperties
| 名称 | 说明 | 值 |
|---|---|---|
| aadClaimsAuthorization | 获取包含 Azure AD Acl 设置的 JSON 字符串。 | string |
| additionalLoginParams | 在以下情况下要发送到 OpenID Connect 授权终结点的登录参数 用户登录。 每个参数必须采用“key=value”格式。 |
string[] |
| allowedAudiences | 验证颁发者颁发的 JSON Web 令牌时，允许的受众值 Azure Active Directory。 请注意，该值 ClientID 始终被视为允许的访问群体，无论此设置如何。 |
string[] |
| allowedExternalRedirectUrls | 登录或注销应用时可重定向到的外部 URL。 请注意，将忽略 URL 的查询字符串部分。 这是通常只有 Windows 应用商店应用程序后端才需要的高级设置。 请注意，始终隐式允许当前域中的 URL。 |
string[] |
| authFilePath | 包含身份验证设置的配置文件的路径。 如果路径是相对路径，则 base 将作为站点的根目录。 |
string |
| clientId | 此信赖方应用程序的客户端 ID，称为client_id。 若要使用 Azure Active Directory 或 启用 OpenID 连接身份验证，需要此设置 其他第三方 OpenID Connect 提供程序。 有关 OpenID Connect 的详细信息： http://openid.net/specs/openid-connect-core-1_0.html |
string |
| 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” |
| enabled | true 如果为当前应用启用了身份验证/授权功能，则为 ;否则为 false。 |
bool |
| facebookAppId | 用于登录的Facebook应用的应用 ID。 启用登录Facebook需要此设置。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string |
| facebookAppSecret | 用于Facebook登录的Facebook应用的应用机密。 启用登录Facebook需要此设置。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string |
| facebookAppSecretSettingName | 包含用于登录Facebook的应用机密的应用设置名称。 | string |
| facebookOAuthScopes | 将作为登录身份验证Facebook一部分请求的 OAuth 2.0 作用域。 此设置是可选的。 Facebook登录文档： https://developers.facebook.com/docs/facebook-login |
string[] |
| gitHubClientId | 用于登录的 GitHub 应用的客户端 ID。 启用 Github 登录需要此设置 |
字符串 |
| gitHubClientSecret | 用于 Github 登录的 GitHub 应用的客户端密码。 启用 Github 登录需要此设置。 |
字符串 |
| gitHubClientSecretSettingName | 包含 Github 的客户端密码的应用设置名称 用于 GitHub 登录的应用。 |
字符串 |
| gitHubOAuthScopes | 将在 GitHub 登录身份验证过程中请求的 OAuth 2.0 范围。 此设置是可选的 |
string[] |
| googleClientId | Google Web 应用程序的 OpenID Connect 客户端 ID。 启用 Google 登录需要此设置。 Google Sign-In 文档： https://developers.google.com/identity/sign-in/web/ |
string |
| 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 Discovery 的详细信息： http://openid.net/specs/openid-connect-discovery-1_0.html |
string |
| microsoftAccountClientId | 为用于身份验证的应用创建的 OAuth 2.0 客户端 ID。 启用 Microsoft 帐户身份验证需要此设置。 Microsoft 帐户 OAuth 文档： https://dev.onedrive.com/auth/msa_oauth.htm |
string |
| 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 | 用于当前应用的身份验证/授权功能的 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 |
string |
| twitterConsumerSecret | 用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密。 启用 Twitter 登录需要此设置。 Twitter Sign-In 文档： https://dev.twitter.com/web/sign-in |
string |
| twitterConsumerSecretSettingName | 包含 Twitter 的 OAuth 1.0a 使用者机密的应用设置名称 用于登录的应用程序。 |
字符串 |
| unauthenticatedClientAction | 未经身份验证的客户端尝试访问应用时要执行的操作。 | “AllowAnonymous” “RedirectToLoginPage” |
| validateIssuer | 获取一个值，该值指示颁发者是否应是有效的 HTTPS URL 并对其进行验证。 | bool |