Web Apps - Update Auth Settings V2

Beschreibung der Authentifizierungs-/Autorisierungseinstellungen Updates Website für Apps im V2-Format

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
name
path True

string

Name der Web-App.

resourceGroupName
path True

string

Name der Ressourcengruppe, zu der die Ressource gehört.

Regex pattern: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

die Azure-Abonnement-ID Dies ist eine GUID-formatierte Zeichenfolge (z. B. 0000000-0000-0000-0000-00000000000000000).

api-version
query True

string

API-Version

Anforderungstext

Name Typ Beschreibung
kind

string

Art der Ressource.

properties.globalValidation

GlobalValidation

Die Konfigurationseinstellungen, die den Validierungsfluss von Benutzern mithilfe von App Service Authentifizierung/Autorisierung bestimmen.

properties.httpSettings

HttpSettings

Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen für App Service Authentifizierung/Autorisierung.

properties.identityProviders

IdentityProviders

Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren App Service Authentifizierung/Autorisierung verwendet werden.

properties.login

Login

Die Konfigurationseinstellungen des Anmeldeflows von Benutzern, die App Service Authentifizierung/Autorisierung verwenden.

properties.platform

AuthPlatform

Die Konfigurationseinstellungen der Plattform von App Service Authentifizierung/Autorisierung.

Antworten

Name Typ Beschreibung
200 OK

SiteAuthSettingsV2

OK

Other Status Codes

DefaultErrorResponse

App Service Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory-OAuth2-Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

Update Auth Settings V2

Sample Request

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/authsettingsV2?api-version=2023-12-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"
      }
    }
  }
}

Sample Response

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

Definitionen

Name Beschreibung
AllowedAudiencesValidation

Die Konfigurationseinstellungen des Überprüfungsflows zulässige Zielgruppen.

AllowedPrincipals

Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Prinzipale.

Apple

Die Konfigurationseinstellungen des Apple-Anbieters.

AppleRegistration

Die Konfigurationseinstellungen der Registrierung für den Apple-Anbieter

AppRegistration

Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit App-IDs und App-Geheimnissen

AuthPlatform

Die Konfigurationseinstellungen der Plattform von App Service Authentifizierung/Autorisierung.

AzureActiveDirectory

Die Konfigurationseinstellungen des Azure Active Directory-Anbieters.

AzureActiveDirectoryLogin

Die Konfigurationseinstellungen des Azure Active Directory-Anmeldeflows.

AzureActiveDirectoryRegistration

Die Konfigurationseinstellungen der Azure Active Directory-App-Registrierung.

AzureActiveDirectoryValidation

Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflows.

AzureStaticWebApps

Die Konfigurationseinstellungen des Azure Static Web Apps Anbieters.

AzureStaticWebAppsRegistration

Die Konfigurationseinstellungen der Registrierung für den Azure Static Web Apps anbieter

BlobStorageTokenStore

Die Konfigurationseinstellungen des Speichers der Token, wenn Blobspeicher verwendet wird.

ClientCredentialMethod

Die Methode, die zum Authentifizieren des Benutzers verwendet werden soll.

ClientRegistration

Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit Client-IDs und Clientgeheimnissen

CookieExpiration

Die Konfigurationseinstellungen des Ablaufs des Sitzungscookies.

CookieExpirationConvention

Die Konvention, die bei der Bestimmung des Ablaufs des Sitzungscookies verwendet wird.

CustomOpenIdConnectProvider

Die Konfigurationseinstellungen des benutzerdefinierten Open ID Connect-Anbieters.

DefaultAuthorizationPolicy

Die Konfigurationseinstellungen der Azure Active Directory-Standardautorisierungsrichtlinie.

DefaultErrorResponse

App Service Fehlerantwort.

Details
Error

Fehlermodell.

Facebook

Die Konfigurationseinstellungen des Facebook Anbieters.

FileSystemTokenStore

Die Konfigurationseinstellungen der Speicherung der Token, wenn ein Dateisystem verwendet wird.

ForwardProxy

Die Konfigurationseinstellungen eines Weiterleitungsproxys, der für die Anforderungen verwendet wird.

ForwardProxyConvention

Die Konvention, die verwendet wird, um die URL der gestellten Anforderung zu bestimmen.

