Bicep 資源定義
containerApps/authConfigs 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.App/containerApps/authConfigs 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.App/containerApps/authConfigs@2022-03-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
globalValidation: {
excludedPaths: [
'string'
]
redirectToProvider: 'string'
unauthenticatedClientAction: 'string'
}
httpSettings: {
forwardProxy: {
convention: 'string'
customHostHeaderName: 'string'
customProtoHeaderName: 'string'
}
requireHttps: bool
routes: {
apiPrefix: 'string'
}
}
identityProviders: {
apple: {
enabled: bool
login: {
scopes: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretSettingName: 'string'
}
}
azureActiveDirectory: {
enabled: bool
isAutoProvisioned: bool
login: {
disableWWWAuthenticate: bool
loginParameters: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretCertificateIssuer: 'string'
clientSecretCertificateSubjectAlternativeName: 'string'
clientSecretCertificateThumbprint: 'string'
clientSecretSettingName: 'string'
openIdIssuer: 'string'
}
validation: {
allowedAudiences: [
'string'
]
defaultAuthorizationPolicy: {
allowedApplications: [
'string'
]
allowedPrincipals: {
groups: [
'string'
]
identities: [
'string'
]
}
}
jwtClaimChecks: {
allowedClientApplications: [
'string'
]
allowedGroups: [
'string'
]
}
}
}
azureStaticWebApps: {
enabled: bool
registration: {
clientId: 'string'
}
}
customOpenIdConnectProviders: {
{customized property}: {
enabled: bool
login: {
nameClaimType: 'string'
scopes: [
'string'
]
}
registration: {
clientCredential: {
clientSecretSettingName: 'string'
method: 'ClientSecretPost'
}
clientId: 'string'
openIdConnectConfiguration: {
authorizationEndpoint: 'string'
certificationUri: 'string'
issuer: 'string'
tokenEndpoint: 'string'
wellKnownOpenIdConfiguration: 'string'
}
}
}
}
facebook: {
enabled: bool
graphApiVersion: 'string'
login: {
scopes: [
'string'
]
}
registration: {
appId: 'string'
appSecretSettingName: 'string'
}
}
gitHub: {
enabled: bool
login: {
scopes: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretSettingName: 'string'
}
}
google: {
enabled: bool
login: {
scopes: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretSettingName: 'string'
}
validation: {
allowedAudiences: [
'string'
]
}
}
twitter: {
enabled: bool
registration: {
consumerKey: 'string'
consumerSecretSettingName: 'string'
}
}
}
login: {
allowedExternalRedirectUrls: [
'string'
]
cookieExpiration: {
convention: 'string'
timeToExpiration: 'string'
}
nonce: {
nonceExpirationInterval: 'string'
validateNonce: bool
}
preserveUrlFragmentsForLogins: bool
routes: {
logoutEndpoint: 'string'
}
}
platform: {
enabled: bool
runtimeVersion: 'string'
}
}
}
屬性值
AllowedAudiencesValidation
名字 |
描述 |
價值 |
allowedAudiences |
要從中驗證 JWT 令牌的物件允許清單的組態設定。 |
string[] |
AllowedPrincipals
名字 |
描述 |
價值 |
組 |
允許的群組清單。 |
string[] |
身份 |
允許的身分識別清單。 |
string[] |
蘋果
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code> 即使設定註冊,還是應該啟用 Apple 提供者;否則,<程式代碼>true</code>。 |
bool |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
Apple 註冊的組態設定。 |
AppleRegistration |
AppleRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
clientSecretSettingName |
包含客戶端密碼的應用程式設定名稱。 |
字串 |
AppRegistration
名字 |
描述 |
價值 |
appId |
用於登入之應用程式的應用程式識別碼。 |
字串 |
appSecretSettingName |
包含應用程式秘密的應用程式設定名稱。 |
字串 |
AuthConfigProperties
名字 |
描述 |
價值 |
globalValidation |
使用服務驗證/授權決定使用者驗證流程的組態設定。 |
GlobalValidation |
httpSettings |
針對 ContainerApp Service Authentication/Authorization 進行的驗證和授權要求的 HTTP 要求組態設定。 |
HttpSettings |
identityProviders |
用來設定 ContainerApp Service Authentication/Authorization 之每個識別提供者的組態設定。 |
IdentityProviders |
登錄 |
使用 ContainerApp Service Authentication/Authorization 之使用者登入流程的組態設定。 |
登入 |
平臺 |
ContainerApp Service Authentication/Authorization 平台的組態設定。 |
AuthPlatform |
名字 |
描述 |
價值 |
啟用 |
如果目前應用程式已啟用驗證/授權功能,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
runtimeVersion |
用於目前應用程式的驗證/授權功能的 RuntimeVersion。 此值中的設定可以控制驗證/授權模組中特定功能的行為。 |
字串 |
AzureActiveDirectory
AzureActiveDirectoryLogin
名字 |
描述 |
價值 |
disableWWWAuthenticate |
如果應該省略 www-authenticate 提供者,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
loginParameters |
登入參數,以在何時傳送至 OpenID Connect 授權端點 使用者登入。 每個參數的格式都必須是 「key=value」。。 |
string[] |
AzureActiveDirectoryRegistration
AzureActiveDirectoryValidation
AzureStaticWebApps
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,仍不應啟用 Azure Static Web Apps 提供者;否則,<程式代碼>true</code>。 |
bool |
註冊 |
Azure Static Web Apps 註冊的組態設定。 |
AzureStaticWebAppsRegistration |
AzureStaticWebAppsRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
ClientRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
clientSecretSettingName |
包含客戶端密碼的應用程式設定名稱。 |
字串 |
CookieExpiration
名字 |
描述 |
價值 |
公約 |
判斷會話 Cookie 到期時所使用的慣例。 |
'FixedTime' 'IdentityProviderDerived' |
timeToExpiration |
要求到期的時間。 |
字串 |
CustomOpenIdConnectProvider
DefaultAuthorizationPolicy
名字 |
描述 |
價值 |
allowedApplications |
Azure Active Directory 允許應用程式的組態設定。 |
string[] |
allowedPrincipals |
Azure Active Directory 允許主體的組態設定。 |
AllowedPrincipals |
Facebook
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code> 即使設定註冊,仍不應啟用 Facebook 提供者;否則,<程式代碼>true</code>。 |
bool |
graphApiVersion |
登入時要使用的Facebook API版本。 |
字串 |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
Facebook 提供者之應用程式註冊的組態設定。 |
AppRegistration |
ForwardProxy
名字 |
描述 |
價值 |
公約 |
用來判斷所提出要求 URL 的慣例。 |
'Custom' 'NoProxy' 'Standard' |
customHostHeaderName |
包含要求主機的標頭名稱。 |
字串 |
customProtoHeaderName |
包含要求配置之標頭的名稱。 |
字串 |
GitHub
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,仍不應啟用 GitHub 提供者;否則,<程式代碼>true</code>。 |
bool |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
GitHub 提供者的應用程式註冊組態設定。 |
ClientRegistration |
GlobalValidation
名字 |
描述 |
價值 |
excludedPaths |
未經驗證流程的路徑不會重新導向至登入頁面。 |
string[] |
redirectToProvider |
設定多個提供者時要使用的預設驗證提供者。 只有在已設定多個提供者和未經驗證的用戶端時,才需要此設定 action 設定為 「RedirectToLoginPage」。。 |
字串 |
unauthenticatedClientAction |
當未經驗證的客戶端嘗試存取應用程式時要採取的動作。 |
'AllowAnonymous' 'RedirectToLoginPage' 'Return401' 'Return403' |
谷歌
HttpSettings
名字 |
描述 |
價值 |
forwardProxy |
用來提出要求的轉寄 Proxy 組態設定。 |
ForwardProxy |
requireHttps |
如果不允許驗證/授權回應沒有 HTTPS 配置,<程式代碼>false</code>;否則,<程式代碼>true</code>。 |
bool |
路線 |
路徑 HTTP 要求的組態設定。 |
HttpSettingsRoutes |
HttpSettingsRoutes
名字 |
描述 |
價值 |
apiPrefix |
前置詞,應該位於所有驗證/授權路徑之前。 |
字串 |
IdentityProviders
IdentityProvidersCustomOpenIdConnectProviders
JwtClaimChecks
名字 |
描述 |
價值 |
allowedClientApplications |
允許的用戶端應用程式清單。 |
string[] |
allowedGroups |
允許的群組清單。 |
string[] |
登錄
名字 |
描述 |
價值 |
allowedExternalRedirectUrls |
可在登入或註銷應用程式時重新導向至 的外部URL。 請注意,會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意,目前網域內的URL一律是隱含允許的。 |
string[] |
cookieExpiration |
會話 Cookie 到期的組態設定。 |
CookieExpiration |
nonce |
登入流程中使用的 Nonce 組態設定。 |
Nonce |
preserveUrlFragmentsForLogins |
如果提出登入要求之後保留來自要求的片段,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
路線 |
指定用於登入和註銷要求的端點的路由。 |
LoginRoutes |
LoginRoutes
名字 |
描述 |
價值 |
logoutEndpoint |
應該提出註銷要求的端點。 |
字串 |
LoginScopes
名字 |
描述 |
價值 |
範圍 |
驗證時應要求的範圍清單。 |
string[] |
Microsoft.App/containerApps/authConfigs
Nonce
名字 |
描述 |
價值 |
nonceExpirationInterval |
要求到期后的時間。 |
字串 |
validateNonce |
如果完成登入流程時不應該驗證 nonce,<程式代碼>false</code>;否則,<程式代碼>true</code>。 |
bool |
OpenIdConnectClientCredential
名字 |
描述 |
價值 |
clientSecretSettingName |
包含自訂 Open ID Connect 提供者用戶端密碼的應用程式設定。 |
字串 |
方法 |
應該用來驗證使用者的方法。 |
'ClientSecretPost' |
OpenIdConnectConfig
名字 |
描述 |
價值 |
authorizationEndpoint |
要用來提出授權要求的端點。 |
字串 |
certificationUri |
提供驗證令牌所需金鑰的端點。 |
字串 |
發行 |
發出令牌的端點。 |
字串 |
tokenEndpoint |
要用來要求令牌的端點。 |
字串 |
wellKnownOpenIdConfiguration |
包含提供者所有組態端點的端點。 |
字串 |
OpenIdConnectLogin
名字 |
描述 |
價值 |
nameClaimType |
包含用戶名稱的宣告名稱。 |
字串 |
範圍 |
驗證時應要求的範圍清單。 |
string[] |
OpenIdConnectRegistration
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,也不應該啟用 Twitter 提供者;否則,<程式代碼>true</code>。 |
bool |
註冊 |
Twitter 提供者之應用程式註冊的組態設定。 |
TwitterRegistration |
名字 |
描述 |
價值 |
consumerKey |
用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密鑰。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔:https://dev.twitter.com/web/sign-in |
字串 |
consumerSecretSettingName |
包含 Twitter OAuth 1.0a 取用者秘密的應用程式設定名稱 用於登入的應用程式。 |
字串 |
ARM 樣本資源定義
containerApps/authConfigs 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.App/containerApps/authConfigs 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.App/containerApps/authConfigs",
"apiVersion": "2022-03-01",
"name": "string",
"properties": {
"globalValidation": {
"excludedPaths": [ "string" ],
"redirectToProvider": "string",
"unauthenticatedClientAction": "string"
},
"httpSettings": {
"forwardProxy": {
"convention": "string",
"customHostHeaderName": "string",
"customProtoHeaderName": "string"
},
"requireHttps": "bool",
"routes": {
"apiPrefix": "string"
}
},
"identityProviders": {
"apple": {
"enabled": "bool",
"login": {
"scopes": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretSettingName": "string"
}
},
"azureActiveDirectory": {
"enabled": "bool",
"isAutoProvisioned": "bool",
"login": {
"disableWWWAuthenticate": "bool",
"loginParameters": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretCertificateIssuer": "string",
"clientSecretCertificateSubjectAlternativeName": "string",
"clientSecretCertificateThumbprint": "string",
"clientSecretSettingName": "string",
"openIdIssuer": "string"
},
"validation": {
"allowedAudiences": [ "string" ],
"defaultAuthorizationPolicy": {
"allowedApplications": [ "string" ],
"allowedPrincipals": {
"groups": [ "string" ],
"identities": [ "string" ]
}
},
"jwtClaimChecks": {
"allowedClientApplications": [ "string" ],
"allowedGroups": [ "string" ]
}
}
},
"azureStaticWebApps": {
"enabled": "bool",
"registration": {
"clientId": "string"
}
},
"customOpenIdConnectProviders": {
"{customized property}": {
"enabled": "bool",
"login": {
"nameClaimType": "string",
"scopes": [ "string" ]
},
"registration": {
"clientCredential": {
"clientSecretSettingName": "string",
"method": "ClientSecretPost"
},
"clientId": "string",
"openIdConnectConfiguration": {
"authorizationEndpoint": "string",
"certificationUri": "string",
"issuer": "string",
"tokenEndpoint": "string",
"wellKnownOpenIdConfiguration": "string"
}
}
}
},
"facebook": {
"enabled": "bool",
"graphApiVersion": "string",
"login": {
"scopes": [ "string" ]
},
"registration": {
"appId": "string",
"appSecretSettingName": "string"
}
},
"gitHub": {
"enabled": "bool",
"login": {
"scopes": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretSettingName": "string"
}
},
"google": {
"enabled": "bool",
"login": {
"scopes": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretSettingName": "string"
},
"validation": {
"allowedAudiences": [ "string" ]
}
},
"twitter": {
"enabled": "bool",
"registration": {
"consumerKey": "string",
"consumerSecretSettingName": "string"
}
}
},
"login": {
"allowedExternalRedirectUrls": [ "string" ],
"cookieExpiration": {
"convention": "string",
"timeToExpiration": "string"
},
"nonce": {
"nonceExpirationInterval": "string",
"validateNonce": "bool"
},
"preserveUrlFragmentsForLogins": "bool",
"routes": {
"logoutEndpoint": "string"
}
},
"platform": {
"enabled": "bool",
"runtimeVersion": "string"
}
}
}
屬性值
AllowedAudiencesValidation
名字 |
描述 |
價值 |
allowedAudiences |
要從中驗證 JWT 令牌的物件允許清單的組態設定。 |
string[] |
AllowedPrincipals
名字 |
描述 |
價值 |
組 |
允許的群組清單。 |
string[] |
身份 |
允許的身分識別清單。 |
string[] |
蘋果
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code> 即使設定註冊,還是應該啟用 Apple 提供者;否則,<程式代碼>true</code>。 |
bool |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
Apple 註冊的組態設定。 |
AppleRegistration |
AppleRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
clientSecretSettingName |
包含客戶端密碼的應用程式設定名稱。 |
字串 |
AppRegistration
名字 |
描述 |
價值 |
appId |
用於登入之應用程式的應用程式識別碼。 |
字串 |
appSecretSettingName |
包含應用程式秘密的應用程式設定名稱。 |
字串 |
AuthConfigProperties
名字 |
描述 |
價值 |
globalValidation |
使用服務驗證/授權決定使用者驗證流程的組態設定。 |
GlobalValidation |
httpSettings |
針對 ContainerApp Service Authentication/Authorization 進行的驗證和授權要求的 HTTP 要求組態設定。 |
HttpSettings |
identityProviders |
用來設定 ContainerApp Service Authentication/Authorization 之每個識別提供者的組態設定。 |
IdentityProviders |
登錄 |
使用 ContainerApp Service Authentication/Authorization 之使用者登入流程的組態設定。 |
登入 |
平臺 |
ContainerApp Service Authentication/Authorization 平台的組態設定。 |
AuthPlatform |
名字 |
描述 |
價值 |
啟用 |
如果目前應用程式已啟用驗證/授權功能,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
runtimeVersion |
用於目前應用程式的驗證/授權功能的 RuntimeVersion。 此值中的設定可以控制驗證/授權模組中特定功能的行為。 |
字串 |
AzureActiveDirectory
AzureActiveDirectoryLogin
名字 |
描述 |
價值 |
disableWWWAuthenticate |
如果應該省略 www-authenticate 提供者,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
loginParameters |
登入參數,以在何時傳送至 OpenID Connect 授權端點 使用者登入。 每個參數的格式都必須是 「key=value」。。 |
string[] |
AzureActiveDirectoryRegistration
AzureActiveDirectoryValidation
AzureStaticWebApps
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,仍不應啟用 Azure Static Web Apps 提供者;否則,<程式代碼>true</code>。 |
bool |
註冊 |
Azure Static Web Apps 註冊的組態設定。 |
AzureStaticWebAppsRegistration |
AzureStaticWebAppsRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
ClientRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
clientSecretSettingName |
包含客戶端密碼的應用程式設定名稱。 |
字串 |
CookieExpiration
名字 |
描述 |
價值 |
公約 |
判斷會話 Cookie 到期時所使用的慣例。 |
'FixedTime' 'IdentityProviderDerived' |
timeToExpiration |
要求到期的時間。 |
字串 |
CustomOpenIdConnectProvider
DefaultAuthorizationPolicy
名字 |
描述 |
價值 |
allowedApplications |
Azure Active Directory 允許應用程式的組態設定。 |
string[] |
allowedPrincipals |
Azure Active Directory 允許主體的組態設定。 |
AllowedPrincipals |
Facebook
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code> 即使設定註冊,仍不應啟用 Facebook 提供者;否則,<程式代碼>true</code>。 |
bool |
graphApiVersion |
登入時要使用的Facebook API版本。 |
字串 |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
Facebook 提供者之應用程式註冊的組態設定。 |
AppRegistration |
ForwardProxy
名字 |
描述 |
價值 |
公約 |
用來判斷所提出要求 URL 的慣例。 |
'Custom' 'NoProxy' 'Standard' |
customHostHeaderName |
包含要求主機的標頭名稱。 |
字串 |
customProtoHeaderName |
包含要求配置之標頭的名稱。 |
字串 |
GitHub
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,仍不應啟用 GitHub 提供者;否則,<程式代碼>true</code>。 |
bool |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
GitHub 提供者的應用程式註冊組態設定。 |
ClientRegistration |
GlobalValidation
名字 |
描述 |
價值 |
excludedPaths |
未經驗證流程的路徑不會重新導向至登入頁面。 |
string[] |
redirectToProvider |
設定多個提供者時要使用的預設驗證提供者。 只有在已設定多個提供者和未經驗證的用戶端時,才需要此設定 action 設定為 「RedirectToLoginPage」。。 |
字串 |
unauthenticatedClientAction |
當未經驗證的客戶端嘗試存取應用程式時要採取的動作。 |
'AllowAnonymous' 'RedirectToLoginPage' 'Return401' 'Return403' |
谷歌
HttpSettings
名字 |
描述 |
價值 |
forwardProxy |
用來提出要求的轉寄 Proxy 組態設定。 |
ForwardProxy |
requireHttps |
如果不允許驗證/授權回應沒有 HTTPS 配置,<程式代碼>false</code>;否則,<程式代碼>true</code>。 |
bool |
路線 |
路徑 HTTP 要求的組態設定。 |
HttpSettingsRoutes |
HttpSettingsRoutes
名字 |
描述 |
價值 |
apiPrefix |
前置詞,應該位於所有驗證/授權路徑之前。 |
字串 |
IdentityProviders
IdentityProvidersCustomOpenIdConnectProviders
JwtClaimChecks
名字 |
描述 |
價值 |
allowedClientApplications |
允許的用戶端應用程式清單。 |
string[] |
allowedGroups |
允許的群組清單。 |
string[] |
登錄
名字 |
描述 |
價值 |
allowedExternalRedirectUrls |
可在登入或註銷應用程式時重新導向至 的外部URL。 請注意,會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意,目前網域內的URL一律是隱含允許的。 |
string[] |
cookieExpiration |
會話 Cookie 到期的組態設定。 |
CookieExpiration |
nonce |
登入流程中使用的 Nonce 組態設定。 |
Nonce |
preserveUrlFragmentsForLogins |
如果提出登入要求之後保留來自要求的片段,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
路線 |
指定用於登入和註銷要求的端點的路由。 |
LoginRoutes |
LoginRoutes
名字 |
描述 |
價值 |
logoutEndpoint |
應該提出註銷要求的端點。 |
字串 |
LoginScopes
名字 |
描述 |
價值 |
範圍 |
驗證時應要求的範圍清單。 |
string[] |
Microsoft.App/containerApps/authConfigs
名字 |
描述 |
價值 |
apiVersion |
API 版本 |
'2022-03-01' |
名字 |
資源名稱 |
字串 (必要) |
性能 |
AuthConfig 資源特定屬性 |
AuthConfigProperties |
類型 |
資源類型 |
'Microsoft.App/containerApps/authConfigs' |
Nonce
名字 |
描述 |
價值 |
nonceExpirationInterval |
要求到期后的時間。 |
字串 |
validateNonce |
如果完成登入流程時不應該驗證 nonce,<程式代碼>false</code>;否則,<程式代碼>true</code>。 |
bool |
OpenIdConnectClientCredential
名字 |
描述 |
價值 |
clientSecretSettingName |
包含自訂 Open ID Connect 提供者用戶端密碼的應用程式設定。 |
字串 |
方法 |
應該用來驗證使用者的方法。 |
'ClientSecretPost' |
OpenIdConnectConfig
名字 |
描述 |
價值 |
authorizationEndpoint |
要用來提出授權要求的端點。 |
字串 |
certificationUri |
提供驗證令牌所需金鑰的端點。 |
字串 |
發行 |
發出令牌的端點。 |
字串 |
tokenEndpoint |
要用來要求令牌的端點。 |
字串 |
wellKnownOpenIdConfiguration |
包含提供者所有組態端點的端點。 |
字串 |
OpenIdConnectLogin
名字 |
描述 |
價值 |
nameClaimType |
包含用戶名稱的宣告名稱。 |
字串 |
範圍 |
驗證時應要求的範圍清單。 |
string[] |
OpenIdConnectRegistration
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,也不應該啟用 Twitter 提供者;否則,<程式代碼>true</code>。 |
bool |
註冊 |
Twitter 提供者之應用程式註冊的組態設定。 |
TwitterRegistration |
名字 |
描述 |
價值 |
consumerKey |
用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密鑰。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔:https://dev.twitter.com/web/sign-in |
字串 |
consumerSecretSettingName |
包含 Twitter OAuth 1.0a 取用者秘密的應用程式設定名稱 用於登入的應用程式。 |
字串 |
containerApps/authConfigs 資源類型可以使用目標作業來部署:
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
若要建立 Microsoft.App/containerApps/authConfigs 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.App/containerApps/authConfigs@2022-03-01"
name = "string"
body = jsonencode({
properties = {
globalValidation = {
excludedPaths = [
"string"
]
redirectToProvider = "string"
unauthenticatedClientAction = "string"
}
httpSettings = {
forwardProxy = {
convention = "string"
customHostHeaderName = "string"
customProtoHeaderName = "string"
}
requireHttps = bool
routes = {
apiPrefix = "string"
}
}
identityProviders = {
apple = {
enabled = bool
login = {
scopes = [
"string"
]
}
registration = {
clientId = "string"
clientSecretSettingName = "string"
}
}
azureActiveDirectory = {
enabled = bool
isAutoProvisioned = bool
login = {
disableWWWAuthenticate = bool
loginParameters = [
"string"
]
}
registration = {
clientId = "string"
clientSecretCertificateIssuer = "string"
clientSecretCertificateSubjectAlternativeName = "string"
clientSecretCertificateThumbprint = "string"
clientSecretSettingName = "string"
openIdIssuer = "string"
}
validation = {
allowedAudiences = [
"string"
]
defaultAuthorizationPolicy = {
allowedApplications = [
"string"
]
allowedPrincipals = {
groups = [
"string"
]
identities = [
"string"
]
}
}
jwtClaimChecks = {
allowedClientApplications = [
"string"
]
allowedGroups = [
"string"
]
}
}
}
azureStaticWebApps = {
enabled = bool
registration = {
clientId = "string"
}
}
customOpenIdConnectProviders = {
{customized property} = {
enabled = bool
login = {
nameClaimType = "string"
scopes = [
"string"
]
}
registration = {
clientCredential = {
clientSecretSettingName = "string"
method = "ClientSecretPost"
}
clientId = "string"
openIdConnectConfiguration = {
authorizationEndpoint = "string"
certificationUri = "string"
issuer = "string"
tokenEndpoint = "string"
wellKnownOpenIdConfiguration = "string"
}
}
}
}
facebook = {
enabled = bool
graphApiVersion = "string"
login = {
scopes = [
"string"
]
}
registration = {
appId = "string"
appSecretSettingName = "string"
}
}
gitHub = {
enabled = bool
login = {
scopes = [
"string"
]
}
registration = {
clientId = "string"
clientSecretSettingName = "string"
}
}
google = {
enabled = bool
login = {
scopes = [
"string"
]
}
registration = {
clientId = "string"
clientSecretSettingName = "string"
}
validation = {
allowedAudiences = [
"string"
]
}
}
twitter = {
enabled = bool
registration = {
consumerKey = "string"
consumerSecretSettingName = "string"
}
}
}
login = {
allowedExternalRedirectUrls = [
"string"
]
cookieExpiration = {
convention = "string"
timeToExpiration = "string"
}
nonce = {
nonceExpirationInterval = "string"
validateNonce = bool
}
preserveUrlFragmentsForLogins = bool
routes = {
logoutEndpoint = "string"
}
}
platform = {
enabled = bool
runtimeVersion = "string"
}
}
})
}
屬性值
AllowedAudiencesValidation
名字 |
描述 |
價值 |
allowedAudiences |
要從中驗證 JWT 令牌的物件允許清單的組態設定。 |
string[] |
AllowedPrincipals
名字 |
描述 |
價值 |
組 |
允許的群組清單。 |
string[] |
身份 |
允許的身分識別清單。 |
string[] |
蘋果
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code> 即使設定註冊,還是應該啟用 Apple 提供者;否則,<程式代碼>true</code>。 |
bool |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
Apple 註冊的組態設定。 |
AppleRegistration |
AppleRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
clientSecretSettingName |
包含客戶端密碼的應用程式設定名稱。 |
字串 |
AppRegistration
名字 |
描述 |
價值 |
appId |
用於登入之應用程式的應用程式識別碼。 |
字串 |
appSecretSettingName |
包含應用程式秘密的應用程式設定名稱。 |
字串 |
AuthConfigProperties
名字 |
描述 |
價值 |
globalValidation |
使用服務驗證/授權決定使用者驗證流程的組態設定。 |
GlobalValidation |
httpSettings |
針對 ContainerApp Service Authentication/Authorization 進行的驗證和授權要求的 HTTP 要求組態設定。 |
HttpSettings |
identityProviders |
用來設定 ContainerApp Service Authentication/Authorization 之每個識別提供者的組態設定。 |
IdentityProviders |
登錄 |
使用 ContainerApp Service Authentication/Authorization 之使用者登入流程的組態設定。 |
登入 |
平臺 |
ContainerApp Service Authentication/Authorization 平台的組態設定。 |
AuthPlatform |
名字 |
描述 |
價值 |
啟用 |
如果目前應用程式已啟用驗證/授權功能,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
runtimeVersion |
用於目前應用程式的驗證/授權功能的 RuntimeVersion。 此值中的設定可以控制驗證/授權模組中特定功能的行為。 |
字串 |
AzureActiveDirectory
AzureActiveDirectoryLogin
名字 |
描述 |
價值 |
disableWWWAuthenticate |
如果應該省略 www-authenticate 提供者,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
loginParameters |
登入參數,以在何時傳送至 OpenID Connect 授權端點 使用者登入。 每個參數的格式都必須是 「key=value」。。 |
string[] |
AzureActiveDirectoryRegistration
AzureActiveDirectoryValidation
AzureStaticWebApps
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,仍不應啟用 Azure Static Web Apps 提供者;否則,<程式代碼>true</code>。 |
bool |
註冊 |
Azure Static Web Apps 註冊的組態設定。 |
AzureStaticWebAppsRegistration |
AzureStaticWebAppsRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
ClientRegistration
名字 |
描述 |
價值 |
clientId |
用於登入之應用程式的用戶端識別碼。 |
字串 |
clientSecretSettingName |
包含客戶端密碼的應用程式設定名稱。 |
字串 |
CookieExpiration
名字 |
描述 |
價值 |
公約 |
判斷會話 Cookie 到期時所使用的慣例。 |
'FixedTime' 'IdentityProviderDerived' |
timeToExpiration |
要求到期的時間。 |
字串 |
CustomOpenIdConnectProvider
DefaultAuthorizationPolicy
名字 |
描述 |
價值 |
allowedApplications |
Azure Active Directory 允許應用程式的組態設定。 |
string[] |
allowedPrincipals |
Azure Active Directory 允許主體的組態設定。 |
AllowedPrincipals |
Facebook
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code> 即使設定註冊,仍不應啟用 Facebook 提供者;否則,<程式代碼>true</code>。 |
bool |
graphApiVersion |
登入時要使用的Facebook API版本。 |
字串 |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
Facebook 提供者之應用程式註冊的組態設定。 |
AppRegistration |
ForwardProxy
名字 |
描述 |
價值 |
公約 |
用來判斷所提出要求 URL 的慣例。 |
'Custom' 'NoProxy' 'Standard' |
customHostHeaderName |
包含要求主機的標頭名稱。 |
字串 |
customProtoHeaderName |
包含要求配置之標頭的名稱。 |
字串 |
GitHub
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,仍不應啟用 GitHub 提供者;否則,<程式代碼>true</code>。 |
bool |
登錄 |
登入流程的組態設定。 |
LoginScopes |
註冊 |
GitHub 提供者的應用程式註冊組態設定。 |
ClientRegistration |
GlobalValidation
名字 |
描述 |
價值 |
excludedPaths |
未經驗證流程的路徑不會重新導向至登入頁面。 |
string[] |
redirectToProvider |
設定多個提供者時要使用的預設驗證提供者。 只有在已設定多個提供者和未經驗證的用戶端時,才需要此設定 action 設定為 「RedirectToLoginPage」。。 |
字串 |
unauthenticatedClientAction |
當未經驗證的客戶端嘗試存取應用程式時要採取的動作。 |
'AllowAnonymous' 'RedirectToLoginPage' 'Return401' 'Return403' |
谷歌
HttpSettings
名字 |
描述 |
價值 |
forwardProxy |
用來提出要求的轉寄 Proxy 組態設定。 |
ForwardProxy |
requireHttps |
如果不允許驗證/授權回應沒有 HTTPS 配置,<程式代碼>false</code>;否則,<程式代碼>true</code>。 |
bool |
路線 |
路徑 HTTP 要求的組態設定。 |
HttpSettingsRoutes |
HttpSettingsRoutes
名字 |
描述 |
價值 |
apiPrefix |
前置詞,應該位於所有驗證/授權路徑之前。 |
字串 |
IdentityProviders
IdentityProvidersCustomOpenIdConnectProviders
JwtClaimChecks
名字 |
描述 |
價值 |
allowedClientApplications |
允許的用戶端應用程式清單。 |
string[] |
allowedGroups |
允許的群組清單。 |
string[] |
登錄
名字 |
描述 |
價值 |
allowedExternalRedirectUrls |
可在登入或註銷應用程式時重新導向至 的外部URL。 請注意,會忽略 URL 的查詢字串部分。 這是 Windows 市集應用程式後端通常需要的進階設定。 請注意,目前網域內的URL一律是隱含允許的。 |
string[] |
cookieExpiration |
會話 Cookie 到期的組態設定。 |
CookieExpiration |
nonce |
登入流程中使用的 Nonce 組態設定。 |
Nonce |
preserveUrlFragmentsForLogins |
如果提出登入要求之後保留來自要求的片段,<程式代碼>true</code>;否則,<程式代碼>false</code>。 |
bool |
路線 |
指定用於登入和註銷要求的端點的路由。 |
LoginRoutes |
LoginRoutes
名字 |
描述 |
價值 |
logoutEndpoint |
應該提出註銷要求的端點。 |
字串 |
LoginScopes
名字 |
描述 |
價值 |
範圍 |
驗證時應要求的範圍清單。 |
string[] |
Microsoft.App/containerApps/authConfigs
名字 |
描述 |
價值 |
名字 |
資源名稱 |
字串 (必要) |
parent_id |
此資源為父系之資源的標識碼。 |
類型資源的標識碼:containerApps |
性能 |
AuthConfig 資源特定屬性 |
AuthConfigProperties |
類型 |
資源類型 |
“Microsoft.App/containerApps/authConfigs@2022-03-01” |
Nonce
名字 |
描述 |
價值 |
nonceExpirationInterval |
要求到期后的時間。 |
字串 |
validateNonce |
如果完成登入流程時不應該驗證 nonce,<程式代碼>false</code>;否則,<程式代碼>true</code>。 |
bool |
OpenIdConnectClientCredential
名字 |
描述 |
價值 |
clientSecretSettingName |
包含自訂 Open ID Connect 提供者用戶端密碼的應用程式設定。 |
字串 |
方法 |
應該用來驗證使用者的方法。 |
'ClientSecretPost' |
OpenIdConnectConfig
名字 |
描述 |
價值 |
authorizationEndpoint |
要用來提出授權要求的端點。 |
字串 |
certificationUri |
提供驗證令牌所需金鑰的端點。 |
字串 |
發行 |
發出令牌的端點。 |
字串 |
tokenEndpoint |
要用來要求令牌的端點。 |
字串 |
wellKnownOpenIdConfiguration |
包含提供者所有組態端點的端點。 |
字串 |
OpenIdConnectLogin
名字 |
描述 |
價值 |
nameClaimType |
包含用戶名稱的宣告名稱。 |
字串 |
範圍 |
驗證時應要求的範圍清單。 |
string[] |
OpenIdConnectRegistration
名字 |
描述 |
價值 |
啟用 |
<程式代碼>false</code>,即使設定註冊,也不應該啟用 Twitter 提供者;否則,<程式代碼>true</code>。 |
bool |
註冊 |
Twitter 提供者之應用程式註冊的組態設定。 |
TwitterRegistration |
名字 |
描述 |
價值 |
consumerKey |
用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密鑰。 啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔:https://dev.twitter.com/web/sign-in |
字串 |
consumerSecretSettingName |
包含 Twitter OAuth 1.0a 取用者秘密的應用程式設定名稱 用於登入的應用程式。 |
字串 |