SiteAuthSettings 類別

參考

Azure App 服務驗證/授權功能的組態設定。

變數只會由伺服器填入，而且會在傳送要求時予以忽略。

繼承: azure.mgmt.web.v2020_12_01.models._models_py3.ProxyOnlyResource

SiteAuthSettings

建構函式

SiteAuthSettings(*, kind: str | None = None, enabled: bool | None = None, runtime_version: str | None = None, unauthenticated_client_action: str | _models.UnauthenticatedClientAction | None = None, token_store_enabled: bool | None = None, allowed_external_redirect_urls: List[str] | None = None, default_provider: str | _models.BuiltInAuthenticationProvider | None = None, token_refresh_extension_hours: float | None = None, client_id: str | None = None, client_secret: str | None = None, client_secret_setting_name: str | None = None, client_secret_certificate_thumbprint: str | None = None, issuer: str | None = None, validate_issuer: bool | None = None, allowed_audiences: List[str] | None = None, additional_login_params: List[str] | None = None, aad_claims_authorization: str | None = None, google_client_id: str | None = None, google_client_secret: str | None = None, google_client_secret_setting_name: str | None = None, google_o_auth_scopes: List[str] | None = None, facebook_app_id: str | None = None, facebook_app_secret: str | None = None, facebook_app_secret_setting_name: str | None = None, facebook_o_auth_scopes: List[str] | None = None, git_hub_client_id: str | None = None, git_hub_client_secret: str | None = None, git_hub_client_secret_setting_name: str | None = None, git_hub_o_auth_scopes: List[str] | None = None, twitter_consumer_key: str | None = None, twitter_consumer_secret: str | None = None, twitter_consumer_secret_setting_name: str | None = None, microsoft_account_client_id: str | None = None, microsoft_account_client_secret: str | None = None, microsoft_account_client_secret_setting_name: str | None = None, microsoft_account_o_auth_scopes: List[str] | None = None, is_auth_from_file: str | None = None, auth_file_path: str | None = None, config_version: str | None = None, **kwargs: Any)

僅限關鍵字的參數

