Microsoft.Web sites/slots/config 'authsettings' 2021-01-01

  • Artikel

Bicep-Ressourcendefinition

Der Ressourcentyp sites/slots/config kann mit Vorgängen bereitgestellt werden, die auf Folgendes abzielen:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie im Änderungsprotokoll.

Optionen für die Name-Eigenschaft

Die Ressource sites/slots/config akzeptiert basierend auf dem Wert der Name-Eigenschaft unterschiedliche Eigenschaften. In diesem Artikel werden die Eigenschaften gezeigt, die verfügbar sind, wenn Sie festlegen name: 'authsettings'.

Für andere Optionen, siehe:

Ressourcenformat

Um eine Microsoft.Web/sites/slots/config-Ressource zu erstellen, fügen Sie der Vorlage den folgenden Bicep hinzu.

resource symbolicname 'Microsoft.Web/sites/slots/config@2021-01-01' = {
  name: 'authsettings'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    aadClaimsAuthorization: 'string'
    additionalLoginParams: [
      'string'
    ]
    allowedAudiences: [
      'string'
    ]
    allowedExternalRedirectUrls: [
      'string'
    ]
    authFilePath: 'string'
    clientId: 'string'
    clientSecret: 'string'
    clientSecretCertificateThumbprint: 'string'
    clientSecretSettingName: 'string'
    configVersion: 'string'
    defaultProvider: 'string'
    enabled: bool
    facebookAppId: 'string'
    facebookAppSecret: 'string'
    facebookAppSecretSettingName: 'string'
    facebookOAuthScopes: [
      'string'
    ]
    gitHubClientId: 'string'
    gitHubClientSecret: 'string'
    gitHubClientSecretSettingName: 'string'
    gitHubOAuthScopes: [
      'string'
    ]
    googleClientId: 'string'
    googleClientSecret: 'string'
    googleClientSecretSettingName: 'string'
    googleOAuthScopes: [
      'string'
    ]
    isAuthFromFile: 'string'
    issuer: 'string'
    microsoftAccountClientId: 'string'
    microsoftAccountClientSecret: 'string'
    microsoftAccountClientSecretSettingName: 'string'
    microsoftAccountOAuthScopes: [
      'string'
    ]
    runtimeVersion: 'string'
    tokenRefreshExtensionHours: int
    tokenStoreEnabled: bool
    twitterConsumerKey: 'string'
    twitterConsumerSecret: 'string'
    twitterConsumerSecretSettingName: 'string'
    unauthenticatedClientAction: 'string'
    validateIssuer: bool
  }
}

Eigenschaftswerte

sites/slots/config-authsettings

Name Beschreibung Wert
name Der Ressourcenname

Weitere Informationen finden Sie unter Festlegen von Namen und Typen für untergeordnete Ressourcen in Bicep.		 "authsettings"
kind Art der Ressource. Zeichenfolge
parent In Bicep können Sie die übergeordnete Ressource für eine untergeordnete Ressource angeben. Sie müssen diese Eigenschaft nur hinzufügen, wenn die untergeordnete Ressource außerhalb der übergeordneten Ressource deklariert wird.

Weitere Informationen finden Sie unter Untergeordnete Ressource außerhalb der übergeordneten Ressource.		 Symbolischer Name für Ressource vom Typ: Slots
properties Ressourcenspezifische Eigenschaften von SiteAuthSettings SiteAuthSettingsProperties

SiteAuthSettingsProperties