GitHub

Die Konfigurationseinstellungen des GitHub-Anbieters.

GlobalValidation

Die Konfigurationseinstellungen, die den Validierungsfluss von Benutzern mithilfe von App Service Authentifizierung/Autorisierung bestimmen.

Google

Die Konfigurationseinstellungen des Google-Anbieters.

HttpSettings

Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen für App Service Authentifizierung/Autorisierung.

HttpSettingsRoutes

Die Konfigurationseinstellungen der Pfade für HTTP-Anforderungen.

IdentityProviders

Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren App Service Authentifizierung/Autorisierung verwendet werden.

JwtClaimChecks

Die Konfigurationseinstellungen der Überprüfungen, die beim Überprüfen der JWT-Ansprüche vorgenommen werden sollen.

LegacyMicrosoftAccount

Die Konfigurationseinstellungen des älteren Microsoft-Kontoanbieters.

Login

Die Konfigurationseinstellungen des Anmeldeflows von Benutzern, die App Service Authentifizierung/Autorisierung verwenden.

LoginRoutes

Die Routen, die die Endpunkte angeben, die für Anmelde- und Abmeldeanforderungen verwendet werden.

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows, einschließlich der Bereiche, die angefordert werden sollen.

Nonce

Die Konfigurationseinstellungen der nonce, die im Anmeldeflow verwendet werden.

OpenIdConnectClientCredential

Die Anmeldeinformationen des Authentifizierungsclients des benutzerdefinierten Open ID Connect-Anbieters.

OpenIdConnectConfig

Die Konfigurationseinstellungen der Endpunkte, die für den benutzerdefinierten Open ID Connect-Anbieter verwendet werden.

OpenIdConnectLogin

Die Konfigurationseinstellungen des Anmeldeflows des benutzerdefinierten Open ID Connect-Anbieters.

OpenIdConnectRegistration

Die Konfigurationseinstellungen der App-Registrierung für den benutzerdefinierten Open ID Connect-Anbieter.

SiteAuthSettingsV2

Konfigurationseinstellungen für das Feature Azure App Service Authentifizierung/Autorisierung V2.

TokenStore

Die Konfigurationseinstellungen des Tokenspeichers.

Twitter

Die Konfigurationseinstellungen des Twitter-Anbieters.

TwitterRegistration

Die Konfigurationseinstellungen der App-Registrierung für den Twitter-Anbieter.

UnauthenticatedClientActionV2

Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

AllowedAudiencesValidation

Die Konfigurationseinstellungen des Überprüfungsflows zulässige Zielgruppen.

Name Typ Beschreibung
allowedAudiences

string[]

Die Konfigurationseinstellungen der zulässigen Liste der Zielgruppen, aus denen das JWT-Token überprüft werden soll.

AllowedPrincipals

Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Prinzipale.

Name Typ Beschreibung
groups

string[]

Die Liste der zulässigen Gruppen.

identities

string[]

Die Liste der zulässigen Identitäten.

Apple

Die Konfigurationseinstellungen des Apple-Anbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der Apple-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden soll; trueandernfalls .

login

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows.

registration

AppleRegistration

Die Konfigurationseinstellungen der Apple-Registrierung.

AppleRegistration

Die Konfigurationseinstellungen der Registrierung für den Apple-Anbieter

Name Typ Beschreibung
clientId

string

Die Client-ID der App, die für die Anmeldung verwendet wird.

clientSecretSettingName

string

Der App-Einstellungsname, der den geheimen Clientschlüssel enthält.

AppRegistration

Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit App-IDs und App-Geheimnissen

Name Typ Beschreibung
appId

string

Die App-ID der App, die für die Anmeldung verwendet wird.

appSecretSettingName

string

Der Name der App-Einstellung, der das App-Geheimnis enthält.

AuthPlatform

Die Konfigurationseinstellungen der Plattform von App Service Authentifizierung/Autorisierung.

Name Typ Beschreibung
configFilePath

string

Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält, wenn sie aus einer Datei stammen. Wenn der Pfad relativ ist, wird basis das Stammverzeichnis der Website verwendet.

enabled

boolean

true , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; falseandernfalls .

runtimeVersion

string

