Web Apps - Get Auth Settings V2

Referência

Serviço:: App Service

Versão da API:: 2023-12-01

Descrição das definições de Autenticação/Autorização do site gets para aplicações através do formato V2

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list?api-version=2023-12-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
name	path	True	string	Nome da aplicação.
resourceGroupName	path	True	string	Nome do grupo de recursos ao qual o recurso pertence. Padrão Regex: `^[-\w\._\(\)]+[^\.]$`
subscriptionId	path	True	string	O seu ID de subscrição do Azure. Esta é uma cadeia formatada por GUID (por exemplo, 0000000000-0000-0000-0000-00000000000000).
api-version	query	True	string	Versão da API

Respostas

Name	Tipo	Description
200 OK	SiteAuthSettingsV2	OK
Other Status Codes	DefaultErrorResponse	Serviço de Aplicações resposta de erro.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

List Auth Settings V2

Pedido de amostra

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


/**
 * Samples for WebApps GetAuthSettingsV2.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettingsV2.json
     */
    /**
     * Sample code: List Auth Settings V2.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listAuthSettingsV2(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().getAuthSettingsV2WithResponse("testrg123", "sitef6141",
            com.azure.core.util.Context.NONE);
    }
}

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

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python list_auth_settings_v2.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.get_auth_settings_v2(
        resource_group_name="testrg123",
        name="sitef6141",
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettingsV2.json
if __name__ == "__main__":
    main()

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

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/21c2852d62ccc3abe9cc3800c989c6826f8363dc/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettingsV2.json
func ExampleWebAppsClient_GetAuthSettingsV2() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().GetAuthSettingsV2(ctx, "testrg123", "sitef6141", nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SiteAuthSettingsV2 = armappservice.SiteAuthSettingsV2{
	// 	Name: to.Ptr("authsettingsv2"),
	// 	Type: to.Ptr("Microsoft.Web/sites/authsettingsv2"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsv2"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteAuthSettingsV2Properties{
	// 		GlobalValidation: &armappservice.GlobalValidation{
	// 			ExcludedPaths: []*string{
	// 				to.Ptr("/nosecrets/Path")},
	// 				RequireAuthentication: to.Ptr(true),
	// 				UnauthenticatedClientAction: to.Ptr(armappservice.UnauthenticatedClientActionV2Return403),
	// 			},
	// 			HTTPSettings: &armappservice.HTTPSettings{
	// 				ForwardProxy: &armappservice.ForwardProxy{
	// 					Convention: to.Ptr(armappservice.ForwardProxyConventionStandard),
	// 					CustomHostHeaderName: to.Ptr("authHeader"),
	// 					CustomProtoHeaderName: to.Ptr("customProtoHeader"),
	// 				},
	// 				RequireHTTPS: to.Ptr(true),
	// 				Routes: &armappservice.HTTPSettingsRoutes{
	// 					APIPrefix: to.Ptr("/authv2/"),
	// 				},
	// 			},
	// 			IdentityProviders: &armappservice.IdentityProviders{
	// 				Google: &armappservice.Google{
	// 					Enabled: to.Ptr(true),
	// 					Login: &armappservice.LoginScopes{
	// 						Scopes: []*string{
	// 							to.Ptr("admin")},
	// 						},
	// 						Registration: &armappservice.ClientRegistration{
	// 							ClientID: to.Ptr("42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"),
	// 							ClientSecretSettingName: to.Ptr("ClientSecret"),
	// 						},
	// 						Validation: &armappservice.AllowedAudiencesValidation{
	// 							AllowedAudiences: []*string{
	// 								to.Ptr("https://example.com")},
	// 							},
	// 						},
	// 					},
	// 					Login: &armappservice.Login{
	// 						AllowedExternalRedirectUrls: []*string{
	// 							to.Ptr("https://someurl.com")},
	// 							CookieExpiration: &armappservice.CookieExpiration{
	// 								Convention: to.Ptr(armappservice.CookieExpirationConventionIdentityProviderDerived),
	// 								TimeToExpiration: to.Ptr("2022:09-01T00:00Z"),
	// 							},
	// 							Nonce: &armappservice.Nonce{
	// 								ValidateNonce: to.Ptr(true),
	// 							},
	// 							PreserveURLFragmentsForLogins: to.Ptr(true),
	// 							Routes: &armappservice.LoginRoutes{
	// 								LogoutEndpoint: to.Ptr("https://app.com/logout"),
	// 							},
	// 							TokenStore: &armappservice.TokenStore{
	// 								Enabled: to.Ptr(true),
	// 								FileSystem: &armappservice.FileSystemTokenStore{
	// 									Directory: to.Ptr("/wwwroot/sites/example"),
	// 								},
	// 								TokenRefreshExtensionHours: to.Ptr[float64](96),
	// 							},
	// 						},
	// 						Platform: &armappservice.AuthPlatform{
	// 							ConfigFilePath: to.Ptr("/auth/config.json"),
	// 							Enabled: to.Ptr(true),
	// 							RuntimeVersion: to.Ptr("~1"),
	// 						},
	// 					},
	// 				}
}

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

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

/**
 * This sample demonstrates how to Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 *
 * @summary Description for Gets site's Authentication / Authorization settings for apps via the V2 format
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/ListAuthSettingsV2.json
 */