名稱	Description
kind	str 資源種類。
enabled	bool `<code>true</code>` 如果目前應用程式已啟用驗證/授權功能，則為 ;否則為 `<code>false</code>` 。
runtime_version	str 用於目前應用程式的 Authentication /Authorization 功能的 RuntimeVersion。此值中的設定可以控制驗證/授權模組中特定功能的行為。
unauthenticated_client_action	str 或 UnauthenticatedClientAction 當未經驗證的用戶端嘗試存取應用程式時，要採取的動作。已知值為：「RedirectToLoginPage」和「AllowAnonymous」。
token_store_enabled	bool `<code>true</code>` 若要永久儲存在登入流程期間取得的平臺特定安全性權杖;否則為 `<code>false</code>` 。預設值為 `<code>false</code>`。
allowed_external_redirect_urls	list[str] 可在登入或登出應用程式時重新導向至的外部 URL。請注意，會忽略 URL 的查詢字串部分。這是 Windows 市集應用程式後端通常需要的進階設定。請注意，目前網域內的 URL 一律會隱含允許。
default_provider	str 或 BuiltInAuthenticationProvider 設定多個提供者時要使用的預設驗證提供者。只有在設定多個提供者且未驗證的用戶端動作設定為「RedirectToLoginPage」時，才需要此設定。已知值為：「AzureActiveDirectory」、「Facebook」、「Google」、「MicrosoftAccount」、「Twitter」和「Github」。
token_refresh_extension_hours	float 會話權杖到期後的小時數，會話權杖可用來呼叫權杖重新整理 API。預設值為 72 小時。
client_id	str 此信賴憑證者應用程式的用戶端識別碼，稱為client_id。若要使用 Azure Active Directory 或其他協力廠商 OpenID Connect 提供者啟用 OpenID 連線驗證，則需要此設定。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html 。
client_secret	str Azure Active Directory 中此信賴憑證者應用程式的用戶端密碼 (，也稱為金鑰) 。這個設定是選擇性的。如果未設定任何用戶端密碼，則會使用 OpenID Connect 隱含驗證流程來驗證終端使用者。否則，OpenID Connect 授權碼流程會用來驗證使用者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html 。
client_secret_setting_name	str 包含信賴憑證者應用程式的用戶端密碼的應用程式設定名稱。
client_secret_certificate_thumbprint	str 用戶端密碼的替代方案，這是用於簽署之憑證的指紋。這個屬性可作為用戶端密碼的取代。它也是選擇性的。
issuer	str 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 。
validate_issuer	bool 取得值，指出簽發者是否應該是有效的 HTTPS URL，並驗證如下。
allowed_audiences	list[str] 允許的物件值在驗證 Azure Active Directory 所發出的 JWT 時考慮。請注意，不論此設定為何，值 `<code>ClientID</code>` 一律被視為允許的物件。
additional_login_params	list[str] 當使用者登入時，要傳送至 OpenID Connect 授權端點的登入參數。每個參數的格式都必須是「key=value」。
aad_claims_authorization	str 取得包含 Azure AD Acl 設定的 JSON 字串。
google_client_id	str Google Web 應用程式的 OpenID Connect 用戶端識別碼。啟用 Google 登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ 。
google_client_secret	str 與 Google Web 應用程式相關聯的用戶端密碼。啟用 Google 登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ 。
google_client_secret_setting_name	str 應用程式設定名稱，其中包含與 Google Web 應用程式相關聯的用戶端密碼。
google_o_auth_scopes	list[str] 將作為 Google Sign-In 驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。如果未指定，則會使用「openid」、「profile」和「email」作為預設範圍。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ 。
facebook_app_id	str 用於登入之 Facebook 應用程式的應用程式識別碼。啟用 Facebook 登入需要此設定。 Facebook 登入檔： https://developers.facebook.com/docs/facebook-login 。
facebook_app_secret	str 用於 Facebook 登入之 Facebook 應用程式的應用程式秘密。啟用 Facebook 登入需要此設定。 Facebook 登入檔： https://developers.facebook.com/docs/facebook-login 。
facebook_app_secret_setting_name	str 應用程式設定名稱，其中包含用於 Facebook 登入的應用程式密碼。
facebook_o_auth_scopes	list[str] 將作為 Facebook 登入驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。 Facebook 登入檔： https://developers.facebook.com/docs/facebook-login 。
git_hub_client_id	str 用於登入的 GitHub 應用程式的用戶端識別碼。啟用 Github 登入需要此設定。
git_hub_client_secret	str GitHub 應用程式用於 Github 登入的用戶端密碼。啟用 Github 登入需要此設定。
git_hub_client_secret_setting_name	str 應用程式設定名稱，其中包含用於 GitHub 登入之 Github 應用程式的用戶端密碼。
git_hub_o_auth_scopes	list[str] 將作為 GitHub 登入驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。
twitter_consumer_key	str 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者金鑰。啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in 。
twitter_consumer_secret	str 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者秘密。啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in 。
twitter_consumer_secret_setting_name	str 應用程式設定名稱，其中包含用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密碼。
microsoft_account_client_id	str 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端識別碼。啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm 。
microsoft_account_client_secret	str 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端密碼。啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm 。
microsoft_account_client_secret_setting_name	str 應用程式設定名稱，其中包含針對用於驗證之應用程式所建立的 OAuth 2.0 用戶端密碼。
microsoft_account_o_auth_scopes	list[str] 將作為 Microsoft 帳戶驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。如果未指定，則會使用「wl.basic」作為預設範圍。 Microsoft 帳戶範圍和許可權檔： https://msdn.microsoft.com/en-us/library/dn631845.aspx 。
is_auth_from_file	str 如果應該從檔案讀取驗證組態設定，則為「true」，否則為「false」。
auth_file_path	str 包含驗證設定的組態檔路徑。如果路徑是相對的，基底將會是月臺的根目錄。
config_version	str 目前應用程式使用的驗證/授權功能的 ConfigVersion。此值中的設定可以控制驗證/授權的控制平面行為。

變數

