Web Apps - Update Auth Settings V2

Usługa:

App Service

Wersja interfejsu API:

2024-04-01

Opis ustawień uwierzytelniania/autoryzacji witryny aktualizacji dla aplikacji w formacie V2

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
name	path	True	string	Nazwa aplikacji internetowej.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$	Nazwa grupy zasobów, do której należy zasób.
subscriptionId	path	True	string	Identyfikator subskrypcji platformy Azure. Jest to ciąg w formacie GUID (np. 0000000000-0000-0000-0000-0000000000000).
api-version	query	True	string	Wersja interfejsu API

Treść żądania

Nazwa	Typ	Opis
kind	string	Rodzaj zasobu.
properties.globalValidation	GlobalValidation	Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.
properties.httpSettings	HttpSettings	Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi App Service.
properties.identityProviders	IdentityProviders	Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi App Service.
properties.login	Login	Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.
properties.platform	AuthPlatform	Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi App Service.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SiteAuthSettingsV2	OK
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

Update Auth Settings V2

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:

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

Definicje

Nazwa	Opis
AllowedAudiencesValidation	Ustawienia konfiguracji przepływu weryfikacji Dozwolone grupy odbiorców.
AllowedPrincipals	Ustawienia konfiguracji dozwolonych podmiotów zabezpieczeń usługi Azure Active Directory.
Apple	Ustawienia konfiguracji dostawcy firmy Apple.
AppleRegistration	Ustawienia konfiguracji rejestracji dostawcy firmy Apple
AppRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawców, którzy mają identyfikatory aplikacji i wpisy tajne aplikacji
AuthPlatform	Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi App Service.
AzureActiveDirectory	Ustawienia konfiguracji dostawcy usługi Azure Active Directory.
AzureActiveDirectoryLogin	Ustawienia konfiguracji przepływu logowania usługi Azure Active Directory.
AzureActiveDirectoryRegistration	Ustawienia konfiguracji rejestracji aplikacji usługi Azure Active Directory.
AzureActiveDirectoryValidation	Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory.
AzureStaticWebApps	Ustawienia konfiguracji dostawcy usługi Azure Static Web Apps.
AzureStaticWebAppsRegistration	Ustawienia konfiguracji rejestracji dostawcy usługi Azure Static Web Apps
BlobStorageTokenStore	Ustawienia konfiguracji magazynu tokenów, jeśli jest używany magazyn obiektów blob.
ClientCredentialMethod	Metoda, która powinna służyć do uwierzytelniania użytkownika.
ClientRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawców, którzy mają identyfikatory klienta i wpisy tajne klienta
CookieExpiration	Ustawienia konfiguracji wygasania pliku cookie sesji.
CookieExpirationConvention	Konwencja używana podczas określania wygaśnięcia pliku cookie sesji.
CustomOpenIdConnectProvider	Ustawienia konfiguracji niestandardowego dostawcy programu Open ID Connect.
DefaultAuthorizationPolicy	Ustawienia konfiguracji domyślnych zasad autoryzacji usługi Azure Active Directory.
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Error	Model błędu.
Facebook	Ustawienia konfiguracji dostawcy serwisu Facebook.
FileSystemTokenStore	Ustawienia konfiguracji magazynu tokenów, jeśli jest używany system plików.
ForwardProxy	Ustawienia konfiguracji serwera proxy przesyłania dalej używane do tworzenia żądań.
ForwardProxyConvention	Konwencja używana do określania adresu URL wykonanego żądania.
GitHub	Ustawienia konfiguracji dostawcy GitHub.
GlobalValidation	Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.
Google	Ustawienia konfiguracji dostawcy Google.
HttpSettings	Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi App Service.
HttpSettingsRoutes	Ustawienia konfiguracji ścieżek żądania HTTP.
IdentityProviders	Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi App Service.
JwtClaimChecks	Ustawienia konfiguracji kontroli, które należy wykonać podczas weryfikowania oświadczeń JWT.
LegacyMicrosoftAccount	Ustawienia konfiguracji starszego dostawcy kont Microsoft.
Login	Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.
LoginRoutes	Trasy określające punkty końcowe używane do logowania i wylogowyywania żądań.
LoginScopes	Ustawienia konfiguracji przepływu logowania, w tym zakresy, których należy zażądać.
Nonce	Ustawienia konfiguracji nieużytego w przepływie logowania.
OpenIdConnectClientCredential	Poświadczenia klienta uwierzytelniania niestandardowego dostawcy programu Open ID Connect.
OpenIdConnectConfig	Ustawienia konfiguracji punktów końcowych używanych dla niestandardowego dostawcy programu Open ID Connect.
OpenIdConnectLogin	Ustawienia konfiguracji przepływu logowania niestandardowego dostawcy programu Open ID Connect.
OpenIdConnectRegistration	Ustawienia konfiguracji rejestracji aplikacji dla niestandardowego dostawcy programu Open ID Connect.
SiteAuthSettingsV2	Ustawienia konfiguracji funkcji uwierzytelnianie/autoryzacja usługi Azure App Service w wersji 2.
TokenStore	Ustawienia konfiguracji magazynu tokenów.
Twitter	Ustawienia konfiguracji dostawcy usługi Twitter.
TwitterRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi Twitter.
UnauthenticatedClientActionV2	Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.