async function listAuthSettingsV2() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.getAuthSettingsV2(resourceGroupName, name);
  console.log(result);
}

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

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/2023-12-01/examples/ListAuthSettingsV2.json
// this example is just showing the usage of "WebApps_GetAuthSettingsV2" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);

// invoke the operation
SiteAuthSettingsV2 result = await webSite.GetAuthSettingsV2Async();

Console.WriteLine($"Succeeded: {result}");

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

Resposta da amostra

Código de estado:: 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"
      }
    }
  }
}

Definições

Name	Description
AllowedAudiencesValidation	As definições de configuração do fluxo de validação Audiências Permitidas.
AllowedPrincipals	As definições de configuração dos principais permitidos do Azure Active Directory.
Apple	As definições de configuração do fornecedor Apple.
AppleRegistration	As definições de configuração do registo do fornecedor Apple
AppRegistration	As definições de configuração do registo de aplicações para fornecedores com IDs de aplicações e segredos de aplicações
AuthPlatform	As definições de configuração da plataforma do Serviço de Aplicações Autenticação/Autorização.
AzureActiveDirectory	As definições de configuração do fornecedor do Azure Active Directory.
AzureActiveDirectoryLogin	As definições de configuração do fluxo de início de sessão do Azure Active Directory.
AzureActiveDirectoryRegistration	As definições de configuração do registo de aplicações do Azure Active Directory.
AzureActiveDirectoryValidation	As definições de configuração do fluxo de validação de tokens do Azure Active Directory.
AzureStaticWebApps	As definições de configuração do fornecedor de Aplicações Web Estáticas do Azure.
AzureStaticWebAppsRegistration	As definições de configuração do registo do fornecedor de Aplicações Web Estáticas do Azure
BlobStorageTokenStore	As definições de configuração do armazenamento dos tokens, se for utilizado o armazenamento de blobs.
ClientCredentialMethod	O método que deve ser utilizado para autenticar o utilizador.
ClientRegistration	As definições de configuração do registo de aplicações para fornecedores com IDs de cliente e segredos do cliente
CookieExpiration	As definições de configuração da expiração do cookie de sessão.
CookieExpirationConvention	A convenção utilizada ao determinar a expiração do cookie de sessão.
CustomOpenIdConnectProvider	As definições de configuração do fornecedor de Open ID Connect personalizado.
DefaultAuthorizationPolicy	As definições de configuração da política de autorização predefinida do Azure Active Directory.
DefaultErrorResponse	Serviço de Aplicações resposta de erro.
Details
Error	Modelo de erro.
Facebook	As definições de configuração do fornecedor de Facebook.
FileSystemTokenStore	As definições de configuração do armazenamento dos tokens, se for utilizado um sistema de ficheiros.
ForwardProxy	As definições de configuração de um proxy de reencaminhamento utilizadas para fazer os pedidos.
ForwardProxyConvention	A convenção utilizada para determinar o URL do pedido feito.
GitHub	As definições de configuração do fornecedor do GitHub.
GlobalValidation	As definições de configuração que determinam o fluxo de validação dos utilizadores que utilizam Serviço de Aplicações Autenticação/Autorização.
Google	As definições de configuração do fornecedor Google.
HttpSettings	As definições de configuração dos pedidos HTTP para pedidos de autenticação e autorização efetuados relativamente à Autenticação/Autorização do Serviço de Aplicações.
HttpSettingsRoutes	As definições de configuração dos pedidos HTTP de caminhos.
IdentityProviders	As definições de configuração de cada um dos fornecedores de identidade utilizados para configurar Serviço de Aplicações Autenticação/Autorização.
JwtClaimChecks	As definições de configuração das verificações que devem ser efetuadas ao validar as Afirmações JWT.
LegacyMicrosoftAccount	As definições de configuração do fornecedor de Conta Microsoft legado.
Login	As definições de configuração do fluxo de início de sessão dos utilizadores que utilizam Serviço de Aplicações Autenticação/Autorização.
LoginRoutes	As rotas que especificam os pontos finais utilizados para pedidos de início de sessão e fim de sessão.
LoginScopes	As definições de configuração do fluxo de início de sessão, incluindo os âmbitos que devem ser pedidos.
Nonce	As definições de configuração do nonce utilizado no fluxo de início de sessão.
OpenIdConnectClientCredential	As credenciais de cliente de autenticação do fornecedor do Open ID Connect personalizado.
OpenIdConnectConfig	As definições de configuração dos pontos finais utilizados para o fornecedor de Open ID Connect personalizado.
OpenIdConnectLogin	As definições de configuração do fluxo de início de sessão do fornecedor do Open ID Connect personalizado.
OpenIdConnectRegistration	As definições de configuração do registo de aplicações do fornecedor do Open ID Connect personalizado.
SiteAuthSettingsV2	Definições de configuração para a funcionalidade Autenticação do Serviço de Aplicações do Azure/Autorização V2.
TokenStore	As definições de configuração do arquivo de tokens.
Twitter	As definições de configuração do fornecedor do Twitter.
TwitterRegistration	As definições de configuração do registo de aplicações para o fornecedor do Twitter.
UnauthenticatedClientActionV2	A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

