Share via


Microsoft.Web sites/slots/config 'authsettings' 2022-09-01

Bicep-resourcedefinitie

Het resourcetype sites/sleuven/config kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Opties voor naameigenschap

De resource sites/sleuven/config accepteert verschillende eigenschappen op basis van de waarde van de naameigenschap . In dit artikel worden de eigenschappen beschreven die beschikbaar zijn wanneer u instelt name: 'authsettings'.

Zie voor andere opties:

Resource-indeling

Als u een Resource Microsoft.Web/sites/slots/config wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.Web/sites/slots/config@2022-09-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
  }
}

Eigenschapswaarden

sites/sleuven/config-authsettings

Naam Description Waarde
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in Bicep.
'authsettings'
Soort Soort resource. tekenreeks
Bovenliggende In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie Onderliggende resource buiten bovenliggende resource voor meer informatie.
Symbolische naam voor resource van het type: sleuven
properties Resourcespecifieke eigenschappen van SiteAuthSettings SiteAuthSettingsEigenschappen

SiteAuthSettingsEigenschappen

Naam Description Waarde
aadClaimsAuthorization Hiermee haalt u een JSON-tekenreeks op met de Azure AD ACL-instellingen. tekenreeks
additionalLoginParams Aanmeldingsparameters die naar het OpenID Connect-autorisatie-eindpunt moeten worden verzonden wanneer
een gebruiker zich aanmeldt. Elke parameter moet de notatie 'key=value' hebben.
tekenreeks[]
allowedAudiences Toegestane doelgroepwaarden om rekening mee te houden bij het valideren van JSON-webtokens die zijn uitgegeven door
Azure Active Directory. Houd er rekening mee dat de ClientID waarde altijd wordt beschouwd als een
toegestane doelgroep, ongeacht deze instelling.
tekenreeks[]
allowedExternalRedirectUrls Externe URL's waarnaar kan worden omgeleid als onderdeel van het aanmelden of afmelden bij de app. Houd er rekening mee dat het queryreeksgedeelte van de URL wordt genegeerd.
Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen.
Url's binnen het huidige domein zijn altijd impliciet toegestaan.
tekenreeks[]
authFilePath Het pad van het configuratiebestand met verificatie-instellingen.
Als het pad relatief is, wordt de hoofdmap van de site als basis gebruikt.
tekenreeks
clientId De client-id van deze relying party-toepassing, ook wel de client_id genoemd.
Deze instelling is vereist voor het inschakelen van OpenID Connection-verificatie met Azure Active Directory of
andere OpenID Connect-providers van derden.
Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
tekenreeks
clientSecret Het clientgeheim van deze relying party-toepassing (in Azure Active Directory wordt dit ook wel de sleutel genoemd).
Deze instelling is optioneel. Als er geen clientgeheim is geconfigureerd, wordt de impliciete verificatiestroom van OpenID Connect gebruikt om eindgebruikers te verifiëren.
Anders wordt de OpenID Connect-autorisatiecodestroom gebruikt om eindgebruikers te verifiëren.
Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
tekenreeks
clientSecretCertificateThumbprint Een alternatief voor het clientgeheim, namelijk de vingerafdruk van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als
een vervanging voor het clientgeheim. Het is ook optioneel.
tekenreeks
clientSecretSettingName De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat. tekenreeks
configVersion De ConfigVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app.
De instelling in deze waarde kan het gedrag van het besturingsvlak voor verificatie/autorisatie bepalen.
tekenreeks
defaultProvider De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd.
Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde client
actie is ingesteld op 'RedirectToLoginPage'.
'AzureActiveDirectory'
'Facebook'
'Github'
'Google'
'MicrosoftAccount'
'Twitter'
enabled true als de functie Verificatie/Autorisatie is ingeschakeld voor de huidige app; anders, false. booleaans
facebookAppId De app-id van de Facebook-app die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Facebook-aanmelding.
Documentatie voor Aanmelding bij Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks
facebookAppSecret Het app-geheim van de Facebook-app die wordt gebruikt voor Facebook-aanmelding.
Deze instelling is vereist voor het inschakelen van Facebook-aanmelding.
Documentatie voor Aanmelding bij Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks
facebookAppSecretSettingName De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Aanmelding op Facebook. tekenreeks
facebookOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Facebook-aanmeldingsverificatie.
Deze instelling is optioneel.
Documentatie voor Aanmelding bij Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks[]
gitHubClientId De client-id van de GitHub-app die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Github-aanmelding
tekenreeks
gitHubClientSecret Het clientgeheim van de GitHub-app die wordt gebruikt voor github-aanmelding.
Deze instelling is vereist voor het inschakelen van Github-aanmelding.
tekenreeks
gitHubClientSecretSettingName De naam van de app-instelling die het clientgeheim van github bevat
app die wordt gebruikt voor GitHub-aanmelding.
tekenreeks
gitHubOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie.
Deze instelling is optioneel
tekenreeks[]
googleClientId De OpenID Connect-client-id voor de Google-webtoepassing.
Deze instelling is vereist voor het inschakelen van Aanmelden bij Google.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks
googleClientSecret Het clientgeheim dat is gekoppeld aan de Google-webtoepassing.
Deze instelling is vereist voor het inschakelen van Aanmelden bij Google.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks
googleClientSecretSettingName De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan
de Google-webtoepassing.
tekenreeks
googleOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Google Sign-In-verificatie.
Deze instelling is optioneel. Als u dit niet opgeeft, worden 'openid', 'profiel' en 'e-mail' als standaardbereiken gebruikt.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks[]
isAuthFromFile 'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand,
"false" anders
tekenreeks
uitgever De OpenID Connect Issuer-URI die de entiteit vertegenwoordigt die toegangstokens voor deze toepassing uitgeeft.
Wanneer u Azure Active Directory gebruikt, is deze waarde de URI van de maptenant, bijvoorbeeld https://sts.windows.net/{tenant-guid}/.
Deze URI is een hoofdlettergevoelige id voor de tokenverlener.
Meer informatie over OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
tekenreeks
microsoftAccountClientId De OAuth 2.0-client-id die is gemaakt voor de app die wordt gebruikt voor verificatie.
Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie.
OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
tekenreeks
microsoftAccountClientSecret Het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie.
Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie.
OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
tekenreeks
microsoftAccountClientSecretSettingName De naam van de app-instelling met het OAuth 2.0-clientgeheim dat is gemaakt voor de
app gebruikt voor verificatie.
tekenreeks
microsoftAccountOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van microsoft-accountverificatie.
Deze instelling is optioneel. Als dit niet is opgegeven, wordt 'wl.basic' gebruikt als het standaardbereik.
Documentatie voor Microsoft-accountbereiken en -machtigingen: https://msdn.microsoft.com/library/dn631845.aspx
tekenreeks[]
runtimeVersion De RuntimeVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app.
De instelling in deze waarde kan het gedrag van bepaalde functies in de module Verificatie/autorisatie bepalen.
tekenreeks
tokenRefreshExtensionHours Het aantal uren na het verlopen van het sessietoken waarvoor een sessietoken kan worden gebruikt
roep de API voor het vernieuwen van tokens aan. Standaard is dit 72 uur.
int
tokenStoreEnabled true om platformspecifieke beveiligingstokens die tijdens aanmeldingsstromen worden verkregen, duurzaam op te slaan; anders, false.
De standaardwaarde is false.
booleaans
twitterConsumerKey De OAuth 1.0a-consumentensleutel van de Twitter-toepassing die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Twitter-aanmelding.
Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
tekenreeks
twitterConsumerSecret Het OAuth 1.0a-consumentengeheim van de Twitter-toepassing die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Twitter-aanmelding.
Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
tekenreeks
twitterConsumerSecretSettingName De naam van de app-instelling die het OAuth 1.0a-consumentengeheim van Twitter bevat
toepassing die wordt gebruikt voor aanmelding.
tekenreeks
unauthenticatedClientAction De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd. booleaans

