Web Apps - Update Auth Settings Slot

Descrição para Atualizações 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}/slots/{slot}/config/authsettings?api-version=2023-12-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
name
path True

string

Nome do aplicativo Web.

resourceGroupName
path True

string

Nome do grupo de recursos ao qual pertence o recurso.

Padrão Regex: ^[-\w\._\(\)]+[^\.]$

slot
path True

string

Nome do slot do aplicativo Web. Se não for especificado, o padrão será o slot de produção.

subscriptionId
path True

string

Sua ID da assinatura do Azure. Esta é uma cadeia de caracteres formatada em GUID (por exemplo, 00000000-0000-0000-0000-0000000000000000000000).

api-version
query True

string

Versão da API

Corpo da solicitação

Nome Tipo Description
kind

string

Tipo de recurso.

properties.aadClaimsAuthorization

string

Obtém uma cadeia de caracteres JSON que contém as configurações de Acl Azure AD.

properties.additionalLoginParams

string[]

Parâmetros de logon a serem enviados para o ponto de extremidade de autorização do OpenID Connect quando um usuário fizer logon. 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 Active Directory. Observe que o ClientID valor é sempre considerado um público-alvo permitido, independentemente dessa configuração.

properties.allowedExternalRedirectUrls

string[]

URLs externas que podem ser redirecionadas para como parte do logon ou logoff 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 implicitamente permitidas.

properties.authFilePath

string

O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, baseará o diretório raiz do site.

properties.clientId

string

A ID do cliente desse 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 Active Directory ou outros provedores do OpenID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

properties.clientSecret

string