AllowedAudiencesValidation

Objekt

Ustawienia konfiguracji przepływu weryfikacji Dozwolone grupy odbiorców.

Nazwa	Typ	Opis
allowedAudiences	string[]	Ustawienia konfiguracji dozwolonej listy odbiorców, z których mają być weryfikowane token JWT.

AllowedPrincipals

Objekt

Ustawienia konfiguracji dozwolonych podmiotów zabezpieczeń usługi Azure Active Directory.

Nazwa	Typ	Opis
groups	string[]	Lista dozwolonych grup.
identities	string[]	Lista dozwolonych tożsamości.

Apple

Objekt

Ustawienia konfiguracji dostawcy firmy Apple.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca firmy Apple nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
login	LoginScopes	Ustawienia konfiguracji przepływu logowania.
registration	AppleRegistration	Ustawienia konfiguracji rejestracji firmy Apple.

AppleRegistration

Objekt

Ustawienia konfiguracji rejestracji dostawcy firmy Apple

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta aplikacji używanej do logowania.
clientSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca klucz tajny klienta.

AppRegistration

Objekt

Ustawienia konfiguracji rejestracji aplikacji dla dostawców, którzy mają identyfikatory aplikacji i wpisy tajne aplikacji

Nazwa	Typ	Opis
appId	string	Identyfikator aplikacji używany do logowania.
appSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca klucz tajny aplikacji.

AuthPlatform

Objekt

Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi App Service.

Nazwa	Typ	Opis
configFilePath	string	Ścieżka pliku konfiguracji zawierającego ustawienia uwierzytelniania, jeśli pochodzą z pliku. Jeśli ścieżka jest względna, baza będzie katalog główny lokacji.
enabled	boolean	true, jeśli dla bieżącej aplikacji jest włączona funkcja uwierzytelnianie/autoryzacja; w przeciwnym razie false.
runtimeVersion	string	RuntimeVersion funkcji uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie niektórych funkcji w module Uwierzytelnianie/autoryzacja.

AzureActiveDirectory

Objekt

Ustawienia konfiguracji dostawcy usługi Azure Active Directory.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca usługi Azure Active Directory nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
isAutoProvisioned	boolean	Pobiera wartość wskazującą, czy konfiguracja usługi Azure AD została automatycznie aprowizowana przy użyciu narzędzi testowych. Jest to flaga wewnętrzna przeznaczona głównie do obsługi portalu zarządzania Azure. Użytkownicy nie powinni odczytywać ani zapisywać w tej właściwości.
login	AzureActiveDirectoryLogin	Ustawienia konfiguracji przepływu logowania usługi Azure Active Directory.
registration	AzureActiveDirectoryRegistration	Ustawienia konfiguracji rejestracji aplikacji usługi Azure Active Directory.
validation	AzureActiveDirectoryValidation	Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory.

AzureActiveDirectoryLogin

