Web Apps - Update Auth Settings V2

Служба:

App Service

Версия API:

2024-04-01

Описание параметров проверки подлинности и авторизации сайта обновлений для приложений с помощью формата версии 2

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
name	path	True	string	Имя веб-приложения.
resourceGroupName	path	True	string	Имя группы ресурсов, к которой принадлежит ресурс. Шаблон регулярного выражения: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Идентификатор подписки Azure. Это строка с форматом GUID (например, 0000000000-0000-0000-0000-00000000000000000000000000000).
api-version	query	True	string	Версия API

Текст запроса

Имя	Тип	Описание
kind	string	Тип ресурса.
properties.globalValidation	GlobalValidation	Параметры конфигурации, определяющие поток проверки пользователей с помощью проверки подлинности и авторизации службы приложений.
properties.httpSettings	HttpSettings	Параметры конфигурации HTTP-запросов для проверки подлинности и авторизации, сделанных в отношении проверки подлинности и авторизации службы приложений.
properties.identityProviders	IdentityProviders	Параметры конфигурации каждого из поставщиков удостоверений, используемых для настройки проверки подлинности и авторизации службы приложений.
properties.login	Login	Параметры конфигурации потока входа пользователей с помощью проверки подлинности и авторизации службы приложений.
properties.platform	AuthPlatform	Параметры конфигурации платформы проверки подлинности и авторизации службы приложений.

Ответы

Имя	Тип	Описание
200 OK	SiteAuthSettingsV2	ХОРОШО
Other Status Codes	DefaultErrorResponse	Ответ об ошибке службы приложений.

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Update Auth Settings V2

Образец запроса

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

Пример ответа

Код состояния:

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

Определения

Имя	Описание
AllowedAudiencesValidation	Параметры конфигурации потока проверки разрешенных аудиторий.
AllowedPrincipals	Параметры конфигурации разрешенных субъектов Azure Active Directory.
Apple	Параметры конфигурации поставщика Apple.
AppleRegistration	Параметры конфигурации регистрации для поставщика Apple
AppRegistration	Параметры конфигурации регистрации приложения для поставщиков с идентификаторами приложений и секретами приложений
AuthPlatform	Параметры конфигурации платформы проверки подлинности и авторизации службы приложений.
AzureActiveDirectory	Параметры конфигурации поставщика Azure Active Directory.
AzureActiveDirectoryLogin	Параметры конфигурации потока входа Azure Active Directory.
AzureActiveDirectoryRegistration	Параметры конфигурации регистрации приложения Azure Active Directory.
AzureActiveDirectoryValidation	Параметры конфигурации потока проверки маркеров Azure Active Directory.
AzureStaticWebApps	Параметры конфигурации поставщика статических веб-приложений Azure.
AzureStaticWebAppsRegistration	Параметры конфигурации регистрации для поставщика статических веб-приложений Azure
BlobStorageTokenStore	Параметры конфигурации хранилища маркеров, если используется хранилище BLOB-объектов.
ClientCredentialMethod	Метод, который следует использовать для проверки подлинности пользователя.
ClientRegistration	Параметры конфигурации регистрации приложения для поставщиков с идентификаторами клиента и секретами клиента
CookieExpiration	Параметры конфигурации срока действия файла cookie сеанса.
CookieExpirationConvention	Соглашение, используемое при определении срока действия файла cookie сеанса.
CustomOpenIdConnectProvider	Параметры конфигурации настраиваемого поставщика Open ID Connect.
DefaultAuthorizationPolicy	Параметры конфигурации политики авторизации Azure Active Directory по умолчанию.
DefaultErrorResponse	Ответ об ошибке службы приложений.
Details
Error	Модель ошибок.
Facebook	Параметры конфигурации поставщика Facebook.
FileSystemTokenStore	Параметры конфигурации хранилища маркеров, если используется файловая система.
ForwardProxy	Параметры конфигурации прокси-сервера пересылки, используемые для выполнения запросов.
ForwardProxyConvention	Соглашение, используемое для определения URL-адреса выполненного запроса.
GitHub	Параметры конфигурации поставщика GitHub.
GlobalValidation	Параметры конфигурации, определяющие поток проверки пользователей с помощью проверки подлинности и авторизации службы приложений.
Google	Параметры конфигурации поставщика Google.
HttpSettings	Параметры конфигурации HTTP-запросов для проверки подлинности и авторизации, сделанных в отношении проверки подлинности и авторизации службы приложений.
HttpSettingsRoutes	Параметры конфигурации путей HTTP-запросов.
IdentityProviders	Параметры конфигурации каждого из поставщиков удостоверений, используемых для настройки проверки подлинности и авторизации службы приложений.
JwtClaimChecks	Параметры конфигурации проверок, которые необходимо выполнить при проверке утверждений JWT.
LegacyMicrosoftAccount	Параметры конфигурации устаревшего поставщика учетных записей Майкрософт.
Login	Параметры конфигурации потока входа пользователей с помощью проверки подлинности и авторизации службы приложений.
LoginRoutes	Маршруты, указывающие конечные точки, используемые для запросов входа и выхода.
LoginScopes	Параметры конфигурации потока входа, включая области, которые должны быть запрошены.
Nonce	Параметры конфигурации nonce, используемые в потоке входа.
OpenIdConnectClientCredential	Учетные данные клиента проверки подлинности настраиваемого поставщика Open ID Connect.
OpenIdConnectConfig	Параметры конфигурации конечных точек, используемых для пользовательского поставщика Open ID Connect.
OpenIdConnectLogin	Параметры конфигурации потока входа пользовательского поставщика Open ID Connect.
OpenIdConnectRegistration	Параметры конфигурации регистрации приложения для пользовательского поставщика Open ID Connect.
SiteAuthSettingsV2	Параметры конфигурации для функции проверки подлинности и авторизации службы приложений Azure версии 2.
TokenStore	Параметры конфигурации хранилища маркеров.
Twitter	Параметры конфигурации поставщика Twitter.
TwitterRegistration	Параметры конфигурации регистрации приложения для поставщика Twitter.
UnauthenticatedClientActionV2	Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению.

