Web Apps - Get Auth Settings V2

Servizio:

App Service

Versione API:

2024-04-01

Descrizione per Le impostazioni di autenticazione/autorizzazione del sito per le app tramite il formato V2

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/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 minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nome del gruppo di risorse a cui appartiene la risorsa.
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	SiteAuthSettingsV2	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 V2

Esempio di richiesta

HTTP

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

Java

/**
 * Samples for WebApps GetAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
     */
    /**
     * Sample code: List Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsV2WithResponse("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

Python

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_v2.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_v2(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.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

Go

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/ListAuthSettingsV2.json
func ExampleWebAppsClient_GetAuthSettingsV2() {
	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().GetAuthSettingsV2(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.SiteAuthSettingsV2 = armappservice.SiteAuthSettingsV2{
	// 	Name: to.Ptr("authsettingsv2"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettingsv2"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsV2Properties{
	// 		GlobalValidation: &armappservice.GlobalValidation{
	// 			ExcludedPaths: []*string{
	// 				to.Ptr("/nosecrets/Path")},
	// 				RequireAuthentication: to.Ptr(true),
	// 				UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionV2Return403),
	// 			},
	// 			HTTPSettings: &armappservice.HTTPSettings{
	// 				ForwardProxy: &armappservice.ForwardProxy{
	// 					Convention: to.Ptr(armappservice.ForwardProxyConventionStandard),
	// 					CustomHostHeaderName: to.Ptr("authHeader"),
	// 					CustomProtoHeaderName: to.Ptr("customProtoHeader"),
	// 				},
	// 				RequireHTTPS: to.Ptr(true),
	// 				Routes: &armappservice.HTTPSettingsRoutes{
	// 					APIPrefix: to.Ptr("/authv2/"),
	// 				},
	// 			},
	// 			IdentityProviders: &armappservice.IdentityProviders{
	// 				Google: &armappservice.Google{
	// 					Enabled: to.Ptr(true),
	// 					Login: &armappservice.LoginScopes{
	// 						Scopes: []*string{
	// 							to.Ptr("admin")},
	// 						},
	// 						Registration: &armappservice.ClientRegistration{
	// 							ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 							ClientSecretSettingName: to.Ptr("ClientSecret"),
	// 						},
	// 						Validation: &armappservice.AllowedAudiencesValidation{
	// 							AllowedAudiences: []*string{
	// 								to.Ptr("https://example.com")},
	// 							},
	// 						},
	// 					},
	// 					Login: &armappservice.Login{
	// 						AllowedExternalRedirectUrls: []*string{
	// 							to.Ptr("https://someurl.com")},
	// 							CookieExpiration: &armappservice.CookieExpiration{
	// 								Convention: to.Ptr(armappservice.CookieExpirationConventionIdentityProviderDerived),
	// 								TimeToExpiration: to.Ptr("2022:09-01T00:00Z"),
	// 							},
	// 							Nonce: &armappservice.Nonce{
	// 								ValidateNonce: to.Ptr(true),
	// 							},
	// 							PreserveURLFragmentsForLogins: to.Ptr(true),
	// 							Routes: &armappservice.LoginRoutes{
	// 								LogoutEndpoint: to.Ptr("https://app.com/logout"),
	// 							},
	// 							TokenStore: &armappservice.TokenStore{
	// 								Enabled: to.Ptr(true),
	// 								FileSystem: &armappservice.FileSystemTokenStore{
	// 									Directory: to.Ptr("/wwwroot/sites/example"),
	// 								},
	// 								TokenRefreshExtensionHours: to.Ptr[float64](96),
	// 							},
	// 						},
	// 						Platform: &armappservice.AuthPlatform{
	// 							ConfigFilePath: to.Ptr("/auth/config.json"),
	// 							Enabled: to.Ptr(true),
	// 							RuntimeVersion: to.Ptr("~1"),
	// 						},
	// 					},
	// 				}
}

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

JavaScript

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

/**
 * This sample demonstrates how to Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ListAuthSettingsV2.json
 */