Name Beschreibung Wert
aadClaimsAuthorization Ruft eine JSON-Zeichenfolge ab, die die Azure AD-Acl-Einstellungen enthält. Zeichenfolge
additionalLoginParams Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn
Ein Benutzer meldet sich an. Jeder Parameter muss die Form "key=value" aufweisen.		 string[]
allowedAudiences Zulässige Zielgruppenwerte, die beim Überprüfen von von ausgestellten JWTs berücksichtigt werden
Azure Active Directory Beachten Sie, dass der ClientID Wert immer als
zulässige Zielgruppe, unabhängig von dieser Einstellung.		 string[]
allowedExternalRedirectUrls Externe URLs, die im Rahmen der Anmeldung oder Abmeldung der App umgeleitet werden können. 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.		 string[]
authFilePath Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält.
Wenn der Pfad relativ ist, wird base das Stammverzeichnis der Website.		 Zeichenfolge
clientId 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 zu aktivieren.
andere OpenID Connect-Anbieter von Drittanbietern.
Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 Zeichenfolge
clientSecret Der geheime Clientschlüssel dieser Anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet).
Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite OpenID Connect-Authentifizierungsflow verwendet, um Endbenutzer zu authentifizieren.
Andernfalls wird der OpenID Connect-Autorisierungscodeflow verwendet, um Endbenutzer zu authentifizieren.
Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 Zeichenfolge
clientSecretCertificateThumbprint Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als
ein Ersatz für den geheimen Clientschlüssel. Es ist auch optional.		 Zeichenfolge
clientSecretSettingName Der App-Einstellungsname, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält. Zeichenfolge
configVersion Die ConfigVersion der Authentifizierungs-/Autorisierungsfunktion, die für die aktuelle App verwendet wird.
Die Einstellung in diesem Wert kann das Verhalten der Steuerungsebene für Authentifizierung/Autorisierung steuern.		 Zeichenfolge
Defaultprovider Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind.
Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter und der nicht authentifizierte Client konfiguriert sind.
action ist auf "RedirectToLoginPage" festgelegt.		 "AzureActiveDirectory"
"Facebook"
"Github"
"Google"
"MicrosoftAccount"
"Twitter"
enabled true , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; falseandernfalls . bool
facebookAppId Die App-ID der Facebook-App, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 Zeichenfolge
facebookAppSecret Das App-Geheimnis der Facebook-App, die für die Facebook-Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 Zeichenfolge
facebookAppSecretSettingName Der App-Einstellungsname, der das für die Facebook-Anmeldung verwendete App-Geheimnis enthält. Zeichenfolge
facebookOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Facebook-Anmeldeauthentifizierung angefordert werden.
Diese Einstellung ist optional.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 string[]
gitHubClientId Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.		 Zeichenfolge
gitHubClientSecret Der geheime Clientschlüssel der GitHub-App, die für die Github-Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.		 Zeichenfolge
gitHubClientSecretSettingName Der App-Einstellungsname, der den geheimen Clientschlüssel des GitHub enthält
App, die für die GitHub-Anmeldung verwendet wird.		 Zeichenfolge
gitHubOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der GitHub-Anmeldeauthentifizierung angefordert werden.
Diese Einstellung ist optional.		 string[]
googleClientId Die OpenID Connect-Client-ID für die Google-Webanwendung.
Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren.
Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/		 Zeichenfolge
googleClientSecret Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist.
Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren.
Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/		 Zeichenfolge
googleClientSecretSettingName Der App-Einstellungsname, der den geheimen Clientschlüssel enthält, der zugeordnet ist
die Google-Webanwendung.		 Zeichenfolge
googleOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Google-Sign-In-Authentifizierung angefordert werden.
Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet.
Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/		 string[]
isAuthFromFile "true", wenn die Konfigurationseinstellungen der Authentifizierung aus einer Datei gelesen werden sollen,
Andernfalls "false"		 Zeichenfolge
Issuer (Aussteller) Der OpenID Connect Issuer-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://sts.windows.net/{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 Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html		 Zeichenfolge
microsoftAccountClientId Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde.
Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren.
Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm		 Zeichenfolge
microsoftAccountClientSecret Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde.
Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren.
Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm		 Zeichenfolge
microsoftAccountClientSecretSettingName Der App-Einstellungsname, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die
App, die für die Authentifizierung verwendet wird.		 Zeichenfolge
microsoftAccountOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Microsoft-Kontoauthentifizierung angefordert werden.
Diese Einstellung ist optional. Falls nicht angegeben, wird "wl.basic" als Standardbereich verwendet.
Dokumentation zu Microsoft-Kontobereichen und Berechtigungen: https://msdn.microsoft.com/library/dn631845.aspx		 string[]
runtimeVersion 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.		 Zeichenfolge
tokenRefreshExtensionHours Die Anzahl der Stunden nach Ablauf des Sitzungstokens, für die ein Sitzungstoken verwendet werden kann
rufen Sie die Tokenaktualisierungs-API auf. Die Standardeinstellung beträgt 72 Stunden.		 INT
tokenStoreEnabled true um plattformspezifische Sicherheitstoken, die während der Anmeldeflows abgerufen werden, dauerhaft zu speichern; falseandernfalls .
Der Standardwert lautet false.		 bool
twitterConsumerKey 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.
Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in		 Zeichenfolge
twitterConsumerSecret Das OAuth 1.0a-Consumergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren.
Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in		 Zeichenfolge
twitterConsumerSecretSettingName Der App-Einstellungsname, der das OAuth 1.0a-Consumergeheimnis des Twitter-Kontos enthält
Anwendung, die für die Anmeldung verwendet wird.		 Zeichenfolge
unauthenticatedClientAction Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein soll und als solcher überprüft werden soll. bool