Objekt

Ustawienia konfiguracji przepływu logowania usługi Azure Active Directory.

Nazwa	Typ	Opis
disableWWWAuthenticate	boolean	true, jeśli dostawca www-authentication powinien zostać pominięty w żądaniu; w przeciwnym razie false.
loginParameters	string[]	Parametry logowania wysyłane do punktu końcowego autoryzacji openID Connect podczas logowania użytkownika. Każdy parametr musi mieć postać "key=value".

AzureActiveDirectoryRegistration

Objekt

Ustawienia konfiguracji rejestracji aplikacji usługi Azure Active Directory.

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta tej aplikacji jednostki uzależnionej, znany jako client_id. To ustawienie jest wymagane do włączenia uwierzytelniania połączenia OpenID za pomocą usługi Azure Active Directory lub innych dostawców openID Connect innych firm. Więcej informacji na temat openID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Alternatywą dla odcisku palca wpisu tajnego klienta jest wystawca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zamiennik odcisku palca certyfikatu tajnego klienta. Jest również opcjonalny.
clientSecretCertificateSubjectAlternativeName	string	Alternatywą dla odcisku palca wpisu tajnego klienta jest alternatywna nazwa podmiotu certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zamiennik odcisku palca certyfikatu tajnego klienta. Jest również opcjonalny.
clientSecretCertificateThumbprint	string	Alternatywą dla klucza tajnego klienta jest odcisk palca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zamiennik klucza tajnego klienta. Jest również opcjonalny.
clientSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca klucz tajny klienta aplikacji jednostki uzależnionej.
openIdIssuer	string	Identyfikator URI wystawcy OpenID Connect reprezentujący jednostkę, która wystawia tokeny dostępu dla tej aplikacji. W przypadku korzystania z usługi Azure Active Directory ta wartość jest identyfikatorem URI dzierżawy katalogu, np. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Ten identyfikator URI jest identyfikatorem z uwzględnieniem wielkości liter dla wystawcy tokenu. Więcej informacji na temat odnajdywania OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Objekt

Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory.

Nazwa	Typ	Opis
allowedAudiences	string[]	Lista odbiorców, którzy mogą pomyślnie wysyłać żądania uwierzytelniania/autoryzacji.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Ustawienia konfiguracji domyślnych zasad autoryzacji.
jwtClaimChecks	JwtClaimChecks	Ustawienia konfiguracji kontroli, które należy wykonać podczas weryfikowania oświadczeń JWT.

AzureStaticWebApps

Objekt

Ustawienia konfiguracji dostawcy usługi Azure Static Web Apps.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca usługi Azure Static Web Apps nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
registration	AzureStaticWebAppsRegistration	Ustawienia konfiguracji rejestracji usługi Azure Static Web Apps.

AzureStaticWebAppsRegistration

Objekt

Ustawienia konfiguracji rejestracji dostawcy usługi Azure Static Web Apps

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta aplikacji używanej do logowania.

BlobStorageTokenStore

Objekt

Ustawienia konfiguracji magazynu tokenów, jeśli jest używany magazyn obiektów blob.

Nazwa	Typ	Opis
sasUrlSettingName	string	Nazwa ustawienia aplikacji zawierającego adres URL sygnatury dostępu współdzielonego magazynu obiektów blob zawierających tokeny.

ClientCredentialMethod

Wyliczanie

Metoda, która powinna służyć do uwierzytelniania użytkownika.

Wartość	Opis
ClientSecretPost

ClientRegistration

Objekt

Ustawienia konfiguracji rejestracji aplikacji dla dostawców, którzy mają identyfikatory klienta i wpisy tajne klienta

Nazwa	Typ	Opis
clientId	string	Identyfikator klienta aplikacji używanej do logowania.
clientSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca klucz tajny klienta.

CookieExpiration

Objekt

Ustawienia konfiguracji wygasania pliku cookie sesji.

Nazwa	Typ	Opis
convention	CookieExpirationConvention	Konwencja używana podczas określania wygaśnięcia pliku cookie sesji.
timeToExpiration	string	Czas po wysłaniu żądania po wygaśnięciu pliku cookie sesji.