AllowedAudiencesValidation

As definições de configuração do fluxo de validação Audiências Permitidas.

Name	Tipo	Description
allowedAudiences	string[]	As definições de configuração da lista permitida de audiências a partir das quais validar o token JWT.

AllowedPrincipals

As definições de configuração dos principais permitidos do Azure Active Directory.

Name	Tipo	Description
groups	string[]	A lista dos grupos permitidos.
identities	string[]	A lista das identidades permitidas.

Apple

As definições de configuração do fornecedor Apple.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor da Apple não deve ser ativado apesar do registo definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de início de sessão.
registration	AppleRegistration	As definições de configuração do registo da Apple.

AppleRegistration

As definições de configuração do registo do fornecedor Apple

Name	Tipo	Description
clientId	string	O ID de Cliente da aplicação utilizada para iniciar sessão.
clientSecretSettingName	string	O nome da definição da aplicação que contém o segredo do cliente.

AppRegistration

As definições de configuração do registo de aplicações para fornecedores com IDs de aplicações e segredos de aplicações

Name	Tipo	Description
appId	string	O ID da Aplicação da aplicação utilizada para iniciar sessão.
appSecretSettingName	string	O nome da definição da aplicação que contém o segredo da aplicação.

AuthPlatform

As definições de configuração da plataforma do Serviço de Aplicações Autenticação/Autorização.