Die RuntimeVersion des Authentifizierungs-/Autorisierungsfeatures, das für die aktuelle App verwendet wird. Die Einstellung in diesem Wert kann das Verhalten bestimmter Features im Modul Authentifizierung/Autorisierung steuern.

AzureActiveDirectory

Die Konfigurationseinstellungen des Azure Active Directory-Anbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der Azure Active Directory-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden soll; trueandernfalls .

isAutoProvisioned

boolean

Ruft einen Wert ab, der angibt, ob die Azure AD-Konfiguration mithilfe von Tools des 1. Drittanbieters automatisch bereitgestellt wurde. Dies ist ein internes Flag, das in erster Linie zur Unterstützung des Azure-Verwaltungsportals vorgesehen ist. Benutzer sollten diese Eigenschaft nicht lesen oder schreiben.

login

AzureActiveDirectoryLogin

Die Konfigurationseinstellungen des Azure Active Directory-Anmeldeflows.

registration

AzureActiveDirectoryRegistration

Die Konfigurationseinstellungen der Azure Active Directory-App-Registrierung.

validation

AzureActiveDirectoryValidation

Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflows.

AzureActiveDirectoryLogin

Die Konfigurationseinstellungen des Azure Active Directory-Anmeldeflows.

Name Typ Beschreibung
disableWWWAuthenticate

boolean

true , wenn der www-authenticate-Anbieter in der Anforderung weggelassen werden soll; falseandernfalls .

loginParameters

string[]

Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn sich ein Benutzer anmeldet. Jeder Parameter muss die Form "key=value" aufweisen.

AzureActiveDirectoryRegistration

Die Konfigurationseinstellungen der Azure Active Directory-App-Registrierung.

Name Typ Beschreibung
clientId

string

Die Client-ID dieser Anwendung der vertrauenden Seite, die als client_id bezeichnet wird. Diese Einstellung ist erforderlich, um die OpenID-Verbindungsauthentifizierung mit Azure Active Directory oder anderen OpenID Connect-Drittanbietern zu aktivieren. Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html

clientSecretCertificateIssuer

string

Eine Alternative zum geheimen Fingerabdruck des Clients, d. h. der Aussteller eines Zertifikats, das zu Signierungszwecken verwendet wird. Diese Eigenschaft fungiert als Ersatz für den Zertifikatfingerabdruck des geheimen Clientschlüssels. Es ist auch optional.

clientSecretCertificateSubjectAlternativeName

string

Eine Alternative zum geheimen Fingerabdruck des Clientschlüssels, d. h. der alternative Antragstellername eines Zertifikats, das zu Signierungszwecken verwendet wird. Diese Eigenschaft fungiert als Ersatz für den Zertifikatfingerabdruck des geheimen Clientschlüssels. Es ist auch optional.

clientSecretCertificateThumbprint

string

Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als Ersatz für den geheimen Clientschlüssel. Es ist auch optional.

clientSecretSettingName

string

Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält.

openIdIssuer

string

Der OpenID Connect-Aussteller-URI, der die Entität darstellt, die Zugriffstoken für diese Anwendung ausgibt. Bei Verwendung von Azure Active Directory ist dieser Wert der URI des Verzeichnismandanten, z. B. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Bei diesem URI handelt es sich um einen Bezeichner, bei dem die Groß-/Kleinschreibung für den Tokenaussteller beachtet wird. Weitere Informationen zur OpenID Connect-Ermittlung: http://openid.net/specs/openid-connect-discovery-1_0.html

AzureActiveDirectoryValidation

Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflows.

Name Typ Beschreibung
allowedAudiences

string[]

Die Liste der Zielgruppen, die erfolgreiche Authentifizierungs-/Autorisierungsanforderungen stellen können.

defaultAuthorizationPolicy

DefaultAuthorizationPolicy

Die Konfigurationseinstellungen der Standardautorisierungsrichtlinie.

jwtClaimChecks

JwtClaimChecks

Die Konfigurationseinstellungen der Überprüfungen, die beim Überprüfen der JWT-Ansprüche vorgenommen werden sollen.

AzureStaticWebApps

Die Konfigurationseinstellungen des Azure Static Web Apps Anbieters.

Name Typ Beschreibung
enabled

boolean

false, wenn der Azure Static Web Apps-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden soll, trueandernfalls .