CookieExpirationConvention

Wyliczanie

Konwencja używana podczas określania wygaśnięcia pliku cookie sesji.

Wartość	Opis
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Objekt

Ustawienia konfiguracji niestandardowego dostawcy programu Open ID Connect.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli niestandardowy dostawca open ID nie powinien być włączony; w przeciwnym razie true.
login	OpenIdConnectLogin	Ustawienia konfiguracji przepływu logowania niestandardowego dostawcy programu Open ID Connect.
registration	OpenIdConnectRegistration	Ustawienia konfiguracji rejestracji aplikacji dla niestandardowego dostawcy programu Open ID Connect.

DefaultAuthorizationPolicy

Objekt

Ustawienia konfiguracji domyślnych zasad autoryzacji usługi Azure Active Directory.

Nazwa	Typ	Opis
allowedApplications	string[]	Ustawienia konfiguracji dozwolonych aplikacji usługi Azure Active Directory.
allowedPrincipals	AllowedPrincipals	Ustawienia konfiguracji dozwolonych podmiotów zabezpieczeń usługi Azure Active Directory.

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Facebook

Objekt

Ustawienia konfiguracji dostawcy serwisu Facebook.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca serwisu Facebook nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
graphApiVersion	string	Wersja interfejsu API serwisu Facebook, która ma być używana podczas logowania.
login	LoginScopes	Ustawienia konfiguracji przepływu logowania.
registration	AppRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawcy serwisu Facebook.

FileSystemTokenStore

Objekt

Ustawienia konfiguracji magazynu tokenów, jeśli jest używany system plików.

Nazwa	Typ	Opis
directory	string	Katalog, w którym będą przechowywane tokeny.

ForwardProxy

Objekt

Ustawienia konfiguracji serwera proxy przesyłania dalej używane do tworzenia żądań.

Nazwa	Typ	Opis
convention	ForwardProxyConvention	Konwencja używana do określania adresu URL wykonanego żądania.
customHostHeaderName	string	Nazwa nagłówka zawierającego hosta żądania.
customProtoHeaderName	string	Nazwa nagłówka zawierającego schemat żądania.

ForwardProxyConvention

Wyliczanie

Konwencja używana do określania adresu URL wykonanego żądania.

Wartość	Opis
Custom
NoProxy
Standard

GitHub

Objekt

Ustawienia konfiguracji dostawcy GitHub.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca usługi GitHub nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
login	LoginScopes	Ustawienia konfiguracji przepływu logowania.
registration	ClientRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi GitHub.

GlobalValidation

Objekt

Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.

Nazwa	Typ	Opis
excludedPaths	string[]	Ścieżki, dla których nieuwierzytelniony przepływ nie zostanie przekierowany do strony logowania.
redirectToProvider	string	Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko wtedy, gdy skonfigurowano wielu dostawców i ustawiono nieuwierzytelnione działanie klienta na wartość "RedirectToLoginPage".
requireAuthentication	boolean	true, jeśli przepływ uwierzytelniania jest wymagany, wymagane jest każde żądanie; w przeciwnym razie false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.

Google

Objekt

Ustawienia konfiguracji dostawcy Google.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca Google nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
login	LoginScopes	Ustawienia konfiguracji przepływu logowania.
registration	ClientRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawcy Google.
validation	AllowedAudiencesValidation	Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory.

HttpSettings

Objekt

Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi App Service.

Nazwa	Typ	Opis
forwardProxy	ForwardProxy	Ustawienia konfiguracji serwera proxy przesyłania dalej używane do tworzenia żądań.
requireHttps	boolean	false, jeśli dopuszczalne są odpowiedzi uwierzytelniania/autoryzacji, które nie mają schematu HTTPS; w przeciwnym razie true.
routes	HttpSettingsRoutes	Ustawienia konfiguracji ścieżek żądania HTTP.

HttpSettingsRoutes

Objekt

Ustawienia konfiguracji ścieżek żądania HTTP.