名稱	Description
id	str 資源識別碼。
name	str 資源名稱。
kind	str 資源種類。
type	str 資源類型。
enabled	bool `<code>true</code>` 如果目前應用程式已啟用驗證/授權功能，則為 ;否則為 `<code>false</code>` 。
runtime_version	str 用於目前應用程式的 Authentication /Authorization 功能的 RuntimeVersion。此值中的設定可以控制驗證/授權模組中特定功能的行為。
unauthenticated_client_action	str 或 UnauthenticatedClientAction 當未經驗證的用戶端嘗試存取應用程式時，要採取的動作。已知值為：「RedirectToLoginPage」和「AllowAnonymous」。
token_store_enabled	bool `<code>true</code>` 若要永久儲存在登入流程期間取得的平臺特定安全性權杖;否則為 `<code>false</code>` 。預設值為 `<code>false</code>`。
allowed_external_redirect_urls	list[str] 可在登入或登出應用程式時重新導向至的外部 URL。請注意，會忽略 URL 的查詢字串部分。這是 Windows 市集應用程式後端通常需要的進階設定。請注意，目前網域內的 URL 一律會隱含允許。
default_provider	str 或 BuiltInAuthenticationProvider 設定多個提供者時要使用的預設驗證提供者。只有在設定多個提供者且未驗證的用戶端動作設定為「RedirectToLoginPage」時，才需要此設定。已知值為：「AzureActiveDirectory」、「Facebook」、「Google」、「MicrosoftAccount」、「Twitter」和「Github」。
token_refresh_extension_hours	float 會話權杖到期後的小時數，會話權杖可用來呼叫權杖重新整理 API。預設值為 72 小時。
client_id	str 此信賴憑證者應用程式的用戶端識別碼，稱為client_id。若要使用 Azure Active Directory 或其他協力廠商 OpenID Connect 提供者啟用 OpenID 連線驗證，則需要此設定。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html 。
client_secret	str Azure Active Directory 中此信賴憑證者應用程式的用戶端密碼 (，也稱為金鑰) 。這個設定是選擇性的。如果未設定任何用戶端密碼，則會使用 OpenID Connect 隱含驗證流程來驗證終端使用者。否則，OpenID Connect 授權碼流程會用來驗證使用者。 OpenID Connect 的詳細資訊： http://openid.net/specs/openid-connect-core-1_0.html 。
client_secret_setting_name	str 包含信賴憑證者應用程式的用戶端密碼的應用程式設定名稱。
client_secret_certificate_thumbprint	str 用戶端密碼的替代方案，這是用於簽署之憑證的指紋。這個屬性可作為用戶端密碼的取代。它也是選擇性的。
issuer	str 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 。
validate_issuer	bool 取得值，指出簽發者是否應該是有效的 HTTPS URL，並驗證如下。
allowed_audiences	list[str] 允許的物件值在驗證 Azure Active Directory 所發出的 JWT 時考慮。請注意，不論此設定為何，值 `<code>ClientID</code>` 一律被視為允許的物件。
additional_login_params	list[str] 當使用者登入時，要傳送至 OpenID Connect 授權端點的登入參數。每個參數的格式都必須是「key=value」。
aad_claims_authorization	str 取得包含 Azure AD Acl 設定的 JSON 字串。
google_client_id	str Google Web 應用程式的 OpenID Connect 用戶端識別碼。啟用 Google 登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ 。
google_client_secret	str 與 Google Web 應用程式相關聯的用戶端密碼。啟用 Google 登入需要此設定。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ 。
google_client_secret_setting_name	str 應用程式設定名稱，其中包含與 Google Web 應用程式相關聯的用戶端密碼。
google_o_auth_scopes	list[str] 將作為 Google Sign-In 驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。如果未指定，則會使用「openid」、「profile」和「email」作為預設範圍。 Google Sign-In 檔： https://developers.google.com/identity/sign-in/web/ 。
facebook_app_id	str 用於登入之 Facebook 應用程式的應用程式識別碼。啟用 Facebook 登入需要此設定。 Facebook 登入檔： https://developers.facebook.com/docs/facebook-login 。
facebook_app_secret	str 用於 Facebook 登入之 Facebook 應用程式的應用程式秘密。啟用 Facebook 登入需要此設定。 Facebook 登入檔： https://developers.facebook.com/docs/facebook-login 。
facebook_app_secret_setting_name	str 應用程式設定名稱，其中包含用於 Facebook 登入的應用程式密碼。
facebook_o_auth_scopes	list[str] 將作為 Facebook 登入驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。 Facebook 登入檔： https://developers.facebook.com/docs/facebook-login 。
git_hub_client_id	str 用於登入的 GitHub 應用程式的用戶端識別碼。啟用 Github 登入需要此設定。
git_hub_client_secret	str GitHub 應用程式用於 Github 登入的用戶端密碼。啟用 Github 登入需要此設定。
git_hub_client_secret_setting_name	str 應用程式設定名稱，其中包含用於 GitHub 登入之 Github 應用程式的用戶端密碼。
git_hub_o_auth_scopes	list[str] 將作為 GitHub 登入驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。
twitter_consumer_key	str 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者金鑰。啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in 。
twitter_consumer_secret	str 用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者秘密。啟用 Twitter 登入需要此設定。 Twitter Sign-In 檔： https://dev.twitter.com/web/sign-in 。
twitter_consumer_secret_setting_name	str 應用程式設定名稱，其中包含用於登入之 Twitter 應用程式的 OAuth 1.0a 取用者密碼。
microsoft_account_client_id	str 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端識別碼。啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm 。
microsoft_account_client_secret	str 針對用於驗證的應用程式所建立的 OAuth 2.0 用戶端密碼。啟用 Microsoft 帳戶驗證需要此設定。 Microsoft 帳戶 OAuth 檔： https://dev.onedrive.com/auth/msa_oauth.htm 。
microsoft_account_client_secret_setting_name	str 應用程式設定名稱，其中包含針對用於驗證之應用程式所建立的 OAuth 2.0 用戶端密碼。
microsoft_account_o_auth_scopes	list[str] 將作為 Microsoft 帳戶驗證一部分要求的 OAuth 2.0 範圍。這個設定是選擇性的。如果未指定，則會使用「wl.basic」作為預設範圍。 Microsoft 帳戶範圍和許可權檔： https://msdn.microsoft.com/en-us/library/dn631845.aspx 。
is_auth_from_file	str 如果應該從檔案讀取驗證組態設定，則為「true」，否則為「false」。
auth_file_path	str 包含驗證設定的組態檔路徑。如果路徑是相對的，基底將會是月臺的根目錄。
config_version	str 目前應用程式使用的驗證/授權功能的 ConfigVersion。此值中的設定可以控制驗證/授權的控制平面行為。

共用方式為

SiteAuthSettings 類別

建構函式

僅限關鍵字的參數

變數

其他資源