你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Apps - Update Auth Settings V2

参考

服务:: App Service

API 版本:: 2024-04-01

通过 V2 格式更新网站的身份验证/授权设置的说明

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	Web 应用的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。正则表达式模式: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	Azure 订阅 ID。这是 GUID 格式的字符串（例如 000000000-0000-0000-0000-00000000000000）。
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

Azure Active Directory OAuth2 Flow

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Update Auth Settings V2

示例请求

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


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

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

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

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

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	具有应用 ID 和应用机密的提供程序的应用注册的配置设置
AuthPlatform	应用服务身份验证/授权平台的配置设置。
AzureActiveDirectory	Azure Active Directory 提供程序的配置设置。
AzureActiveDirectoryLogin	Azure Active Directory 登录流的配置设置。
AzureActiveDirectoryRegistration	Azure Active Directory 应用注册的配置设置。
AzureActiveDirectoryValidation	Azure Active Directory 令牌验证流的配置设置。
AzureStaticWebApps	Azure 静态 Web 应用提供程序的配置设置。
AzureStaticWebAppsRegistration	Azure Static Web Apps 提供程序注册的配置设置
BlobStorageTokenStore	如果使用 Blob 存储，则令牌存储的配置设置。
ClientCredentialMethod	应用于对用户进行身份验证的方法。
ClientRegistration	具有客户端 ID 和客户端机密的提供程序的应用注册的配置设置
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	旧版Microsoft帐户提供程序的配置设置。
Login	使用应用服务身份验证/授权的用户登录流的配置设置。
LoginRoutes	指定用于登录和注销请求的终结点的路由。
LoginScopes	登录流的配置设置，包括应请求的范围。
Nonce	登录流中使用的 nonce 的配置设置。
OpenIdConnectClientCredential	自定义 Open ID Connect 提供程序的身份验证客户端凭据。
OpenIdConnectConfig	用于自定义 Open ID Connect 提供程序的终结点的配置设置。
OpenIdConnectLogin	自定义 Open ID Connect 提供程序登录流的配置设置。
OpenIdConnectRegistration	自定义 Open ID Connect 提供程序的应用注册的配置设置。
SiteAuthSettingsV2	Azure 应用服务身份验证/授权 V2 功能的配置设置。
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	用于登录的应用的客户端 ID。
clientSecretSettingName	string	包含客户端密码的应用设置名称。

AppRegistration

Object

具有应用 ID 和应用机密的提供程序的应用注册的配置设置

名称	类型	说明
appId	string	用于登录的应用的应用 ID。
appSecretSettingName	string	包含应用机密的应用设置名称。

AuthPlatform

Object

应用服务身份验证/授权平台的配置设置。

名称	类型	说明
configFilePath	string	包含身份验证设置的配置文件的路径（如果它们来自文件）。如果路径是相对路径，则站点的根目录将为基目录。
enabled	boolean	如果为当前应用启用了身份验证/授权功能，则 `true`;否则，`false`。
runtimeVersion	string	用于当前应用的身份验证/授权功能的 RuntimeVersion。此值中的设置可以控制身份验证/授权模块中某些功能的行为。

AzureActiveDirectory

Object

Azure Active Directory 提供程序的配置设置。

名称	类型	说明
enabled	boolean	`false` 如果不应启用 Azure Active Directory 提供程序，尽管设置了注册;否则，`true`。
isAutoProvisioned	boolean	获取一个值，该值指示是否使用第一方工具自动预配 Azure AD 配置。这是一个内部标志，主要用于支持 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-authenticate 提供程序;否则，`false`。
loginParameters	string[]	用户登录时要发送到 OpenID Connect 授权终结点的登录参数。每个参数必须采用“key=value”格式。

AzureActiveDirectoryRegistration

Object

Azure Active Directory 应用注册的配置设置。

名称	类型	说明
clientId	string	此信赖方应用程序的客户端 ID，称为client_id。若要使用 Azure Active Directory 或其他第三方 OpenID Connect 提供程序启用 OpenID 连接身份验证，则需要此设置。有关 OpenID Connect 的详细信息：http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	客户端机密指纹的替代方法，它是用于签名的证书的颁发者。此属性充当客户端机密证书指纹的替代项。它也是可选的。
clientSecretCertificateSubjectAlternativeName	string	客户端机密指纹的替代方法，它是用于签名的证书的使用者可选名称。此属性充当客户端机密证书指纹的替代项。它也是可选的。
clientSecretCertificateThumbprint	string	客户端机密的替代方法，即用于签名的证书的指纹。此属性充当客户端机密的替代项。它也是可选的。
clientSecretSettingName	string	包含信赖方应用程序的客户端密码的应用设置名称。
openIdIssuer	string	OpenID Connect 颁发者 URI，表示颁发此应用程序的访问令牌的实体。使用 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 静态 Web 应用提供程序的配置设置。

