Web Apps - Update Auth Settings V2

Dienst:

App Service

API-Version:

2024-04-01

Beschreibung der Authentifizierungs-/Autorisierungseinstellungen der Updates-Website für Apps über das V2-Format

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
name	path	True	string	Name der Web-App.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Name der Ressourcengruppe, zu der die Ressource gehört.
subscriptionId	path	True	string	Ihre Azure-Abonnement-ID. Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-000000000000).
api-version	query	True	string	API-Version

Anforderungstext

Name	Typ	Beschreibung
kind	string	Art der Ressource.
properties.globalValidation	GlobalValidation	Die Konfigurationseinstellungen, die den Überprüfungsfluss von Benutzern mithilfe der App-Dienstauthentifizierung/Autorisierung bestimmen.
properties.httpSettings	HttpSettings	Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen, die für die Authentifizierung/Autorisierung von App-Diensten vorgenommen wurden.
properties.identityProviders	IdentityProviders	Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren der App-Dienstauthentifizierung/Autorisierung verwendet werden.
properties.login	Login	Die Konfigurationseinstellungen des Anmeldeflusses von Benutzern, die die App-Dienstauthentifizierung/Autorisierung verwenden.
properties.platform	AuthPlatform	Die Konfigurationseinstellungen der Plattform der App-Dienstauthentifizierung/Autorisierung.

Antworten

Name	Typ	Beschreibung
200 OK	SiteAuthSettingsV2	OKAY
Other Status Codes	DefaultErrorResponse	Fehlerantwort des App-Diensts.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

Update Auth Settings V2

Beispielanforderung

HTTP

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

{
  "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"
      }
    }
  }
}

Java

import com.azure.resourcemanager.appservice.fluent.models.SiteAuthSettingsV2Inner;
import com.azure.resourcemanager.appservice.models.AllowedAudiencesValidation;
import com.azure.resourcemanager.appservice.models.AuthPlatform;
import com.azure.resourcemanager.appservice.models.ClientRegistration;
import com.azure.resourcemanager.appservice.models.CookieExpiration;
import com.azure.resourcemanager.appservice.models.CookieExpirationConvention;
import com.azure.resourcemanager.appservice.models.FileSystemTokenStore;
import com.azure.resourcemanager.appservice.models.ForwardProxy;
import com.azure.resourcemanager.appservice.models.ForwardProxyConvention;
import com.azure.resourcemanager.appservice.models.GlobalValidation;
import com.azure.resourcemanager.appservice.models.Google;
import com.azure.resourcemanager.appservice.models.HttpSettings;
import com.azure.resourcemanager.appservice.models.HttpSettingsRoutes;
import com.azure.resourcemanager.appservice.models.IdentityProviders;
import com.azure.resourcemanager.appservice.models.Login;
import com.azure.resourcemanager.appservice.models.LoginRoutes;
import com.azure.resourcemanager.appservice.models.LoginScopes;
import com.azure.resourcemanager.appservice.models.Nonce;
import com.azure.resourcemanager.appservice.models.TokenStore;
import com.azure.resourcemanager.appservice.models.UnauthenticatedClientActionV2;
import java.util.Arrays;