AllowedAudiencesValidation

Object

Параметры конфигурации потока проверки разрешенных аудиторий.

Имя	Тип	Описание
allowedAudiences	string[]	Параметры конфигурации разрешенного списка аудиторий, из которых необходимо проверить токен JWT.

AllowedPrincipals

Object

Параметры конфигурации разрешенных субъектов Azure Active Directory.

Имя	Тип	Описание
groups	string[]	Список разрешенных групп.
identities	string[]	Список разрешенных удостоверений.

Apple

Object

Параметры конфигурации поставщика Apple.

Имя	Тип	Описание
enabled	boolean	false, если поставщик Apple не должен быть включен, несмотря на регистрацию набора; в противном случае true.
login	LoginScopes	Параметры конфигурации потока входа.
registration	AppleRegistration	Параметры конфигурации регистрации Apple.

AppleRegistration

Object

Параметры конфигурации регистрации для поставщика Apple

Имя	Тип	Описание
clientId	string	Идентификатор клиента приложения, используемого для входа.
clientSecretSettingName	string	Имя параметра приложения, содержащее секрет клиента.

AppRegistration

Object

Параметры конфигурации регистрации приложения для поставщиков с идентификаторами приложений и секретами приложений

Имя	Тип	Описание
appId	string	Идентификатор приложения, используемого для входа.
appSecretSettingName	string	Имя параметра приложения, содержащее секрет приложения.

AuthPlatform

Object

Параметры конфигурации платформы проверки подлинности и авторизации службы приложений.

Имя	Тип	Описание
configFilePath	string	Путь файла конфигурации, содержащего параметры проверки подлинности, если они приходят из файла. Если путь является относительным, база будет корневой каталог сайта.
enabled	boolean	true, если функция проверки подлинности и авторизации включена для текущего приложения; в противном случае false.
runtimeVersion	string	Среда выполнения функции проверки подлинности и авторизации, используемая для текущего приложения. Параметр в этом значении может управлять поведением определенных функций в модуле проверки подлинности и авторизации.

AzureActiveDirectory

Object

Параметры конфигурации поставщика Azure Active Directory.

Имя	Тип	Описание
enabled	boolean	false, если поставщик Azure Active Directory не должен быть включен, несмотря на регистрацию набора; в противном случае true.
isAutoProvisioned	boolean	Возвращает значение, указывающее, была ли конфигурация Azure AD подготовлена автоматически с помощью 1-го стороннего инструмента. Это внутренний флаг, в первую очередь предназначенный для поддержки портала управления Azure. Пользователи не должны читать или записывать данные в это свойство.
login	AzureActiveDirectoryLogin	Параметры конфигурации потока входа Azure Active Directory.
registration	AzureActiveDirectoryRegistration	Параметры конфигурации регистрации приложения Azure Active Directory.
validation	AzureActiveDirectoryValidation	Параметры конфигурации потока проверки маркеров Azure Active Directory.