Name	Tipo	Description
configFilePath	string	O caminho do ficheiro de configuração que contém as definições de autenticação se forem provenientes de um ficheiro. Se o caminho for relativo, a base será o diretório de raiz do site.
enabled	boolean	`true` se a funcionalidade Autenticação/Autorização estiver ativada para a aplicação atual; caso contrário, `false`.
runtimeVersion	string	A RuntimeVersion da funcionalidade Autenticação/Autorização em utilização para a aplicação atual. A definição neste valor pode controlar o comportamento de determinadas funcionalidades no módulo Autenticação/Autorização.

AzureActiveDirectory

As definições de configuração do fornecedor do Azure Active Directory.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor do Azure Active Directory não deve ser ativado apesar do registo definido; caso contrário, `true`.
isAutoProvisioned	boolean	Obtém um valor que indica se a configuração do Azure AD foi aprovisionada automaticamente com ferramentas originais. Este é um sinalizador interno destinado principalmente a suportar o Portal de Gestão do Azure. Os utilizadores não devem ler nem escrever nesta propriedade.
login	AzureActiveDirectoryLogin	As definições de configuração do fluxo de início de sessão do Azure Active Directory.
registration	AzureActiveDirectoryRegistration	As definições de configuração do registo de aplicações do Azure Active Directory.
validation	AzureActiveDirectoryValidation	As definições de configuração do fluxo de validação de tokens do Azure Active Directory.

AzureActiveDirectoryLogin

As definições de configuração do fluxo de início de sessão do Azure Active Directory.

Name	Tipo	Description
disableWWWAuthenticate	boolean	`true` se o fornecedor www-authenticate deve ser omitido do pedido; caso contrário, `false`.
loginParameters	string[]	Parâmetros de início de sessão para enviar para o ponto final de autorização do OpenID Connect quando um utilizador inicia sessão. Cada parâmetro tem de estar no formato "key=value".

AzureActiveDirectoryRegistration

As definições de configuração do registo de aplicações do Azure Active Directory.

Name	Tipo	Description
clientId	string	O ID de Cliente desta aplicação de entidade confiadora, conhecida como client_id. Esta definição é necessária para ativar a autenticação da Ligação OpenID com o Azure Active Directory ou outros fornecedores openID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
clientSecretCertificateIssuer	string	Uma alternativa ao thumbprint do segredo do cliente, que é o emissor de um certificado utilizado para fins de assinatura. Esta propriedade funciona como um substituto do Thumbprint do Certificado de Segredo do Cliente. Também é opcional.
clientSecretCertificateSubjectAlternativeName	string	Uma alternativa ao thumbprint do segredo do cliente, que é o nome alternativo do requerente de um certificado utilizado para fins de assinatura. Esta propriedade funciona como um substituto do Thumbprint do Certificado de Segredo do Cliente. Também é opcional.
clientSecretCertificateThumbprint	string	Uma alternativa ao segredo do cliente, que é o thumbprint de um certificado utilizado para fins de assinatura. Esta propriedade atua como um substituto do Segredo do Cliente. Também é opcional.
clientSecretSettingName	string	O nome da definição da aplicação que contém o segredo do cliente da aplicação da entidade confiadora.
openIdIssuer	string	O URI do Emissor do OpenID Connect que representa a entidade que emite tokens de acesso para esta aplicação. Ao utilizar o Azure Active Directory, este valor é o URI do inquilino do diretório, por exemplo, https://login.microsoftonline.com/v2.0/{tenant-guid}/. Este URI é um identificador sensível às maiúsculas e minúsculas do emissor do token. Mais informações sobre a Deteção do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

As definições de configuração do fluxo de validação de tokens do Azure Active Directory.