Ressourcendefinition mit einer ARM-Vorlage

Der Ressourcentyp sites/slots/config kann mit Vorgängen bereitgestellt werden, die folgende Ziele haben:

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Optionen für die Name-Eigenschaft

Die Ressource sites/slots/config akzeptiert verschiedene Eigenschaften basierend auf dem Wert der Name-Eigenschaft . In diesem Artikel werden die Eigenschaften veranschaulicht, die verfügbar sind, wenn Sie festlegen name: 'authsettings'.

Für andere Optionen, siehe:

Ressourcenformat

Um eine Microsoft.Web/sites/slots/config-Ressource zu erstellen, fügen Sie der Vorlage den folgenden JSON-Code hinzu.

{
  "type": "Microsoft.Web/sites/slots/config",
  "apiVersion": "2021-01-01",
  "name": "authsettings",
  "kind": "string",
  "properties": {
    "aadClaimsAuthorization": "string",
    "additionalLoginParams": [ "string" ],
    "allowedAudiences": [ "string" ],
    "allowedExternalRedirectUrls": [ "string" ],
    "authFilePath": "string",
    "clientId": "string",
    "clientSecret": "string",
    "clientSecretCertificateThumbprint": "string",
    "clientSecretSettingName": "string",
    "configVersion": "string",
    "defaultProvider": "string",
    "enabled": "bool",
    "facebookAppId": "string",
    "facebookAppSecret": "string",
    "facebookAppSecretSettingName": "string",
    "facebookOAuthScopes": [ "string" ],
    "gitHubClientId": "string",
    "gitHubClientSecret": "string",
    "gitHubClientSecretSettingName": "string",
    "gitHubOAuthScopes": [ "string" ],
    "googleClientId": "string",
    "googleClientSecret": "string",
    "googleClientSecretSettingName": "string",
    "googleOAuthScopes": [ "string" ],
    "isAuthFromFile": "string",
    "issuer": "string",
    "microsoftAccountClientId": "string",
    "microsoftAccountClientSecret": "string",
    "microsoftAccountClientSecretSettingName": "string",
    "microsoftAccountOAuthScopes": [ "string" ],
    "runtimeVersion": "string",
    "tokenRefreshExtensionHours": "int",
    "tokenStoreEnabled": "bool",
    "twitterConsumerKey": "string",
    "twitterConsumerSecret": "string",
    "twitterConsumerSecretSettingName": "string",
    "unauthenticatedClientAction": "string",
    "validateIssuer": "bool"
  }
}

Eigenschaftswerte

sites/slots/config-authsettings

Name Beschreibung Wert
type Ressourcentyp "Microsoft.Web/sites/slots/config"
apiVersion Die Ressourcen-API-Version '2021-01-01'
name Der Ressourcenname

Erfahren Sie, wie Sie Namen und Typen für untergeordnete Ressourcen in JSON-ARM-Vorlagen festlegen.		 "Authentifizierungseinstellungen"
kind Art der Ressource. Zeichenfolge
properties Ressourcenspezifische Eigenschaften von SiteAuthSettings SiteAuthSettingsProperties

SiteAuthSettingsProperties