AzureActiveDirectoryLogin

Object

Параметры конфигурации потока входа Azure Active Directory.

Имя	Тип	Описание
disableWWWAuthenticate	boolean	true, если поставщик www-authentication должен быть опущен из запроса; в противном случае false.
loginParameters	string[]	Параметры входа для отправки в конечную точку авторизации OpenID Connect при входе пользователя. Каждый параметр должен находиться в форме "key=value".

AzureActiveDirectoryRegistration

Object

Параметры конфигурации регистрации приложения Azure Active Directory.

Имя	Тип	Описание
clientId	string	Идентификатор клиента этого проверяющего приложения, известного как client_id. Этот параметр необходим для включения проверки подлинности подключения OpenID с Помощью Azure Active Directory или других сторонних поставщиков OpenID Connect. Дополнительные сведения о OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Альтернатива отпечатку секрета клиента, которая является издателем сертификата, используемого для подписывания. Это свойство выступает в качестве замены отпечатка сертификата секрета клиента. Это также необязательно.
clientSecretCertificateSubjectAlternativeName	string	Альтернатива отпечатку секрета клиента, которая является альтернативным именем сертификата, используемого для подписывания. Это свойство выступает в качестве замены отпечатка сертификата секрета клиента. Это также необязательно.
clientSecretCertificateThumbprint	string	Альтернатива секрету клиента— отпечаток сертификата, используемого для подписывания. Это свойство выступает в качестве замены секрета клиента. Это также необязательно.
clientSecretSettingName	string	Имя параметра приложения, содержащее секрет клиента приложения проверяющей стороны.
openIdIssuer	string	URI издателя OpenID Connect, представляющий сущность, которая выдает маркеры доступа для этого приложения. При использовании Azure Active Directory это значение является универсальным кодом ресурса (URI) клиента каталога, например https://login.microsoftonline.com/v2.0/{tenant-guid}/. Этот универсальный код ресурса (URI) — это идентификатор, чувствительный к регистру для издателя маркеров. Дополнительные сведения об обнаружении OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Object

Параметры конфигурации потока проверки маркеров Azure Active Directory.

Имя	Тип	Описание
allowedAudiences	string[]	Список аудиторий, которые могут выполнять успешные запросы проверки подлинности и авторизации.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	Параметры конфигурации политики авторизации по умолчанию.
jwtClaimChecks	JwtClaimChecks	Параметры конфигурации проверок, которые необходимо выполнить при проверке утверждений JWT.

AzureStaticWebApps

Object

Параметры конфигурации поставщика статических веб-приложений Azure.

Имя	Тип	Описание
enabled	boolean	false, если поставщик статических веб-приложений Azure не должен быть включен, несмотря на регистрацию набора; в противном случае true.
registration	AzureStaticWebAppsRegistration	Параметры конфигурации регистрации статических веб-приложений Azure.

AzureStaticWebAppsRegistration

Object

Параметры конфигурации регистрации для поставщика статических веб-приложений Azure

Имя	Тип	Описание
clientId	string	Идентификатор клиента приложения, используемого для входа.

BlobStorageTokenStore

Object

Параметры конфигурации хранилища маркеров, если используется хранилище BLOB-объектов.

Имя	Тип	Описание
sasUrlSettingName	string	Имя параметра приложения, содержащего URL-адрес SAS хранилища BLOB-объектов, содержащего маркеры.

ClientCredentialMethod

Enumeration

Метод, который следует использовать для проверки подлинности пользователя.

Значение	Описание
ClientSecretPost

ClientRegistration

Object

Параметры конфигурации регистрации приложения для поставщиков с идентификаторами клиента и секретами клиента

Имя	Тип	Описание
clientId	string	Идентификатор клиента приложения, используемого для входа.
clientSecretSettingName	string	Имя параметра приложения, содержащее секрет клиента.

CookieExpiration

Object

Параметры конфигурации срока действия файла cookie сеанса.

Имя	Тип	Описание
convention	CookieExpirationConvention	Соглашение, используемое при определении срока действия файла cookie сеанса.
timeToExpiration	string	Время после выполнения запроса при истечении срока действия файла cookie сеанса.

CookieExpirationConvention

Enumeration

