Web Apps - Get Auth Settings

Riferimento

Servizio:: App Service

Versione API:: 2024-04-01

Descrizione per Ottiene le impostazioni di autenticazione/autorizzazione di un'app.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list?api-version=2024-04-01

Parametri dell'URI

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

Risposte

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

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

List Auth Settings

Esempio di richiesta

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


/**
 * Samples for WebApps GetAuthSettings.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
     */
    /**
     * Sample code: List Auth Settings.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettings(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsWithResponse("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_auth_settings.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_auth_settings(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
func ExampleWebAppsClient_GetAuthSettings() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetAuthSettings(ctx, "testrg123", "sitef6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SiteAuthSettings = armappservice.SiteAuthSettings{
	// 	Name: to.Ptr("authsettings"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettings"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsProperties{
	// 		AllowedExternalRedirectUrls: []*string{
	// 			to.Ptr("sitef6141.customdomain.net"),
	// 			to.Ptr("sitef6141.customdomain.info")},
	// 			ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 			DefaultProvider: to.Ptr(armappservice.BuiltInAuthenticationProviderGoogle),
	// 			Enabled: to.Ptr(true),
	// 			RuntimeVersion: to.Ptr("~1"),
	// 			TokenRefreshExtensionHours: to.Ptr[float64](120),
	// 			TokenStoreEnabled: to.Ptr(true),
	// 			UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionRedirectToLoginPage),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Description for Gets the Authentication/Authorization settings of an app.
 *
 * @summary Description for Gets the Authentication/Authorization settings of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
 */
async function listAuthSettings() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAuthSettings(resourceGroupName, name);
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettings.json
// this example is just showing the usage of "WebApps_GetAuthSettings" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
SiteAuthSettings result = await webSite.GetAuthSettingsAsync();

Console.WriteLine($"Succeeded: {result}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Risposta di esempio

Codice di stato:: 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	Risposta di errore del servizio app.
Details
Error	Modello di errore.
SiteAuthSettings	Impostazioni di configurazione per la funzionalità Autenticazione/autorizzazione del servizio app di Azure.
UnauthenticatedClientAction	Azione da eseguire quando un client non autenticato tenta di accedere all'app.

BuiltInAuthenticationProvider

Enumeration

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".

Valore	Descrizione
AzureActiveDirectory
Facebook
Github
Google
MicrosoftAccount
Twitter

DefaultErrorResponse

Object

Risposta di errore del servizio app.

Nome	Tipo	Descrizione
error	Error	Modello di errore.

Details

Object

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

Object

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

Object

Impostazioni di configurazione per la funzionalità Autenticazione/autorizzazione del 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 di destinatari consentiti da considerare quando si convalidano i token Web JSON rilasciati da Azure Active Directory. Si noti che il valore `ClientID` viene sempre considerato un gruppo di destinatari consentito, indipendentemente da questa impostazione.
properties.allowedExternalRedirectUrls	string[]	URL esterni che possono essere reindirizzati a 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 sarà la directory radice del sito.
properties.clientId	string	ID client di questa applicazione relying party, noto 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 Login. Documentazione di Facebook Login: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecret	string	Segreto app dell'app Facebook usata per Facebook Login. Questa impostazione è necessaria per abilitare Facebook Login. Documentazione di Facebook Login: https://developers.facebook.com/docs/facebook-login
properties.facebookAppSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto dell'app usato per Facebook Login.
properties.facebookOAuthScopes	string[]	Gli ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione di Facebook Login. Questa impostazione è facoltativa. Documentazione di Facebook Login: https://developers.facebook.com/docs/facebook-login
properties.gitHubClientId	string	ID client dell'app GitHub usato 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[]	Gli ambiti OAuth 2.0 che verranno richiesti come parte dell'autenticazione di accesso a GitHub. Questa impostazione è facoltativa
properties.googleClientId	string	ID client OpenID Connect per l'applicazione Web Google. Questa impostazione è necessaria per abilitare l'accesso a Google. 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 l'accesso a Google. 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[]	Gli 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'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 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 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 un token di sessione può essere usato per chiamare l'API di aggiornamento del token. Il valore predefinito è 72 ore.
properties.tokenStoreEnabled	boolean	`true` di 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

Enumeration

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

Valore	Descrizione
AllowAnonymous
RedirectToLoginPage