/**
 * Samples for WebApps UpdateAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.json
     */
    /**
     * Sample code: Update Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().updateAuthSettingsV2WithResponse("testrg123",
            "sitef6141",
            new SiteAuthSettingsV2Inner()
                .withPlatform(new AuthPlatform().withEnabled(true).withRuntimeVersion("~1")
                    .withConfigFilePath("/auth/config.json"))
                .withGlobalValidation(new GlobalValidation().withRequireAuthentication(true)
                    .withUnauthenticatedClientAction(UnauthenticatedClientActionV2.RETURN403)
                    .withExcludedPaths(Arrays.asList("/nosecrets/Path")))
                .withIdentityProviders(new IdentityProviders().withGoogle(new Google().withEnabled(true)
                    .withRegistration(new ClientRegistration()
                        .withClientId("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com")
                        .withClientSecretSettingName("fakeTokenPlaceholder"))
                    .withLogin(new LoginScopes().withScopes(Arrays.asList("admin"))).withValidation(
                        new AllowedAudiencesValidation().withAllowedAudiences(Arrays.asList("https://example.com")))))
                .withLogin(new Login().withRoutes(new LoginRoutes().withLogoutEndpoint("https://app.com/logout"))
                    .withTokenStore(new TokenStore().withEnabled(true).withTokenRefreshExtensionHours(96.0D)
                        .withFileSystem(new FileSystemTokenStore().withDirectory("/wwwroot/sites/example")))
                    .withPreserveUrlFragmentsForLogins(true)
                    .withAllowedExternalRedirectUrls(Arrays.asList("https://someurl.com"))
                    .withCookieExpiration(
                        new CookieExpiration().withConvention(CookieExpirationConvention.IDENTITY_PROVIDER_DERIVED)
                            .withTimeToExpiration("2022:09-01T00:00Z"))
                    .withNonce(new Nonce().withValidateNonce(true)))
                .withHttpSettings(new HttpSettings().withRequireHttps(true)
                    .withRoutes(new HttpSettingsRoutes().withApiPrefix("/authv2/"))
                    .withForwardProxy(new ForwardProxy().withConvention(ForwardProxyConvention.STANDARD)
                        .withCustomHostHeaderName("authHeader").withCustomProtoHeaderName("customProtoHeader"))),
            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 update_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.update_auth_settings_v2(
        resource_group_name="testrg123",
        name="sitef6141",
        site_auth_settings_v2={
            "properties": {
                "globalValidation": {
                    "excludedPaths": ["/nosecrets/Path"],
                    "requireAuthentication": True,
                    "unauthenticatedClientAction": "Return403",
                },
                "httpSettings": {
                    "forwardProxy": {
                        "convention": "Standard",
                        "customHostHeaderName": "authHeader",
                        "customProtoHeaderName": "customProtoHeader",
                    },
                    "requireHttps": True,
                    "routes": {"apiPrefix": "/authv2/"},
                },
                "identityProviders": {
                    "google": {
                        "enabled": True,
                        "login": {"scopes": ["admin"]},
                        "registration": {
                            "clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
                            "clientSecretSettingName": "ClientSecret",
                        },
                        "validation": {"allowedAudiences": ["https://example.com"]},
                    }
                },
                "login": {
                    "allowedExternalRedirectUrls": ["https://someurl.com"],
                    "cookieExpiration": {
                        "convention": "IdentityProviderDerived",
                        "timeToExpiration": "2022:09-01T00:00Z",
                    },
                    "nonce": {"validateNonce": True},
                    "preserveUrlFragmentsForLogins": True,
                    "routes": {"logoutEndpoint": "https://app.com/logout"},
                    "tokenStore": {
                        "enabled": True,
                        "fileSystem": {"directory": "/wwwroot/sites/example"},
                        "tokenRefreshExtensionHours": 96,
                    },
                },
                "platform": {"configFilePath": "/auth/config.json", "enabled": True, "runtimeVersion": "~1"},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateAuthSettingsV2.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/azcore/to"
	"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/UpdateAuthSettingsV2.json
func ExampleWebAppsClient_UpdateAuthSettingsV2() {
	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().UpdateAuthSettingsV2(ctx, "testrg123", "sitef6141", armappservice.SiteAuthSettingsV2{
		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"),
			},
		},
	}, 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 Updates site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Updates 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/UpdateAuthSettingsV2.json
 */