Name	Tipo	Description
allowedAudiences	string[]	A lista de audiências que podem fazer pedidos de autenticação/autorização com êxito.
defaultAuthorizationPolicy	DefaultAuthorizationPolicy	As definições de configuração da política de autorização predefinida.
jwtClaimChecks	JwtClaimChecks	As definições de configuração das verificações que devem ser efetuadas ao validar as Afirmações JWT.

AzureStaticWebApps

As definições de configuração do fornecedor de Aplicações Web Estáticas do Azure.

Name	Tipo	Description
enabled	boolean	`false`se o fornecedor de Aplicações Web Estáticas do Azure não deve ser ativado apesar do registo definido; caso contrário, `true`.
registration	AzureStaticWebAppsRegistration	As definições de configuração do Aplicações Web Estáticas do Azure registo.

AzureStaticWebAppsRegistration

As definições de configuração do registo do fornecedor de Aplicações Web Estáticas do Azure

Name	Tipo	Description
clientId	string	O ID de Cliente da aplicação utilizada para iniciar sessão.

BlobStorageTokenStore

As definições de configuração do armazenamento dos tokens, se for utilizado o armazenamento de blobs.

Name	Tipo	Description
sasUrlSettingName	string	O nome da definição da aplicação que contém o URL de SAS do armazenamento de blobs que contém os tokens.

ClientCredentialMethod

O método que deve ser utilizado para autenticar o utilizador.

Name	Tipo	Description
ClientSecretPost	string

ClientRegistration

As definições de configuração do registo de aplicações para fornecedores com IDs de cliente e segredos do cliente

Name	Tipo	Description
clientId	string	O ID de Cliente da aplicação utilizada para iniciar sessão.
clientSecretSettingName	string	O nome da definição da aplicação que contém o segredo do cliente.

CookieExpiration

As definições de configuração da expiração do cookie de sessão.

Name	Tipo	Description
convention	CookieExpirationConvention	A convenção utilizada ao determinar a expiração do cookie de sessão.
timeToExpiration	string	O tempo após o pedido ser efetuado quando o cookie de sessão deve expirar.

CookieExpirationConvention

A convenção utilizada ao determinar a expiração do cookie de sessão.

Name	Tipo	Description
FixedTime	string
IdentityProviderDerived	string

CustomOpenIdConnectProvider

As definições de configuração do fornecedor de Open ID Connect personalizado.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor de Fornecedor de ID Aberto personalizado não estiver ativado; caso contrário, `true`.
login	OpenIdConnectLogin	As definições de configuração do fluxo de início de sessão do fornecedor do Open ID Connect personalizado.
registration	OpenIdConnectRegistration	As definições de configuração do registo de aplicações do fornecedor do Open ID Connect personalizado.

DefaultAuthorizationPolicy

As definições de configuração da política de autorização predefinida do Azure Active Directory.

Name	Tipo	Description
allowedApplications	string[]	As definições de configuração das aplicações permitidas do Azure Active Directory.
allowedPrincipals	AllowedPrincipals	As definições de configuração dos principais permitidos do Azure Active Directory.

DefaultErrorResponse

Serviço de Aplicações resposta de erro.

Name	Tipo	Description
error	Error	Modelo de erro.

Details

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Error

Modelo de erro.

Name	Tipo	Description
code	string	Cadeia padronizada para identificar programaticamente o erro.
details	Details[]	Erros detalhados.
innererror	string	Mais informações para depurar o erro.
message	string	Descrição detalhada do erro e informações de depuração.
target	string	Descrição detalhada do erro e informações de depuração.

Facebook

As definições de configuração do fornecedor de Facebook.

Name	Tipo	Description
enabled	boolean	`false`se o fornecedor de Facebook não deve ser ativado apesar do registo definido; caso contrário, `true`.
graphApiVersion	string	A versão da API de Facebook a ser utilizada durante o início de sessão.
login	LoginScopes	As definições de configuração do fluxo de início de sessão.
registration	AppRegistration	As definições de configuração do registo de aplicações do fornecedor de Facebook.