registration

AzureStaticWebAppsRegistration

Die Konfigurationseinstellungen des Azure Static Web Apps Registrierung.

AzureStaticWebAppsRegistration

Die Konfigurationseinstellungen der Registrierung für den Azure Static Web Apps anbieter

Name Typ Beschreibung
clientId

string

Die Client-ID der App, die für die Anmeldung verwendet wird.

BlobStorageTokenStore

Die Konfigurationseinstellungen des Speichers der Token, wenn Blobspeicher verwendet wird.

Name Typ Beschreibung
sasUrlSettingName

string

Der Name der App-Einstellung, die die SAS-URL des Blobspeichers enthält, der die Token enthält.

ClientCredentialMethod

Die Methode, die zum Authentifizieren des Benutzers verwendet werden soll.

Name Typ Beschreibung
ClientSecretPost

string

ClientRegistration

Die Konfigurationseinstellungen der App-Registrierung für Anbieter mit Client-IDs und Clientgeheimnissen

Name Typ Beschreibung
clientId

string

Die Client-ID der App, die für die Anmeldung verwendet wird.

clientSecretSettingName

string

Der App-Einstellungsname, der den geheimen Clientschlüssel enthält.

CookieExpiration

Die Konfigurationseinstellungen des Ablaufs des Sitzungscookies.

Name Typ Beschreibung
convention

CookieExpirationConvention

Die Konvention, die bei der Bestimmung des Ablaufs des Sitzungscookies verwendet wird.

timeToExpiration

string

Die Zeit nach der Anforderung, wenn das Sitzungscookies ablaufen soll.

CookieExpirationConvention

Die Konvention, die bei der Bestimmung des Ablaufs des Sitzungscookies verwendet wird.

Name Typ Beschreibung
FixedTime

string

IdentityProviderDerived

string

CustomOpenIdConnectProvider

Die Konfigurationseinstellungen des benutzerdefinierten Open ID Connect-Anbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der benutzerdefinierte Open ID-Anbieter nicht aktiviert sein soll; trueandernfalls .

login

OpenIdConnectLogin

Die Konfigurationseinstellungen des Anmeldeflows des benutzerdefinierten Open ID Connect-Anbieters.

registration

OpenIdConnectRegistration

Die Konfigurationseinstellungen der App-Registrierung für den benutzerdefinierten Open ID Connect-Anbieter.

DefaultAuthorizationPolicy

Die Konfigurationseinstellungen der Azure Active Directory-Standardautorisierungsrichtlinie.

Name Typ Beschreibung
allowedApplications

string[]

Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Anwendungen.

allowedPrincipals

AllowedPrincipals

Die Konfigurationseinstellungen der zulässigen Azure Active Directory-Prinzipale.

DefaultErrorResponse

App Service Fehlerantwort.

Name Typ Beschreibung
error

Error

Fehlermodell.

Details

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.

message

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

target

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

Error

Fehlermodell.

Name Typ Beschreibung
code

string

Standardisierte Zeichenfolge zum programmgesteuerten Identifizieren des Fehlers.

details

Details[]

Detaillierte Fehler.

innererror

string

Weitere Informationen zum Debuggen des Fehlers.

message

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

target

string

Ausführliche Fehlerbeschreibung und Debuginformationen.

Facebook

Die Konfigurationseinstellungen des Facebook Anbieters.

Name Typ Beschreibung
enabled

boolean

false, wenn der Facebook Anbieter trotz der festgelegten Registrierung nicht aktiviert werden soll, trueandernfalls .

graphApiVersion

string

Die Version der Facebook-API, die bei der Anmeldung verwendet werden soll.

login

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows.

registration

AppRegistration

Die Konfigurationseinstellungen der App-Registrierung für den Facebook Anbieters.

FileSystemTokenStore

Die Konfigurationseinstellungen der Speicherung der Token, wenn ein Dateisystem verwendet wird.

Name Typ Beschreibung
directory

string

Das Verzeichnis, in dem die Token gespeichert werden.

ForwardProxy

Die Konfigurationseinstellungen eines Weiterleitungsproxys, der für die Anforderungen verwendet wird.

Name Typ Beschreibung
convention

ForwardProxyConvention

