Web Apps - Update Auth Settings

Riferimento

Service:: App Service

API Version:: 2023-12-01

Descrizione per Aggiornamenti le impostazioni di autenticazione/autorizzazione associate all'app Web.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
name	path	True	string	Nome dell'app Web.
resourceGroupName	path	True	string	Nome del gruppo di risorse a cui appartiene la risorsa. Regex pattern: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	L'ID sottoscrizione di Azure. Si tratta di una stringa in formato GUID (ad esempio 000000000-0000-0000-0000-0000-000000000000).
api-version	query	True	string	Versione API

Corpo della richiesta

Nome	Tipo	Descrizione
kind	string	Tipo di risorsa.
properties.aadClaimsAuthorization	string	Ottiene una stringa JSON contenente le impostazioni dell'elenco di controllo di accesso di Azure AD.
properties.additionalLoginParams	string[]	Parametri di accesso da inviare all'endpoint di autorizzazione OpenID Connect quando un utente accede. Ogni parametro deve essere nel formato "key=value".
properties.allowedAudiences	string[]	Valori dei destinatari consentiti da considerare quando si convalidano i token Web JSON emessi da Azure Active Directory. Si noti che il `ClientID` valore viene sempre considerato un gruppo di destinatari consentito, indipendentemente da questa impostazione.
properties.allowedExternalRedirectUrls	string[]	URL esterni a cui è possibile reindirizzare come parte dell'accesso o della disconnessione dall'app. Si noti che la parte della stringa di query dell'URL viene ignorata. Si tratta di un'impostazione avanzata in genere necessaria solo per i back-end dell'applicazione Windows Store. Si noti che gli URL all'interno del dominio corrente sono sempre consentiti in modo implicito.
properties.authFilePath	string	Percorso del file di configurazione contenente le impostazioni di autenticazione. Se il percorso è relativo, base eseguirà la directory radice del sito.
properties.clientId	string	ID client di questa applicazione relying party, nota come client_id. Questa impostazione è necessaria per abilitare l'autenticazione della connessione OpenID con Azure Active Directory o altri provider OpenID Connect di terze parti. Altre informazioni su OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Il segreto client di questa applicazione relying party (in Azure Active Directory, detto anche chiave). Questa impostazione è facoltativa. Se non è configurato alcun segreto client, il flusso di autenticazione implicita di OpenID Connect viene usato per autenticare gli utenti finali. In caso contrario, il flusso del codice di autorizzazione OpenID Connect viene usato per autenticare gli utenti finali. Altre informazioni su OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativa al segreto client, ovvero l'identificazione personale di un certificato usato per la firma. Questa proprietà funge da sostituzione del segreto client. È anche facoltativo.
properties.clientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client dell'applicazione relying party.
properties.configVersion	string	ConfigVersion della funzionalità Autenticazione/Autorizzazione in uso per l'app corrente. L'impostazione in questo valore può controllare il comportamento del piano di controllo per Autenticazione/Autorizzazione.
properties.defaultProvider	BuiltInAuthenticationProvider	Provider di autenticazione predefinito da usare quando sono configurati più provider. Questa impostazione è necessaria solo se sono configurati più provider e l'azione client non autenticata è impostata su "RedirectToLoginPage".
properties.enabled	boolean	`true` se la funzionalità autenticazione/autorizzazione è abilitata per l'app corrente; in caso contrario, `false`.
properties.facebookAppId	string	ID app dell'app Facebook usata per l'accesso. Questa impostazione è necessaria per abilitare Facebook Account di accesso. Facebook documentazione di accesso:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Segreto app dell'app Facebook usata per l'accesso Facebook. Questa impostazione è necessaria per abilitare Facebook Account di accesso. Facebook documentazione di accesso:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto dell'app usato per Facebook Account di accesso.
properties.facebookOAuthScopes	string[]	Gli ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione di Facebook account di accesso. Questa impostazione è facoltativa. Facebook documentazione di accesso:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID client dell'app GitHub usata per l'accesso. Questa impostazione è necessaria per abilitare l'accesso a GitHub
properties.gitHubClientSecret	string	Segreto client dell'app GitHub usata per l'accesso a Github. Questa impostazione è necessaria per abilitare l'accesso a GitHub.
properties.gitHubClientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client dell'app GitHub usata per l'accesso a GitHub.
properties.gitHubOAuthScopes	string[]	Ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione dell'account di accesso di GitHub. Questa impostazione è facoltativa
properties.googleClientId	string	ID client OpenID Connect per l'applicazione Web Google. Questa impostazione è necessaria per abilitare Google Sign-In. Documentazione di Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Segreto client associato all'applicazione Web Google. Questa impostazione è necessaria per abilitare Google Sign-In. Documentazione di Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client associato all'applicazione Web Google.
properties.googleOAuthScopes	string[]	Ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione di Google Sign-In. Questa impostazione è facoltativa. Se non specificato, "openid", "profile" e "email" vengono usati come ambiti predefiniti. Documentazione di Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" se le impostazioni di configurazione dell'autenticazione devono essere lette da un file, "false" in caso contrario,
properties.issuer	string	URI dell'autorità di certificazione OpenID Connect che rappresenta l'entità che rilascia i token di accesso per questa applicazione. Quando si usa Azure Active Directory, questo valore è l'URI del tenant della directory, ad esempio https://sts.windows.net/{tenant-guid}/. Questo URI è un identificatore con distinzione tra maiuscole e minuscole per l'autorità emittente del token. Altre informazioni sull'individuazione OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID client OAuth 2.0 creato per l'app usata per l'autenticazione. Questa impostazione è necessaria per abilitare l'autenticazione dell'account Microsoft. Documentazione di OAuth dell'account Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Segreto client OAuth 2.0 creato per l'app usata per l'autenticazione. Questa impostazione è necessaria per abilitare l'autenticazione dell'account Microsoft. Documentazione di OAuth dell'account Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nome dell'impostazione dell'app contenente il segreto client OAuth 2.0 creato per l'app usata per l'autenticazione.
properties.microsoftAccountOAuthScopes	string[]	Ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione dell'account Microsoft. Questa impostazione è facoltativa. Se non specificato, "wl.basic" viene usato come ambito predefinito. Documentazione su ambiti e autorizzazioni dell'account Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion della funzionalità autenticazione/autorizzazione in uso per l'app corrente. L'impostazione in questo valore può controllare il comportamento di determinate funzionalità nel modulo Autenticazione/Autorizzazione.
properties.tokenRefreshExtensionHours	number	Numero di ore dopo la scadenza del token di sessione che è possibile usare un token di sessione per chiamare l'API di aggiornamento del token. Il valore predefinito è 72 ore.
properties.tokenStoreEnabled	boolean	`true` per archiviare in modo permanente token di sicurezza specifici della piattaforma ottenuti durante i flussi di accesso; in caso contrario, `false`. Il valore predefinito è `false`.
properties.twitterConsumerKey	string	Chiave consumer OAuth 1.0a dell'applicazione Twitter usata per l'accesso. Questa impostazione è necessaria per abilitare l'accesso a Twitter. Documentazione di Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Segreto consumer OAuth 1.0a dell'applicazione Twitter usato per l'accesso. Questa impostazione è necessaria per abilitare l'accesso a Twitter. Documentazione di Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto consumer OAuth 1.0a dell'applicazione Twitter usata per l'accesso.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Azione da eseguire quando un client non autenticato tenta di accedere all'app.
properties.validateIssuer	boolean	Ottiene un valore che indica se l'autorità emittente deve essere un URL HTTPS valido e convalidare come tale.