Name Beschreibung Wert
aadClaimsAuthorization Ruft eine JSON-Zeichenfolge ab, die die Azure AD-ACL-Einstellungen enthält. Zeichenfolge
additionalLoginParams Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn
ein Benutzer meldet sich an. Jeder Parameter muss das Format "key=value" aufweisen.		 string[]
allowedAudiences Zulässige Zielgruppenwerte, die beim Überprüfen von von ausgestellten JWTs berücksichtigt werden
Azure Active Directory Beachten Sie, dass der ClientID Wert immer als
Zulässige Zielgruppe, unabhängig von dieser Einstellung.		 string[]
allowedExternalRedirectUrls 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.		 string[]
authFilePath Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält.
Wenn der Pfad relativ ist, wird base das Stammverzeichnis der Website.		 Zeichenfolge
clientId 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 zu aktivieren.
andere OpenID Connect-Anbieter von Drittanbietern.
Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 Zeichenfolge
clientSecret Der geheime Clientschlüssel dieser Anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet).
Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite OpenID Connect-Authentifizierungsflow verwendet, um Endbenutzer zu authentifizieren.
Andernfalls wird der OpenID Connect-Autorisierungscodeflow verwendet, um Endbenutzer zu authentifizieren.
Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 Zeichenfolge
clientSecretCertificateThumbprint Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als
ein Ersatz für den geheimen Clientschlüssel. Es ist auch optional.		 Zeichenfolge
clientSecretSettingName Der Name der App-Einstellung, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält. Zeichenfolge
configVersion Die ConfigVersion der Authentifizierungs-/Autorisierungsfunktion, die für die aktuelle App verwendet wird.
Die Einstellung in diesem Wert kann das Verhalten der Steuerungsebene für Authentifizierung/Autorisierung steuern.		 Zeichenfolge
Defaultprovider Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind.
Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter und der nicht authentifizierte Client konfiguriert sind.
action ist auf "RedirectToLoginPage" festgelegt.		 "AzureActiveDirectory"
"Facebook"
"GitHub"
"Google"
"MicrosoftAccount"
"Twitter"
enabled true , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; falseandernfalls . bool
facebookAppId Die App-ID der Facebook-App, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 Zeichenfolge
facebookAppSecret Das App-Geheimnis der Facebook-App, die für die Facebook-Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 Zeichenfolge
facebookAppSecretSettingName Der Name der App-Einstellung, der das für die Facebook-Anmeldung verwendete App-Geheimnis enthält. Zeichenfolge
facebookOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Facebook-Anmeldeauthentifizierung angefordert werden.
Diese Einstellung ist optional.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 string[]
gitHubClientId Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die GitHub-Anmeldung zu aktivieren.		 Zeichenfolge
gitHubClientSecret Der geheime Clientschlüssel der GitHub-App, die für die GitHub-Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die GitHub-Anmeldung zu aktivieren.		 Zeichenfolge
gitHubClientSecretSettingName Der Name der App-Einstellung, der den geheimen Clientschlüssel des GitHub enthält.
App, die für die GitHub-Anmeldung verwendet wird.		 Zeichenfolge
gitHubOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der GitHub-Anmeldeauthentifizierung angefordert werden.
Diese Einstellung ist optional.		 string[]
googleClientId Die OpenID Connect-Client-ID für die Google-Webanwendung.
Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren.
Google Sign-In-Dokumentation: https://developers.google.com/identity/sign-in/web/		 Zeichenfolge
googleClientSecret Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist.
Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren.
Google Sign-In-Dokumentation: https://developers.google.com/identity/sign-in/web/		 Zeichenfolge
googleClientSecretSettingName Der Name der App-Einstellung, der den geheimen Clientschlüssel enthält, der zugeordnet ist
die Google-Webanwendung.		 Zeichenfolge
googleOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Google-Sign-In-Authentifizierung angefordert werden.
Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet.
Google Sign-In-Dokumentation: https://developers.google.com/identity/sign-in/web/		 string[]
isAuthFromFile "true", wenn die Konfigurationseinstellungen für die Authentifizierung aus einer Datei gelesen werden sollen,
Andernfalls "false"		 Zeichenfolge
Issuer (Aussteller) Der OpenID Connect Issuer-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://sts.windows.net/{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 Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html		 Zeichenfolge
microsoftAccountClientId Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde.
Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren.
Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm		 Zeichenfolge
microsoftAccountClientSecret Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde.
Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren.
Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm		 Zeichenfolge
microsoftAccountClientSecretSettingName Der App-Einstellungsname, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die
App, die für die Authentifizierung verwendet wird.		 Zeichenfolge
microsoftAccountOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Microsoft-Kontoauthentifizierung angefordert werden.
Diese Einstellung ist optional. Falls nicht angegeben, wird "wl.basic" als Standardbereich verwendet.
Dokumentation zu Microsoft-Kontobereichen und Berechtigungen: https://msdn.microsoft.com/library/dn631845.aspx		 string[]
runtimeVersion 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.		 Zeichenfolge
tokenRefreshExtensionHours Die Anzahl der Stunden nach Ablauf des Sitzungstokens, für die ein Sitzungstoken verwendet werden kann
rufen Sie die Tokenaktualisierungs-API auf. Die Standardeinstellung beträgt 72 Stunden.		 INT
tokenStoreEnabled true um plattformspezifische Sicherheitstoken, die während der Anmeldeflows abgerufen werden, dauerhaft zu speichern; falseandernfalls .
Der Standardwert lautet false.		 bool
twitterConsumerKey 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.
Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in		 Zeichenfolge
twitterConsumerSecret Das OAuth 1.0a-Consumergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren.
Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in		 Zeichenfolge
twitterConsumerSecretSettingName Der App-Einstellungsname, der das OAuth 1.0a-Consumergeheimnis des Twitter-Kontos enthält
Anwendung, die für die Anmeldung verwendet wird.		 Zeichenfolge
unauthenticatedClientAction Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein soll und als solcher überprüft werden soll. bool

