Web Apps - Update Auth Settings Slot

Service:

App Service

API Version:

2023-12-01

A webalkalmazáshoz társított hitelesítési/engedélyezési beállítások Frissítések leírása.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings?api-version=2023-12-01

URI-paraméterek

Name	In	Kötelező	Típus	Description
name	path	True	string	A webalkalmazás neve.
resourceGroupName	path	True	string	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik. Regex pattern: ^[-\w\._\(\)]+[^\.]$
slot	path	True	string	A webalkalmazás-tárolóhely neve. Ha nincs megadva, akkor az alapértelmezett érték az éles pont lesz.
subscriptionId	path	True	string	Az Azure-előfizetés azonosítója. Ez egy GUID formátumú sztring (például 00000000-0000-0000-0000-00000000000000).
api-version	query	True	string	API-verzió

Kérelem törzse

Name	Típus	Description
kind	string	Erőforrás típusa.
properties.aadClaimsAuthorization	string	Lekéri a Azure AD ACL-beállításokat tartalmazó JSON-sztringet.
properties.additionalLoginParams	string[]	Bejelentkezési paraméterek az OpenID Connect engedélyezési végpontjára való küldéshez, amikor egy felhasználó bejelentkezik. Minden paraméternek "key=value" formában kell lennie.
properties.allowedAudiences	string[]	Az Azure Active Directory által kibocsátott JSON-webtokenek ellenőrzésekor figyelembe veendő célközönségértékek. Vegye figyelembe, hogy az ClientID érték mindig engedélyezett célközönségnek számít, függetlenül attól, hogy ez a beállítás.
properties.allowedExternalRedirectUrls	string[]	Külső URL-címek, amelyek az alkalmazásba való bejelentkezés vagy kijelentkezés részeként átirányíthatók. Vegye figyelembe, hogy az URL-cím lekérdezési sztringjének része figyelmen kívül lesz hagyva. Ez egy speciális beállítás, amelyet általában csak a Windows Áruházbeli alkalmazások háttérrendszerei igényelnek. Vegye figyelembe, hogy az aktuális tartományban lévő URL-címek mindig implicit módon engedélyezettek.
properties.authFilePath	string	A hitelesítési beállításokat tartalmazó konfigurációs fájl elérési útja. Ha az elérési út relatív, az alap lesz a hely gyökérkönyvtára.
properties.clientId	string	Ennek a függő entitásalkalmazásnak az ügyfél-azonosítója, más néven a client_id. Ez a beállítás az OpenID-kapcsolat Azure Active Directoryval vagy más külső OpenID Connect-szolgáltatókkal történő engedélyezéséhez szükséges. További információ az OpenID Connectről: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	A függő entitásalkalmazás titkos ügyfélkódja (az Azure Active Directoryban ezt kulcsnak is nevezik). Ez a beállítás nem kötelező. Ha nincs konfigurálva titkos ügyfélkód, a rendszer az OpenID Connect implicit hitelesítési folyamatot használja a végfelhasználók hitelesítéséhez. Ellenkező esetben az OpenID Connect engedélyezési kódfolyamat a végfelhasználók hitelesítésére szolgál. További információ az OpenID Connectről: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Az ügyfél titkos kódjának alternatíva az aláíráshoz használt tanúsítvány ujjlenyomata. Ez a tulajdonság helyettesíti az ügyfélkulcsot. Ez szintén nem kötelező.
properties.clientSecretSettingName	string	Az alkalmazásbeállítás neve, amely a függő entitásalkalmazás titkos ügyfélkulcsát tartalmazza.
properties.configVersion	string	Az aktuális alkalmazáshoz használt Hitelesítési/engedélyezési funkció ConfigVersion tulajdonsága. Az ebben az értékben megadott beállítás szabályozhatja a vezérlősík viselkedését a hitelesítés/engedélyezés esetében.
properties.defaultProvider	BuiltInAuthenticationProvider	Az alapértelmezett hitelesítési szolgáltató, amelyet több szolgáltató konfigurálásakor kell használni. Erre a beállításra csak akkor van szükség, ha több szolgáltató van konfigurálva, és a nem hitelesített ügyfélművelet "RedirectToLoginPage" értékre van állítva.
properties.enabled	boolean	true ha a hitelesítés/engedélyezés funkció engedélyezve van az aktuális alkalmazáshoz; egyéb esetben: false.
properties.facebookAppId	string	A bejelentkezéshez használt Facebook alkalmazás alkalmazásazonosítója. Ez a beállítás Facebook bejelentkezés engedélyezéséhez szükséges. Facebook bejelentkezési dokumentáció:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	A bejelentkezéshez használt Facebook alkalmazás titkos Facebook. Ez a beállítás Facebook bejelentkezés engedélyezéséhez szükséges. Facebook bejelentkezési dokumentáció:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Az alkalmazásbeállítás neve, amely a bejelentkezés Facebook használt titkos alkalmazáskulcsot tartalmazza.
properties.facebookOAuthScopes	string[]	A bejelentkezési hitelesítés Facebook részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező. Facebook bejelentkezési dokumentáció:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	A bejelentkezéshez használt GitHub-alkalmazás ügyfél-azonosítója. Ez a beállítás szükséges a GitHub-bejelentkezés engedélyezéséhez
properties.gitHubClientSecret	string	A GitHub-bejelentkezéshez használt GitHub-alkalmazás titkos ügyfélkódja. Ez a beállítás szükséges a GitHub-bejelentkezés engedélyezéséhez.
properties.gitHubClientSecretSettingName	string	A GitHub-bejelentkezéshez használt GitHub-alkalmazás titkos ügyfélkulcsát tartalmazó alkalmazásbeállítás neve.
properties.gitHubOAuthScopes	string[]	A GitHub Login-hitelesítés részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező
properties.googleClientId	string	A Google-webalkalmazás OpenID Connect-ügyfélazonosítója. Ez a beállítás szükséges a Google-bejelentkezés engedélyezéséhez. A Google Sign-In dokumentációja: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	A Google-webalkalmazáshoz társított titkos ügyfélkód. Ez a beállítás szükséges a Google-bejelentkezés engedélyezéséhez. A Google Sign-In dokumentációja: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	A Google-webalkalmazáshoz társított titkos ügyfélkulcsot tartalmazó alkalmazásbeállítás neve.
properties.googleOAuthScopes	string[]	A Google Sign-In hitelesítés részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező. Ha nincs megadva, a rendszer az "openid", a "profile" és az "e-mail" tartományt használja alapértelmezett hatókörként. A Google Sign-In dokumentációja: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" (igaz), ha a hitelesítési konfigurációs beállításokat egy fájlból kell beolvasni, ellenkező esetben "false" (hamis)
properties.issuer	string	Az OpenID Connect-kiállító URI-ja, amely azt az entitást jelöli, amely hozzáférési jogkivonatokat ad ki az alkalmazáshoz. Az Azure Active Directory használatakor ez az érték a címtárbérlő URI-ja, például: https://sts.windows.net/{tenant-guid}/. Ez az URI a tokenkibocsátó kis- és nagybetűk megkülönböztetése. További információ az OpenID Connect-felderítésről: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	A hitelesítéshez használt alkalmazáshoz létrehozott OAuth 2.0 ügyfél-azonosító. Ez a beállítás szükséges a Microsoft-fiók hitelesítésének engedélyezéséhez. A Microsoft Account OAuth dokumentációja: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	A hitelesítéshez használt alkalmazáshoz létrehozott OAuth 2.0 ügyfélkulcs. Ez a beállítás szükséges a Microsoft-fiók hitelesítésének engedélyezéséhez. A Microsoft Account OAuth dokumentációja: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	A hitelesítéshez használt alkalmazáshoz létrehozott OAuth 2.0 ügyfélkulcsot tartalmazó alkalmazásbeállítás neve.
properties.microsoftAccountOAuthScopes	string[]	A Microsoft-fiók hitelesítésének részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező. Ha nincs megadva, a "wl.basic" lesz az alapértelmezett hatókör. A Microsoft-fiók hatóköreinek és engedélyeinek dokumentációja: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	Az aktuális alkalmazáshoz használt Hitelesítés/engedélyezés funkció RuntimeVersion tulajdonsága. Az ebben az értékben megadott beállítás szabályozhatja bizonyos funkciók viselkedését a Hitelesítés/engedélyezés modulban.
properties.tokenRefreshExtensionHours	number	A munkamenet-jogkivonat lejáratát követő órák száma, amellyel a munkamenet-jogkivonat meghívható a jogkivonat frissítési API-jának meghívásához. Az alapértelmezett érték 72 óra.
properties.tokenStoreEnabled	boolean	true a bejelentkezési folyamatok során beszerzett platformspecifikus biztonsági jogkivonatok tartós tárolása; egyéb esetben: false. A mező alapértelmezett értéke: false.
properties.twitterConsumerKey	string	A Bejelentkezéshez használt Twitter-alkalmazás OAuth 1.0a fogyasztói kulcsa. Ez a beállítás szükséges a Twitter-bejelentkezés engedélyezéséhez. A Twitter Sign-In dokumentációja: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	A bejelentkezéshez használt Twitter-alkalmazás OAuth 1.0a fogyasztói titkos kódja. Ez a beállítás szükséges a Twitter-bejelentkezés engedélyezéséhez. A Twitter Sign-In dokumentációja: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	A bejelentkezéshez használt Twitter-alkalmazás OAuth 1.0a felhasználói titkos kódját tartalmazó alkalmazásbeállítás neve.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	A művelet, amelyet akkor kell elvégezni, amikor egy hitelesítés nélküli ügyfél megpróbál hozzáférni az alkalmazáshoz.
properties.validateIssuer	boolean	Lekéri azt az értéket, amely jelzi, hogy a kibocsátónak érvényes HTTPS URL-címnek kell-e lennie, és így kell ellenőriznie.