async function updateAuthSettingsV2() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const siteAuthSettingsV2 = {
    globalValidation: {
      excludedPaths: ["/nosecrets/Path"],
      requireAuthentication: true,
      unauthenticatedClientAction: "Return403",
    },
    httpSettings: {
      forwardProxy: {
        convention: "Standard",
        customHostHeaderName: "authHeader",
        customProtoHeaderName: "customProtoHeader",
      },
      requireHttps: true,
      routes: { apiPrefix: "/authv2/" },
    },
    identityProviders: {
      google: {
        enabled: true,
        login: { scopes: ["admin"] },
        registration: {
          clientId: "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
          clientSecretSettingName: "ClientSecret",
        },
        validation: { allowedAudiences: ["https://example.com"] },
      },
    },
    login: {
      allowedExternalRedirectUrls: ["https://someurl.com"],
      cookieExpiration: {
        convention: "IdentityProviderDerived",
        timeToExpiration: "2022:09-01T00:00Z",
      },
      nonce: { validateNonce: true },
      preserveUrlFragmentsForLogins: true,
      routes: { logoutEndpoint: "https://app.com/logout" },
      tokenStore: {
        enabled: true,
        fileSystem: { directory: "/wwwroot/sites/example" },
        tokenRefreshExtensionHours: 96,
      },
    },
    platform: {
      configFilePath: "/auth/config.json",
      enabled: true,
      runtimeVersion: "~1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.updateAuthSettingsV2(
    resourceGroupName,
    name,
    siteAuthSettingsV2,
  );
  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/UpdateAuthSettingsV2.json
// this example is just showing the usage of "WebApps_UpdateAuthSettingsV2" 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 siteAuthSettingsV2 = new SiteAuthSettingsV2()
{
    Platform = new AuthPlatform()
    {
        IsEnabled = true,
        RuntimeVersion = "~1",
        ConfigFilePath = "/auth/config.json",
    },
    GlobalValidation = new GlobalValidation()
    {
        IsAuthenticationRequired = true,
        UnauthenticatedClientAction = UnauthenticatedClientActionV2.Return403,
        ExcludedPaths =
        {
        "/nosecrets/Path"
        },
    },
    IdentityProviders = new AppServiceIdentityProviders()
    {
        Google = new AppServiceGoogleProvider()
        {
            IsEnabled = true,
            Registration = new ClientRegistration()
            {
                ClientId = "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com",
                ClientSecretSettingName = "ClientSecret",
            },
            LoginScopes =
            {
            "admin"
            },
            ValidationAllowedAudiences =
            {
            "https://example.com"
            },
        },
    },
    Login = new WebAppLoginInfo()
    {
        RoutesLogoutEndpoint = "https://app.com/logout",
        TokenStore = new AppServiceTokenStore()
        {
            IsEnabled = true,
            TokenRefreshExtensionHours = 96,
            FileSystemDirectory = "/wwwroot/sites/example",
        },
        PreserveUrlFragmentsForLogins = true,
        AllowedExternalRedirectUrls =
        {
        "https://someurl.com"
        },
        CookieExpiration = new WebAppCookieExpiration()
        {
            Convention = CookieExpirationConvention.IdentityProviderDerived,
            TimeToExpiration = "2022:09-01T00:00Z",
        },
        Nonce = new LoginFlowNonceSettings()
        {
            ValidateNonce = true,
        },
    },
    HttpSettings = new AppServiceHttpSettings()
    {
        IsHttpsRequired = true,
        RoutesApiPrefix = "/authv2/",
        ForwardProxy = new AppServiceForwardProxy()
        {
            Convention = ForwardProxyConvention.Standard,
            CustomHostHeaderName = "authHeader",
            CustomProtoHeaderName = "customProtoHeader",
        },
    },
};
SiteAuthSettingsV2 result = await webSite.UpdateAuthSettingsV2Async(siteAuthSettingsV2);

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

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
AllowedAudiencesValidation	Die Konfigurationseinstellungen des Überprüfungsflusses für zulässige Zielgruppen.
AllowedPrincipals	Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Prinzipale.
Apple	Die Konfigurationseinstellungen des Apple-Anbieters.
AppleRegistration	Die Konfigurationseinstellungen der Registrierung für den Apple-Anbieter
AppRegistration	Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit App-IDs und geheimen App-Schlüsseln
AuthPlatform	Die Konfigurationseinstellungen der Plattform der App-Dienstauthentifizierung/Autorisierung.
AzureActiveDirectory	Die Konfigurationseinstellungen des Azure Active Directory-Anbieters.
AzureActiveDirectoryLogin	Die Konfigurationseinstellungen des Azure Active Directory-Anmeldeflusses.
AzureActiveDirectoryRegistration	Die Konfigurationseinstellungen der Azure Active Directory-App-Registrierung.
AzureActiveDirectoryValidation	Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflusses.
AzureStaticWebApps	Die Konfigurationseinstellungen des Azure Static Web Apps-Anbieters.
AzureStaticWebAppsRegistration	Die Konfigurationseinstellungen der Registrierung für den Azure Static Web Apps-Anbieter
BlobStorageTokenStore	Die Konfigurationseinstellungen des Speichers der Token, wenn blob-Speicher verwendet wird.
ClientCredentialMethod	Die Methode, die zum Authentifizieren des Benutzers verwendet werden soll.
ClientRegistration	Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit Client-IDs und geheimen Clientschlüsseln
CookieExpiration	Die Konfigurationseinstellungen des Ablaufs des Sitzungscookies.
CookieExpirationConvention	Die Konvention, die beim Bestimmen des Ablaufs des Sitzungscookies verwendet wird.
CustomOpenIdConnectProvider	Die Konfigurationseinstellungen des benutzerdefinierten Open ID Connect-Anbieters.
DefaultAuthorizationPolicy	Die Konfigurationseinstellungen der Azure Active Directory-Standardautorisierungsrichtlinie.
DefaultErrorResponse	Fehlerantwort des App-Diensts.
Details
Error	Fehlermodell.
Facebook	Die Konfigurationseinstellungen des Facebook-Anbieters.
FileSystemTokenStore	Die Konfigurationseinstellungen des Speichers der Token, wenn ein Dateisystem verwendet wird.
ForwardProxy	Die Konfigurationseinstellungen eines Weiterleitungsproxys, mit dem die Anforderungen vorgenommen werden.
ForwardProxyConvention	Die Konvention, die verwendet wird, um die URL der gestellten Anforderung zu bestimmen.
GitHub	Die Konfigurationseinstellungen des GitHub-Anbieters.
GlobalValidation	Die Konfigurationseinstellungen, die den Überprüfungsfluss von Benutzern mithilfe der App-Dienstauthentifizierung/Autorisierung bestimmen.
Google	Die Konfigurationseinstellungen des Google-Anbieters.
HttpSettings	Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen, die für die Authentifizierung/Autorisierung von App-Diensten vorgenommen wurden.
HttpSettingsRoutes	Die Konfigurationseinstellungen der Pfad-HTTP-Anforderungen.
IdentityProviders	Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren der App-Dienstauthentifizierung/Autorisierung verwendet werden.
JwtClaimChecks	Die Konfigurationseinstellungen der Prüfungen, die beim Überprüfen der JWT-Ansprüche vorgenommen werden sollen.
LegacyMicrosoftAccount	Die Konfigurationseinstellungen des älteren Microsoft-Kontoanbieters.
Login	Die Konfigurationseinstellungen des Anmeldeflusses von Benutzern, die die App-Dienstauthentifizierung/Autorisierung verwenden.
LoginRoutes	Die Routen, die die Endpunkte angeben, die für Anmelde- und Abmeldeanforderungen verwendet werden.
LoginScopes	Die Konfigurationseinstellungen des Anmeldeflusses, einschließlich der Bereiche, die angefordert werden sollen.
Nonce	Die Konfigurationseinstellungen der im Anmeldefluss verwendeten Nonce.
OpenIdConnectClientCredential	Die Anmeldeinformationen des Authentifizierungsclients des benutzerdefinierten Open ID Connect-Anbieters.
OpenIdConnectConfig	Die Konfigurationseinstellungen der Endpunkte, die für den benutzerdefinierten Open ID Connect-Anbieter verwendet werden.
OpenIdConnectLogin	Die Konfigurationseinstellungen des Anmeldeflusses des benutzerdefinierten Open ID Connect-Anbieters.
OpenIdConnectRegistration	Die Konfigurationseinstellungen der App-Registrierung für den benutzerdefinierten Open ID Connect-Anbieter.
SiteAuthSettingsV2	Konfigurationseinstellungen für die Azure App Service-Authentifizierung /Autorisierung V2-Funktion.
TokenStore	Die Konfigurationseinstellungen des Tokenspeichers.
Twitter	Die Konfigurationseinstellungen des Twitter-Anbieters.
TwitterRegistration	Die Konfigurationseinstellungen der App-Registrierung für den Twitter-Anbieter.
UnauthenticatedClientActionV2	Die Auszuführende Aktion, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

AllowedAudiencesValidation

Objekt

Die Konfigurationseinstellungen des Überprüfungsflusses für zulässige Zielgruppen.

Name	Typ	Beschreibung
allowedAudiences	string[]	Die Konfigurationseinstellungen der liste der zulässigen Zielgruppen, aus denen das JWT-Token überprüft werden soll.

AllowedPrincipals

Objekt

Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Prinzipale.

Name	Typ	Beschreibung
groups	string[]	Die Liste der zulässigen Gruppen.
identities	string[]	Die Liste der zulässigen Identitäten.

Apple

Objekt

Die Konfigurationseinstellungen des Apple-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der Apple-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
login	LoginScopes	Die Konfigurationseinstellungen des Anmeldeflusses.
registration	AppleRegistration	Die Konfigurationseinstellungen der Apple-Registrierung.

AppleRegistration

Objekt

Die Konfigurationseinstellungen der Registrierung für den Apple-Anbieter

Name	Typ	Beschreibung
clientId	string	Die Client-ID der App, die für die Anmeldung verwendet wird.
clientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält.

AppRegistration

Objekt

Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit App-IDs und geheimen App-Schlüsseln

Name	Typ	Beschreibung
appId	string	Die App-ID der App, die für die Anmeldung verwendet wird.
appSecretSettingName	string	Der Name der App-Einstellung, der den geheimen App-Schlüssel enthält.

AuthPlatform

Objekt

Die Konfigurationseinstellungen der Plattform der App-Dienstauthentifizierung/Autorisierung.

Name	Typ	Beschreibung
configFilePath	string	Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält, wenn sie aus einer Datei stammen. Wenn der Pfad relativ ist, basiert die Basis auf dem Stammverzeichnis der Website.
enabled	boolean	true, wenn das Feature "Authentifizierung/Autorisierung" für die aktuelle App aktiviert ist; andernfalls false.
runtimeVersion	string	Die RuntimeVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Authentifizierungs-/Autorisierungsmodul steuern.

AzureActiveDirectory

Objekt

Die Konfigurationseinstellungen des Azure Active Directory-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der Azure Active Directory-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
isAutoProvisioned	boolean	Ruft einen Wert ab, der angibt, ob die Azure AD-Konfiguration automatisch mithilfe von Tools von Drittanbietern bereitgestellt wurde. Dies ist ein internes Flag, das hauptsächlich zur Unterstützung des Azure-Verwaltungsportals vorgesehen ist. Benutzer sollten diese Eigenschaft nicht lesen oder schreiben.
login	AzureActiveDirectoryLogin	Die Konfigurationseinstellungen des Azure Active Directory-Anmeldeflusses.
registration	AzureActiveDirectoryRegistration	Die Konfigurationseinstellungen der Azure Active Directory-App-Registrierung.
validation	AzureActiveDirectoryValidation	Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflusses.

AzureActiveDirectoryLogin

Objekt

Die Konfigurationseinstellungen des Azure Active Directory-Anmeldeflusses.

Name	Typ	Beschreibung
disableWWWAuthenticate	boolean	true, wenn der Www-Authenticate-Anbieter von der Anforderung weggelassen werden sollte; andernfalls false.
loginParameters	string[]	Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss sich im Format "key=value" befinden.

AzureActiveDirectoryRegistration

Objekt

Die Konfigurationseinstellungen der Azure Active Directory-App-Registrierung.

Name	Typ	Beschreibung
clientId	string	Die Client-ID dieser anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Anbietern von Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Eine Alternative zum Fingerabdruck des geheimen Clientschlüssels, d. h. der Aussteller eines Zertifikats, das für Signaturzwecke verwendet wird. Diese Eigenschaft dient als Ersatz für den Fingerabdruck des geheimen Clientschlüsselzertifikats. Es ist auch optional.
clientSecretCertificateSubjectAlternativeName	string	Eine Alternative zum Fingerabdruck des geheimen Clientschlüssels, d. h. der alternative Antragstellername eines Zertifikats, das für Signaturzwecke verwendet wird. Diese Eigenschaft dient als Ersatz für den Fingerabdruck des geheimen Clientschlüsselzertifikats. Es ist auch optional.
clientSecretCertificateThumbprint	string	Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das für Signaturzwecke verwendet wird. Diese Eigenschaft dient als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.
clientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.
openIdIssuer	string	Der OpenID Connect Issuer-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Bei diesem URI handelt es sich um einen bezeichner mit Groß-/Kleinschreibung für den Tokenherausgeber. Weitere Informationen zur OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Objekt

Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflusses.

Name	Typ	Beschreibung
allowedAudiences	string[]	Die Liste der Zielgruppen, die erfolgreiche Authentifizierungs-/Autorisierungsanforderungen vornehmen können.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Die Konfigurationseinstellungen der Standardautorisierungsrichtlinie.
jwtClaimChecks	JwtClaimChecks	Die Konfigurationseinstellungen der Prüfungen, die beim Überprüfen der JWT-Ansprüche vorgenommen werden sollen.

AzureStaticWebApps

Objekt

Die Konfigurationseinstellungen des Azure Static Web Apps-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der Azure Static Web Apps-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
registration	AzureStaticWebAppsRegistration	Die Konfigurationseinstellungen der Azure Static Web Apps-Registrierung.

AzureStaticWebAppsRegistration

Objekt

Die Konfigurationseinstellungen der Registrierung für den Azure Static Web Apps-Anbieter

Name	Typ	Beschreibung
clientId	string	Die Client-ID der App, die für die Anmeldung verwendet wird.

BlobStorageTokenStore

Objekt

Die Konfigurationseinstellungen des Speichers der Token, wenn blob-Speicher verwendet wird.

Name	Typ	Beschreibung
sasUrlSettingName	string	Der Name der App-Einstellung, die die SAS-URL des BLOB-Speichers enthält, der die Token enthält.

ClientCredentialMethod

Enumeration

Die Methode, die zum Authentifizieren des Benutzers verwendet werden soll.

Wert	Beschreibung
ClientSecretPost

ClientRegistration

Objekt

Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit Client-IDs und geheimen Clientschlüsseln

Name	Typ	Beschreibung
clientId	string	Die Client-ID der App, die für die Anmeldung verwendet wird.
clientSecretSettingName	string	Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält.

CookieExpiration

Objekt

Die Konfigurationseinstellungen des Ablaufs des Sitzungscookies.

Name	Typ	Beschreibung
convention	CookieExpirationConvention	Die Konvention, die beim Bestimmen des Ablaufs des Sitzungscookies verwendet wird.
timeToExpiration	string	Der Zeitpunkt, zu dem die Anforderung gestellt wird, wenn das Sitzungscookies ablaufen soll.

CookieExpirationConvention

Enumeration

Die Konvention, die beim Bestimmen des Ablaufs des Sitzungscookies verwendet wird.

Wert	Beschreibung
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Objekt

Die Konfigurationseinstellungen des benutzerdefinierten Open ID Connect-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der benutzerdefinierte Anbieter für Open ID nicht aktiviert werden sollte; andernfalls true.
login	OpenIdConnectLogin	Die Konfigurationseinstellungen des Anmeldeflusses des benutzerdefinierten Open ID Connect-Anbieters.
registration	OpenIdConnectRegistration	Die Konfigurationseinstellungen der App-Registrierung für den benutzerdefinierten Open ID Connect-Anbieter.

DefaultAuthorizationPolicy

Objekt

Die Konfigurationseinstellungen der Azure Active Directory-Standardautorisierungsrichtlinie.

Name	Typ	Beschreibung
allowedApplications	string[]	Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Anwendungen.
allowedPrincipals	AllowedPrincipals	Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Prinzipale.

DefaultErrorResponse

Objekt

Fehlerantwort des App-Diensts.

Name	Typ	Beschreibung
error	Error	Fehlermodell.

Details

Objekt

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Error

Objekt

Fehlermodell.

Name	Typ	Beschreibung
code	string	Standardisierte Zeichenfolge, um den Fehler programmgesteuert zu identifizieren.
details	Details[]	Detaillierte Fehler.
innererror	string	Weitere Informationen zum Debuggen von Fehlern.
message	string	Detaillierte Fehlerbeschreibung und Debuginformationen.
target	string	Detaillierte Fehlerbeschreibung und Debuginformationen.

Facebook

Objekt

Die Konfigurationseinstellungen des Facebook-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der Facebook-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
graphApiVersion	string	Die Version der Facebook-API, die beim Anmelden verwendet werden soll.
login	LoginScopes	Die Konfigurationseinstellungen des Anmeldeflusses.
registration	AppRegistration	Die Konfigurationseinstellungen der App-Registrierung für den Facebook-Anbieter.

FileSystemTokenStore

Objekt

Die Konfigurationseinstellungen des Speichers der Token, wenn ein Dateisystem verwendet wird.

Name	Typ	Beschreibung
directory	string	Das Verzeichnis, in dem die Token gespeichert werden.

ForwardProxy

Objekt

Die Konfigurationseinstellungen eines Weiterleitungsproxys, mit dem die Anforderungen vorgenommen werden.

Name	Typ	Beschreibung
convention	ForwardProxyConvention	Die Konvention, die verwendet wird, um die URL der gestellten Anforderung zu bestimmen.
customHostHeaderName	string	Der Name des Headers, der den Host der Anforderung enthält.
customProtoHeaderName	string	Der Name des Headers, der das Schema der Anforderung enthält.

ForwardProxyConvention

Enumeration

Die Konvention, die verwendet wird, um die URL der gestellten Anforderung zu bestimmen.

Wert	Beschreibung
Custom
NoProxy
Standard

GitHub

Objekt

Die Konfigurationseinstellungen des GitHub-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der GitHub-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
login	LoginScopes	Die Konfigurationseinstellungen des Anmeldeflusses.
registration	ClientRegistration	Die Konfigurationseinstellungen der App-Registrierung für den GitHub-Anbieter.

GlobalValidation

Objekt

Die Konfigurationseinstellungen, die den Überprüfungsfluss von Benutzern mithilfe der App-Dienstauthentifizierung/Autorisierung bestimmen.

Name	Typ	Beschreibung
excludedPaths	string[]	Die Pfade, für die der nicht authentifizierte Fluss nicht an die Anmeldeseite umgeleitet wird.
redirectToProvider	string	Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.
requireAuthentication	boolean	true, wenn der Authentifizierungsfluss erforderlich ist, wird eine Anforderung gestellt; andernfalls false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Die Auszuführende Aktion, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

Google

Objekt

Die Konfigurationseinstellungen des Google-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der Google-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
login	LoginScopes	Die Konfigurationseinstellungen des Anmeldeflusses.
registration	ClientRegistration	Die Konfigurationseinstellungen der App-Registrierung für den Google-Anbieter.
validation	AllowedAudiencesValidation	Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflusses.

HttpSettings

Objekt

Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen, die für die Authentifizierung/Autorisierung von App-Diensten vorgenommen wurden.

Name	Typ	Beschreibung
forwardProxy	ForwardProxy	Die Konfigurationseinstellungen eines Weiterleitungsproxys, mit dem die Anforderungen vorgenommen werden.
requireHttps	boolean	false, wenn die Authentifizierungs-/Autorisierungsantworten nicht über das HTTPS-Schema zulässig sind; andernfalls true.
routes	HttpSettingsRoutes	Die Konfigurationseinstellungen der Pfad-HTTP-Anforderungen.

HttpSettingsRoutes

Objekt

Die Konfigurationseinstellungen der Pfad-HTTP-Anforderungen.

Name	Typ	Beschreibung
apiPrefix	string	Das Präfix, das allen Authentifizierungs-/Autorisierungspfaden vorausgehen soll.

IdentityProviders

Objekt

Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren der App-Dienstauthentifizierung/Autorisierung verwendet werden.

Name	Typ	Beschreibung
apple	Apple	Die Konfigurationseinstellungen des Apple-Anbieters.
azureActiveDirectory	AzureActiveDirectory	Die Konfigurationseinstellungen des Azure Active Directory-Anbieters.
azureStaticWebApps	AzureStaticWebApps	Die Konfigurationseinstellungen des Azure Static Web Apps-Anbieters.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Die Zuordnung des Namens des Alias jedes benutzerdefinierten Open ID Connect-Anbieters zu den Konfigurationseinstellungen des benutzerdefinierten Open ID Connect-Anbieters.
facebook	Facebook	Die Konfigurationseinstellungen des Facebook-Anbieters.
gitHub	GitHub	Die Konfigurationseinstellungen des GitHub-Anbieters.
google	Google	Die Konfigurationseinstellungen des Google-Anbieters.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Die Konfigurationseinstellungen des älteren Microsoft-Kontoanbieters.
twitter	Twitter	Die Konfigurationseinstellungen des Twitter-Anbieters.

JwtClaimChecks

Objekt

Die Konfigurationseinstellungen der Prüfungen, die beim Überprüfen der JWT-Ansprüche vorgenommen werden sollen.

Name	Typ	Beschreibung
allowedClientApplications	string[]	Die Liste der zulässigen Clientanwendungen.
allowedGroups	string[]	Die Liste der zulässigen Gruppen.

LegacyMicrosoftAccount

Objekt

Die Konfigurationseinstellungen des älteren Microsoft-Kontoanbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der ältere Microsoft-Kontoanbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
login	LoginScopes	Die Konfigurationseinstellungen des Anmeldeflusses.
registration	ClientRegistration	Die Konfigurationseinstellungen der App-Registrierung für den älteren Microsoft-Kontoanbieter.
validation	AllowedAudiencesValidation	Die Konfigurationseinstellungen des Legacy-Tokenablaufs des Microsoft-Kontoanbieters.

Login

Objekt

Die Konfigurationseinstellungen des Anmeldeflusses von Benutzern, die die App-Dienstauthentifizierung/Autorisierung verwenden.

Name	Typ	Beschreibung
allowedExternalRedirectUrls	string[]	Externe URLs, die als Teil der Anmeldung oder Abmeldung der App umgeleitet werden können. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die in der Regel nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.
cookieExpiration	CookieExpiration	Die Konfigurationseinstellungen des Ablaufs des Sitzungscookies.
nonce	Nonce	Die Konfigurationseinstellungen der im Anmeldefluss verwendeten Nonce.
preserveUrlFragmentsForLogins	boolean	true, wenn die Fragmente aus der Anforderung beibehalten werden, nachdem die Anmeldeanforderung gestellt wurde; andernfalls false.
routes	LoginRoutes	Die Routen, die die Endpunkte angeben, die für Anmelde- und Abmeldeanforderungen verwendet werden.
tokenStore	TokenStore	Die Konfigurationseinstellungen des Tokenspeichers.

LoginRoutes

Objekt

Die Routen, die die Endpunkte angeben, die für Anmelde- und Abmeldeanforderungen verwendet werden.

Name	Typ	Beschreibung
logoutEndpoint	string	Der Endpunkt, an dem eine Abmeldeanforderung erfolgen soll.

LoginScopes

Objekt

Die Konfigurationseinstellungen des Anmeldeflusses, einschließlich der Bereiche, die angefordert werden sollen.

Name	Typ	Beschreibung
scopes	string[]	Eine Liste der Bereiche, die beim Authentifizieren angefordert werden sollen.

Nonce

Objekt

Die Konfigurationseinstellungen der im Anmeldefluss verwendeten Nonce.

Name	Typ	Beschreibung
nonceExpirationInterval	string	Der Zeitpunkt, zu dem die Anforderung gestellt wurde, wenn die Nonce ablaufen soll.
validateNonce	boolean	false, wenn die Nonce beim Abschließen des Anmeldeflusses nicht überprüft werden sollte; andernfalls true.

OpenIdConnectClientCredential

Objekt

Die Anmeldeinformationen des Authentifizierungsclients des benutzerdefinierten Open ID Connect-Anbieters.

Name	Typ	Beschreibung
clientSecretSettingName	string	Die App-Einstellung, die den geheimen Clientschlüssel für den benutzerdefinierten Open ID Connect-Anbieter enthält.
method	ClientCredentialMethod	Die Methode, die zum Authentifizieren des Benutzers verwendet werden soll.

OpenIdConnectConfig

Objekt

Die Konfigurationseinstellungen der Endpunkte, die für den benutzerdefinierten Open ID Connect-Anbieter verwendet werden.

Name	Typ	Beschreibung
authorizationEndpoint	string	Der Endpunkt, der verwendet werden soll, um eine Autorisierungsanforderung zu stellen.
certificationUri	string	Der Endpunkt, der die zum Überprüfen des Tokens erforderlichen Schlüssel bereitstellt.
issuer	string	Der Endpunkt, der das Token ausgibt.
tokenEndpoint	string	Der Endpunkt, der zum Anfordern eines Tokens verwendet werden soll.
wellKnownOpenIdConfiguration	string	Der Endpunkt, der alle Konfigurationsendpunkte für den Anbieter enthält.

OpenIdConnectLogin

Objekt

Die Konfigurationseinstellungen des Anmeldeflusses des benutzerdefinierten Open ID Connect-Anbieters.

Name	Typ	Beschreibung
nameClaimType	string	Der Name des Anspruchs, der den Benutzernamen enthält.
scopes	string[]	Eine Liste der Bereiche, die beim Authentifizieren angefordert werden sollen.

OpenIdConnectRegistration

Objekt

Die Konfigurationseinstellungen der App-Registrierung für den benutzerdefinierten Open ID Connect-Anbieter.

Name	Typ	Beschreibung
clientCredential	OpenIdConnectClientCredential	Die Authentifizierungsanmeldeinformationen des benutzerdefinierten Open ID Connect-Anbieters.
clientId	string	Die Client-ID des benutzerdefinierten Open ID Connect-Anbieters.
openIdConnectConfiguration	OpenIdConnectConfig	Die Konfigurationseinstellungen der Endpunkte, die für den benutzerdefinierten Open ID Connect-Anbieter verwendet werden.

SiteAuthSettingsV2

Objekt

Konfigurationseinstellungen für die Azure App Service-Authentifizierung /Autorisierung V2-Funktion.

Name	Typ	Beschreibung
id	string	Ressourcen-ID.
kind	string	Art der Ressource.
name	string	Ressourcenname.
properties.globalValidation	GlobalValidation	Die Konfigurationseinstellungen, die den Überprüfungsfluss von Benutzern mithilfe der App-Dienstauthentifizierung/Autorisierung bestimmen.
properties.httpSettings	HttpSettings	Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen, die für die Authentifizierung/Autorisierung von App-Diensten vorgenommen wurden.
properties.identityProviders	IdentityProviders	Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren der App-Dienstauthentifizierung/Autorisierung verwendet werden.
properties.login	Login	Die Konfigurationseinstellungen des Anmeldeflusses von Benutzern, die die App-Dienstauthentifizierung/Autorisierung verwenden.
properties.platform	AuthPlatform	Die Konfigurationseinstellungen der Plattform der App-Dienstauthentifizierung/Autorisierung.
type	string	Ressourcentyp.

TokenStore

Objekt

Die Konfigurationseinstellungen des Tokenspeichers.

Name	Typ	Beschreibung
azureBlobStorage	BlobStorageTokenStore	Die Konfigurationseinstellungen des Speichers der Token, wenn blob-Speicher verwendet wird.
enabled	boolean	true, plattformspezifische Sicherheitstoken, die während der Anmeldeflüsse abgerufen werden, dauerhaft zu speichern; andernfalls false. Der Standardwert ist false.
fileSystem	FileSystemTokenStore	Die Konfigurationseinstellungen des Speichers der Token, wenn ein Dateisystem verwendet wird.
tokenRefreshExtensionHours	number (double)	Die Anzahl der Stunden nach ablauf des Sitzungstokens, mit der ein Sitzungstoken die Tokenaktualisierungs-API aufrufen kann. Der Standardwert ist 72 Stunden.

Twitter

Objekt

Die Konfigurationseinstellungen des Twitter-Anbieters.

Name	Typ	Beschreibung
enabled	boolean	false, wenn der Twitter-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden sollte; andernfalls true.
registration	TwitterRegistration	Die Konfigurationseinstellungen der App-Registrierung für den Twitter-Anbieter.

TwitterRegistration

Objekt

Die Konfigurationseinstellungen der App-Registrierung für den Twitter-Anbieter.

Name	Typ	Beschreibung
consumerKey	string	Der OAuth 1.0a Consumer Key der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	Der Name der App-Einstellung, der das OAuth 1.0a-Verbrauchergeheimnis der Twitter-Anwendung enthält, die für die Anmeldung verwendet wird.

UnauthenticatedClientActionV2

Enumeration

Die Auszuführende Aktion, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

Wert	Beschreibung
AllowAnonymous
RedirectToLoginPage
Return401
Return403