Соглашение, используемое при определении срока действия файла cookie сеанса.

Значение	Описание
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

Параметры конфигурации настраиваемого поставщика Open ID Connect.

Имя	Тип	Описание
enabled	boolean	false, если не следует включить настраиваемый поставщик поставщиков открытых идентификаторов; в противном случае true.
login	OpenIdConnectLogin	Параметры конфигурации потока входа пользовательского поставщика Open ID Connect.
registration	OpenIdConnectRegistration	Параметры конфигурации регистрации приложения для пользовательского поставщика Open ID Connect.

DefaultAuthorizationPolicy

Object

Параметры конфигурации политики авторизации Azure Active Directory по умолчанию.

Имя	Тип	Описание
allowedApplications	string[]	Параметры конфигурации разрешенных приложений Azure Active Directory.
allowedPrincipals	AllowedPrincipals	Параметры конфигурации разрешенных субъектов Azure Active Directory.

DefaultErrorResponse

Object

Ответ об ошибке службы приложений.

Имя	Тип	Описание
error	Error	Модель ошибок.

Details

Object

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

Error

Object

Модель ошибок.

Имя	Тип	Описание
code	string	Стандартизованная строка для программной идентификации ошибки.
details	Details[]	Подробные ошибки.
innererror	string	Дополнительные сведения об ошибке отладки.
message	string	Подробные сведения об ошибке и сведения об отладке.
target	string	Подробные сведения об ошибке и сведения об отладке.

Facebook

Object

Параметры конфигурации поставщика Facebook.

Имя	Тип	Описание
enabled	boolean	false, если поставщик Facebook не должен быть включен, несмотря на регистрацию набора; в противном случае true.
graphApiVersion	string	Версия API Facebook, которую следует использовать при входе.
login	LoginScopes	Параметры конфигурации потока входа.
registration	AppRegistration	Параметры конфигурации регистрации приложения для поставщика Facebook.

FileSystemTokenStore

Object

Параметры конфигурации хранилища маркеров, если используется файловая система.

Имя	Тип	Описание
directory	string	Каталог, в котором будут храниться маркеры.

ForwardProxy

Object

Параметры конфигурации прокси-сервера пересылки, используемые для выполнения запросов.

Имя	Тип	Описание
convention	ForwardProxyConvention	Соглашение, используемое для определения URL-адреса выполненного запроса.
customHostHeaderName	string	Имя заголовка, содержащего узел запроса.
customProtoHeaderName	string	Имя заголовка, содержащего схему запроса.

ForwardProxyConvention

Enumeration

Соглашение, используемое для определения URL-адреса выполненного запроса.

Значение	Описание
Custom
NoProxy
Standard

GitHub

Object

Параметры конфигурации поставщика GitHub.

Имя	Тип	Описание
enabled	boolean	false, если поставщик GitHub не должен быть включен, несмотря на регистрацию набора; в противном случае true.
login	LoginScopes	Параметры конфигурации потока входа.
registration	ClientRegistration	Параметры конфигурации регистрации приложения для поставщика GitHub.

GlobalValidation

Object

Параметры конфигурации, определяющие поток проверки пользователей с помощью проверки подлинности и авторизации службы приложений.

Имя	Тип	Описание
excludedPaths	string[]	Пути, для которых не будет перенаправлен поток без проверки подлинности, не будут перенаправлены на страницу входа.
redirectToProvider	string	Поставщик проверки подлинности по умолчанию, используемый при настройке нескольких поставщиков. Этот параметр необходим только в том случае, если настроено несколько поставщиков, а для действия клиента, не прошедших проверку подлинности, задано значение RedirectToLoginPage.
requireAuthentication	boolean	true, если поток проверки подлинности требуется любой запрос; в противном случае false.
unauthenticatedClientAction	UnauthenticatedClientActionV2	Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению.

Google

Object

Параметры конфигурации поставщика Google.

Имя	Тип	Описание
enabled	boolean	false, если поставщик Google не должен быть включен, несмотря на регистрацию набора; в противном случае true.
login	LoginScopes	Параметры конфигурации потока входа.
registration	ClientRegistration	Параметры конфигурации регистрации приложения для поставщика Google.
validation	AllowedAudiencesValidation	Параметры конфигурации потока проверки маркеров Azure Active Directory.

HttpSettings

Object

Параметры конфигурации HTTP-запросов для проверки подлинности и авторизации, сделанных в отношении проверки подлинности и авторизации службы приложений.