Risposte

Nome	Tipo	Descrizione
200 OK	SiteAuthSettings	OK
Other Status Codes	DefaultErrorResponse	servizio app risposta di errore.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

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

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

Update Auth Settings

Sample Request

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings?api-version=2023-12-01

{
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Sample Response

Status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
  "name": "authsettings",
  "type": "Microsoft.Web/sites/authsettings",
  "kind": "app",
  "properties": {
    "enabled": true,
    "runtimeVersion": "~1",
    "unauthenticatedClientAction": "RedirectToLoginPage",
    "tokenStoreEnabled": true,
    "allowedExternalRedirectUrls": [
      "sitef6141.customdomain.net",
      "sitef6141.customdomain.info"
    ],
    "defaultProvider": "Google",
    "tokenRefreshExtensionHours": 120,
    "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
  }
}

Definizioni

Nome	Descrizione
BuiltInAuthenticationProvider	Provider di autenticazione predefinito da usare quando sono configurati più provider. Questa impostazione è necessaria solo se sono configurati più provider e l'azione client non autenticata è impostata su "RedirectToLoginPage".
DefaultErrorResponse	servizio app risposta di errore.
Details
Error	Modello di errore.
SiteAuthSettings	Impostazioni di configurazione per la funzionalità autenticazione/autorizzazione di Servizio app di Azure.
UnauthenticatedClientAction	Azione da eseguire quando un client non autenticato tenta di accedere all'app.

