Web Apps - Update Auth Settings
Descrição para Atualiza as configurações de Autenticação/Autorização associadas ao aplicativo Web.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings?api-version=2025-03-01
Parâmetros URI
| Nome | Em | Necessário | Tipo | Descrição |
|---|---|---|---|---|
|
name
|
path | True |
string |
Nome do aplicativo Web. |
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+[^\.]$ |
Nome do grupo de recursos ao qual o recurso pertence. |
|
subscription
|
path | True |
string |
O seu ID de subscrição do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-0000000000000). |
|
api-version
|
query | True |
string |
Versão da API |
Órgão do Pedido
| Nome | Tipo | Descrição |
|---|---|---|
| kind |
string |
Tipo de recurso. |
| properties.aadClaimsAuthorization |
string |
Obtém uma cadeia de caracteres JSON contendo as configurações de Acl do Azure AD. |
| properties.additionalLoginParams |
string[] |
Parâmetros de login para enviar ao ponto de extremidade de autorização do OpenID Connect quando um usuário fizer login. Cada parâmetro deve estar no formato "key=value". |
| properties.allowedAudiences |
string[] |
Valores de audiência permitidos a serem considerados ao validar Tokens Web JSON emitidos pelo Azure Ative Directory. Observe que o |
| properties.allowedExternalRedirectUrls |
string[] |
URLs externos que podem ser redirecionados como parte do login ou logout do aplicativo. Observe que a parte da cadeia de caracteres de consulta da URL é ignorada. Essa é uma configuração avançada normalmente necessária apenas para back-ends de aplicativos da Windows Store. Observe que as URLs dentro do domínio atual são sempre permitidas implicitamente. |
| properties.authFilePath |
string |
O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, a base será o diretório raiz do site. |
| properties.clientId |
string |
A ID do Cliente deste aplicativo de terceira parte confiável, conhecida como client_id. Essa configuração é necessária para habilitar a autenticação de Conexão OpenID com o Azure Ative Directory ou outros provedores OpenID Connect de terceiros 3rd. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
| properties.clientSecret |
string |
O Segredo do Cliente deste aplicativo de terceira parte confiável (no Azure Ative Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícito do OpenID Connect será usado para autenticar os usuários finais. Caso contrário, o fluxo de código de autorização do OpenID Connect será usado para autenticar usuários finais. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
| properties.clientSecretCertificateThumbprint |
string |
Uma alternativa ao segredo do cliente, que é a impressão digital de um certificado usado para fins de assinatura. Esta propriedade atua como um substituto para o Segredo do Cliente. Também é opcional. |
| properties.clientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável. |
| properties.configVersion |
string |
O ConfigVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração neste valor pode controlar o comportamento do plano de controle para Autenticação / Autorização. |
| properties.defaultProvider |
O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só é necessária se vários provedores estiverem configurados e a ação do cliente não autenticado estiver definida como "RedirectToLoginPage". |
|
| properties.enabled |
boolean |
|
| properties.facebookAppId |
string |
O ID do aplicativo do Facebook usado para login. Essa configuração é necessária para habilitar o Login do Facebook. Documentação de login do Facebook: https://developers.facebook.com/docs/facebook-login |
| properties.facebookAppSecret |
string |
O segredo do aplicativo do Facebook usado para o login do Facebook. Essa configuração é necessária para habilitar o Login do Facebook. Documentação de login do Facebook: https://developers.facebook.com/docs/facebook-login |
| properties.facebookAppSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do aplicativo usado para o Login do Facebook. |
| properties.facebookOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de Login do Facebook. Essa configuração é opcional. Documentação de login do Facebook: https://developers.facebook.com/docs/facebook-login |
| properties.gitHubClientId |
string |
A ID do cliente do aplicativo GitHub usado para login. Essa configuração é necessária para habilitar o login no Github |
| properties.gitHubClientSecret |
string |
O segredo do cliente do aplicativo GitHub usado para o login do Github. Essa configuração é necessária para habilitar o login no Github. |
| properties.gitHubClientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para o Login do GitHub. |
| properties.gitHubOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de login do GitHub. Essa configuração é opcional |
| properties.googleClientId |
string |
O OpenID Connect Client ID para o aplicativo da Web do Google. Essa configuração é necessária para ativar o Google Sign-In. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
| properties.googleClientSecret |
string |
O segredo do cliente associado ao aplicativo da Web do Google. Essa configuração é necessária para ativar o Google Sign-In. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
| properties.googleClientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente associado ao aplicativo da Web do Google. |
| properties.googleOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação do Google Sign-In. Essa configuração é opcional. Se não for especificado, "openid", "profile" e "email" são usados como escopos padrão. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
| properties.isAuthFromFile |
string |
"true" se as configurações de configuração de autenticação devem ser lidas de um arquivo, "false" caso contrário |
| properties.issuer |
string |
O URI do Emissor do OpenID Connect que representa a entidade que emite tokens de acesso para este aplicativo.
Ao usar o Azure Ative Directory, esse valor é o URI do locatário do diretório, por exemplo, |
| properties.microsoftAccountClientId |
string |
A ID do cliente OAuth 2.0 que foi criada para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm |
| properties.microsoftAccountClientSecret |
string |
O segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm |
| properties.microsoftAccountClientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação. |
| properties.microsoftAccountOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação da Conta da Microsoft. Essa configuração é opcional. Se não for especificado, "wl.basic" será usado como o escopo padrão. Documentação de Escopos e permissões da Conta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx |
| properties.runtimeVersion |
string |
O RuntimeVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração neste valor pode controlar o comportamento de determinados recursos no módulo Autenticação / Autorização. |
| properties.tokenRefreshExtensionHours |
number (double) |
O número de horas após a expiração do token de sessão que um token de sessão pode ser usado para chamar a API de atualização de token. A predefinição são 72 horas. |
| properties.tokenStoreEnabled |
boolean |
|
| properties.twitterConsumerKey |
string |
A chave de consumidor OAuth 1.0a do aplicativo Twitter usada para entrar. Essa configuração é necessária para habilitar o Login do Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in |
| properties.twitterConsumerSecret |
string |
O segredo do consumidor OAuth 1.0a do aplicativo Twitter usado para entrar. Essa configuração é necessária para habilitar o Login do Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in |
| properties.twitterConsumerSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar. |
| properties.unauthenticatedClientAction |
A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo. |
|
| properties.validateIssuer |
boolean |
Obtém um valor que indica se o emissor deve ser uma URL HTTPS válida e ser validado como tal. |
Respostas
| Nome | Tipo | Descrição |
|---|---|---|
| 200 OK |
OK |
|
| Other Status Codes |
Resposta de erro do Serviço de Aplicativo. |
Segurança
azure_auth
Azure Ative Directory OAuth2 Flow
Tipo:
oauth2
Flow:
implicit
URL de autorização:
https://login.microsoftonline.com/common/oauth2/authorize
Alcances
| Nome | Descrição |
|---|---|
| user_impersonation | personificar a sua conta de utilizador |
Exemplos
Update Auth Settings
Pedido de exemplo
PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings?api-version=2025-03-01
{
"properties": {
"enabled": true,
"runtimeVersion": "~1",
"unauthenticatedClientAction": "RedirectToLoginPage",
"tokenStoreEnabled": true,
"allowedExternalRedirectUrls": [
"sitef6141.customdomain.net",
"sitef6141.customdomain.info"
],
"defaultProvider": "Google",
"tokenRefreshExtensionHours": 120,
"clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
}
}
Resposta de exemplo
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettings",
"name": "authsettings",
"type": "Microsoft.Web/sites/authsettings",
"kind": "app",
"properties": {
"enabled": true,
"runtimeVersion": "~1",
"unauthenticatedClientAction": "RedirectToLoginPage",
"tokenStoreEnabled": true,
"allowedExternalRedirectUrls": [
"sitef6141.customdomain.net",
"sitef6141.customdomain.info"
],
"defaultProvider": "Google",
"tokenRefreshExtensionHours": 120,
"clientId": "42d795a9-8abb-4d06-8534-39528af40f8e.apps.googleusercontent.com"
}
}
Definições
| Nome | Descrição |
|---|---|
|
Built |
O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só é necessária se vários provedores estiverem configurados e a ação do cliente não autenticado estiver definida como "RedirectToLoginPage". |
|
Default |
Resposta de erro do Serviço de Aplicativo. |
| Details | |
| Error |
Modelo de erro. |
|
Site |
Definições de configuração para o recurso de Autenticação/Autorização do Serviço de Aplicativo do Azure. |
|
Unauthenticated |
A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo. |
BuiltInAuthenticationProvider
O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só é necessária se vários provedores estiverem configurados e a ação do cliente não autenticado estiver definida como "RedirectToLoginPage".
| Valor | Descrição |
|---|---|
| AzureActiveDirectory | |
| MicrosoftAccount | |
| Github |
DefaultErrorResponse
Resposta de erro do Serviço de Aplicativo.
| Nome | Tipo | Descrição |
|---|---|---|
| error |
Modelo de erro. |
Details
| Nome | Tipo | Descrição |
|---|---|---|
| code |
string |
String 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.
| Nome | Tipo | Descrição |
|---|---|---|
| code |
string |
String padronizada para identificar programaticamente o erro. |
| details |
Details[] |
Erros detalhados. |
| innererror |
string |
Mais informações para depurar 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. |
SiteAuthSettings
Definições de configuração para o recurso de Autenticação/Autorização do Serviço de Aplicativo do Azure.
| Nome | Tipo | Descrição |
|---|---|---|
| id |
string |
Id do recurso. |
| kind |
string |
Tipo de recurso. |
| name |
string |
Nome do recurso. |
| properties.aadClaimsAuthorization |
string |
Obtém uma cadeia de caracteres JSON contendo as configurações de Acl do Azure AD. |
| properties.additionalLoginParams |
string[] |
Parâmetros de login para enviar ao ponto de extremidade de autorização do OpenID Connect quando um usuário fizer login. Cada parâmetro deve estar no formato "key=value". |
| properties.allowedAudiences |
string[] |
Valores de audiência permitidos a serem considerados ao validar Tokens Web JSON emitidos pelo Azure Ative Directory. Observe que o |
| properties.allowedExternalRedirectUrls |
string[] |
URLs externos que podem ser redirecionados como parte do login ou logout do aplicativo. Observe que a parte da cadeia de caracteres de consulta da URL é ignorada. Essa é uma configuração avançada normalmente necessária apenas para back-ends de aplicativos da Windows Store. Observe que as URLs dentro do domínio atual são sempre permitidas implicitamente. |
| properties.authFilePath |
string |
O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, a base será o diretório raiz do site. |
| properties.clientId |
string |
A ID do Cliente deste aplicativo de terceira parte confiável, conhecida como client_id. Essa configuração é necessária para habilitar a autenticação de Conexão OpenID com o Azure Ative Directory ou outros provedores OpenID Connect de terceiros 3rd. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
| properties.clientSecret |
string |
O Segredo do Cliente deste aplicativo de terceira parte confiável (no Azure Ative Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícito do OpenID Connect será usado para autenticar os usuários finais. Caso contrário, o fluxo de código de autorização do OpenID Connect será usado para autenticar usuários finais. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
| properties.clientSecretCertificateThumbprint |
string |
Uma alternativa ao segredo do cliente, que é a impressão digital de um certificado usado para fins de assinatura. Esta propriedade atua como um substituto para o Segredo do Cliente. Também é opcional. |
| properties.clientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo de terceira parte confiável. |
| properties.configVersion |
string |
O ConfigVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração neste valor pode controlar o comportamento do plano de controle para Autenticação / Autorização. |
| properties.defaultProvider |
O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só é necessária se vários provedores estiverem configurados e a ação do cliente não autenticado estiver definida como "RedirectToLoginPage". |
|
| properties.enabled |
boolean |
|
| properties.facebookAppId |
string |
O ID do aplicativo do Facebook usado para login. Essa configuração é necessária para habilitar o Login do Facebook. Documentação de login do Facebook: https://developers.facebook.com/docs/facebook-login |
| properties.facebookAppSecret |
string |
O segredo do aplicativo do Facebook usado para o login do Facebook. Essa configuração é necessária para habilitar o Login do Facebook. Documentação de login do Facebook: https://developers.facebook.com/docs/facebook-login |
| properties.facebookAppSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do aplicativo usado para o Login do Facebook. |
| properties.facebookOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de Login do Facebook. Essa configuração é opcional. Documentação de login do Facebook: https://developers.facebook.com/docs/facebook-login |
| properties.gitHubClientId |
string |
A ID do cliente do aplicativo GitHub usado para login. Essa configuração é necessária para habilitar o login no Github |
| properties.gitHubClientSecret |
string |
O segredo do cliente do aplicativo GitHub usado para o login do Github. Essa configuração é necessária para habilitar o login no Github. |
| properties.gitHubClientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para o Login do GitHub. |
| properties.gitHubOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de login do GitHub. Essa configuração é opcional |
| properties.googleClientId |
string |
O OpenID Connect Client ID para o aplicativo da Web do Google. Essa configuração é necessária para ativar o Google Sign-In. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
| properties.googleClientSecret |
string |
O segredo do cliente associado ao aplicativo da Web do Google. Essa configuração é necessária para ativar o Google Sign-In. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
| properties.googleClientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente associado ao aplicativo da Web do Google. |
| properties.googleOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação do Google Sign-In. Essa configuração é opcional. Se não for especificado, "openid", "profile" e "email" são usados como escopos padrão. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/ |
| properties.isAuthFromFile |
string |
"true" se as configurações de configuração de autenticação devem ser lidas de um arquivo, "false" caso contrário |
| properties.issuer |
string |
O URI do Emissor do OpenID Connect que representa a entidade que emite tokens de acesso para este aplicativo.
Ao usar o Azure Ative Directory, esse valor é o URI do locatário do diretório, por exemplo, |
| properties.microsoftAccountClientId |
string |
A ID do cliente OAuth 2.0 que foi criada para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm |
| properties.microsoftAccountClientSecret |
string |
O segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação. Essa configuração é necessária para habilitar a autenticação da Conta da Microsoft. Documentação OAuth da Conta Microsoft: https://dev.onedrive.com/auth/msa_oauth.htm |
| properties.microsoftAccountClientSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do cliente OAuth 2.0 que foi criado para o aplicativo usado para autenticação. |
| properties.microsoftAccountOAuthScopes |
string[] |
Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação da Conta da Microsoft. Essa configuração é opcional. Se não for especificado, "wl.basic" será usado como o escopo padrão. Documentação de Escopos e permissões da Conta Microsoft: https://msdn.microsoft.com/en-us/library/dn631845.aspx |
| properties.runtimeVersion |
string |
O RuntimeVersion do recurso de autenticação/autorização em uso para o aplicativo atual. A configuração neste valor pode controlar o comportamento de determinados recursos no módulo Autenticação / Autorização. |
| properties.tokenRefreshExtensionHours |
number (double) |
O número de horas após a expiração do token de sessão que um token de sessão pode ser usado para chamar a API de atualização de token. A predefinição são 72 horas. |
| properties.tokenStoreEnabled |
boolean |
|
| properties.twitterConsumerKey |
string |
A chave de consumidor OAuth 1.0a do aplicativo Twitter usada para entrar. Essa configuração é necessária para habilitar o Login do Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in |
| properties.twitterConsumerSecret |
string |
O segredo do consumidor OAuth 1.0a do aplicativo Twitter usado para entrar. Essa configuração é necessária para habilitar o Login do Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in |
| properties.twitterConsumerSecretSettingName |
string |
O nome da configuração do aplicativo que contém o segredo do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar. |
| properties.unauthenticatedClientAction |
A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo. |
|
| properties.validateIssuer |
boolean |
Obtém um valor que indica se o emissor deve ser uma URL HTTPS válida e ser validado como tal. |
| type |
string |
Tipo de recurso. |
UnauthenticatedClientAction
A ação a ser executada quando um cliente não autenticado tenta acessar o aplicativo.
| Valor | Descrição |
|---|---|
| RedirectToLoginPage | |
| AllowAnonymous |