Nazwa	Typ	Opis
apiPrefix	string	Prefiks, który powinien poprzedzać wszystkie ścieżki uwierzytelniania/autoryzacji.

IdentityProviders

Objekt

Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi App Service.

Nazwa	Typ	Opis
apple	Apple	Ustawienia konfiguracji dostawcy firmy Apple.
azureActiveDirectory	AzureActiveDirectory	Ustawienia konfiguracji dostawcy usługi Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	Ustawienia konfiguracji dostawcy usługi Azure Static Web Apps.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Mapa nazwy aliasu każdego niestandardowego dostawcy programu Open ID Connect z ustawieniami konfiguracji niestandardowego dostawcy programu Open ID Connect.
facebook	Facebook	Ustawienia konfiguracji dostawcy serwisu Facebook.
gitHub	GitHub	Ustawienia konfiguracji dostawcy GitHub.
google	Google	Ustawienia konfiguracji dostawcy Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Ustawienia konfiguracji starszego dostawcy kont Microsoft.
twitter	Twitter	Ustawienia konfiguracji dostawcy usługi Twitter.

JwtClaimChecks

Objekt

Ustawienia konfiguracji kontroli, które należy wykonać podczas weryfikowania oświadczeń JWT.

Nazwa	Typ	Opis
allowedClientApplications	string[]	Lista dozwolonych aplikacji klienckich.
allowedGroups	string[]	Lista dozwolonych grup.

LegacyMicrosoftAccount

Objekt

Ustawienia konfiguracji starszego dostawcy kont Microsoft.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli starszy dostawca kont Microsoft nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie true.
login	LoginScopes	Ustawienia konfiguracji przepływu logowania.
registration	ClientRegistration	Ustawienia konfiguracji rejestracji aplikacji dla starszego dostawcy kont Microsoft.
validation	AllowedAudiencesValidation	Ustawienia konfiguracji starszego przepływu weryfikacji tokenu dostawcy kont Microsoft.

Login

Objekt

Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.

Nazwa	Typ	Opis
allowedExternalRedirectUrls	string[]	Zewnętrzne adresy URL, do których można przekierować w ramach logowania lub wylogowywania się z aplikacji. Należy pamiętać, że część ciągu zapytania adresu URL jest ignorowana. Jest to zaawansowane ustawienie zwykle wymagane tylko przez zaplecza aplikacji ze Sklepu Windows. Należy pamiętać, że adresy URL w bieżącej domenie są zawsze niejawnie dozwolone.
cookieExpiration	CookieExpiration	Ustawienia konfiguracji wygasania pliku cookie sesji.
nonce	Nonce	Ustawienia konfiguracji nieużytego w przepływie logowania.
preserveUrlFragmentsForLogins	boolean	true, jeśli fragmenty żądania są zachowywane po wykonaniu żądania logowania; w przeciwnym razie false.
routes	LoginRoutes	Trasy określające punkty końcowe używane do logowania i wylogowyywania żądań.
tokenStore	TokenStore	Ustawienia konfiguracji magazynu tokenów.

LoginRoutes

Objekt

Trasy określające punkty końcowe używane do logowania i wylogowyywania żądań.

Nazwa	Typ	Opis
logoutEndpoint	string	Punkt końcowy, w którym powinno zostać wykonane żądanie wylogowania.

LoginScopes

Objekt

Ustawienia konfiguracji przepływu logowania, w tym zakresy, których należy zażądać.

Nazwa	Typ	Opis
scopes	string[]	Lista zakresów, których należy zażądać podczas uwierzytelniania.

Nonce

Objekt

Ustawienia konfiguracji nieużytego w przepływie logowania.

Nazwa	Typ	Opis
nonceExpirationInterval	string	Czas po wysłaniu żądania, kiedy element nie powinien wygasać.
validateNonce	boolean	false, jeśli element nie powinien być weryfikowany podczas kończenia przepływu logowania; w przeciwnym razie true.

OpenIdConnectClientCredential

Objekt

Poświadczenia klienta uwierzytelniania niestandardowego dostawcy programu Open ID Connect.