BuiltInAuthenticationProvider

Provider di autenticazione predefinito da usare quando sono configurati più provider. Questa impostazione è necessaria solo se sono configurati più provider e l'azione client non autenticata è impostata su "RedirectToLoginPage".

Nome	Tipo	Descrizione
AzureActiveDirectory	string
Facebook	string
Github	string
Google	string
MicrosoftAccount	string
Twitter	string

DefaultErrorResponse

servizio app risposta di errore.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

Error

Modello di errore.

Nome	Tipo	Descrizione
code	string	Stringa standardizzata per identificare l'errore a livello di codice.
details	Details[]	Errori dettagliati.
innererror	string	Altre informazioni per eseguire il debug dell'errore.
message	string	Descrizione dettagliata dell'errore e informazioni di debug.
target	string	Descrizione dettagliata dell'errore e informazioni di debug.

SiteAuthSettings

Impostazioni di configurazione per la funzionalità autenticazione/autorizzazione di Servizio app di Azure.

Nome	Tipo	Descrizione
id	string	ID risorsa.
kind	string	Tipo di risorsa.
name	string	Nome risorsa.
properties.aadClaimsAuthorization	string	Ottiene una stringa JSON contenente le impostazioni dell'elenco di controllo di accesso di Azure AD.
properties.additionalLoginParams	string[]	Parametri di accesso da inviare all'endpoint di autorizzazione OpenID Connect quando un utente accede. Ogni parametro deve essere nel formato "key=value".
properties.allowedAudiences	string[]	Valori dei destinatari consentiti da considerare quando si convalidano i token Web JSON emessi da Azure Active Directory. Si noti che il `ClientID` valore viene sempre considerato un gruppo di destinatari consentito, indipendentemente da questa impostazione.
properties.allowedExternalRedirectUrls	string[]	URL esterni a cui è possibile reindirizzare come parte dell'accesso o della disconnessione dall'app. Si noti che la parte della stringa di query dell'URL viene ignorata. Si tratta di un'impostazione avanzata in genere necessaria solo per i back-end dell'applicazione Windows Store. Si noti che gli URL all'interno del dominio corrente sono sempre consentiti in modo implicito.
properties.authFilePath	string	Percorso del file di configurazione contenente le impostazioni di autenticazione. Se il percorso è relativo, base eseguirà la directory radice del sito.
properties.clientId	string	ID client di questa applicazione relying party, nota come client_id. Questa impostazione è necessaria per abilitare l'autenticazione della connessione OpenID con Azure Active Directory o altri provider OpenID Connect di terze parti. Altre informazioni su OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecret	string	Il segreto client di questa applicazione relying party (in Azure Active Directory, detto anche chiave). Questa impostazione è facoltativa. Se non è configurato alcun segreto client, il flusso di autenticazione implicita di OpenID Connect viene usato per autenticare gli utenti finali. In caso contrario, il flusso del codice di autorizzazione OpenID Connect viene usato per autenticare gli utenti finali. Altre informazioni su OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
properties.clientSecretCertificateThumbprint	string	Alternativa al segreto client, ovvero l'identificazione personale di un certificato usato per la firma. Questa proprietà funge da sostituzione del segreto client. È anche facoltativo.
properties.clientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client dell'applicazione relying party.
properties.configVersion	string	ConfigVersion della funzionalità Autenticazione/Autorizzazione in uso per l'app corrente. L'impostazione in questo valore può controllare il comportamento del piano di controllo per Autenticazione/Autorizzazione.
properties.defaultProvider	BuiltInAuthenticationProvider	Provider di autenticazione predefinito da usare quando sono configurati più provider. Questa impostazione è necessaria solo se sono configurati più provider e l'azione client non autenticata è impostata su "RedirectToLoginPage".
properties.enabled	boolean	`true` se la funzionalità autenticazione/autorizzazione è abilitata per l'app corrente; in caso contrario, `false`.
properties.facebookAppId	string	ID app dell'app Facebook usata per l'accesso. Questa impostazione è necessaria per abilitare Facebook Account di accesso. Facebook documentazione di accesso:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Segreto app dell'app Facebook usata per l'accesso Facebook. Questa impostazione è necessaria per abilitare Facebook Account di accesso. Facebook documentazione di accesso:https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto dell'app usato per Facebook Account di accesso.
properties.facebookOAuthScopes	string[]	Gli ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione di Facebook account di accesso. Questa impostazione è facoltativa. Facebook documentazione di accesso:https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID client dell'app GitHub usata per l'accesso. Questa impostazione è necessaria per abilitare l'accesso a GitHub
properties.gitHubClientSecret	string	Segreto client dell'app GitHub usata per l'accesso a Github. Questa impostazione è necessaria per abilitare l'accesso a GitHub.
properties.gitHubClientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client dell'app GitHub usata per l'accesso a GitHub.
properties.gitHubOAuthScopes	string[]	Ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione dell'account di accesso di GitHub. Questa impostazione è facoltativa
properties.googleClientId	string	ID client OpenID Connect per l'applicazione Web Google. Questa impostazione è necessaria per abilitare Google Sign-In. Documentazione di Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecret	string	Segreto client associato all'applicazione Web Google. Questa impostazione è necessaria per abilitare Google Sign-In. Documentazione di Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.googleClientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client associato all'applicazione Web Google.
properties.googleOAuthScopes	string[]	Ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione di Google Sign-In. Questa impostazione è facoltativa. Se non specificato, "openid", "profile" e "email" vengono usati come ambiti predefiniti. Documentazione di Google Sign-In: https://developers.google.com/identity/sign-in/web/
properties.isAuthFromFile	string	"true" se le impostazioni di configurazione dell'autenticazione devono essere lette da un file, "false" in caso contrario,
properties.issuer	string	URI dell'autorità di certificazione OpenID Connect che rappresenta l'entità che rilascia i token di accesso per questa applicazione. Quando si usa Azure Active Directory, questo valore è l'URI del tenant della directory, ad esempio https://sts.windows.net/{tenant-guid}/. Questo URI è un identificatore con distinzione tra maiuscole e minuscole per l'autorità emittente del token. Altre informazioni sull'individuazione OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html
properties.microsoftAccountClientId	string	ID client OAuth 2.0 creato per l'app usata per l'autenticazione. Questa impostazione è necessaria per abilitare l'autenticazione dell'account Microsoft. Documentazione di OAuth dell'account Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecret	string	Segreto client OAuth 2.0 creato per l'app usata per l'autenticazione. Questa impostazione è necessaria per abilitare l'autenticazione dell'account Microsoft. Documentazione di OAuth dell'account Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm
properties.microsoftAccountClientSecretSettingName	string	Nome dell'impostazione dell'app contenente il segreto client OAuth 2.0 creato per l'app usata per l'autenticazione.
properties.microsoftAccountOAuthScopes	string[]	Ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione dell'account Microsoft. Questa impostazione è facoltativa. Se non specificato, "wl.basic" viene usato come ambito predefinito. Documentazione su ambiti e autorizzazioni dell'account Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx
properties.runtimeVersion	string	RuntimeVersion della funzionalità autenticazione/autorizzazione in uso per l'app corrente. L'impostazione in questo valore può controllare il comportamento di determinate funzionalità nel modulo Autenticazione/Autorizzazione.
properties.tokenRefreshExtensionHours	number	Numero di ore dopo la scadenza del token di sessione che è possibile usare un token di sessione per chiamare l'API di aggiornamento del token. Il valore predefinito è 72 ore.
properties.tokenStoreEnabled	boolean	`true` per archiviare in modo permanente token di sicurezza specifici della piattaforma ottenuti durante i flussi di accesso; in caso contrario, `false`. Il valore predefinito è `false`.
properties.twitterConsumerKey	string	Chiave consumer OAuth 1.0a dell'applicazione Twitter usata per l'accesso. Questa impostazione è necessaria per abilitare l'accesso a Twitter. Documentazione di Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecret	string	Segreto consumer OAuth 1.0a dell'applicazione Twitter usato per l'accesso. Questa impostazione è necessaria per abilitare l'accesso a Twitter. Documentazione di Twitter Sign-In: https://dev.twitter.com/web/sign-in
properties.twitterConsumerSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto consumer OAuth 1.0a dell'applicazione Twitter usata per l'accesso.
properties.unauthenticatedClientAction	UnauthenticatedClientAction	Azione da eseguire quando un client non autenticato tenta di accedere all'app.
properties.validateIssuer	boolean	Ottiene un valore che indica se l'autorità emittente deve essere un URL HTTPS valido e convalidare come tale.
type	string	Tipo di risorsa.

UnauthenticatedClientAction

Azione da eseguire quando un client non autenticato tenta di accedere all'app.

Nome	Tipo	Descrizione
AllowAnonymous	string
RedirectToLoginPage	string