FileSystemTokenStore

As definições de configuração do armazenamento dos tokens, se for utilizado um sistema de ficheiros.

Name	Tipo	Description
directory	string	O diretório no qual os tokens serão armazenados.

ForwardProxy

As definições de configuração de um proxy de reencaminhamento utilizadas para fazer os pedidos.

Name	Tipo	Description
convention	ForwardProxyConvention	A convenção utilizada para determinar o URL do pedido feito.
customHostHeaderName	string	O nome do cabeçalho que contém o anfitrião do pedido.
customProtoHeaderName	string	O nome do cabeçalho que contém o esquema do pedido.

ForwardProxyConvention

A convenção utilizada para determinar o URL do pedido feito.

Name	Tipo	Description
Custom	string
NoProxy	string
Standard	string

GitHub

As definições de configuração do fornecedor do GitHub.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor do GitHub não deve ser ativado apesar do registo definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de início de sessão.
registration	ClientRegistration	As definições de configuração do registo de aplicações para o fornecedor do GitHub.

GlobalValidation

As definições de configuração que determinam o fluxo de validação dos utilizadores que utilizam Serviço de Aplicações Autenticação/Autorização.

Name	Tipo	Description
excludedPaths	string[]	Os caminhos para os quais o fluxo não autenticado não seria redirecionado para a página de início de sessão.
redirectToProvider	string	O fornecedor de autenticação predefinido a utilizar quando vários fornecedores estão configurados. Esta definição só é necessária se vários fornecedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".
requireAuthentication	boolean	`true` se o fluxo de autenticação for necessário, qualquer pedido é feito; caso contrário, `false`.
unauthenticatedClientAction	UnauthenticatedClientActionV2	A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

Google

As definições de configuração do fornecedor Google.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor google não deve ser ativado apesar do registo definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de início de sessão.
registration	ClientRegistration	As definições de configuração do registo de aplicações para o fornecedor Google.
validation	AllowedAudiencesValidation	As definições de configuração do fluxo de validação de tokens do Azure Active Directory.

HttpSettings

As definições de configuração dos pedidos HTTP para pedidos de autenticação e autorização efetuados relativamente à Autenticação/Autorização do Serviço de Aplicações.

Name	Tipo	Description
forwardProxy	ForwardProxy	As definições de configuração de um proxy de reencaminhamento utilizadas para fazer os pedidos.
requireHttps	boolean	`false` se as respostas de autenticação/autorização que não têm o esquema HTTPS forem permitidas; caso contrário, `true`.
routes	HttpSettingsRoutes	As definições de configuração dos pedidos HTTP de caminhos.

HttpSettingsRoutes

As definições de configuração dos pedidos HTTP de caminhos.

Name	Tipo	Description
apiPrefix	string	O prefixo que deve preceder todos os caminhos de autenticação/autorização.

IdentityProviders

As definições de configuração de cada um dos fornecedores de identidade utilizados para configurar Serviço de Aplicações Autenticação/Autorização.

Name	Tipo	Description
apple	Apple	As definições de configuração do fornecedor Apple.
azureActiveDirectory	AzureActiveDirectory	As definições de configuração do fornecedor do Azure Active Directory.
azureStaticWebApps	AzureStaticWebApps	As definições de configuração do fornecedor de Aplicações Web Estáticas do Azure.
customOpenIdConnectProviders	<string, CustomOpenIdConnectProvider>	O mapa do nome do alias de cada fornecedor de Open ID Connect personalizado para as definições de configuração do fornecedor de Open ID Connect personalizado.
facebook	Facebook	As definições de configuração do fornecedor de Facebook.
gitHub	GitHub	As definições de configuração do fornecedor do GitHub.
google	Google	As definições de configuração do fornecedor Google.
legacyMicrosoftAccount	LegacyMicrosoftAccount	As definições de configuração do fornecedor de Conta Microsoft legado.
twitter	Twitter	As definições de configuração do fornecedor do Twitter.