Die Konvention, die verwendet wird, um die URL der gestellten Anforderung zu bestimmen.

customHostHeaderName

string

Der Name des Headers, der den Host der Anforderung enthält.

customProtoHeaderName

string

Der Name des Headers, der das Schema der Anforderung enthält.

ForwardProxyConvention

Die Konvention, die verwendet wird, um die URL der gestellten Anforderung zu bestimmen.

Name Typ Beschreibung
Custom

string

NoProxy

string

Standard

string

GitHub

Die Konfigurationseinstellungen des GitHub-Anbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der GitHub-Anbieter trotz der Setregistrierung nicht aktiviert werden soll; trueandernfalls .

login

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows.

registration

ClientRegistration

Die Konfigurationseinstellungen der App-Registrierung für den GitHub-Anbieter.

GlobalValidation

Die Konfigurationseinstellungen, die den Validierungsfluss von Benutzern mithilfe von App Service Authentifizierung/Autorisierung bestimmen.

Name Typ Beschreibung
excludedPaths

string[]

Die Pfade, für die nicht authentifizierter Flow nicht zur Anmeldeseite umgeleitet werden würde.

redirectToProvider

string

Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind. Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter konfiguriert sind und die nicht authentifizierte Clientaktion auf "RedirectToLoginPage" festgelegt ist.

requireAuthentication

boolean

true wenn der Authentifizierungsfluss erforderlich ist, wird eine Anforderung gestellt; falseandernfalls .

unauthenticatedClientAction

UnauthenticatedClientActionV2

Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

Google

Die Konfigurationseinstellungen des Google-Anbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der Google-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden soll; trueandernfalls .

login

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows.

registration

ClientRegistration

Die Konfigurationseinstellungen der App-Registrierung für den Google-Anbieter.

validation

AllowedAudiencesValidation

Die Konfigurationseinstellungen des Azure Active Directory-Tokenüberprüfungsflows.

HttpSettings

Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen für App Service Authentifizierung/Autorisierung.

Name Typ Beschreibung
forwardProxy

ForwardProxy

Die Konfigurationseinstellungen eines Weiterleitungsproxys, der zum Senden der Anforderungen verwendet wird.

requireHttps

boolean

false , wenn die Authentifizierungs-/Autorisierungsantworten ohne HTTPS-Schema zulässig sind; trueandernfalls .

routes

HttpSettingsRoutes

Die Konfigurationseinstellungen der Pfade für HTTP-Anforderungen.

HttpSettingsRoutes

Die Konfigurationseinstellungen der Pfade für HTTP-Anforderungen.

Name Typ Beschreibung
apiPrefix

string

Das Präfix, das allen Authentifizierungs-/Autorisierungspfaden vorangehen soll.

IdentityProviders

Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren App Service Authentifizierung/Autorisierung verwendet werden.

Name Typ Beschreibung
apple

Apple

Die Konfigurationseinstellungen des Apple-Anbieters.

azureActiveDirectory

AzureActiveDirectory

Die Konfigurationseinstellungen des Azure Active Directory-Anbieters.

azureStaticWebApps

AzureStaticWebApps

Die Konfigurationseinstellungen des Azure Static Web Apps Anbieters.

customOpenIdConnectProviders

<string,  CustomOpenIdConnectProvider>

Die Zuordnung des Namens des Alias jedes benutzerdefinierten Open ID Connect-Anbieters zu den Konfigurationseinstellungen des benutzerdefinierten Open ID Connect-Anbieters.

facebook

Facebook

Die Konfigurationseinstellungen des Facebook Anbieters.

gitHub

GitHub

Die Konfigurationseinstellungen des GitHub-Anbieters.

google

Google

Die Konfigurationseinstellungen des Google-Anbieters.

legacyMicrosoftAccount

LegacyMicrosoftAccount

Die Konfigurationseinstellungen des älteren Microsoft-Kontoanbieters.

twitter

Twitter

Die Konfigurationseinstellungen des Twitter-Anbieters.

JwtClaimChecks

Die Konfigurationseinstellungen der Überprüfungen, die beim Überprüfen der JWT-Ansprüche vorgenommen werden sollen.

Name Typ Beschreibung
allowedClientApplications

string[]

Die Liste der zulässigen Clientanwendungen.