名称	类型	说明
enabled	boolean	如果不应启用 Azure 静态 Web 应用提供程序（尽管设置了注册）;`false`;否则，`true`。
registration	AzureStaticWebAppsRegistration	Azure 静态 Web 应用注册的配置设置。

AzureStaticWebAppsRegistration

Object

Azure Static Web Apps 提供程序注册的配置设置

名称	类型	说明
clientId	string	用于登录的应用的客户端 ID。

BlobStorageTokenStore

Object

如果使用 Blob 存储，则令牌存储的配置设置。

名称	类型	说明
sasUrlSettingName	string	包含包含令牌的 Blob 存储的 SAS URL 的应用设置的名称。

ClientCredentialMethod

Enumeration

应用于对用户进行身份验证的方法。

值	说明
ClientSecretPost

ClientRegistration

Object

具有客户端 ID 和客户端机密的提供程序的应用注册的配置设置

名称	类型	说明
clientId	string	用于登录的应用的客户端 ID。
clientSecretSettingName	string	包含客户端密码的应用设置名称。

CookieExpiration

Object

会话 Cookie 过期的配置设置。

名称	类型	说明
convention	CookieExpirationConvention	确定会话 Cookie 过期时使用的约定。
timeToExpiration	string	发出请求后的时间，会话 Cookie 应过期。

CookieExpirationConvention

Enumeration

确定会话 Cookie 过期时使用的约定。

值	说明
FixedTime
IdentityProviderDerived

CustomOpenIdConnectProvider

Object

自定义 Open ID Connect 提供程序的配置设置。

名称	类型	说明
enabled	boolean	如果不应启用自定义 Open ID 提供程序提供程序，则 `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	登录时要使用的 Facebook API 版本。
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	如果允许身份验证/授权响应没有 HTTPS 方案，则 `false`;否则，`true`。
routes	HttpSettingsRoutes	路径 HTTP 请求的配置设置。

HttpSettingsRoutes

Object

路径 HTTP 请求的配置设置。

名称	类型	说明
apiPrefix	string	所有身份验证/授权路径前面的前缀。

IdentityProviders

Object

用于配置应用服务身份验证/授权的每个标识提供者的配置设置。

名称	类型	说明
apple	Apple	Apple 提供程序的配置设置。
azureActiveDirectory	AzureActiveDirectory	Azure Active Directory 提供程序的配置设置。
azureStaticWebApps	AzureStaticWebApps	Azure 静态 Web 应用提供程序的配置设置。
customOpenIdConnectProviders	<string, CustomOpenIdConnectProvider>	每个自定义 Open ID Connect 提供程序的别名的名称映射到自定义 Open ID Connect 提供程序的配置设置。
facebook	Facebook	Facebook 提供程序的配置设置。
gitHub	GitHub	GitHub 提供程序的配置设置。
google	Google	Google 提供程序的配置设置。
legacyMicrosoftAccount	LegacyMicrosoftAccount	旧版Microsoft帐户提供程序的配置设置。
twitter	Twitter	Twitter 提供程序的配置设置。

JwtClaimChecks

Object

验证 JWT 声明时应进行的检查的配置设置。

名称	类型	说明
allowedClientApplications	string[]	允许的客户端应用程序列表。
allowedGroups	string[]	允许的组的列表。

LegacyMicrosoftAccount

Object

旧版Microsoft帐户提供程序的配置设置。

名称	类型	说明
enabled	boolean	`false` 如果尽管设置了注册，但不应启用旧版Microsoft帐户提供程序;否则，`true`。
login	LoginScopes	登录流的配置设置。
registration	ClientRegistration	旧版Microsoft帐户提供程序的应用注册的配置设置。
validation	AllowedAudiencesValidation	旧版Microsoft帐户提供程序令牌验证流的配置设置。

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	发出请求后，nonce 应过期的时间。
validateNonce	boolean	如果完成登录流时不应验证 nonce，则 `false`;否则，`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 提供程序的客户端 ID。
openIdConnectConfiguration	OpenIdConnectConfig	用于自定义 Open ID Connect 提供程序的终结点的配置设置。

SiteAuthSettingsV2

Object

Azure 应用服务身份验证/授权 V2 功能的配置设置。

名称	类型	说明
id	string	资源 ID。
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	如果尽管设置了注册，但不应启用 Twitter 提供程序，则 `false`;否则，`true`。
registration	TwitterRegistration	Twitter 提供程序的应用注册的配置设置。

TwitterRegistration

Object

Twitter 提供程序的应用注册的配置设置。

名称	类型	说明
consumerKey	string	用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者密钥。启用 Twitter 登录需要此设置。 Twitter Sign-In 文档：https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	包含用于登录的 Twitter 应用程序的 OAuth 1.0a 使用者机密的应用设置名称。

UnauthenticatedClientActionV2

Enumeration

未经身份验证的客户端尝试访问应用时要执行的作。

值	说明
AllowAnonymous
RedirectToLoginPage
Return401
Return403