JwtClaimChecks

As definições de configuração das verificações que devem ser efetuadas ao validar as Afirmações JWT.

Name	Tipo	Description
allowedClientApplications	string[]	A lista das aplicações cliente permitidas.
allowedGroups	string[]	A lista dos grupos permitidos.

LegacyMicrosoftAccount

As definições de configuração do fornecedor de Conta Microsoft legado.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor de Conta Microsoft legado não deve ser ativado apesar do registo definido; caso contrário, `true`.
login	LoginScopes	As definições de configuração do fluxo de início de sessão.
registration	ClientRegistration	As definições de configuração do registo de aplicações para o fornecedor de Conta Microsoft legado.
validation	AllowedAudiencesValidation	As definições de configuração do fluxo de validação de tokens do fornecedor de Conta Microsoft legado.

As definições de configuração do fluxo de início de sessão dos utilizadores que utilizam Serviço de Aplicações Autenticação/Autorização.

Name	Tipo	Description
allowedExternalRedirectUrls	string[]	URLs externos para os quais pode ser redirecionado como parte do início de sessão ou de fim de sessão da aplicação. Tenha em atenção que a parte da cadeia de consulta do URL é ignorada. Normalmente, esta é uma definição avançada necessária apenas para back-ends de aplicações da Loja Windows. Tenha em atenção que os URLs dentro do domínio atual são sempre implicitamente permitidos.
cookieExpiration	CookieExpiration	As definições de configuração da expiração do cookie de sessão.
nonce	Nonce	As definições de configuração do nonce utilizado no fluxo de início de sessão.
preserveUrlFragmentsForLogins	boolean	`true` se os fragmentos do pedido forem preservados após a criação do pedido de início de sessão; caso contrário, `false`.
routes	LoginRoutes	As rotas que especificam os pontos finais utilizados para pedidos de início de sessão e fim de sessão.
tokenStore	TokenStore	As definições de configuração do arquivo de tokens.

LoginRoutes

As rotas que especificam os pontos finais utilizados para pedidos de início de sessão e fim de sessão.

Name	Tipo	Description
logoutEndpoint	string	O ponto final no qual deve ser feito um pedido de fim de sessão.

LoginScopes

As definições de configuração do fluxo de início de sessão, incluindo os âmbitos que devem ser pedidos.

Name	Tipo	Description
scopes	string[]	Uma lista dos âmbitos que devem ser pedidos durante a autenticação.

Nonce

As definições de configuração do nonce utilizado no fluxo de início de sessão.

Name	Tipo	Description
nonceExpirationInterval	string	O tempo após o pedido ser efetuado quando o nonce deve expirar.
validateNonce	boolean	`false` se o nonce não deve ser validado durante a conclusão do fluxo de início de sessão; caso contrário, `true`.

OpenIdConnectClientCredential

As credenciais de cliente de autenticação do fornecedor do Open ID Connect personalizado.

Name	Tipo	Description
clientSecretSettingName	string	A definição da aplicação que contém o segredo do cliente do fornecedor de Open ID Connect personalizado.
method	ClientCredentialMethod	O método que deve ser utilizado para autenticar o utilizador.

OpenIdConnectConfig

As definições de configuração dos pontos finais utilizados para o fornecedor de Open ID Connect personalizado.

Name	Tipo	Description
authorizationEndpoint	string	O ponto final a ser utilizado para fazer um pedido de autorização.
certificationUri	string	O ponto final que fornece as chaves necessárias para validar o token.
issuer	string	O ponto final que emite o token.
tokenEndpoint	string	O ponto final a ser utilizado para pedir um token.
wellKnownOpenIdConfiguration	string	O ponto final que contém todos os pontos finais de configuração do fornecedor.