Имя	Тип	Описание
forwardProxy	ForwardProxy	Параметры конфигурации прокси-сервера пересылки, используемые для выполнения запросов.
requireHttps	boolean	false, если ответы проверки подлинности и авторизации, не имеющие схемы HTTPS, допустимы; в противном случае true.
routes	HttpSettingsRoutes	Параметры конфигурации путей HTTP-запросов.

HttpSettingsRoutes

Object

Параметры конфигурации путей HTTP-запросов.

Имя	Тип	Описание
apiPrefix	string	Префикс, который должен предшествовать всем путям проверки подлинности и авторизации.

IdentityProviders

Object

Параметры конфигурации каждого из поставщиков удостоверений, используемых для настройки проверки подлинности и авторизации службы приложений.

Имя	Тип	Описание
apple	Apple	Параметры конфигурации поставщика Apple.
azureActiveDirectory	AzureActiveDirectory	Параметры конфигурации поставщика Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	Параметры конфигурации поставщика статических веб-приложений Azure.
customOpenIdConnectProviders	<string,  CustomOpenIdConnectProvider>	Карта имени псевдонима каждого настраиваемого поставщика Open ID Connect с параметрами конфигурации настраиваемого поставщика Open ID Connect.
facebook	Facebook	Параметры конфигурации поставщика Facebook.
gitHub	GitHub	Параметры конфигурации поставщика GitHub.
google	Google	Параметры конфигурации поставщика Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	Параметры конфигурации устаревшего поставщика учетных записей Майкрософт.
twitter	Twitter	Параметры конфигурации поставщика Twitter.

JwtClaimChecks

Object

Параметры конфигурации проверок, которые необходимо выполнить при проверке утверждений JWT.

Имя	Тип	Описание
allowedClientApplications	string[]	Список разрешенных клиентских приложений.
allowedGroups	string[]	Список разрешенных групп.

LegacyMicrosoftAccount

Object

Параметры конфигурации устаревшего поставщика учетных записей Майкрософт.

Имя	Тип	Описание
enabled	boolean	false, если устаревший поставщик учетной записи Майкрософт не должен быть включен, несмотря на регистрацию набора; в противном случае true.
login	LoginScopes	Параметры конфигурации потока входа.
registration	ClientRegistration	Параметры конфигурации регистрации приложения для устаревшего поставщика учетных записей Майкрософт.
validation	AllowedAudiencesValidation	Параметры конфигурации устаревшего потока проверки маркеров поставщика учетных записей Майкрософт.

Login

Object

Параметры конфигурации потока входа пользователей с помощью проверки подлинности и авторизации службы приложений.

Имя	Тип	Описание
allowedExternalRedirectUrls	string[]	Внешние URL-адреса, которые можно перенаправить в рамках входа или выхода из приложения. Обратите внимание, что часть строки запроса URL-адреса игнорируется. Это расширенный параметр, который обычно требуется только серверной части приложения Магазина Windows. Обратите внимание, что URL-адреса в текущем домене всегда неявно разрешены.
cookieExpiration	CookieExpiration	Параметры конфигурации срока действия файла cookie сеанса.
nonce	Nonce	Параметры конфигурации nonce, используемые в потоке входа.
preserveUrlFragmentsForLogins	boolean	true, если фрагменты из запроса сохраняются после выполнения запроса на вход; в противном случае false.
routes	LoginRoutes	Маршруты, указывающие конечные точки, используемые для запросов входа и выхода.
tokenStore	TokenStore	Параметры конфигурации хранилища маркеров.

LoginRoutes

Object

Маршруты, указывающие конечные точки, используемые для запросов входа и выхода.

Имя	Тип	Описание
logoutEndpoint	string	Конечная точка, с которой должен выполняться запрос на выход.

LoginScopes

Object

Параметры конфигурации потока входа, включая области, которые должны быть запрошены.

Имя	Тип	Описание
scopes	string[]	Список областей, которые следует запрашивать при проверке подлинности.

Nonce

Object

Параметры конфигурации nonce, используемые в потоке входа.

Имя	Тип	Описание
nonceExpirationInterval	string	Время после выполнения запроса при истечении срока действия неисключаемого действия.
validateNonce	boolean	false, если не следует проверять значение nonce при завершении потока входа; в противном случае true.

OpenIdConnectClientCredential

Object

Учетные данные клиента проверки подлинности настраиваемого поставщика Open ID Connect.