Resourcedefinitie van ARM-sjabloon

Het resourcetype sites/sites/config kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Opties voor naameigenschap

De site/sleuven/config-resource accepteert verschillende eigenschappen op basis van de waarde van de naameigenschap . In dit artikel worden de eigenschappen beschreven die beschikbaar zijn wanneer u instelt name: 'authsettings'.

Zie voor andere opties:

Resource-indeling

Als u een Microsoft.Web/sites/slots/config-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.Web/sites/slots/config",
  "apiVersion": "2022-09-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"
  }
}

Eigenschapswaarden

sites/sites/config-authsettings

Naam Description Waarde
type Het resourcetype 'Microsoft.Web/sites/slots/config'
apiVersion De resource-API-versie '2022-09-01'
naam De resourcenaam

Meer informatie over het instellen van namen en typen voor onderliggende resources in JSON ARM-sjablonen.
'authsettings'
Soort Soort resource. tekenreeks
properties Resourcespecifieke eigenschappen van SiteAuthSettings SiteAuthSettingsEigenschappen

SiteAuthSettingsEigenschappen

Naam Description Waarde
aadClaimsAuthorization Hiermee haalt u een JSON-tekenreeks op met de Azure AD ACL-instellingen. tekenreeks
additionalLoginParams Aanmeldingsparameters die moeten worden verzonden naar het OpenID Connect-autorisatie-eindpunt wanneer
een gebruiker zich aanmeldt. Elke parameter moet de notatie 'key=value' hebben.
tekenreeks[]
allowedAudiences Toegestane doelgroepwaarden om rekening mee te houden bij het valideren van JSON-webtokens die zijn uitgegeven door
Azure Active Directory. Houd er rekening mee dat de ClientID waarde altijd wordt beschouwd als een
toegestane doelgroep, ongeacht deze instelling.
tekenreeks[]
allowedExternalRedirectUrls Externe URL's waarnaar kan worden omgeleid als onderdeel van het aanmelden of afmelden bij de app. Houd er rekening mee dat het queryreeksgedeelte van de URL wordt genegeerd.
Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen.
URL's binnen het huidige domein zijn altijd impliciet toegestaan.
tekenreeks[]
authFilePath Het pad van het configuratiebestand met verificatie-instellingen.
Als het pad relatief is, wordt de hoofdmap van de site als basis gebruikt.
tekenreeks
clientId De client-id van deze relying party-toepassing, ook wel de client_id genoemd.
Deze instelling is vereist voor het inschakelen van OpenID Connection-verificatie met Azure Active Directory of
andere OpenID Connect-providers van derden.
Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
tekenreeks
clientSecret Het clientgeheim van deze relying party-toepassing (in Azure Active Directory wordt dit ook wel de sleutel genoemd).
Deze instelling is optioneel. Als er geen clientgeheim is geconfigureerd, wordt de impliciete verificatiestroom van OpenID Connect gebruikt om eindgebruikers te verifiëren.
Anders wordt de OpenID Connect-autorisatiecodestroom gebruikt om eindgebruikers te verifiëren.
Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
tekenreeks
clientSecretCertificateThumbprint Een alternatief voor het clientgeheim, namelijk de vingerafdruk van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als
een vervanging voor het clientgeheim. Het is ook optioneel.
tekenreeks
clientSecretSettingName De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat. tekenreeks
configVersion De configuratieversie van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app.
De instelling in deze waarde kan het gedrag van het besturingsvlak voor verificatie/autorisatie bepalen.
tekenreeks
defaultProvider De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd.
Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde client
actie is ingesteld op 'RedirectToLoginPage'.
'AzureActiveDirectory'
'Facebook'
'Github'
'Google'
'MicrosoftAccount'
'Twitter'
enabled true als de functie Verificatie/Autorisatie is ingeschakeld voor de huidige app; anders, false. booleaans
facebookAppId De app-id van de Facebook-app die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Facebook-aanmelding.
Aanmeldingsdocumentatie voor Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks
facebookAppSecret Het app-geheim van de Facebook-app die wordt gebruikt voor Aanmelding bij Facebook.
Deze instelling is vereist voor het inschakelen van Facebook-aanmelding.
Aanmeldingsdocumentatie voor Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks
facebookAppSecretSettingName De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Facebook-aanmelding. tekenreeks
facebookOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Facebook-aanmeldingsverificatie.
Deze instelling is optioneel.
Aanmeldingsdocumentatie voor Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks[]
gitHubClientId De client-id van de GitHub-app die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van GitHub-aanmelding
tekenreeks
gitHubClientSecret Het clientgeheim van de GitHub-app die wordt gebruikt voor Github-aanmelding.
Deze instelling is vereist voor het inschakelen van Github-aanmelding.
tekenreeks
gitHubClientSecretSettingName De naam van de app-instelling die het clientgeheim van de GitHub bevat
app die wordt gebruikt voor GitHub-aanmelding.
tekenreeks
gitHubOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie.
Deze instelling is optioneel
tekenreeks[]
googleClientId De OpenID Connect-client-id voor de Google-webtoepassing.
Deze instelling is vereist voor het inschakelen van Aanmelden bij Google.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks
googleClientSecret Het clientgeheim dat is gekoppeld aan de Google-webtoepassing.
Deze instelling is vereist voor het inschakelen van Aanmelden bij Google.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks
googleClientSecretSettingName De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan
de Google-webtoepassing.
tekenreeks
googleOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Google Sign-In-verificatie.
Deze instelling is optioneel. Als dit niet is opgegeven, worden 'openid', 'profile' en 'email' als standaardbereiken gebruikt.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks[]
isAuthFromFile 'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand,
"false" anders
tekenreeks
uitgever De OpenID Connect Issuer-URI die de entiteit vertegenwoordigt die toegangstokens voor deze toepassing uitgeeft.
Wanneer u Azure Active Directory gebruikt, is deze waarde de URI van de maptenant, bijvoorbeeld https://sts.windows.net/{tenant-guid}/.
Deze URI is een hoofdlettergevoelige id voor de tokenverlener.
Meer informatie over OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
tekenreeks
microsoftAccountClientId De OAuth 2.0-client-id die is gemaakt voor de app die wordt gebruikt voor verificatie.
Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie.
OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
tekenreeks
microsoftAccountClientSecret Het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie.
Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie.
OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
tekenreeks
microsoftAccountClientSecretSettingName De naam van de app-instelling met het OAuth 2.0-clientgeheim dat is gemaakt voor de
app gebruikt voor verificatie.
tekenreeks
microsoftAccountOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van microsoft-accountverificatie.
Deze instelling is optioneel. Als dit niet is opgegeven, wordt 'wl.basic' gebruikt als het standaardbereik.
Documentatie voor Microsoft-accountbereiken en -machtigingen: https://msdn.microsoft.com/library/dn631845.aspx
tekenreeks[]
runtimeVersion De RuntimeVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app.
De instelling in deze waarde kan het gedrag van bepaalde functies in de module Verificatie/autorisatie bepalen.
tekenreeks
tokenRefreshExtensionHours Het aantal uren na het verlopen van het sessietoken waarvoor een sessietoken kan worden gebruikt
roep de API voor het vernieuwen van tokens aan. Standaard is dit 72 uur.
int
tokenStoreEnabled true om platformspecifieke beveiligingstokens die tijdens aanmeldingsstromen worden verkregen, duurzaam op te slaan; anders, false.
De standaardwaarde is false.
booleaans
twitterConsumerKey De OAuth 1.0a-consumentensleutel van de Twitter-toepassing die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Twitter-aanmelding.
Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
tekenreeks
twitterConsumerSecret Het OAuth 1.0a-consumentengeheim van de Twitter-toepassing die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Twitter-aanmelding.
Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
tekenreeks
twitterConsumerSecretSettingName De naam van de app-instelling die het OAuth 1.0a-consumentengeheim van Twitter bevat
toepassing die wordt gebruikt voor aanmelding.
tekenreeks
unauthenticatedClientAction De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app. 'AllowAnonymous'
'RedirectToLoginPage'
validateIssuer Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd. booleaans