Válaszok

Name	Típus	Description
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	App Service hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	felhasználói fiók megszemélyesítése

Definíciók

Name	Description
BuiltInAuthenticationProvider	Az alapértelmezett hitelesítési szolgáltató, amelyet több szolgáltató konfigurálásakor kell használni. Erre a beállításra csak akkor van szükség, ha több szolgáltató van konfigurálva, és a nem hitelesített ügyfélművelet "RedirectToLoginPage" értékre van állítva.
DefaultErrorResponse	App Service hibaválasz.
Details
Error	Hibamodell.
SiteAuthSettings	A Azure App Service hitelesítési/engedélyezési funkciójának konfigurációs beállításai.
UnauthenticatedClientAction	A művelet, amelyet akkor kell elvégezni, amikor egy hitelesítés nélküli ügyfél megpróbál hozzáférni az alkalmazáshoz.

BuiltInAuthenticationProvider

Az alapértelmezett hitelesítési szolgáltató, amelyet több szolgáltató konfigurálásakor kell használni. Erre a beállításra csak akkor van szükség, ha több szolgáltató van konfigurálva, és a nem hitelesített ügyfélművelet "RedirectToLoginPage" értékre van állítva.

Name	Típus	Description
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

App Service hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

Error

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakeresésről.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

SiteAuthSettings