OpenIdConnectLogin

As definições de configuração do fluxo de início de sessão do fornecedor do Open ID Connect personalizado.

Name	Tipo	Description
nameClaimType	string	O nome da afirmação que contém o nome de utilizador.
scopes	string[]	Uma lista dos âmbitos que devem ser pedidos durante a autenticação.

OpenIdConnectRegistration

As definições de configuração do registo de aplicações do fornecedor do Open ID Connect personalizado.

Name	Tipo	Description
clientCredential	OpenIdConnectClientCredential	As credenciais de autenticação do fornecedor do Open ID Connect personalizado.
clientId	string	O ID de cliente do fornecedor do Open ID Connect personalizado.
openIdConnectConfiguration	OpenIdConnectConfig	As definições de configuração dos pontos finais utilizados para o fornecedor de Open ID Connect personalizado.

SiteAuthSettingsV2

Definições de configuração para a funcionalidade Autenticação do Serviço de Aplicações do Azure/Autorização V2.

Name	Tipo	Description
id	string	ID do Recurso.
kind	string	Tipo de recurso.
name	string	Nome do Recurso.
properties.globalValidation	GlobalValidation	As definições de configuração que determinam o fluxo de validação dos utilizadores que utilizam Serviço de Aplicações Autenticação/Autorização.
properties.httpSettings	HttpSettings	As definições de configuração dos pedidos HTTP para pedidos de autenticação e autorização efetuados relativamente à Autenticação/Autorização do Serviço de Aplicações.
properties.identityProviders	IdentityProviders	As definições de configuração de cada um dos fornecedores de identidade utilizados para configurar Serviço de Aplicações Autenticação/Autorização.
properties.login	Login	As definições de configuração do fluxo de início de sessão dos utilizadores que utilizam Serviço de Aplicações Autenticação/Autorização.
properties.platform	AuthPlatform	As definições de configuração da plataforma do Serviço de Aplicações Autenticação/Autorização.
type	string	Tipo de recurso.

TokenStore

As definições de configuração do arquivo de tokens.

Name	Tipo	Description
azureBlobStorage	BlobStorageTokenStore	As definições de configuração do armazenamento dos tokens, se for utilizado o armazenamento de blobs.
enabled	boolean	`true` para armazenar de forma duradoura tokens de segurança específicos da plataforma que são obtidos durante os fluxos de início de sessão; caso contrário, `false`. A predefinição é `false`.
fileSystem	FileSystemTokenStore	As definições de configuração do armazenamento dos tokens, se for utilizado um sistema de ficheiros.
tokenRefreshExtensionHours	number	O número de horas após a expiração do token de sessão que um token de sessão pode ser utilizado para chamar a API de atualização de tokens. A predefinição são 72 horas.

Twitter

As definições de configuração do fornecedor do Twitter.

Name	Tipo	Description
enabled	boolean	`false` se o fornecedor do Twitter não deve ser ativado apesar do registo definido; caso contrário, `true`.
registration	TwitterRegistration	As definições de configuração do registo de aplicações para o fornecedor do Twitter.

TwitterRegistration

As definições de configuração do registo de aplicações para o fornecedor do Twitter.

Name	Tipo	Description
consumerKey	string	A chave de consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão. Esta definição é necessária para ativar o Início de Sessão no Twitter. Documentação de Sign-In do Twitter: https://dev.twitter.com/web/sign-in
consumerSecretSettingName	string	O nome da definição da aplicação que contém o segredo de consumidor OAuth 1.0a da aplicação twitter utilizada para iniciar sessão.

UnauthenticatedClientActionV2

A ação a tomar quando um cliente não autenticado tenta aceder à aplicação.

Name	Tipo	Description
AllowAnonymous	string
RedirectToLoginPage	string
Return401	string
Return403	string