Terraform (AzAPI-Anbieter) Ressourcendefinition

Der Ressourcentyp sites/slots/config kann mit Vorgängen bereitgestellt werden, die folgende Ziele haben:

  • Ressourcengruppen

Eine Liste der geänderten Eigenschaften in jeder API-Version finden Sie unter Änderungsprotokoll.

Optionen für die Name-Eigenschaft

Die Ressource sites/slots/config akzeptiert verschiedene Eigenschaften basierend auf dem Wert der Name-Eigenschaft . In diesem Artikel werden die Eigenschaften veranschaulicht, die verfügbar sind, wenn Sie festlegen name: 'authsettings'.

Für andere Optionen, siehe:

Ressourcenformat

Um eine Microsoft.Web/sites/slots/config-Ressource zu erstellen, fügen Sie der Vorlage die folgende Terraform-Ressource hinzu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots/config@2021-01-01"
  name = "authsettings"
  parent_id = "string"
  body = jsonencode({
    properties = {
      aadClaimsAuthorization = "string"
      additionalLoginParams = [
        "string"
      ]
      allowedAudiences = [
        "string"
      ]
      allowedExternalRedirectUrls = [
        "string"
      ]
      authFilePath = "string"
      clientId = "string"
      clientSecret = "string"
      clientSecretCertificateThumbprint = "string"
      clientSecretSettingName = "string"
      configVersion = "string"
      defaultProvider = "string"
      enabled = bool
      facebookAppId = "string"
      facebookAppSecret = "string"
      facebookAppSecretSettingName = "string"
      facebookOAuthScopes = [
        "string"
      ]
      gitHubClientId = "string"
      gitHubClientSecret = "string"
      gitHubClientSecretSettingName = "string"
      gitHubOAuthScopes = [
        "string"
      ]
      googleClientId = "string"
      googleClientSecret = "string"
      googleClientSecretSettingName = "string"
      googleOAuthScopes = [
        "string"
      ]
      isAuthFromFile = "string"
      issuer = "string"
      microsoftAccountClientId = "string"
      microsoftAccountClientSecret = "string"
      microsoftAccountClientSecretSettingName = "string"
      microsoftAccountOAuthScopes = [
        "string"
      ]
      runtimeVersion = "string"
      tokenRefreshExtensionHours = int
      tokenStoreEnabled = bool
      twitterConsumerKey = "string"
      twitterConsumerSecret = "string"
      twitterConsumerSecretSettingName = "string"
      unauthenticatedClientAction = "string"
      validateIssuer = bool
    }
    kind = "string"
  })
}

Eigenschaftswerte

sites/slots/config-authsettings

Name Beschreibung Wert
type Ressourcentyp "Microsoft.Web/sites/slots/config@2021-01-01"
name Der Ressourcenname "Authentifizierungseinstellungen"
parent_id Die ID der Ressource, die die übergeordnete Ressource für diese Ressource ist. ID für Ressource vom Typ: Slots
kind Art der Ressource. Zeichenfolge
properties Ressourcenspezifische Eigenschaften von SiteAuthSettings SiteAuthSettingsProperties