Nazwa	Typ	Opis
clientSecretSettingName	string	Ustawienie aplikacji zawierające wpis tajny klienta dla niestandardowego dostawcy programu Open ID Connect.
method	ClientCredentialMethod	Metoda, która powinna służyć do uwierzytelniania użytkownika.

OpenIdConnectConfig

Objekt

Ustawienia konfiguracji punktów końcowych używanych dla niestandardowego dostawcy programu Open ID Connect.

Nazwa	Typ	Opis
authorizationEndpoint	string	Punkt końcowy, który ma być używany do tworzenia żądania autoryzacji.
certificationUri	string	Punkt końcowy, który udostępnia klucze niezbędne do zweryfikowania tokenu.
issuer	string	Punkt końcowy, który wystawia token.
tokenEndpoint	string	Punkt końcowy, który ma być używany do żądania tokenu.
wellKnownOpenIdConfiguration	string	Punkt końcowy zawierający wszystkie punkty końcowe konfiguracji dostawcy.

OpenIdConnectLogin

Objekt

Ustawienia konfiguracji przepływu logowania niestandardowego dostawcy programu Open ID Connect.

Nazwa	Typ	Opis
nameClaimType	string	Nazwa oświadczenia zawierającego nazwę użytkowników.
scopes	string[]	Lista zakresów, których należy zażądać podczas uwierzytelniania.

OpenIdConnectRegistration

Objekt

Ustawienia konfiguracji rejestracji aplikacji dla niestandardowego dostawcy programu Open ID Connect.

Nazwa	Typ	Opis
clientCredential	OpenIdConnectClientCredential	Poświadczenia uwierzytelniania niestandardowego dostawcy open ID Connect.
clientId	string	Identyfikator klienta niestandardowego dostawcy programu Open ID Connect.
openIdConnectConfiguration	OpenIdConnectConfig	Ustawienia konfiguracji punktów końcowych używanych dla niestandardowego dostawcy programu Open ID Connect.

SiteAuthSettingsV2

Objekt

Ustawienia konfiguracji funkcji uwierzytelnianie/autoryzacja usługi Azure App Service w wersji 2.

Nazwa	Typ	Opis
id	string	Identyfikator zasobu.
kind	string	Rodzaj zasobu.
name	string	Nazwa zasobu.
properties.globalValidation	GlobalValidation	Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.
properties.httpSettings	HttpSettings	Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi App Service.
properties.identityProviders	IdentityProviders	Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi App Service.
properties.login	Login	Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi App Service.
properties.platform	AuthPlatform	Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi App Service.
type	string	Typ zasobu.

TokenStore

Objekt

Ustawienia konfiguracji magazynu tokenów.

Nazwa	Typ	Opis
azureBlobStorage	BlobStorageTokenStore	Ustawienia konfiguracji magazynu tokenów, jeśli jest używany magazyn obiektów blob.
enabled	boolean	true trwałe przechowywanie tokenów zabezpieczających specyficznych dla platformy, które są uzyskiwane podczas przepływów logowania; w przeciwnym razie false. Wartość domyślna to false.
fileSystem	FileSystemTokenStore	Ustawienia konfiguracji magazynu tokenów, jeśli jest używany system plików.
tokenRefreshExtensionHours	number (double)	Liczba godzin po wygaśnięciu tokenu sesji, za pomocą którego można wywołać interfejs API odświeżania tokenu. Wartość domyślna to 72 godziny.

Twitter

Objekt

Ustawienia konfiguracji dostawcy usługi Twitter.

Nazwa	Typ	Opis
enabled	boolean	false, jeśli dostawca usługi Twitter nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie true.
registration	TwitterRegistration	Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi Twitter.

TwitterRegistration

Objekt

Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi Twitter.

Nazwa	Typ	Opis
consumerKey	string	Klucz użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	Nazwa ustawienia aplikacji zawierająca wpis tajny użytkownika OAuth 1.0a aplikacji Twitter używany do logowania.

UnauthenticatedClientActionV2

Wyliczanie

Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji.

Wartość	Opis
AllowAnonymous
RedirectToLoginPage
Return401
Return403