allowedGroups

string[]

Die Liste der zulässigen Gruppen.

LegacyMicrosoftAccount

Die Konfigurationseinstellungen des älteren Microsoft-Kontoanbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der Ältere Microsoft-Kontoanbieter trotz der festgelegten Registrierung nicht aktiviert werden soll; trueandernfalls .

login

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows.

registration

ClientRegistration

Die Konfigurationseinstellungen der App-Registrierung für den älteren Microsoft-Kontoanbieter.

validation

AllowedAudiencesValidation

Die Konfigurationseinstellungen des Tokenüberprüfungsflows des Legacy-Microsoft-Kontoanbieters.

Login

Die Konfigurationseinstellungen des Anmeldeflows von Benutzern, die App Service Authentifizierung/Autorisierung verwenden.

Name Typ Beschreibung
allowedExternalRedirectUrls

string[]

Externe URLs, zu denen im Rahmen des Anmeldens oder Abmeldens der App umgeleitet werden kann. Beachten Sie, dass der Abfragezeichenfolgenteil der URL ignoriert wird. Dies ist eine erweiterte Einstellung, die normalerweise nur von Windows Store-Anwendungs-Back-Ends benötigt wird. Beachten Sie, dass URLs innerhalb der aktuellen Domäne immer implizit zulässig sind.

cookieExpiration

CookieExpiration

Die Konfigurationseinstellungen des Ablaufs des Sitzungscookies.

nonce

Nonce

Die Konfigurationseinstellungen der nonce, die im Anmeldeflow verwendet wird.

preserveUrlFragmentsForLogins

boolean

true , wenn die Fragmente aus der Anforderung beibehalten werden, nachdem die Anmeldeanforderung gestellt wurde; falseandernfalls .

routes

LoginRoutes

Die Routen, die die Endpunkte angeben, die für Anmelde- und Abmeldeanforderungen verwendet werden.

tokenStore

TokenStore

Die Konfigurationseinstellungen des Tokenspeichers.

LoginRoutes

Die Routen, die die Endpunkte angeben, die für Anmelde- und Abmeldeanforderungen verwendet werden.

Name Typ Beschreibung
logoutEndpoint

string

Der Endpunkt, an dem eine Abmeldeanforderung gestellt werden soll.

LoginScopes

Die Konfigurationseinstellungen des Anmeldeflows, einschließlich der Bereiche, die angefordert werden sollen.

Name Typ Beschreibung
scopes

string[]

Eine Liste der Bereiche, die bei der Authentifizierung angefordert werden sollen.

Nonce

Die Konfigurationseinstellungen der nonce, die im Anmeldeflow verwendet werden.

Name Typ Beschreibung
nonceExpirationInterval

string

Die Zeit nach der Anforderung, wenn die Nonce ablaufen soll.

validateNonce

boolean

false , wenn die Nonce beim Abschließen des Anmeldeflows nicht überprüft werden soll; trueandernfalls .

OpenIdConnectClientCredential

Die Anmeldeinformationen des Authentifizierungsclients des benutzerdefinierten Open ID Connect-Anbieters.

Name Typ Beschreibung
clientSecretSettingName

string

Die App-Einstellung, die den geheimen Clientschlüssel für den benutzerdefinierten Open ID Connect-Anbieter enthält.

method

ClientCredentialMethod

Die Methode, die zum Authentifizieren des Benutzers verwendet werden soll.

OpenIdConnectConfig

Die Konfigurationseinstellungen der Endpunkte, die für den benutzerdefinierten Open ID Connect-Anbieter verwendet werden.

Name Typ Beschreibung
authorizationEndpoint

string

Der Endpunkt, der zum Ausführen einer Autorisierungsanforderung verwendet werden soll.

certificationUri

string

Der Endpunkt, der die Schlüssel bereitstellt, die zum Überprüfen des Tokens erforderlich sind.

issuer

string

Der Endpunkt, der das Token ausgibt.

tokenEndpoint

string

Der Endpunkt, der zum Anfordern eines Tokens verwendet werden soll.

wellKnownOpenIdConfiguration

string

Der Endpunkt, der alle Konfigurationsendpunkte für den Anbieter enthält.

OpenIdConnectLogin