SiteAuthSettingsProperties

Name Beschreibung Wert
aadClaimsAuthorization Ruft eine JSON-Zeichenfolge ab, die die Azure AD-ACL-Einstellungen enthält. Zeichenfolge
additionalLoginParams Anmeldeparameter, die an den OpenID Connect-Autorisierungsendpunkt gesendet werden sollen, wenn
ein Benutzer meldet sich an. Jeder Parameter muss das Format "key=value" aufweisen.		 string[]
allowedAudiences Zulässige Zielgruppenwerte, die beim Überprüfen von von ausgestellten JWTs berücksichtigt werden
Azure Active Directory Beachten Sie, dass der ClientID Wert immer als
Zulässige Zielgruppe, unabhängig von dieser Einstellung.		 string[]
allowedExternalRedirectUrls 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.		 string[]
authFilePath Der Pfad der Konfigurationsdatei, die Authentifizierungseinstellungen enthält.
Wenn der Pfad relativ ist, wird basis das Stammverzeichnis der Website verwendet.		 Zeichenfolge
clientId 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
andere OpenID Connect-Anbieter von Drittanbietern.
Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 Zeichenfolge
clientSecret Der geheime Clientschlüssel dieser Anwendung der vertrauenden Seite (in Azure Active Directory wird dies auch als Schlüssel bezeichnet).
Diese Einstellung ist optional. Wenn kein geheimer Clientschlüssel konfiguriert ist, wird der implizite Authentifizierungsflow von OpenID Connect verwendet, um Endbenutzer zu authentifizieren.
Andernfalls wird der OpenID Connect-Autorisierungscodeflow verwendet, um Endbenutzer zu authentifizieren.
Weitere Informationen zu OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html		 Zeichenfolge
clientSecretCertificateThumbprint Eine Alternative zum geheimen Clientschlüssel, d. h. der Fingerabdruck eines Zertifikats, das zu Signaturzwecken verwendet wird. Diese Eigenschaft fungiert als
ein Ersatz für den geheimen Clientschlüssel. Es ist auch optional.		 Zeichenfolge
clientSecretSettingName Der App-Einstellungsname, der den geheimen Clientschlüssel der Anwendung der vertrauenden Seite enthält. Zeichenfolge
configVersion Die ConfigVersion der Authentifizierungs-/Autorisierungsfunktion, die für die aktuelle App verwendet wird.
Die Einstellung in diesem Wert kann das Verhalten der Steuerungsebene für Authentifizierung/Autorisierung steuern.		 Zeichenfolge
Defaultprovider Der Standardauthentifizierungsanbieter, der verwendet werden soll, wenn mehrere Anbieter konfiguriert sind.
Diese Einstellung ist nur erforderlich, wenn mehrere Anbieter und der nicht authentifizierte Client konfiguriert sind.
action ist auf "RedirectToLoginPage" festgelegt.		 "AzureActiveDirectory"
"Facebook"
"Github"
"Google"
"MicrosoftAccount"
"Twitter"
enabled true , wenn die Authentifizierungs-/Autorisierungsfunktion für die aktuelle App aktiviert ist; falseandernfalls . bool
facebookAppId Die App-ID der Facebook-App, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 Zeichenfolge
facebookAppSecret Das App-Geheimnis der Facebook-App, die für die Facebook-Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Facebook-Anmeldung zu aktivieren.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 Zeichenfolge
facebookAppSecretSettingName Der App-Einstellungsname, der das für die Facebook-Anmeldung verwendete App-Geheimnis enthält. Zeichenfolge
facebookOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Facebook-Anmeldeauthentifizierung angefordert werden.
Diese Einstellung ist optional.
Dokumentation zur Facebook-Anmeldung: https://developers.facebook.com/docs/facebook-login		 string[]
gitHubClientId Die Client-ID der GitHub-App, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.		 Zeichenfolge
gitHubClientSecret Der geheime Clientschlüssel der GitHub-App, die für die Github-Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Github-Anmeldung zu aktivieren.		 Zeichenfolge
gitHubClientSecretSettingName Der App-Einstellungsname, der den geheimen Clientschlüssel des GitHub enthält
App, die für die GitHub-Anmeldung verwendet wird.		 Zeichenfolge
gitHubOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der GitHub-Anmeldeauthentifizierung angefordert werden.
Diese Einstellung ist optional.		 string[]
googleClientId Die OpenID Connect-Client-ID für die Google-Webanwendung.
Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren.
Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/		 Zeichenfolge
googleClientSecret Der geheime Clientschlüssel, der der Google-Webanwendung zugeordnet ist.
Diese Einstellung ist erforderlich, um die Google-Anmeldung zu aktivieren.
Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/		 Zeichenfolge
googleClientSecretSettingName Der App-Einstellungsname, der den geheimen Clientschlüssel enthält, der zugeordnet ist
die Google-Webanwendung.		 Zeichenfolge
googleOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Google-Sign-In-Authentifizierung angefordert werden.
Diese Einstellung ist optional. Wenn nicht angegeben, werden "openid", "profile" und "email" als Standardbereiche verwendet.
Google Sign-In Dokumentation: https://developers.google.com/identity/sign-in/web/		 string[]
isAuthFromFile "true", wenn die Konfigurationseinstellungen der Authentifizierung aus einer Datei gelesen werden sollen,
Andernfalls "false"		 Zeichenfolge
Issuer (Aussteller) Der OpenID Connect Issuer-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://sts.windows.net/{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 Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html		 Zeichenfolge
microsoftAccountClientId Die OAuth 2.0-Client-ID, die für die für die Authentifizierung verwendete App erstellt wurde.
Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren.
Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm		 Zeichenfolge
microsoftAccountClientSecret Der geheime OAuth 2.0-Clientschlüssel, der für die für die Authentifizierung verwendete App erstellt wurde.
Diese Einstellung ist erforderlich, um die Microsoft-Kontoauthentifizierung zu aktivieren.
Microsoft-Konto OAuth-Dokumentation: https://dev.onedrive.com/auth/msa_oauth.htm		 Zeichenfolge
microsoftAccountClientSecretSettingName Der App-Einstellungsname, der den geheimen OAuth 2.0-Clientschlüssel enthält, der für die
App, die für die Authentifizierung verwendet wird.		 Zeichenfolge
microsoftAccountOAuthScopes Die OAuth 2.0-Bereiche, die im Rahmen der Microsoft-Kontoauthentifizierung angefordert werden.
Diese Einstellung ist optional. Falls nicht angegeben, wird "wl.basic" als Standardbereich verwendet.
Dokumentation zu Microsoft-Kontobereichen und Berechtigungen: https://msdn.microsoft.com/library/dn631845.aspx		 string[]
runtimeVersion 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.		 Zeichenfolge
tokenRefreshExtensionHours Die Anzahl der Stunden nach Ablauf des Sitzungstokens, für die ein Sitzungstoken verwendet werden kann
rufen Sie die Tokenaktualisierungs-API auf. Die Standardeinstellung beträgt 72 Stunden.		 INT
tokenStoreEnabled true um plattformspezifische Sicherheitstoken, die während der Anmeldeflows abgerufen werden, dauerhaft zu speichern; falseandernfalls .
Der Standardwert lautet false.		 bool
twitterConsumerKey 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.
Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in		 Zeichenfolge
twitterConsumerSecret Das OAuth 1.0a-Consumergeheimnis der Twitter-Anwendung, die für die Anmeldung verwendet wird.
Diese Einstellung ist erforderlich, um die Twitter-Anmeldung zu aktivieren.
Twitter Sign-In Dokumentation: https://dev.twitter.com/web/sign-in		 Zeichenfolge
twitterConsumerSecretSettingName Der App-Einstellungsname, der das OAuth 1.0a-Consumergeheimnis des Twitter-Kontos enthält
Anwendung, die für die Anmeldung verwendet wird.		 Zeichenfolge
unauthenticatedClientAction Die Aktion, die ausgeführt werden soll, wenn ein nicht authentifizierter Client versucht, auf die App zuzugreifen. "AllowAnonymous"
"RedirectToLoginPage"
validateIssuer Ruft einen Wert ab, der angibt, ob der Aussteller eine gültige HTTPS-URL sein soll und als solcher überprüft werden soll. bool