A Azure App Service hitelesítési/engedélyezési funkciójának konfigurációs beállításai.

Name	Típus	Description
id	string	Erőforrás-azonosító.
kind	string	Erőforrás típusa.
name	string	Erőforrás neve.
properties.aadClaimsAuthorization	string	Lekéri a Azure AD ACL-beállításokat tartalmazó JSON-sztringet.
properties.additionalLoginParams	string[]	Bejelentkezési paraméterek az OpenID Connect engedélyezési végpontjára való küldéshez, amikor egy felhasználó bejelentkezik. Minden paraméternek "key=value" formában kell lennie.
properties.allowedAudiences	string[]	Az Azure Active Directory által kibocsátott JSON-webtokenek ellenőrzésekor figyelembe veendő célközönségértékek. Vegye figyelembe, hogy az ClientID érték mindig engedélyezett célközönségnek számít, függetlenül attól, hogy ez a beállítás.
properties.allowedExternalRedirectUrls	string[]	Külső URL-címek, amelyek az alkalmazásba való bejelentkezés vagy kijelentkezés részeként átirányíthatók. Vegye figyelembe, hogy az URL-cím lekérdezési sztringjének része figyelmen kívül lesz hagyva. Ez egy speciális beállítás, amelyet általában csak a Windows Áruházbeli alkalmazások háttérrendszerei igényelnek. Vegye figyelembe, hogy az aktuális tartományban lévő URL-címek mindig implicit módon engedélyezettek.
properties.authFilePath	string	A hitelesítési beállításokat tartalmazó konfigurációs fájl elérési útja. Ha az elérési út relatív, az alap lesz a hely gyökérkönyvtára.
properties.clientId	string	Ennek a függő entitásalkalmazásnak az ügyfél-azonosítója, más néven a client_id. Ez a beállítás az OpenID-kapcsolat Azure Active Directoryval vagy más külső OpenID Connect-szolgáltatókkal történő engedélyezéséhez szükséges. További információ az OpenID Connectről: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	A függő entitásalkalmazás titkos ügyfélkódja (az Azure Active Directoryban ezt kulcsnak is nevezik). Ez a beállítás nem kötelező. Ha nincs konfigurálva titkos ügyfélkód, a rendszer az OpenID Connect implicit hitelesítési folyamatot használja a végfelhasználók hitelesítéséhez. Ellenkező esetben az OpenID Connect engedélyezési kódfolyamat a végfelhasználók hitelesítésére szolgál. További információ az OpenID Connectről: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Az ügyfél titkos kódjának alternatíva az aláíráshoz használt tanúsítvány ujjlenyomata. Ez a tulajdonság helyettesíti az ügyfélkulcsot. Ez szintén nem kötelező.
properties.clientSecretSettingName	string	Az alkalmazásbeállítás neve, amely a függő entitásalkalmazás titkos ügyfélkulcsát tartalmazza.
properties.configVersion	string	Az aktuális alkalmazáshoz használt Hitelesítési/engedélyezési funkció ConfigVersion tulajdonsága. Az ebben az értékben megadott beállítás szabályozhatja a vezérlősík viselkedését a hitelesítés/engedélyezés esetében.
properties.defaultProvider	BuiltInAuthenticationProvider	Az alapértelmezett hitelesítési szolgáltató, amelyet több szolgáltató konfigurálásakor kell használni. Erre a beállításra csak akkor van szükség, ha több szolgáltató van konfigurálva, és a nem hitelesített ügyfélművelet "RedirectToLoginPage" értékre van állítva.
properties.enabled	boolean	true ha a hitelesítés/engedélyezés funkció engedélyezve van az aktuális alkalmazáshoz; egyéb esetben: false.
properties.facebookAppId	string	A bejelentkezéshez használt Facebook alkalmazás alkalmazásazonosítója. Ez a beállítás Facebook bejelentkezés engedélyezéséhez szükséges. Facebook bejelentkezési dokumentáció:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	A bejelentkezéshez használt Facebook alkalmazás titkos Facebook. Ez a beállítás Facebook bejelentkezés engedélyezéséhez szükséges. Facebook bejelentkezési dokumentáció:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Az alkalmazásbeállítás neve, amely a bejelentkezés Facebook használt titkos alkalmazáskulcsot tartalmazza.
properties.facebookOAuthScopes	string[]	A bejelentkezési hitelesítés Facebook részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező. Facebook bejelentkezési dokumentáció:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	A bejelentkezéshez használt GitHub-alkalmazás ügyfél-azonosítója. Ez a beállítás szükséges a GitHub-bejelentkezés engedélyezéséhez
properties.gitHubClientSecret	string	A GitHub-bejelentkezéshez használt GitHub-alkalmazás titkos ügyfélkódja. Ez a beállítás szükséges a GitHub-bejelentkezés engedélyezéséhez.
properties.gitHubClientSecretSettingName	string	A GitHub-bejelentkezéshez használt GitHub-alkalmazás titkos ügyfélkulcsát tartalmazó alkalmazásbeállítás neve.
properties.gitHubOAuthScopes	string[]	A GitHub Login-hitelesítés részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező
properties.googleClientId	string	A Google-webalkalmazás OpenID Connect-ügyfélazonosítója. Ez a beállítás szükséges a Google-bejelentkezés engedélyezéséhez. A Google Sign-In dokumentációja: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	A Google-webalkalmazáshoz társított titkos ügyfélkód. Ez a beállítás szükséges a Google-bejelentkezés engedélyezéséhez. A Google Sign-In dokumentációja: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	A Google-webalkalmazáshoz társított titkos ügyfélkulcsot tartalmazó alkalmazásbeállítás neve.
properties.googleOAuthScopes	string[]	A Google Sign-In hitelesítés részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező. Ha nincs megadva, a rendszer az "openid", a "profile" és az "e-mail" tartományt használja alapértelmezett hatókörként. A Google Sign-In dokumentációja: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" (igaz), ha a hitelesítési konfigurációs beállításokat egy fájlból kell beolvasni, ellenkező esetben "false" (hamis)
properties.issuer	string	Az OpenID Connect-kiállító URI-ja, amely azt az entitást jelöli, amely hozzáférési jogkivonatokat ad ki az alkalmazáshoz. Az Azure Active Directory használatakor ez az érték a címtárbérlő URI-ja, például: https://sts.windows.net/{tenant-guid}/. Ez az URI a tokenkibocsátó kis- és nagybetűk megkülönböztetése. További információ az OpenID Connect-felderítésről: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	A hitelesítéshez használt alkalmazáshoz létrehozott OAuth 2.0 ügyfél-azonosító. Ez a beállítás szükséges a Microsoft-fiók hitelesítésének engedélyezéséhez. A Microsoft Account OAuth dokumentációja: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	A hitelesítéshez használt alkalmazáshoz létrehozott OAuth 2.0 ügyfélkulcs. Ez a beállítás szükséges a Microsoft-fiók hitelesítésének engedélyezéséhez. A Microsoft Account OAuth dokumentációja: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	A hitelesítéshez használt alkalmazáshoz létrehozott OAuth 2.0 ügyfélkulcsot tartalmazó alkalmazásbeállítás neve.
properties.microsoftAccountOAuthScopes	string[]	A Microsoft-fiók hitelesítésének részeként kért OAuth 2.0-hatókörök. Ez a beállítás nem kötelező. Ha nincs megadva, a "wl.basic" lesz az alapértelmezett hatókör. A Microsoft-fiók hatóköreinek és engedélyeinek dokumentációja: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	Az aktuális alkalmazáshoz használt Hitelesítés/engedélyezés funkció RuntimeVersion tulajdonsága. Az ebben az értékben megadott beállítás szabályozhatja bizonyos funkciók viselkedését a Hitelesítés/engedélyezés modulban.
properties.tokenRefreshExtensionHours	number	A munkamenet-jogkivonat lejáratát követő órák száma, amellyel a munkamenet-jogkivonat meghívható a jogkivonat frissítési API-jának meghívásához. Az alapértelmezett érték 72 óra.
properties.tokenStoreEnabled	boolean	true a bejelentkezési folyamatok során beszerzett platformspecifikus biztonsági jogkivonatok tartós tárolása; egyéb esetben: false. A mező alapértelmezett értéke: false.
properties.twitterConsumerKey	string	A Bejelentkezéshez használt Twitter-alkalmazás OAuth 1.0a fogyasztói kulcsa. Ez a beállítás szükséges a Twitter-bejelentkezés engedélyezéséhez. A Twitter Sign-In dokumentációja: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	A bejelentkezéshez használt Twitter-alkalmazás OAuth 1.0a fogyasztói titkos kódja. Ez a beállítás szükséges a Twitter-bejelentkezés engedélyezéséhez. A Twitter Sign-In dokumentációja: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	A bejelentkezéshez használt Twitter-alkalmazás OAuth 1.0a felhasználói titkos kódját tartalmazó alkalmazásbeállítás neve.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	A művelet, amelyet akkor kell elvégezni, amikor egy hitelesítés nélküli ügyfél megpróbál hozzáférni az alkalmazáshoz.
properties.validateIssuer	boolean	Lekéri azt az értéket, amely jelzi, hogy a kibocsátónak érvényes HTTPS URL-címnek kell-e lennie, és így kell ellenőriznie.
type	string	Erőforrástípus.

UnauthenticatedClientAction

A művelet, amelyet akkor kell elvégezni, amikor egy hitelesítés nélküli ügyfél megpróbál hozzáférni az alkalmazáshoz.

Name	Típus	Description
AllowAnonymous	string
RedirectToLoginPage	string