O Segredo do Cliente desse aplicativo de terceira parte confiável (no Azure Active Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícita 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 os 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. Essa propriedade atua como uma substituição 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 nesse valor pode controlar o comportamento do painel de controle para Autenticação/Autorização.

properties.defaultProvider

BuiltInAuthenticationProvider

O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só será necessária se vários provedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

properties.enabled

boolean

true se o recurso autenticação/autorização estiver habilitado para o aplicativo atual; caso contrário, false.

properties.facebookAppId

string

A ID do aplicativo do Facebook usado para logon. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon:https://developers.facebook.com/docs/facebook-login

properties.facebookAppSecret

string

O Segredo do Aplicativo do aplicativo Facebook usado para logon Facebook. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon: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 Facebook Logon.

properties.facebookOAuthScopes

string[]

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do Facebook. Essa configuração é opcional. Facebook documentação de logon:https://developers.facebook.com/docs/facebook-login

properties.gitHubClientId

string

A ID do cliente do aplicativo GitHub usada para logon. Essa configuração é necessária para habilitar o logon do Github

properties.gitHubClientSecret

string

O Segredo do Cliente do aplicativo GitHub usado para logon do Github. Essa configuração é necessária para habilitar o logon do Github.

properties.gitHubClientSecretSettingName

string

O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para logon do GitHub.

properties.gitHubOAuthScopes

string[]

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do GitHub. Essa configuração é opcional

properties.googleClientId

string

A ID do cliente do OpenID Connect para o aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada no Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.googleClientSecret

string

O segredo do cliente associado ao aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada no Google. 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 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" serã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 autenticação devem ser lidas de um arquivo, caso contrário, "false"

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 Active Directory, esse valor é o URI do locatário do diretório, por exemplo https://sts.windows.net/{tenant-guid}/, . Esse URI é um identificador que diferencia maiúsculas de minúsculas para o emissor do token. Mais informações sobre a descoberta do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

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 do 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 do 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 de conta da 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 nesse valor pode controlar o comportamento de determinados recursos no módulo Autenticação/Autorização.

properties.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 usado para chamar a API de atualização de token. O padrão é de 72 horas.

properties.tokenStoreEnabled

boolean

true para armazenar permanentemente tokens de segurança específicos da plataforma obtidos durante os fluxos de logon; caso contrário, false. O padrão é false.

properties.twitterConsumerKey

string

A chave do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in

properties.twitterConsumerSecret

string

O segredo do consumidor do OAuth 1.0a do aplicativo do Twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no 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

UnauthenticatedClientAction

A ação a ser tomada 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 Description
200 OK

SiteAuthSettings

OK

Other Status Codes

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Definições

Nome Description
BuiltInAuthenticationProvider

O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só será necessária se vários provedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Details
Error

Modelo de erro.

SiteAuthSettings

Definições de configuração para o recurso de autenticação/autorização do Serviço de Aplicativo do Azure.

UnauthenticatedClientAction

A ação a ser tomada 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ó será necessária se vários provedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

Nome Tipo Description
AzureActiveDirectory

string

Facebook

string

Github

string

Google

string

MicrosoftAccount

string

Twitter

string

DefaultErrorResponse

Serviço de Aplicativo resposta de erro.

Nome Tipo Description
error

Error

Modelo de erro.

Details

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.

message

string

Informações detalhadas de descrição e depuração de erros.

target

string

Informações detalhadas de descrição e depuração de erros.

Error

Modelo de erro.

Nome Tipo Description
code

string

Cadeia de caracteres padronizada para identificar programaticamente o erro.

details

Details[]

Erros detalhados.

innererror

string

Mais informações sobre o erro de depuração.

message

string

Informações detalhadas de descrição e depuração de erros.

target

string

Informações detalhadas de descrição e depuração de erros.

SiteAuthSettings

Definições de configuração para o recurso de autenticação/autorização do Serviço de Aplicativo do Azure.

Nome Tipo Description
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 que contém as configurações de Acl Azure AD.

properties.additionalLoginParams

string[]

Parâmetros de logon a serem enviados para o ponto de extremidade de autorização do OpenID Connect quando um usuário fizer logon. 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 Active Directory. Observe que o ClientID valor é sempre considerado um público-alvo permitido, independentemente dessa configuração.

properties.allowedExternalRedirectUrls

string[]

URLs externas que podem ser redirecionadas para como parte do logon ou logoff 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 implicitamente permitidas.

properties.authFilePath

string

O caminho do arquivo de configuração que contém as configurações de autenticação. Se o caminho for relativo, baseará o diretório raiz do site.

properties.clientId

string

A ID do cliente desse 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 Active Directory ou outros provedores do OpenID Connect de terceiros. Mais informações sobre o OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

properties.clientSecret

string

O Segredo do Cliente desse aplicativo de terceira parte confiável (no Azure Active Directory, isso também é chamado de Chave). Essa configuração é opcional. Se nenhum segredo do cliente estiver configurado, o fluxo de autenticação implícita 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 os 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. Essa propriedade atua como uma substituição 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 nesse valor pode controlar o comportamento do painel de controle para Autenticação/Autorização.

properties.defaultProvider

BuiltInAuthenticationProvider

O provedor de autenticação padrão a ser usado quando vários provedores são configurados. Essa configuração só será necessária se vários provedores estiverem configurados e a ação de cliente não autenticada estiver definida como "RedirectToLoginPage".

properties.enabled

boolean

true se o recurso autenticação/autorização estiver habilitado para o aplicativo atual; caso contrário, false.

properties.facebookAppId

string

A ID do aplicativo do Facebook usado para logon. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon:https://developers.facebook.com/docs/facebook-login

properties.facebookAppSecret

string

O Segredo do Aplicativo do aplicativo Facebook usado para logon Facebook. Essa configuração é necessária para habilitar Facebook Logon. Facebook documentação de logon: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 Facebook Logon.

properties.facebookOAuthScopes

string[]

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do Facebook. Essa configuração é opcional. Facebook documentação de logon:https://developers.facebook.com/docs/facebook-login

properties.gitHubClientId

string

A ID do cliente do aplicativo GitHub usada para logon. Essa configuração é necessária para habilitar o logon do Github

properties.gitHubClientSecret

string

O Segredo do Cliente do aplicativo GitHub usado para logon do Github. Essa configuração é necessária para habilitar o logon do Github.

properties.gitHubClientSecretSettingName

string

O nome da configuração do aplicativo que contém o segredo do cliente do aplicativo Github usado para logon do GitHub.

properties.gitHubOAuthScopes

string[]

Os escopos do OAuth 2.0 que serão solicitados como parte da autenticação de logon do GitHub. Essa configuração é opcional

properties.googleClientId

string

A ID do cliente do OpenID Connect para o aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada no Google. Documentação do Google Sign-In: https://developers.google.com/identity/sign-in/web/

properties.googleClientSecret

string

O segredo do cliente associado ao aplicativo Web do Google. Essa configuração é necessária para habilitar a entrada no Google. 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 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" serã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 autenticação devem ser lidas de um arquivo, caso contrário, "false"

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 Active Directory, esse valor é o URI do locatário do diretório, por exemplo https://sts.windows.net/{tenant-guid}/, . Esse URI é um identificador que diferencia maiúsculas de minúsculas para o emissor do token. Mais informações sobre a descoberta do OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html

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 do 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 do 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 de conta da 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 nesse valor pode controlar o comportamento de determinados recursos no módulo Autenticação/Autorização.

properties.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 usado para chamar a API de atualização de token. O padrão é de 72 horas.

properties.tokenStoreEnabled

boolean

true para armazenar permanentemente tokens de segurança específicos da plataforma obtidos durante os fluxos de logon; caso contrário, false. O padrão é false.

properties.twitterConsumerKey

string

A chave do consumidor OAuth 1.0a do aplicativo do Twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no Twitter. Documentação do Twitter Sign-In: https://dev.twitter.com/web/sign-in

properties.twitterConsumerSecret

string

O segredo do consumidor do OAuth 1.0a do aplicativo do Twitter usado para entrar. Essa configuração é necessária para habilitar a entrada no 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

UnauthenticatedClientAction

A ação a ser tomada 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 tomada quando um cliente não autenticado tenta acessar o aplicativo.

Nome Tipo Description
AllowAnonymous

string

RedirectToLoginPage

string