async function listAuthSettingsV2() {
  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.getAuthSettingsV2(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

dotnet

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/ListAuthSettingsV2.json
// this example is just showing the usage of "WebApps_GetAuthSettingsV2" 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
SiteAuthSettingsV2 result = await webSite.GetAuthSettingsV2Async();

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/authsettingsv2",
  "name": "authsettingsv2",
  "type": "Microsoft.Web/sites/authsettingsv2",
  "kind": "app",
  "properties": {
    "platform": {
      "enabled": true,
      "runtimeVersion": "~1",
      "configFilePath": "/auth/config.json"
    },
    "globalValidation": {
      "requireAuthentication": true,
      "unauthenticatedClientAction": "Return403",
      "excludedPaths": [
        "/nosecrets/Path"
      ]
    },
    "identityProviders": {
      "google": {
        "enabled": true,
        "registration": {
          "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
          "clientSecretSettingName": "ClientSecret"
        },
        "login": {
          "scopes": [
            "admin"
          ]
        },
        "validation": {
          "allowedAudiences": [
            "https://example.com"
          ]
        }
      }
    },
    "login": {
      "routes": {
        "logoutEndpoint": "https://app.com/logout"
      },
      "tokenStore": {
        "enabled": true,
        "tokenRefreshExtensionHours": 96,
        "fileSystem": {
          "directory": "/wwwroot/sites/example"
        }
      },
      "preserveUrlFragmentsForLogins": true,
      "allowedExternalRedirectUrls": [
        "https://someurl.com"
      ],
      "cookieExpiration": {
        "convention": "IdentityProviderDerived",
        "timeToExpiration": "2022:09-01T00:00Z"
      },
      "nonce": {
        "validateNonce": true
      }
    },
    "httpSettings": {
      "requireHttps": true,
      "routes": {
        "apiPrefix": "/authv2/"
      },
      "forwardProxy": {
        "convention": "Standard",
        "customHostHeaderName": "authHeader",
        "customProtoHeaderName": "customProtoHeader"
      }
    }
  }
}

Definizioni

Nome	Descrizione
AllowedAudiencesValidation	Impostazioni di configurazione del flusso di convalida Gruppi di destinatari consentiti.
AllowedPrincipals	Impostazioni di configurazione delle entità consentite di Azure Active Directory.
Apple	Impostazioni di configurazione del provider Apple.
AppleRegistration	Impostazioni di configurazione della registrazione per il provider Apple
AppRegistration	Impostazioni di configurazione della registrazione dell'app per i provider con ID app e segreti dell'app
AuthPlatform	Impostazioni di configurazione della piattaforma dell'autenticazione/autorizzazione del servizio app.
AzureActiveDirectory	Impostazioni di configurazione del provider di Azure Active Directory.
AzureActiveDirectoryLogin	Impostazioni di configurazione del flusso di accesso di Azure Active Directory.
AzureActiveDirectoryRegistration	Impostazioni di configurazione della registrazione dell'app Azure Active Directory.
AzureActiveDirectoryValidation	Impostazioni di configurazione del flusso di convalida del token di Azure Active Directory.
AzureStaticWebApps	Impostazioni di configurazione del provider app Web statiche di Azure.
AzureStaticWebAppsRegistration	Impostazioni di configurazione della registrazione per il provider di app Web statiche di Azure
BlobStorageTokenStore	Impostazioni di configurazione dell'archiviazione dei token se viene usata l'archiviazione BLOB.
ClientCredentialMethod	Metodo da utilizzare per autenticare l'utente.
ClientRegistration	Impostazioni di configurazione della registrazione dell'app per i provider con ID client e segreti client
CookieExpiration	Impostazioni di configurazione della scadenza del cookie di sessione.
CookieExpirationConvention	Convenzione utilizzata per determinare la scadenza del cookie di sessione.
CustomOpenIdConnectProvider	Impostazioni di configurazione del provider Open ID Connect personalizzato.
DefaultAuthorizationPolicy	Impostazioni di configurazione dei criteri di autorizzazione predefiniti di Azure Active Directory.
DefaultErrorResponse	Risposta di errore del servizio app.
Details
Error	Modello di errore.
Facebook	Impostazioni di configurazione del provider Facebook.
FileSystemTokenStore	Impostazioni di configurazione dell'archiviazione dei token se viene usato un file system.
ForwardProxy	Impostazioni di configurazione di un proxy di inoltro usato per effettuare le richieste.
ForwardProxyConvention	Convenzione utilizzata per determinare l'URL della richiesta effettuata.
GitHub	Impostazioni di configurazione del provider GitHub.
GlobalValidation	Impostazioni di configurazione che determinano il flusso di convalida degli utenti che usano l'autenticazione/autorizzazione del servizio app.
Google	Impostazioni di configurazione del provider Google.
HttpSettings	Le impostazioni di configurazione delle richieste HTTP per le richieste di autenticazione e autorizzazione effettuate per l'autenticazione/autorizzazione del servizio app.
HttpSettingsRoutes	Impostazioni di configurazione dei percorsi richieste HTTP.
IdentityProviders	Le impostazioni di configurazione di ognuno dei provider di identità usati per configurare l'autenticazione/autorizzazione del servizio app.
JwtClaimChecks	Le impostazioni di configurazione dei controlli da eseguire durante la convalida delle attestazioni JWT.
LegacyMicrosoftAccount	Impostazioni di configurazione del provider di account Microsoft legacy.
Login	Le impostazioni di configurazione del flusso di accesso degli utenti che usano l'autenticazione/autorizzazione del servizio app.
LoginRoutes	Route che specificano gli endpoint usati per le richieste di accesso e disconnessione.
LoginScopes	Impostazioni di configurazione del flusso di accesso, inclusi gli ambiti che devono essere richiesti.
Nonce	Impostazioni di configurazione del nonce utilizzato nel flusso di accesso.
OpenIdConnectClientCredential	Credenziali client di autenticazione del provider Open ID Connect personalizzato.
OpenIdConnectConfig	Impostazioni di configurazione degli endpoint usati per il provider Open ID Connect personalizzato.
OpenIdConnectLogin	Impostazioni di configurazione del flusso di accesso del provider Open ID Connect personalizzato.
OpenIdConnectRegistration	Impostazioni di configurazione della registrazione dell'app per il provider Open ID Connect personalizzato.
SiteAuthSettingsV2	Impostazioni di configurazione per la funzionalità Autenticazione/autorizzazione del servizio app di Azure V2.
TokenStore	Impostazioni di configurazione dell'archivio token.
Twitter	Impostazioni di configurazione del provider Twitter.
TwitterRegistration	Impostazioni di configurazione della registrazione dell'app per il provider Twitter.
UnauthenticatedClientActionV2	Azione da eseguire quando un client non autenticato tenta di accedere all'app.

AllowedAudiencesValidation

Object

Impostazioni di configurazione del flusso di convalida Gruppi di destinatari consentiti.

Nome	Tipo	Descrizione
allowedAudiences	string[]	Impostazioni di configurazione dell'elenco di destinatari consentiti da cui convalidare il token JWT.

AllowedPrincipals

Object

Impostazioni di configurazione delle entità consentite di Azure Active Directory.

Nome	Tipo	Descrizione
groups	string[]	Elenco dei gruppi consentiti.
identities	string[]	Elenco delle identità consentite.

Apple

Object

Impostazioni di configurazione del provider Apple.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider Apple non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
login	LoginScopes	Impostazioni di configurazione del flusso di accesso.
registration	AppleRegistration	Impostazioni di configurazione della registrazione Apple.

AppleRegistration

Object

Impostazioni di configurazione della registrazione per il provider Apple

Nome	Tipo	Descrizione
clientId	string	ID client dell'app usata per l'accesso.
clientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client.

AppRegistration

Object

Impostazioni di configurazione della registrazione dell'app per i provider con ID app e segreti dell'app

Nome	Tipo	Descrizione
appId	string	ID app dell'app usata per l'accesso.
appSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto dell'app.

AuthPlatform

Object

Impostazioni di configurazione della piattaforma dell'autenticazione/autorizzazione del servizio app.

Nome	Tipo	Descrizione
configFilePath	string	Percorso del file di configurazione contenente le impostazioni di autenticazione se provengono da un file. Se il percorso è relativo, base sarà la directory radice del sito.
enabled	boolean	true se la funzionalità Autenticazione/Autorizzazione è abilitata per l'app corrente; in caso contrario, false.
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.

AzureActiveDirectory

Object

Impostazioni di configurazione del provider di Azure Active Directory.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider di Azure Active Directory non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
isAutoProvisioned	boolean	Ottiene un valore che indica se è stato eseguito il provisioning automatico della configurazione di Azure AD usando gli strumenti di prima parte. Si tratta di un flag interno destinato principalmente al supporto del portale di gestione di Azure. Gli utenti non devono leggere o scrivere in questa proprietà.
login	AzureActiveDirectoryLogin	Impostazioni di configurazione del flusso di accesso di Azure Active Directory.
registration	AzureActiveDirectoryRegistration	Impostazioni di configurazione della registrazione dell'app Azure Active Directory.
validation	AzureActiveDirectoryValidation	Impostazioni di configurazione del flusso di convalida del token di Azure Active Directory.

AzureActiveDirectoryLogin

Object

Impostazioni di configurazione del flusso di accesso di Azure Active Directory.

Nome	Tipo	Descrizione
disableWWWAuthenticate	boolean	true se il provider www-authenticate deve essere omesso dalla richiesta; in caso contrario, false.
loginParameters	string[]	Parametri di accesso da inviare all'endpoint di autorizzazione OpenID Connect quando un utente accede. Ogni parametro deve essere nel formato "key=value".

AzureActiveDirectoryRegistration

Object

Impostazioni di configurazione della registrazione dell'app Azure Active Directory.

Nome	Tipo	Descrizione
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
clientSecretCertificateIssuer	string	Alternativa all'identificazione personale del segreto client, ovvero l'autorità emittente di un certificato usato per la firma. Questa proprietà funge da sostituzione dell'identificazione personale del certificato segreto client. È anche facoltativo.
clientSecretCertificateSubjectAlternativeName	string	Alternativa all'identificazione personale del segreto client, ovvero il nome alternativo del soggetto di un certificato usato a scopo di firma. Questa proprietà funge da sostituzione dell'identificazione personale del certificato segreto client. È anche facoltativo.
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.
clientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client dell'applicazione relying party.
openIdIssuer	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://login.microsoftonline.com/v2.0/{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

AzureActiveDirectoryValidation

Object

Impostazioni di configurazione del flusso di convalida del token di Azure Active Directory.

Nome	Tipo	Descrizione
allowedAudiences	string[]	Elenco di gruppi di destinatari che possono effettuare richieste di autenticazione/autorizzazione riuscite.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Impostazioni di configurazione dei criteri di autorizzazione predefiniti.
jwtClaimChecks	JwtClaimChecks	Le impostazioni di configurazione dei controlli da eseguire durante la convalida delle attestazioni JWT.

AzureStaticWebApps

Object

Impostazioni di configurazione del provider app Web statiche di Azure.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider di app Web statiche di Azure non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
registration	AzureStaticWebAppsRegistration	Impostazioni di configurazione della registrazione di App Web statiche di Azure.

AzureStaticWebAppsRegistration

Object

Impostazioni di configurazione della registrazione per il provider di app Web statiche di Azure

Nome	Tipo	Descrizione
clientId	string	ID client dell'app usata per l'accesso.

BlobStorageTokenStore

Object

Impostazioni di configurazione dell'archiviazione dei token se viene usata l'archiviazione BLOB.

Nome	Tipo	Descrizione
sasUrlSettingName	string	Nome dell'impostazione dell'app contenente l'URL di firma di accesso condiviso dell'archivio BLOB contenente i token.

ClientCredentialMethod

Enumerazione

Metodo da utilizzare per autenticare l'utente.

Valore	Descrizione
ClientSecretPost

ClientRegistration

Object

Impostazioni di configurazione della registrazione dell'app per i provider con ID client e segreti client

Nome	Tipo	Descrizione
clientId	string	ID client dell'app usata per l'accesso.
clientSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto client.

CookieExpiration

Object

Impostazioni di configurazione della scadenza del cookie di sessione.

Nome	Tipo	Descrizione
convention	CookieExpirationConvention	Convenzione utilizzata per determinare la scadenza del cookie di sessione.
timeToExpiration	string	Ora dopo l'esecuzione della richiesta alla scadenza del cookie di sessione.

CookieExpirationConvention

Enumerazione

Convenzione utilizzata per determinare la scadenza del cookie di sessione.

Valore	Descrizione
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

Impostazioni di configurazione del provider Open ID Connect personalizzato.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider del provider Open ID personalizzato non deve essere abilitato; in caso contrario, true.
login	OpenIdConnectLogin	Impostazioni di configurazione del flusso di accesso del provider Open ID Connect personalizzato.
registration	OpenIdConnectRegistration	Impostazioni di configurazione della registrazione dell'app per il provider Open ID Connect personalizzato.

DefaultAuthorizationPolicy

Object

Impostazioni di configurazione dei criteri di autorizzazione predefiniti di Azure Active Directory.

Nome	Tipo	Descrizione
allowedApplications	string[]	Impostazioni di configurazione delle applicazioni consentite di Azure Active Directory.
allowedPrincipals	AllowedPrincipals	Impostazioni di configurazione delle entità consentite di Azure Active Directory.

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.

Facebook

Object

Impostazioni di configurazione del provider Facebook.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider facebook non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
graphApiVersion	string	Versione dell'API Facebook da usare durante l'accesso.
login	LoginScopes	Impostazioni di configurazione del flusso di accesso.
registration	AppRegistration	Impostazioni di configurazione della registrazione dell'app per il provider Facebook.

FileSystemTokenStore

Object

Impostazioni di configurazione dell'archiviazione dei token se viene usato un file system.

Nome	Tipo	Descrizione
directory	string	Directory in cui verranno archiviati i token.

ForwardProxy

Object

Impostazioni di configurazione di un proxy di inoltro usato per effettuare le richieste.

Nome	Tipo	Descrizione
convention	ForwardProxyConvention	Convenzione utilizzata per determinare l'URL della richiesta effettuata.
customHostHeaderName	string	Nome dell'intestazione contenente l'host della richiesta.
customProtoHeaderName	string	Nome dell'intestazione contenente lo schema della richiesta.

ForwardProxyConvention

Enumerazione

Convenzione utilizzata per determinare l'URL della richiesta effettuata.

Valore	Descrizione
Custom
NoProxy
Standard

GitHub

Object

Impostazioni di configurazione del provider GitHub.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider GitHub non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
login	LoginScopes	Impostazioni di configurazione del flusso di accesso.
registration	ClientRegistration	Impostazioni di configurazione della registrazione dell'app per il provider GitHub.

GlobalValidation

Object

Impostazioni di configurazione che determinano il flusso di convalida degli utenti che usano l'autenticazione/autorizzazione del servizio app.

Nome	Tipo	Descrizione
excludedPaths	string[]	I percorsi per i quali il flusso non autenticato non verrà reindirizzato alla pagina di accesso.
redirectToProvider	string	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".
requireAuthentication	boolean	true se il flusso di autenticazione è necessario per qualsiasi richiesta; in caso contrario, false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Azione da eseguire quando un client non autenticato tenta di accedere all'app.

Google

Object

Impostazioni di configurazione del provider Google.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider Google non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
login	LoginScopes	Impostazioni di configurazione del flusso di accesso.
registration	ClientRegistration	Impostazioni di configurazione della registrazione dell'app per il provider Google.
validation	AllowedAudiencesValidation	Impostazioni di configurazione del flusso di convalida del token di Azure Active Directory.

HttpSettings

Object

Le impostazioni di configurazione delle richieste HTTP per le richieste di autenticazione e autorizzazione effettuate per l'autenticazione/autorizzazione del servizio app.

Nome	Tipo	Descrizione
forwardProxy	ForwardProxy	Impostazioni di configurazione di un proxy di inoltro usato per effettuare le richieste.
requireHttps	boolean	false se le risposte di autenticazione/autorizzazione non hanno lo schema HTTPS consentito; in caso contrario, true.
routes	HttpSettingsRoutes	Impostazioni di configurazione dei percorsi richieste HTTP.

HttpSettingsRoutes

Object

Impostazioni di configurazione dei percorsi richieste HTTP.

Nome	Tipo	Descrizione
apiPrefix	string	Prefisso che deve precedere tutti i percorsi di autenticazione/autorizzazione.

IdentityProviders

Object

Le impostazioni di configurazione di ognuno dei provider di identità usati per configurare l'autenticazione/autorizzazione del servizio app.

Nome	Tipo	Descrizione
apple	Apple	Impostazioni di configurazione del provider Apple.
azureActiveDirectory	AzureActiveDirectory	Impostazioni di configurazione del provider di Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	Impostazioni di configurazione del provider app Web statiche di Azure.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Mappa del nome dell'alias di ogni provider Open ID Connect personalizzato alle impostazioni di configurazione del provider Open ID Connect personalizzato.
facebook	Facebook	Impostazioni di configurazione del provider Facebook.
gitHub	GitHub	Impostazioni di configurazione del provider GitHub.
google	Google	Impostazioni di configurazione del provider Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Impostazioni di configurazione del provider di account Microsoft legacy.
twitter	Twitter	Impostazioni di configurazione del provider Twitter.

JwtClaimChecks

Object

Le impostazioni di configurazione dei controlli da eseguire durante la convalida delle attestazioni JWT.

Nome	Tipo	Descrizione
allowedClientApplications	string[]	Elenco delle applicazioni client consentite.
allowedGroups	string[]	Elenco dei gruppi consentiti.

LegacyMicrosoftAccount

Object

Impostazioni di configurazione del provider di account Microsoft legacy.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider di account Microsoft legacy non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
login	LoginScopes	Impostazioni di configurazione del flusso di accesso.
registration	ClientRegistration	Impostazioni di configurazione della registrazione dell'app per il provider di account Microsoft legacy.
validation	AllowedAudiencesValidation	Impostazioni di configurazione del flusso di convalida del token del provider di account Microsoft legacy.

Login

Object

Le impostazioni di configurazione del flusso di accesso degli utenti che usano l'autenticazione/autorizzazione del servizio app.

Nome	Tipo	Descrizione
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.
cookieExpiration	CookieExpiration	Impostazioni di configurazione della scadenza del cookie di sessione.
nonce	Nonce	Impostazioni di configurazione del nonce utilizzato nel flusso di accesso.
preserveUrlFragmentsForLogins	boolean	true se i frammenti della richiesta vengono mantenuti dopo l'esecuzione della richiesta di accesso; in caso contrario, false.
routes	LoginRoutes	Route che specificano gli endpoint usati per le richieste di accesso e disconnessione.
tokenStore	TokenStore	Impostazioni di configurazione dell'archivio token.

LoginRoutes

Object

Route che specificano gli endpoint usati per le richieste di accesso e disconnessione.

Nome	Tipo	Descrizione
logoutEndpoint	string	Endpoint in cui deve essere effettuata una richiesta di disconnessione.

LoginScopes

Object

Impostazioni di configurazione del flusso di accesso, inclusi gli ambiti che devono essere richiesti.

Nome	Tipo	Descrizione
scopes	string[]	Elenco degli ambiti che devono essere richiesti durante l'autenticazione.

Nonce

Object

Impostazioni di configurazione del nonce utilizzato nel flusso di accesso.

Nome	Tipo	Descrizione
nonceExpirationInterval	string	L'ora dopo l'esecuzione della richiesta alla scadenza del nonce.
validateNonce	boolean	false se il nonce non deve essere convalidato durante il completamento del flusso di accesso; in caso contrario, true.

OpenIdConnectClientCredential

Object

Credenziali client di autenticazione del provider Open ID Connect personalizzato.

Nome	Tipo	Descrizione
clientSecretSettingName	string	Impostazione dell'app che contiene il segreto client per il provider Open ID Connect personalizzato.
method	ClientCredentialMethod	Metodo da utilizzare per autenticare l'utente.

OpenIdConnectConfig

Object

Impostazioni di configurazione degli endpoint usati per il provider Open ID Connect personalizzato.

Nome	Tipo	Descrizione
authorizationEndpoint	string	Endpoint da usare per effettuare una richiesta di autorizzazione.
certificationUri	string	Endpoint che fornisce le chiavi necessarie per convalidare il token.
issuer	string	Endpoint che rilascia il token.
tokenEndpoint	string	Endpoint da usare per richiedere un token.
wellKnownOpenIdConfiguration	string	Endpoint che contiene tutti gli endpoint di configurazione per il provider.

OpenIdConnectLogin

Object

Impostazioni di configurazione del flusso di accesso del provider Open ID Connect personalizzato.

Nome	Tipo	Descrizione
nameClaimType	string	Nome dell'attestazione che contiene il nome utente.
scopes	string[]	Elenco degli ambiti che devono essere richiesti durante l'autenticazione.

OpenIdConnectRegistration

Object

Impostazioni di configurazione della registrazione dell'app per il provider Open ID Connect personalizzato.

Nome	Tipo	Descrizione
clientCredential	OpenIdConnectClientCredential	Credenziali di autenticazione del provider Open ID Connect personalizzato.
clientId	string	ID client del provider Open ID Connect personalizzato.
openIdConnectConfiguration	OpenIdConnectConfig	Impostazioni di configurazione degli endpoint usati per il provider Open ID Connect personalizzato.

SiteAuthSettingsV2

Object

Impostazioni di configurazione per la funzionalità Autenticazione/autorizzazione del servizio app di Azure V2.

Nome	Tipo	Descrizione
id	string	ID risorsa.
kind	string	Tipo di risorsa.
name	string	Nome risorsa.
properties.globalValidation	GlobalValidation	Impostazioni di configurazione che determinano il flusso di convalida degli utenti che usano l'autenticazione/autorizzazione del servizio app.
properties.httpSettings	HttpSettings	Le impostazioni di configurazione delle richieste HTTP per le richieste di autenticazione e autorizzazione effettuate per l'autenticazione/autorizzazione del servizio app.
properties.identityProviders	IdentityProviders	Le impostazioni di configurazione di ognuno dei provider di identità usati per configurare l'autenticazione/autorizzazione del servizio app.
properties.login	Login	Le impostazioni di configurazione del flusso di accesso degli utenti che usano l'autenticazione/autorizzazione del servizio app.
properties.platform	AuthPlatform	Impostazioni di configurazione della piattaforma dell'autenticazione/autorizzazione del servizio app.
type	string	Tipo di risorsa.

TokenStore

Object

Impostazioni di configurazione dell'archivio token.

Nome	Tipo	Descrizione
azureBlobStorage	BlobStorageTokenStore	Impostazioni di configurazione dell'archiviazione dei token se viene usata l'archiviazione BLOB.
enabled	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.
fileSystem	FileSystemTokenStore	Impostazioni di configurazione dell'archiviazione dei token se viene usato un file system.
tokenRefreshExtensionHours	number (double)	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.

Twitter

Object

Impostazioni di configurazione del provider Twitter.

Nome	Tipo	Descrizione
enabled	boolean	false se il provider twitter non deve essere abilitato nonostante la registrazione impostata; in caso contrario, true.
registration	TwitterRegistration	Impostazioni di configurazione della registrazione dell'app per il provider Twitter.

TwitterRegistration

Object

Impostazioni di configurazione della registrazione dell'app per il provider Twitter.

Nome	Tipo	Descrizione
consumerKey	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
consumerSecretSettingName	string	Nome dell'impostazione dell'app che contiene il segreto consumer OAuth 1.0a dell'applicazione Twitter usata per l'accesso.

UnauthenticatedClientActionV2

Enumerazione

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

Valore	Descrizione
AllowAnonymous
RedirectToLoginPage
Return401
Return403