Имя	Тип	Описание
clientSecretSettingName	string	Параметр приложения, содержащий секрет клиента для пользовательского поставщика Open ID Connect.
method	ClientCredentialMethod	Метод, который следует использовать для проверки подлинности пользователя.

OpenIdConnectConfig

Object

Параметры конфигурации конечных точек, используемых для пользовательского поставщика Open ID Connect.

Имя	Тип	Описание
authorizationEndpoint	string	Конечная точка, используемая для выполнения запроса авторизации.
certificationUri	string	Конечная точка, предоставляющая ключи, необходимые для проверки маркера.
issuer	string	Конечная точка, которая выдает маркер.
tokenEndpoint	string	Конечная точка, используемая для запроса маркера.
wellKnownOpenIdConfiguration	string	Конечная точка, содержащая все конечные точки конфигурации для поставщика.

OpenIdConnectLogin

Object

Параметры конфигурации потока входа пользовательского поставщика Open ID Connect.

Имя	Тип	Описание
nameClaimType	string	Имя утверждения, содержащего имя пользователя.
scopes	string[]	Список областей, которые следует запрашивать при проверке подлинности.

OpenIdConnectRegistration

Object

Параметры конфигурации регистрации приложения для пользовательского поставщика Open ID Connect.

Имя	Тип	Описание
clientCredential	OpenIdConnectClientCredential	Учетные данные проверки подлинности настраиваемого поставщика Open ID Connect.
clientId	string	Идентификатор клиента настраиваемого поставщика Open ID Connect.
openIdConnectConfiguration	OpenIdConnectConfig	Параметры конфигурации конечных точек, используемых для пользовательского поставщика Open ID Connect.

SiteAuthSettingsV2

Object

Параметры конфигурации для функции проверки подлинности и авторизации службы приложений Azure версии 2.

Имя	Тип	Описание
id	string	Идентификатор ресурса.
kind	string	Тип ресурса.
name	string	Имя ресурса.
properties.globalValidation	GlobalValidation	Параметры конфигурации, определяющие поток проверки пользователей с помощью проверки подлинности и авторизации службы приложений.
properties.httpSettings	HttpSettings	Параметры конфигурации HTTP-запросов для проверки подлинности и авторизации, сделанных в отношении проверки подлинности и авторизации службы приложений.
properties.identityProviders	IdentityProviders	Параметры конфигурации каждого из поставщиков удостоверений, используемых для настройки проверки подлинности и авторизации службы приложений.
properties.login	Login	Параметры конфигурации потока входа пользователей с помощью проверки подлинности и авторизации службы приложений.
properties.platform	AuthPlatform	Параметры конфигурации платформы проверки подлинности и авторизации службы приложений.
type	string	Тип ресурса.

TokenStore

Object

Параметры конфигурации хранилища маркеров.

Имя	Тип	Описание
azureBlobStorage	BlobStorageTokenStore	Параметры конфигурации хранилища маркеров, если используется хранилище BLOB-объектов.
enabled	boolean	true для безопасного хранения маркеров безопасности для конкретной платформы, полученных во время потоков входа; в противном случае false. Значение по умолчанию — false.
fileSystem	FileSystemTokenStore	Параметры конфигурации хранилища маркеров, если используется файловая система.
tokenRefreshExtensionHours	number	Количество часов после истечения срока действия маркера сеанса, которое можно использовать для вызова API обновления маркера. Значение по умолчанию — 72 часа.

Twitter

Object

Параметры конфигурации поставщика Twitter.

Имя	Тип	Описание
enabled	boolean	false, если поставщик Twitter не должен быть включен, несмотря на регистрацию набора; в противном случае true.
registration	TwitterRegistration	Параметры конфигурации регистрации приложения для поставщика Twitter.

TwitterRegistration

Object

Параметры конфигурации регистрации приложения для поставщика Twitter.

Имя	Тип	Описание
consumerKey	string	Ключ потребителя OAuth 1.0a приложения Twitter, используемого для входа. Этот параметр необходим для включения входа в Twitter. Документация Sign-In Twitter: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	Имя параметра приложения, содержащее секрет потребителя OAuth 1.0a приложения Twitter, используемого для входа.

UnauthenticatedClientActionV2

Enumeration

Действие, которое необходимо предпринять, когда клиент, не прошедший проверку подлинности, пытается получить доступ к приложению.

Значение	Описание
AllowAnonymous
RedirectToLoginPage
Return401
Return403