Terraform-resourcedefinitie (AzAPI-provider)

Het resourcetype sites/sites/config kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • Resourcegroepen

Zie wijzigingenlogboek voor een lijst met gewijzigde eigenschappen in elke API-versie.

Opties voor naameigenschap

De site/sleuven/config-resource accepteert verschillende eigenschappen op basis van de waarde van de naameigenschap . In dit artikel worden de eigenschappen beschreven die beschikbaar zijn wanneer u instelt name: 'authsettings'.

Zie voor andere opties:

Resource-indeling

Als u een Resource Microsoft.Web/sites/slots/config wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots/config@2022-09-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"
  })
}

Eigenschapswaarden

sites/sites/config-authsettings

Naam Description Waarde
type Het resourcetype "Microsoft.Web/sites/slots/config@2022-09-01"
naam De resourcenaam "authsettings"
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van type: sleuven
Soort Soort resource. tekenreeks
properties Resourcespecifieke eigenschappen van SiteAuthSettings SiteAuthSettingsEigenschappen

SiteAuthSettingsEigenschappen

Naam Description Waarde
aadClaimsAuthorization Hiermee haalt u een JSON-tekenreeks op met de Azure AD ACL-instellingen. tekenreeks
additionalLoginParams Aanmeldingsparameters die moeten worden verzonden naar het OpenID Connect-autorisatie-eindpunt wanneer
een gebruiker zich aanmeldt. Elke parameter moet de notatie 'key=value' hebben.
tekenreeks[]
allowedAudiences Toegestane doelgroepwaarden om rekening mee te houden bij het valideren van JSON-webtokens die zijn uitgegeven door
Azure Active Directory. Houd er rekening mee dat de ClientID waarde altijd wordt beschouwd als een
toegestane doelgroep, ongeacht deze instelling.
tekenreeks[]
allowedExternalRedirectUrls Externe URL's waarnaar kan worden omgeleid als onderdeel van het aanmelden of afmelden bij de app. Houd er rekening mee dat het queryreeksgedeelte van de URL wordt genegeerd.
Dit is een geavanceerde instelling die doorgaans alleen nodig is voor back-ends van Windows Store-toepassingen.
URL's binnen het huidige domein zijn altijd impliciet toegestaan.
tekenreeks[]
authFilePath Het pad van het configuratiebestand met verificatie-instellingen.
Als het pad relatief is, wordt de hoofdmap van de site als basis gebruikt.
tekenreeks
clientId De client-id van deze relying party-toepassing, bekend als de client_id.
Deze instelling is vereist voor het inschakelen van OpenID-verbindingsverificatie met Azure Active Directory of
andere OpenID Connect-providers van derden.
Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
tekenreeks
clientSecret Het clientgeheim van deze relying party-toepassing (in Azure Active Directory wordt dit ook wel de sleutel genoemd).
Deze instelling is optioneel. Als er geen clientgeheim is geconfigureerd, wordt de impliciete verificatiestroom van OpenID Connect gebruikt om eindgebruikers te verifiëren.
Anders wordt de OpenID Connect-autorisatiecodestroom gebruikt om eindgebruikers te verifiëren.
Meer informatie over OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html
tekenreeks
clientSecretCertificateThumbprint Een alternatief voor het clientgeheim, namelijk de vingerafdruk van een certificaat dat wordt gebruikt voor ondertekeningsdoeleinden. Deze eigenschap fungeert als
een vervanging voor het clientgeheim. Het is ook optioneel.
tekenreeks
clientSecretSettingName De naam van de app-instelling die het clientgeheim van de relying party-toepassing bevat. tekenreeks
configVersion De ConfigVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app.
De instelling in deze waarde kan het gedrag van het besturingsvlak voor verificatie/autorisatie bepalen.
tekenreeks
defaultProvider De standaardverificatieprovider die moet worden gebruikt wanneer meerdere providers zijn geconfigureerd.
Deze instelling is alleen nodig als er meerdere providers zijn geconfigureerd en de niet-geverifieerde client
actie is ingesteld op 'RedirectToLoginPage'.
"AzureActiveDirectory"
"Facebook"
"Github"
"Google"
"MicrosoftAccount"
"Twitter"
enabled true als de functie Verificatie/Autorisatie is ingeschakeld voor de huidige app; anders, false. booleaans
facebookAppId De app-id van de Facebook-app die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Facebook-aanmelding.
Documentatie voor Aanmelding bij Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks
facebookAppSecret Het app-geheim van de Facebook-app die wordt gebruikt voor Facebook-aanmelding.
Deze instelling is vereist voor het inschakelen van Facebook-aanmelding.
Documentatie voor Aanmelding bij Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks
facebookAppSecretSettingName De naam van de app-instelling die het app-geheim bevat dat wordt gebruikt voor Aanmelding op Facebook. tekenreeks
facebookOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Facebook-aanmeldingsverificatie.
Deze instelling is optioneel.
Documentatie voor Aanmelding bij Facebook: https://developers.facebook.com/docs/facebook-login
tekenreeks[]
gitHubClientId De client-id van de GitHub-app die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Github-aanmelding
tekenreeks
gitHubClientSecret Het clientgeheim van de GitHub-app die wordt gebruikt voor github-aanmelding.
Deze instelling is vereist voor het inschakelen van Github-aanmelding.
tekenreeks
gitHubClientSecretSettingName De naam van de app-instelling die het clientgeheim van github bevat
app die wordt gebruikt voor GitHub-aanmelding.
tekenreeks
gitHubOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van GitHub-aanmeldingsverificatie.
Deze instelling is optioneel
tekenreeks[]
googleClientId De OpenID Connect-client-id voor de Google-webtoepassing.
Deze instelling is vereist voor het inschakelen van Aanmelden bij Google.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks
googleClientSecret Het clientgeheim dat is gekoppeld aan de Google-webtoepassing.
Deze instelling is vereist voor het inschakelen van Aanmelden bij Google.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks
googleClientSecretSettingName De naam van de app-instelling die het clientgeheim bevat dat is gekoppeld aan
de Google-webtoepassing.
tekenreeks
googleOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van Google Sign-In-verificatie.
Deze instelling is optioneel. Als u dit niet opgeeft, worden 'openid', 'profiel' en 'e-mail' als standaardbereiken gebruikt.
Documentatie voor Google Sign-In: https://developers.google.com/identity/sign-in/web/
tekenreeks[]
isAuthFromFile 'true' als de configuratie-instellingen voor verificatie moeten worden gelezen uit een bestand,
"false" anders
tekenreeks
uitgever De OpenID Connect Issuer-URI die de entiteit vertegenwoordigt die toegangstokens voor deze toepassing uitgeeft.
Wanneer u Azure Active Directory gebruikt, is deze waarde de URI van de maptenant, bijvoorbeeld https://sts.windows.net/{tenant-guid}/.
Deze URI is een hoofdlettergevoelige id voor de tokenverlener.
Meer informatie over OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html
tekenreeks
microsoftAccountClientId De OAuth 2.0-client-id die is gemaakt voor de app die wordt gebruikt voor verificatie.
Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie.
OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
tekenreeks
microsoftAccountClientSecret Het OAuth 2.0-clientgeheim dat is gemaakt voor de app die wordt gebruikt voor verificatie.
Deze instelling is vereist voor het inschakelen van Microsoft-accountverificatie.
OAuth-documentatie voor Microsoft-account: https://dev.onedrive.com/auth/msa_oauth.htm
tekenreeks
microsoftAccountClientSecretSettingName De naam van de app-instelling met het OAuth 2.0-clientgeheim dat is gemaakt voor de
app gebruikt voor verificatie.
tekenreeks
microsoftAccountOAuthScopes De OAuth 2.0-bereiken die worden aangevraagd als onderdeel van microsoft-accountverificatie.
Deze instelling is optioneel. Als dit niet is opgegeven, wordt 'wl.basic' gebruikt als het standaardbereik.
Documentatie voor Microsoft-accountbereiken en -machtigingen: https://msdn.microsoft.com/library/dn631845.aspx
tekenreeks[]
runtimeVersion De RuntimeVersion van de verificatie-/autorisatiefunctie die wordt gebruikt voor de huidige app.
De instelling in deze waarde kan het gedrag van bepaalde functies in de module Verificatie/autorisatie bepalen.
tekenreeks
tokenRefreshExtensionHours Het aantal uren na het verlopen van het sessietoken waarvoor een sessietoken kan worden gebruikt
roep de API voor het vernieuwen van tokens aan. Standaard is dit 72 uur.
int
tokenStoreEnabled true om platformspecifieke beveiligingstokens die tijdens aanmeldingsstromen worden verkregen, duurzaam op te slaan; anders, false.
De standaardwaarde is false.
booleaans
twitterConsumerKey De OAuth 1.0a-consumentensleutel van de Twitter-toepassing die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Twitter-aanmelding.
Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
tekenreeks
twitterConsumerSecret Het OAuth 1.0a-consumentengeheim van de Twitter-toepassing die wordt gebruikt voor aanmelding.
Deze instelling is vereist voor het inschakelen van Twitter-aanmelding.
Documentatie voor Twitter Sign-In: https://dev.twitter.com/web/sign-in
tekenreeks
twitterConsumerSecretSettingName De naam van de app-instelling die het OAuth 1.0a-consumentengeheim van Twitter bevat
toepassing die wordt gebruikt voor aanmelding.
tekenreeks
unauthenticatedClientAction De actie die moet worden uitgevoerd wanneer een niet-geverifieerde client toegang probeert te krijgen tot de app. "AllowAnonymous"
"RedirectToLoginPage"
validateIssuer Hiermee wordt een waarde opgehaald die aangeeft of de verlener een geldige HTTPS-URL moet zijn en als zodanig moet worden gevalideerd. booleaans