Die Konfigurationseinstellungen des Anmeldeflows des benutzerdefinierten Open ID Connect-Anbieters.

Name Typ Beschreibung
nameClaimType

string

Der Name des Anspruchs, der den Benutzernamen enthält.

scopes

string[]

Eine Liste der Bereiche, die bei der Authentifizierung angefordert werden sollen.

OpenIdConnectRegistration

Die Konfigurationseinstellungen der App-Registrierung für den benutzerdefinierten Open ID Connect-Anbieter.

Name Typ Beschreibung
clientCredential

OpenIdConnectClientCredential

Die Anmeldeinformationen für die Authentifizierung des benutzerdefinierten Open ID Connect-Anbieters.

clientId

string

Die Client-ID des benutzerdefinierten Open ID Connect-Anbieters.

openIdConnectConfiguration

OpenIdConnectConfig

Die Konfigurationseinstellungen der Endpunkte, die für den benutzerdefinierten Open ID Connect-Anbieter verwendet werden.

SiteAuthSettingsV2

Konfigurationseinstellungen für das Feature Azure App Service Authentifizierung/Autorisierung V2.

Name Typ Beschreibung
id

string

Ressourcen-ID.

kind

string

Art der Ressource.

name

string

Ressourcenname.

properties.globalValidation

GlobalValidation

Die Konfigurationseinstellungen, die den Validierungsfluss von Benutzern mithilfe von App Service Authentifizierung/Autorisierung bestimmen.

properties.httpSettings

HttpSettings

Die Konfigurationseinstellungen der HTTP-Anforderungen für Authentifizierungs- und Autorisierungsanforderungen für App Service Authentifizierung/Autorisierung.

properties.identityProviders

IdentityProviders

Die Konfigurationseinstellungen der einzelnen Identitätsanbieter, die zum Konfigurieren App Service Authentifizierung/Autorisierung verwendet werden.

properties.login

Login

Die Konfigurationseinstellungen des Anmeldeflows von Benutzern, die App Service Authentifizierung/Autorisierung verwenden.

properties.platform

AuthPlatform

Die Konfigurationseinstellungen der Plattform von App Service Authentifizierung/Autorisierung.

type

string

Der Ressourcentyp.

TokenStore

Die Konfigurationseinstellungen des Tokenspeichers.

Name Typ Beschreibung
azureBlobStorage

BlobStorageTokenStore

Die Konfigurationseinstellungen des Speichers der Token, wenn Blobspeicher verwendet wird.

enabled

boolean

true um plattformspezifische Sicherheitstoken, die während der Anmeldeflows abgerufen werden, dauerhaft zu speichern; falseandernfalls . Der Standardwert lautet false.

fileSystem

FileSystemTokenStore

Die Konfigurationseinstellungen der Speicherung der Token, wenn ein Dateisystem verwendet wird.

tokenRefreshExtensionHours

number

Die Anzahl der Stunden nach Ablauf des Sitzungstokens, die ein Sitzungstoken zum Aufrufen der Tokenaktualisierungs-API verwendet werden kann. Die Standardeinstellung beträgt 72 Stunden.

Twitter

Die Konfigurationseinstellungen des Twitter-Anbieters.

Name Typ Beschreibung
enabled

boolean

false , wenn der Twitter-Anbieter trotz der festgelegten Registrierung nicht aktiviert werden soll; trueandernfalls .

registration

TwitterRegistration

Die Konfigurationseinstellungen der App-Registrierung für den Twitter-Anbieter.

TwitterRegistration

Die Konfigurationseinstellungen der App-Registrierung für den Twitter-Anbieter.

Name Typ Beschreibung
consumerKey

string

Der OAuth 1.0a-Consumerschlüssel der Twitter-Anwendung, die für die Anmeldung verwendet wird. Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren. Dokumentation zu Twitter-Sign-In: https://dev.twitter.com/web/sign-in

consumerSecretSettingName

string

Der Name der App-Einstellung, der das OAuth 1.0a-Consumergeheimnis der twitter-Anwendung enthält, die für die Anmeldung verwendet wird.

UnauthenticatedClientActionV2

Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen.

Name Typ Beschreibung
AllowAnonymous

string

RedirectToLoginPage

string

Return401

string

Return403

string