Definicja zasobu Bicep
Typ zasobu containerApps/authConfigs można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Aby utworzyć zasób Microsoft.App/containerApps/authConfigs, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.App/containerApps/authConfigs@2024-10-02-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
encryptionSettings: {
containerAppAuthEncryptionSecretName: 'string'
containerAppAuthSigningSecretName: 'string'
}
globalValidation: {
excludedPaths: [
'string'
]
redirectToProvider: 'string'
unauthenticatedClientAction: 'string'
}
httpSettings: {
forwardProxy: {
convention: 'string'
customHostHeaderName: 'string'
customProtoHeaderName: 'string'
}
requireHttps: bool
routes: {
apiPrefix: 'string'
}
}
identityProviders: {
apple: {
enabled: bool
login: {
scopes: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretSettingName: 'string'
}
}
azureActiveDirectory: {
enabled: bool
isAutoProvisioned: bool
login: {
disableWWWAuthenticate: bool
loginParameters: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretCertificateIssuer: 'string'
clientSecretCertificateSubjectAlternativeName: 'string'
clientSecretCertificateThumbprint: 'string'
clientSecretSettingName: 'string'
openIdIssuer: 'string'
}
validation: {
allowedAudiences: [
'string'
]
defaultAuthorizationPolicy: {
allowedApplications: [
'string'
]
allowedPrincipals: {
groups: [
'string'
]
identities: [
'string'
]
}
}
jwtClaimChecks: {
allowedClientApplications: [
'string'
]
allowedGroups: [
'string'
]
}
}
}
azureStaticWebApps: {
enabled: bool
registration: {
clientId: 'string'
}
}
customOpenIdConnectProviders: {
{customized property}: {
enabled: bool
login: {
nameClaimType: 'string'
scopes: [
'string'
]
}
registration: {
clientCredential: {
clientSecretSettingName: 'string'
method: 'ClientSecretPost'
}
clientId: 'string'
openIdConnectConfiguration: {
authorizationEndpoint: 'string'
certificationUri: 'string'
issuer: 'string'
tokenEndpoint: 'string'
wellKnownOpenIdConfiguration: 'string'
}
}
}
}
facebook: {
enabled: bool
graphApiVersion: 'string'
login: {
scopes: [
'string'
]
}
registration: {
appId: 'string'
appSecretSettingName: 'string'
}
}
gitHub: {
enabled: bool
login: {
scopes: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretSettingName: 'string'
}
}
google: {
enabled: bool
login: {
scopes: [
'string'
]
}
registration: {
clientId: 'string'
clientSecretSettingName: 'string'
}
validation: {
allowedAudiences: [
'string'
]
}
}
twitter: {
enabled: bool
registration: {
consumerKey: 'string'
consumerSecretSettingName: 'string'
}
}
}
login: {
allowedExternalRedirectUrls: [
'string'
]
cookieExpiration: {
convention: 'string'
timeToExpiration: 'string'
}
nonce: {
nonceExpirationInterval: 'string'
validateNonce: bool
}
preserveUrlFragmentsForLogins: bool
routes: {
logoutEndpoint: 'string'
}
tokenStore: {
azureBlobStorage: {
blobContainerUri: 'string'
clientId: 'string'
managedIdentityResourceId: 'string'
sasUrlSettingName: 'string'
}
enabled: bool
tokenRefreshExtensionHours: int
}
}
platform: {
enabled: bool
runtimeVersion: 'string'
}
}
}
Wartości właściwości
AllowedAudiencesValidation
Nazwa |
Opis |
Wartość |
allowedAudiences |
Ustawienia konfiguracji dozwolonej listy odbiorców, z których mają być weryfikowane token JWT. |
string[] |
AllowedPrincipals
Nazwa |
Opis |
Wartość |
Grupy |
Lista dozwolonych grup. |
string[] |
Tożsamości |
Lista dozwolonych tożsamości. |
string[] |
Jabłko
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca firmy Apple nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji firmy Apple. |
AppleRegistration |
AppleRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta. |
struna |
AppRegistration
Nazwa |
Opis |
Wartość |
appId |
Identyfikator aplikacji używany do logowania. |
struna |
appSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny aplikacji. |
struna |
AuthConfigProperties
Nazwa |
Opis |
Wartość |
encryptionSettings |
Ustawienia konfiguracji wpisów tajnych odwołują się do klucza szyfrowania i klucza podpisywania dla uwierzytelniania/autoryzacji usługi ContainerApp Service. |
EncryptionSettings |
globalValidation |
Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi. |
GlobalValidation |
httpSettings |
Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi ContainerApp Service. |
HttpSettings |
identityProviders |
Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi ContainerApp Service. |
IdentityProviders |
login |
Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi ContainerApp Service. |
logowania |
podest |
Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi ContainerApp Service. |
AuthPlatform |
Nazwa |
Opis |
Wartość |
Włączone |
<kod>true</code>, jeśli funkcja uwierzytelniania/autoryzacji jest włączona dla bieżącej aplikacji; w przeciwnym razie kod <>false</code>. |
Bool |
runtimeVersion |
RuntimeVersion funkcji uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie niektórych funkcji w module Uwierzytelnianie/autoryzacja. |
struna |
AzureActiveDirectory
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Azure Active Directory nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
isAutoProvisioned |
Pobiera wartość wskazującą, czy konfiguracja usługi Azure AD została automatycznie aprowizowana przy użyciu narzędzi testowych. Jest to flaga wewnętrzna przeznaczona głównie do obsługi portalu zarządzania Azure. Użytkownicy nie powinni odczyt lub zapis do tej właściwości. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania usługi Azure Active Directory. |
AzureActiveDirectoryLogin |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji usługi Azure Active Directory. |
AzureActiveDirectoryRegistration |
walidacja |
Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory. |
AzureActiveDirectoryValidation |
AzureActiveDirectoryLogin
Nazwa |
Opis |
Wartość |
disableWWAuthenticate |
<kod>true</code>, jeśli dostawca www-authentication powinien zostać pominięty w żądaniu; w przeciwnym razie kod <>false</code>. |
Bool |
loginParameters |
Parametry logowania wysyłane do punktu końcowego autoryzacji OpenID Connect podczas użytkownik loguje się. Każdy parametr musi mieć postać "key=value". |
string[] |
AzureActiveDirectoryRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta tej aplikacji jednostki uzależnionej, znany jako client_id. To ustawienie jest wymagane do włączenia uwierzytelniania połączenia OpenID za pomocą usługi Azure Active Directory lub innych dostawców openID Connect innych firm. Więcej informacji na temat openID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
struna |
clientSecretCertificateIssuer |
Alternatywą dla odcisku palca wpisu tajnego klienta jest wystawca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie odcisku palca certyfikatu klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretCertificateSubjectAlternativeName |
Alternatywą dla odcisku palca wpisu tajnego klienta jest alternatywna nazwa podmiotu certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie odcisku palca certyfikatu klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretCertificateThumbprint |
Alternatywą dla klucza tajnego klienta jest odcisk palca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta aplikacji jednostki uzależnionej. |
struna |
openIdIssuer |
Identyfikator URI wystawcy OpenID Connect reprezentujący jednostkę, która wystawia tokeny dostępu dla tej aplikacji. W przypadku korzystania z usługi Azure Active Directory ta wartość jest identyfikatorem URI dzierżawy katalogu, np. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Ten identyfikator URI jest identyfikatorem z uwzględnieniem wielkości liter dla wystawcy tokenu. Więcej informacji na temat odnajdywania OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html |
struna |
AzureActiveDirectoryValidation
Nazwa |
Opis |
Wartość |
allowedAudiences |
Lista odbiorców, którzy mogą pomyślnie wysyłać żądania uwierzytelniania/autoryzacji. |
string[] |
defaultAuthorizationPolicy |
Ustawienia konfiguracji domyślnych zasad autoryzacji. |
DefaultAuthorizationPolicy |
jwtClaimChecks |
Ustawienia konfiguracji kontroli, które należy wykonać podczas weryfikowania oświadczeń JWT. |
JwtClaimChecks |
AzureStaticWebApps
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Azure Static Web Apps nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
rejestracja |
Ustawienia konfiguracji rejestracji usługi Azure Static Web Apps. |
AzureStaticWebAppsRegistration |
AzureStaticWebAppsRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
BlobStorageTokenStore
Nazwa |
Opis |
Wartość |
BlobContainerUri |
Identyfikator URI magazynu obiektów blob zawierający tokeny. Nie należy używać razem z elementem sasUrlSettingName. |
struna |
clientId |
Identyfikator klienta tożsamości zarządzanej User-Assigned. Nie należy używać go wraz z identyfikatorem managedIdentityResourceId. |
struna |
managedIdentityResourceId |
Identyfikator zasobu tożsamości zarządzanej User-Assigned. Nie należy używać razem z identyfikatorem clientId. |
struna |
sasUrlSettingName |
Nazwa wpisów tajnych aplikacji zawierających adres URL sygnatury dostępu współdzielonego magazynu obiektów blob zawierających tokeny. Nie należy używać go wraz z identyfikatorem blobContainerUri. |
struna |
ClientRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta. |
struna |
CookieExpiration
Nazwa |
Opis |
Wartość |
konwencja |
Konwencja używana podczas określania wygaśnięcia pliku cookie sesji. |
"FixedTime" "IdentityProviderDerived" |
timeToExpiration |
Czas po wysłaniu żądania po wygaśnięciu pliku cookie sesji. |
struna |
CustomOpenIdConnectProvider
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli niestandardowy dostawca open ID nie powinien być włączony; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectLogin |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectRegistration |
DefaultAuthorizationPolicy
Nazwa |
Opis |
Wartość |
allowedApplications |
Ustawienia konfiguracji dozwolonych aplikacji usługi Azure Active Directory. |
string[] |
allowedPrincipals |
Ustawienia konfiguracji dozwolonych podmiotów zabezpieczeń usługi Azure Active Directory. |
AllowedPrincipals |
EncryptionSettings
Nazwa |
Opis |
Wartość |
containerAppAuthEncryptionSecretName |
Nazwa wpisu tajnego, do której odwołuje się klucz EncryptionKey. |
struna |
containerAppAuthSigningSecretName |
Nazwa wpisu tajnego, do której odwołuje się klucz podpisywania. |
struna |
Facebook
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca serwisu Facebook nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie <kod>true</code>. |
Bool |
graphApiVersion |
Wersja interfejsu API serwisu Facebook, która ma być używana podczas logowania. |
struna |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy serwisu Facebook. |
AppRegistration |
ForwardProxy
Nazwa |
Opis |
Wartość |
konwencja |
Konwencja używana do określania adresu URL wykonanego żądania. |
"Niestandardowy" "NoProxy" "Standardowa" |
customHostHeaderName |
Nazwa nagłówka zawierającego hosta żądania. |
struna |
customProtoHeaderName |
Nazwa nagłówka zawierającego schemat żądania. |
struna |
GitHub
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca Usługi GitHub nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi GitHub. |
ClientRegistration |
GlobalValidation
Nazwa |
Opis |
Wartość |
excludedPaths |
Ścieżki, dla których nieuwierzytelniony przepływ nie zostanie przekierowany do strony logowania. |
string[] |
redirectToProvider |
Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko w przypadku skonfigurowania wielu dostawców i nieuwierzytelnionego klienta akcja jest ustawiona na wartość "RedirectToLoginPage". |
struna |
nieuwierzytelnionyClientAction |
Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji. |
"AllowAnonymous" "RedirectToLoginPage" "Return401" "Return403" |
Google
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca Google nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy Google. |
ClientRegistration |
walidacja |
Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory. |
AllowedAudiencesValidation |
HttpSettings
Nazwa |
Opis |
Wartość |
forwardProxy |
Ustawienia konfiguracji serwera proxy przesyłania dalej używane do tworzenia żądań. |
ForwardProxy |
requireHttps |
<kod>fałszywe</code>, jeśli dopuszczalne są odpowiedzi uwierzytelniania/autoryzacji bez schematu HTTPS; w przeciwnym razie <kod>true</code>. |
Bool |
Trasy |
Ustawienia konfiguracji ścieżek żądania HTTP. |
HttpSettingsRoutes |
HttpSettingsRoutes
Nazwa |
Opis |
Wartość |
apiPrefix |
Prefiks, który powinien poprzedzać wszystkie ścieżki uwierzytelniania/autoryzacji. |
struna |
IdentityProviders
Nazwa |
Opis |
Wartość |
jabłko |
Ustawienia konfiguracji dostawcy firmy Apple. |
Apple |
azureActiveDirectory |
Ustawienia konfiguracji dostawcy usługi Azure Active Directory. |
AzureActiveDirectory |
azureStaticWebApps |
Ustawienia konfiguracji dostawcy usługi Azure Static Web Apps. |
AzureStaticWebApps |
customOpenIdConnectProviders |
Mapa nazwy aliasu każdego niestandardowego dostawcy programu Open ID Connect ustawienia konfiguracji niestandardowego dostawcy programu Open ID Connect. |
IdentityProvidersCustomOpenIdConnectProviders |
facebook |
Ustawienia konfiguracji dostawcy serwisu Facebook. |
Facebook |
gitHub |
Ustawienia konfiguracji dostawcy GitHub. |
GitHub |
google |
Ustawienia konfiguracji dostawcy Google. |
Google |
świergot |
Ustawienia konfiguracji dostawcy usługi Twitter. |
Twitter |
IdentityProvidersCustomOpenIdConnectProviders
JwtClaimChecks
Nazwa |
Opis |
Wartość |
allowedClientApplications |
Lista dozwolonych aplikacji klienckich. |
string[] |
allowedGroups |
Lista dozwolonych grup. |
string[] |
Login
Nazwa |
Opis |
Wartość |
allowedExternalRedirectUrls |
Zewnętrzne adresy URL, do których można przekierować w ramach logowania lub wylogowywania się z aplikacji. Należy pamiętać, że część ciągu zapytania adresu URL jest ignorowana. Jest to zaawansowane ustawienie zwykle wymagane tylko przez zaplecza aplikacji ze Sklepu Windows. Należy pamiętać, że adresy URL w bieżącej domenie są zawsze niejawnie dozwolone. |
string[] |
cookieExpiration |
Ustawienia konfiguracji wygasania pliku cookie sesji. |
CookieExpiration |
nonce |
Ustawienia konfiguracji nieużytego w przepływie logowania. |
nonce |
preserveUrlFragmentsForLogins |
<kod>true</code>, jeśli fragmenty żądania są zachowywane po wykonaniu żądania logowania; w przeciwnym razie kod <>false</code>. |
Bool |
Trasy |
Trasy określające punkty końcowe używane do logowania i wylogowyywania żądań. |
LoginRoutes |
tokenStore |
Ustawienia konfiguracji magazynu tokenów. |
TokenStore |
LoginRoutes
Nazwa |
Opis |
Wartość |
wylogowywanie Punktu końcowego |
Punkt końcowy, w którym powinno zostać wykonane żądanie wylogowania. |
struna |
LoginScopes
Nazwa |
Opis |
Wartość |
Zakresów |
Lista zakresów, których należy zażądać podczas uwierzytelniania. |
string[] |
Microsoft.App/containerApps/authConfigs
Nazwa |
Opis |
Wartość |
nazwa |
Nazwa zasobu |
ciąg (wymagany) |
rodzic |
W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.
Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: containerApps |
Właściwości |
Właściwości specyficzne dla zasobu AuthConfig |
AuthConfigProperties |
Nonce
Nazwa |
Opis |
Wartość |
nonceExpirationInterval |
Czas po wysłaniu żądania, kiedy element nie powinien wygasać. |
struna |
validateNonce |
<kod>false</code>, jeśli nie powinny być weryfikowane podczas kończenia przepływu logowania; w przeciwnym razie <kod>true</code>. |
Bool |
OpenIdConnectClientCredential
Nazwa |
Opis |
Wartość |
clientSecretSettingName |
Ustawienie aplikacji zawierające wpis tajny klienta dla niestandardowego dostawcy programu Open ID Connect. |
struna |
metoda |
Metoda, która powinna służyć do uwierzytelniania użytkownika. |
"ClientSecretPost" |
OpenIdConnectConfig
Nazwa |
Opis |
Wartość |
authorizationEndpoint |
Punkt końcowy, który ma być używany do tworzenia żądania autoryzacji. |
struna |
certificationUri |
Punkt końcowy, który udostępnia klucze niezbędne do zweryfikowania tokenu. |
struna |
Emitenta |
Punkt końcowy, który wystawia token. |
struna |
tokenEndpoint |
Punkt końcowy, który ma być używany do żądania tokenu. |
struna |
wellKnownOpenIdConfiguration |
Punkt końcowy zawierający wszystkie punkty końcowe konfiguracji dostawcy. |
struna |
OpenIdConnectLogin
Nazwa |
Opis |
Wartość |
nameClaimType |
Nazwa oświadczenia zawierającego nazwę użytkowników. |
struna |
Zakresów |
Lista zakresów, których należy zażądać podczas uwierzytelniania. |
string[] |
OpenIdConnectRegistration
Nazwa |
Opis |
Wartość |
clientCredential |
Poświadczenia uwierzytelniania niestandardowego dostawcy open ID Connect. |
OpenIdConnectClientCredential |
clientId |
Identyfikator klienta niestandardowego dostawcy programu Open ID Connect. |
struna |
openIdConnectConfiguration |
Ustawienia konfiguracji punktów końcowych używanych dla niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectConfig |
Magazyn tokenów
Nazwa |
Opis |
Wartość |
azureBlobStorage |
Ustawienia konfiguracji magazynu tokenów, jeśli jest używany magazyn obiektów blob. |
BlobStorageTokenStore |
Włączone |
<kod>true</code> do trwałego przechowywania tokenów zabezpieczających specyficznych dla platformy, które są uzyskiwane podczas przepływów logowania; w przeciwnym razie kod <>false</code>. Wartość domyślna to kod <>false</code>. |
Bool |
tokenRefreshExtensionHours |
Liczba godzin po wygaśnięciu tokenu sesji, za pomocą którego można użyć tokenu sesji wywołaj interfejs API odświeżania tokenu. Wartość domyślna to 72 godziny. |
Int |
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Twitter nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi Twitter. |
TwitterRegistration |
Nazwa |
Opis |
Wartość |
consumerKey |
Klucz użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in |
struna |
consumerSecretSettingName |
Nazwa ustawienia aplikacji zawierająca wpis tajny użytkownika OAuth 1.0a w usłudze Twitter aplikacja używana do logowania. |
struna |
Definicja zasobu szablonu usługi ARM
Typ zasobu containerApps/authConfigs można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Aby utworzyć zasób Microsoft.App/containerApps/authConfigs, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.App/containerApps/authConfigs",
"apiVersion": "2024-10-02-preview",
"name": "string",
"properties": {
"encryptionSettings": {
"containerAppAuthEncryptionSecretName": "string",
"containerAppAuthSigningSecretName": "string"
},
"globalValidation": {
"excludedPaths": [ "string" ],
"redirectToProvider": "string",
"unauthenticatedClientAction": "string"
},
"httpSettings": {
"forwardProxy": {
"convention": "string",
"customHostHeaderName": "string",
"customProtoHeaderName": "string"
},
"requireHttps": "bool",
"routes": {
"apiPrefix": "string"
}
},
"identityProviders": {
"apple": {
"enabled": "bool",
"login": {
"scopes": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretSettingName": "string"
}
},
"azureActiveDirectory": {
"enabled": "bool",
"isAutoProvisioned": "bool",
"login": {
"disableWWWAuthenticate": "bool",
"loginParameters": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretCertificateIssuer": "string",
"clientSecretCertificateSubjectAlternativeName": "string",
"clientSecretCertificateThumbprint": "string",
"clientSecretSettingName": "string",
"openIdIssuer": "string"
},
"validation": {
"allowedAudiences": [ "string" ],
"defaultAuthorizationPolicy": {
"allowedApplications": [ "string" ],
"allowedPrincipals": {
"groups": [ "string" ],
"identities": [ "string" ]
}
},
"jwtClaimChecks": {
"allowedClientApplications": [ "string" ],
"allowedGroups": [ "string" ]
}
}
},
"azureStaticWebApps": {
"enabled": "bool",
"registration": {
"clientId": "string"
}
},
"customOpenIdConnectProviders": {
"{customized property}": {
"enabled": "bool",
"login": {
"nameClaimType": "string",
"scopes": [ "string" ]
},
"registration": {
"clientCredential": {
"clientSecretSettingName": "string",
"method": "ClientSecretPost"
},
"clientId": "string",
"openIdConnectConfiguration": {
"authorizationEndpoint": "string",
"certificationUri": "string",
"issuer": "string",
"tokenEndpoint": "string",
"wellKnownOpenIdConfiguration": "string"
}
}
}
},
"facebook": {
"enabled": "bool",
"graphApiVersion": "string",
"login": {
"scopes": [ "string" ]
},
"registration": {
"appId": "string",
"appSecretSettingName": "string"
}
},
"gitHub": {
"enabled": "bool",
"login": {
"scopes": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretSettingName": "string"
}
},
"google": {
"enabled": "bool",
"login": {
"scopes": [ "string" ]
},
"registration": {
"clientId": "string",
"clientSecretSettingName": "string"
},
"validation": {
"allowedAudiences": [ "string" ]
}
},
"twitter": {
"enabled": "bool",
"registration": {
"consumerKey": "string",
"consumerSecretSettingName": "string"
}
}
},
"login": {
"allowedExternalRedirectUrls": [ "string" ],
"cookieExpiration": {
"convention": "string",
"timeToExpiration": "string"
},
"nonce": {
"nonceExpirationInterval": "string",
"validateNonce": "bool"
},
"preserveUrlFragmentsForLogins": "bool",
"routes": {
"logoutEndpoint": "string"
},
"tokenStore": {
"azureBlobStorage": {
"blobContainerUri": "string",
"clientId": "string",
"managedIdentityResourceId": "string",
"sasUrlSettingName": "string"
},
"enabled": "bool",
"tokenRefreshExtensionHours": "int"
}
},
"platform": {
"enabled": "bool",
"runtimeVersion": "string"
}
}
}
Wartości właściwości
AllowedAudiencesValidation
Nazwa |
Opis |
Wartość |
allowedAudiences |
Ustawienia konfiguracji dozwolonej listy odbiorców, z których mają być weryfikowane token JWT. |
string[] |
AllowedPrincipals
Nazwa |
Opis |
Wartość |
Grupy |
Lista dozwolonych grup. |
string[] |
Tożsamości |
Lista dozwolonych tożsamości. |
string[] |
Jabłko
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca firmy Apple nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji firmy Apple. |
AppleRegistration |
AppleRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta. |
struna |
AppRegistration
Nazwa |
Opis |
Wartość |
appId |
Identyfikator aplikacji używany do logowania. |
struna |
appSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny aplikacji. |
struna |
AuthConfigProperties
Nazwa |
Opis |
Wartość |
encryptionSettings |
Ustawienia konfiguracji wpisów tajnych odwołują się do klucza szyfrowania i klucza podpisywania dla uwierzytelniania/autoryzacji usługi ContainerApp Service. |
EncryptionSettings |
globalValidation |
Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi. |
GlobalValidation |
httpSettings |
Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi ContainerApp Service. |
HttpSettings |
identityProviders |
Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi ContainerApp Service. |
IdentityProviders |
login |
Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi ContainerApp Service. |
logowania |
podest |
Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi ContainerApp Service. |
AuthPlatform |
Nazwa |
Opis |
Wartość |
Włączone |
<kod>true</code>, jeśli funkcja uwierzytelniania/autoryzacji jest włączona dla bieżącej aplikacji; w przeciwnym razie kod <>false</code>. |
Bool |
runtimeVersion |
RuntimeVersion funkcji uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie niektórych funkcji w module Uwierzytelnianie/autoryzacja. |
struna |
AzureActiveDirectory
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Azure Active Directory nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
isAutoProvisioned |
Pobiera wartość wskazującą, czy konfiguracja usługi Azure AD została automatycznie aprowizowana przy użyciu narzędzi testowych. Jest to flaga wewnętrzna przeznaczona głównie do obsługi portalu zarządzania Azure. Użytkownicy nie powinni odczyt lub zapis do tej właściwości. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania usługi Azure Active Directory. |
AzureActiveDirectoryLogin |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji usługi Azure Active Directory. |
AzureActiveDirectoryRegistration |
walidacja |
Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory. |
AzureActiveDirectoryValidation |
AzureActiveDirectoryLogin
Nazwa |
Opis |
Wartość |
disableWWAuthenticate |
<kod>true</code>, jeśli dostawca www-authentication powinien zostać pominięty w żądaniu; w przeciwnym razie kod <>false</code>. |
Bool |
loginParameters |
Parametry logowania wysyłane do punktu końcowego autoryzacji OpenID Connect podczas użytkownik loguje się. Każdy parametr musi mieć postać "key=value". |
string[] |
AzureActiveDirectoryRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta tej aplikacji jednostki uzależnionej, znany jako client_id. To ustawienie jest wymagane do włączenia uwierzytelniania połączenia OpenID za pomocą usługi Azure Active Directory lub innych dostawców openID Connect innych firm. Więcej informacji na temat openID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
struna |
clientSecretCertificateIssuer |
Alternatywą dla odcisku palca wpisu tajnego klienta jest wystawca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie odcisku palca certyfikatu klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretCertificateSubjectAlternativeName |
Alternatywą dla odcisku palca wpisu tajnego klienta jest alternatywna nazwa podmiotu certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie odcisku palca certyfikatu klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretCertificateThumbprint |
Alternatywą dla klucza tajnego klienta jest odcisk palca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta aplikacji jednostki uzależnionej. |
struna |
openIdIssuer |
Identyfikator URI wystawcy OpenID Connect reprezentujący jednostkę, która wystawia tokeny dostępu dla tej aplikacji. W przypadku korzystania z usługi Azure Active Directory ta wartość jest identyfikatorem URI dzierżawy katalogu, np. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Ten identyfikator URI jest identyfikatorem z uwzględnieniem wielkości liter dla wystawcy tokenu. Więcej informacji na temat odnajdywania OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html |
struna |
AzureActiveDirectoryValidation
Nazwa |
Opis |
Wartość |
allowedAudiences |
Lista odbiorców, którzy mogą pomyślnie wysyłać żądania uwierzytelniania/autoryzacji. |
string[] |
defaultAuthorizationPolicy |
Ustawienia konfiguracji domyślnych zasad autoryzacji. |
DefaultAuthorizationPolicy |
jwtClaimChecks |
Ustawienia konfiguracji kontroli, które należy wykonać podczas weryfikowania oświadczeń JWT. |
JwtClaimChecks |
AzureStaticWebApps
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Azure Static Web Apps nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
rejestracja |
Ustawienia konfiguracji rejestracji usługi Azure Static Web Apps. |
AzureStaticWebAppsRegistration |
AzureStaticWebAppsRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
BlobStorageTokenStore
Nazwa |
Opis |
Wartość |
BlobContainerUri |
Identyfikator URI magazynu obiektów blob zawierający tokeny. Nie należy używać razem z elementem sasUrlSettingName. |
struna |
clientId |
Identyfikator klienta tożsamości zarządzanej User-Assigned. Nie należy używać go wraz z identyfikatorem managedIdentityResourceId. |
struna |
managedIdentityResourceId |
Identyfikator zasobu tożsamości zarządzanej User-Assigned. Nie należy używać razem z identyfikatorem clientId. |
struna |
sasUrlSettingName |
Nazwa wpisów tajnych aplikacji zawierających adres URL sygnatury dostępu współdzielonego magazynu obiektów blob zawierających tokeny. Nie należy używać go wraz z identyfikatorem blobContainerUri. |
struna |
ClientRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta. |
struna |
CookieExpiration
Nazwa |
Opis |
Wartość |
konwencja |
Konwencja używana podczas określania wygaśnięcia pliku cookie sesji. |
"FixedTime" "IdentityProviderDerived" |
timeToExpiration |
Czas po wysłaniu żądania po wygaśnięciu pliku cookie sesji. |
struna |
CustomOpenIdConnectProvider
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli niestandardowy dostawca open ID nie powinien być włączony; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectLogin |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectRegistration |
DefaultAuthorizationPolicy
Nazwa |
Opis |
Wartość |
allowedApplications |
Ustawienia konfiguracji dozwolonych aplikacji usługi Azure Active Directory. |
string[] |
allowedPrincipals |
Ustawienia konfiguracji dozwolonych podmiotów zabezpieczeń usługi Azure Active Directory. |
AllowedPrincipals |
EncryptionSettings
Nazwa |
Opis |
Wartość |
containerAppAuthEncryptionSecretName |
Nazwa wpisu tajnego, do której odwołuje się klucz EncryptionKey. |
struna |
containerAppAuthSigningSecretName |
Nazwa wpisu tajnego, do której odwołuje się klucz podpisywania. |
struna |
Facebook
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca serwisu Facebook nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie <kod>true</code>. |
Bool |
graphApiVersion |
Wersja interfejsu API serwisu Facebook, która ma być używana podczas logowania. |
struna |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy serwisu Facebook. |
AppRegistration |
ForwardProxy
Nazwa |
Opis |
Wartość |
konwencja |
Konwencja używana do określania adresu URL wykonanego żądania. |
"Niestandardowy" "NoProxy" "Standardowa" |
customHostHeaderName |
Nazwa nagłówka zawierającego hosta żądania. |
struna |
customProtoHeaderName |
Nazwa nagłówka zawierającego schemat żądania. |
struna |
GitHub
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca Usługi GitHub nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi GitHub. |
ClientRegistration |
GlobalValidation
Nazwa |
Opis |
Wartość |
excludedPaths |
Ścieżki, dla których nieuwierzytelniony przepływ nie zostanie przekierowany do strony logowania. |
string[] |
redirectToProvider |
Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko w przypadku skonfigurowania wielu dostawców i nieuwierzytelnionego klienta akcja jest ustawiona na wartość "RedirectToLoginPage". |
struna |
nieuwierzytelnionyClientAction |
Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji. |
"AllowAnonymous" "RedirectToLoginPage" "Return401" "Return403" |
Google
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca Google nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy Google. |
ClientRegistration |
walidacja |
Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory. |
AllowedAudiencesValidation |
HttpSettings
Nazwa |
Opis |
Wartość |
forwardProxy |
Ustawienia konfiguracji serwera proxy przesyłania dalej używane do tworzenia żądań. |
ForwardProxy |
requireHttps |
<kod>fałszywe</code>, jeśli dopuszczalne są odpowiedzi uwierzytelniania/autoryzacji bez schematu HTTPS; w przeciwnym razie <kod>true</code>. |
Bool |
Trasy |
Ustawienia konfiguracji ścieżek żądania HTTP. |
HttpSettingsRoutes |
HttpSettingsRoutes
Nazwa |
Opis |
Wartość |
apiPrefix |
Prefiks, który powinien poprzedzać wszystkie ścieżki uwierzytelniania/autoryzacji. |
struna |
IdentityProviders
Nazwa |
Opis |
Wartość |
jabłko |
Ustawienia konfiguracji dostawcy firmy Apple. |
Apple |
azureActiveDirectory |
Ustawienia konfiguracji dostawcy usługi Azure Active Directory. |
AzureActiveDirectory |
azureStaticWebApps |
Ustawienia konfiguracji dostawcy usługi Azure Static Web Apps. |
AzureStaticWebApps |
customOpenIdConnectProviders |
Mapa nazwy aliasu każdego niestandardowego dostawcy programu Open ID Connect ustawienia konfiguracji niestandardowego dostawcy programu Open ID Connect. |
IdentityProvidersCustomOpenIdConnectProviders |
facebook |
Ustawienia konfiguracji dostawcy serwisu Facebook. |
Facebook |
gitHub |
Ustawienia konfiguracji dostawcy GitHub. |
GitHub |
google |
Ustawienia konfiguracji dostawcy Google. |
Google |
świergot |
Ustawienia konfiguracji dostawcy usługi Twitter. |
Twitter |
IdentityProvidersCustomOpenIdConnectProviders
JwtClaimChecks
Nazwa |
Opis |
Wartość |
allowedClientApplications |
Lista dozwolonych aplikacji klienckich. |
string[] |
allowedGroups |
Lista dozwolonych grup. |
string[] |
Login
Nazwa |
Opis |
Wartość |
allowedExternalRedirectUrls |
Zewnętrzne adresy URL, do których można przekierować w ramach logowania lub wylogowywania się z aplikacji. Należy pamiętać, że część ciągu zapytania adresu URL jest ignorowana. Jest to zaawansowane ustawienie zwykle wymagane tylko przez zaplecza aplikacji ze Sklepu Windows. Należy pamiętać, że adresy URL w bieżącej domenie są zawsze niejawnie dozwolone. |
string[] |
cookieExpiration |
Ustawienia konfiguracji wygasania pliku cookie sesji. |
CookieExpiration |
nonce |
Ustawienia konfiguracji nieużytego w przepływie logowania. |
nonce |
preserveUrlFragmentsForLogins |
<kod>true</code>, jeśli fragmenty żądania są zachowywane po wykonaniu żądania logowania; w przeciwnym razie kod <>false</code>. |
Bool |
Trasy |
Trasy określające punkty końcowe używane do logowania i wylogowyywania żądań. |
LoginRoutes |
tokenStore |
Ustawienia konfiguracji magazynu tokenów. |
TokenStore |
LoginRoutes
Nazwa |
Opis |
Wartość |
wylogowywanie Punktu końcowego |
Punkt końcowy, w którym powinno zostać wykonane żądanie wylogowania. |
struna |
LoginScopes
Nazwa |
Opis |
Wartość |
Zakresów |
Lista zakresów, których należy zażądać podczas uwierzytelniania. |
string[] |
Microsoft.App/containerApps/authConfigs
Nazwa |
Opis |
Wartość |
apiVersion |
Wersja interfejsu API |
"2024-10-02-preview" |
nazwa |
Nazwa zasobu |
ciąg (wymagany) |
Właściwości |
Właściwości specyficzne dla zasobu AuthConfig |
AuthConfigProperties |
typ |
Typ zasobu |
"Microsoft.App/containerApps/authConfigs" |
Nonce
Nazwa |
Opis |
Wartość |
nonceExpirationInterval |
Czas po wysłaniu żądania, kiedy element nie powinien wygasać. |
struna |
validateNonce |
<kod>false</code>, jeśli nie powinny być weryfikowane podczas kończenia przepływu logowania; w przeciwnym razie <kod>true</code>. |
Bool |
OpenIdConnectClientCredential
Nazwa |
Opis |
Wartość |
clientSecretSettingName |
Ustawienie aplikacji zawierające wpis tajny klienta dla niestandardowego dostawcy programu Open ID Connect. |
struna |
metoda |
Metoda, która powinna służyć do uwierzytelniania użytkownika. |
"ClientSecretPost" |
OpenIdConnectConfig
Nazwa |
Opis |
Wartość |
authorizationEndpoint |
Punkt końcowy, który ma być używany do tworzenia żądania autoryzacji. |
struna |
certificationUri |
Punkt końcowy, który udostępnia klucze niezbędne do zweryfikowania tokenu. |
struna |
Emitenta |
Punkt końcowy, który wystawia token. |
struna |
tokenEndpoint |
Punkt końcowy, który ma być używany do żądania tokenu. |
struna |
wellKnownOpenIdConfiguration |
Punkt końcowy zawierający wszystkie punkty końcowe konfiguracji dostawcy. |
struna |
OpenIdConnectLogin
Nazwa |
Opis |
Wartość |
nameClaimType |
Nazwa oświadczenia zawierającego nazwę użytkowników. |
struna |
Zakresów |
Lista zakresów, których należy zażądać podczas uwierzytelniania. |
string[] |
OpenIdConnectRegistration
Nazwa |
Opis |
Wartość |
clientCredential |
Poświadczenia uwierzytelniania niestandardowego dostawcy open ID Connect. |
OpenIdConnectClientCredential |
clientId |
Identyfikator klienta niestandardowego dostawcy programu Open ID Connect. |
struna |
openIdConnectConfiguration |
Ustawienia konfiguracji punktów końcowych używanych dla niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectConfig |
Magazyn tokenów
Nazwa |
Opis |
Wartość |
azureBlobStorage |
Ustawienia konfiguracji magazynu tokenów, jeśli jest używany magazyn obiektów blob. |
BlobStorageTokenStore |
Włączone |
<kod>true</code> do trwałego przechowywania tokenów zabezpieczających specyficznych dla platformy, które są uzyskiwane podczas przepływów logowania; w przeciwnym razie kod <>false</code>. Wartość domyślna to kod <>false</code>. |
Bool |
tokenRefreshExtensionHours |
Liczba godzin po wygaśnięciu tokenu sesji, za pomocą którego można użyć tokenu sesji wywołaj interfejs API odświeżania tokenu. Wartość domyślna to 72 godziny. |
Int |
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Twitter nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi Twitter. |
TwitterRegistration |
Nazwa |
Opis |
Wartość |
consumerKey |
Klucz użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in |
struna |
consumerSecretSettingName |
Nazwa ustawienia aplikacji zawierająca wpis tajny użytkownika OAuth 1.0a w usłudze Twitter aplikacja używana do logowania. |
struna |
Typ zasobu containerApps/authConfigs można wdrożyć przy użyciu operacji docelowych:
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Aby utworzyć zasób Microsoft.App/containerApps/authConfigs, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.App/containerApps/authConfigs@2024-10-02-preview"
name = "string"
body = jsonencode({
properties = {
encryptionSettings = {
containerAppAuthEncryptionSecretName = "string"
containerAppAuthSigningSecretName = "string"
}
globalValidation = {
excludedPaths = [
"string"
]
redirectToProvider = "string"
unauthenticatedClientAction = "string"
}
httpSettings = {
forwardProxy = {
convention = "string"
customHostHeaderName = "string"
customProtoHeaderName = "string"
}
requireHttps = bool
routes = {
apiPrefix = "string"
}
}
identityProviders = {
apple = {
enabled = bool
login = {
scopes = [
"string"
]
}
registration = {
clientId = "string"
clientSecretSettingName = "string"
}
}
azureActiveDirectory = {
enabled = bool
isAutoProvisioned = bool
login = {
disableWWWAuthenticate = bool
loginParameters = [
"string"
]
}
registration = {
clientId = "string"
clientSecretCertificateIssuer = "string"
clientSecretCertificateSubjectAlternativeName = "string"
clientSecretCertificateThumbprint = "string"
clientSecretSettingName = "string"
openIdIssuer = "string"
}
validation = {
allowedAudiences = [
"string"
]
defaultAuthorizationPolicy = {
allowedApplications = [
"string"
]
allowedPrincipals = {
groups = [
"string"
]
identities = [
"string"
]
}
}
jwtClaimChecks = {
allowedClientApplications = [
"string"
]
allowedGroups = [
"string"
]
}
}
}
azureStaticWebApps = {
enabled = bool
registration = {
clientId = "string"
}
}
customOpenIdConnectProviders = {
{customized property} = {
enabled = bool
login = {
nameClaimType = "string"
scopes = [
"string"
]
}
registration = {
clientCredential = {
clientSecretSettingName = "string"
method = "ClientSecretPost"
}
clientId = "string"
openIdConnectConfiguration = {
authorizationEndpoint = "string"
certificationUri = "string"
issuer = "string"
tokenEndpoint = "string"
wellKnownOpenIdConfiguration = "string"
}
}
}
}
facebook = {
enabled = bool
graphApiVersion = "string"
login = {
scopes = [
"string"
]
}
registration = {
appId = "string"
appSecretSettingName = "string"
}
}
gitHub = {
enabled = bool
login = {
scopes = [
"string"
]
}
registration = {
clientId = "string"
clientSecretSettingName = "string"
}
}
google = {
enabled = bool
login = {
scopes = [
"string"
]
}
registration = {
clientId = "string"
clientSecretSettingName = "string"
}
validation = {
allowedAudiences = [
"string"
]
}
}
twitter = {
enabled = bool
registration = {
consumerKey = "string"
consumerSecretSettingName = "string"
}
}
}
login = {
allowedExternalRedirectUrls = [
"string"
]
cookieExpiration = {
convention = "string"
timeToExpiration = "string"
}
nonce = {
nonceExpirationInterval = "string"
validateNonce = bool
}
preserveUrlFragmentsForLogins = bool
routes = {
logoutEndpoint = "string"
}
tokenStore = {
azureBlobStorage = {
blobContainerUri = "string"
clientId = "string"
managedIdentityResourceId = "string"
sasUrlSettingName = "string"
}
enabled = bool
tokenRefreshExtensionHours = int
}
}
platform = {
enabled = bool
runtimeVersion = "string"
}
}
})
}
Wartości właściwości
AllowedAudiencesValidation
Nazwa |
Opis |
Wartość |
allowedAudiences |
Ustawienia konfiguracji dozwolonej listy odbiorców, z których mają być weryfikowane token JWT. |
string[] |
AllowedPrincipals
Nazwa |
Opis |
Wartość |
Grupy |
Lista dozwolonych grup. |
string[] |
Tożsamości |
Lista dozwolonych tożsamości. |
string[] |
Jabłko
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca firmy Apple nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji firmy Apple. |
AppleRegistration |
AppleRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta. |
struna |
AppRegistration
Nazwa |
Opis |
Wartość |
appId |
Identyfikator aplikacji używany do logowania. |
struna |
appSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny aplikacji. |
struna |
AuthConfigProperties
Nazwa |
Opis |
Wartość |
encryptionSettings |
Ustawienia konfiguracji wpisów tajnych odwołują się do klucza szyfrowania i klucza podpisywania dla uwierzytelniania/autoryzacji usługi ContainerApp Service. |
EncryptionSettings |
globalValidation |
Ustawienia konfiguracji, które określają przepływ weryfikacji użytkowników przy użyciu uwierzytelniania/autoryzacji usługi. |
GlobalValidation |
httpSettings |
Ustawienia konfiguracji żądań HTTP dla żądań uwierzytelniania i autoryzacji wysyłanych względem uwierzytelniania/autoryzacji usługi ContainerApp Service. |
HttpSettings |
identityProviders |
Ustawienia konfiguracji każdego dostawcy tożsamości używane do konfigurowania uwierzytelniania/autoryzacji usługi ContainerApp Service. |
IdentityProviders |
login |
Ustawienia konfiguracji przepływu logowania użytkowników przy użyciu uwierzytelniania/autoryzacji usługi ContainerApp Service. |
logowania |
podest |
Ustawienia konfiguracji platformy uwierzytelniania/autoryzacji usługi ContainerApp Service. |
AuthPlatform |
Nazwa |
Opis |
Wartość |
Włączone |
<kod>true</code>, jeśli funkcja uwierzytelniania/autoryzacji jest włączona dla bieżącej aplikacji; w przeciwnym razie kod <>false</code>. |
Bool |
runtimeVersion |
RuntimeVersion funkcji uwierzytelniania/autoryzacji używanej dla bieżącej aplikacji. Ustawienie w tej wartości może kontrolować zachowanie niektórych funkcji w module Uwierzytelnianie/autoryzacja. |
struna |
AzureActiveDirectory
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Azure Active Directory nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
isAutoProvisioned |
Pobiera wartość wskazującą, czy konfiguracja usługi Azure AD została automatycznie aprowizowana przy użyciu narzędzi testowych. Jest to flaga wewnętrzna przeznaczona głównie do obsługi portalu zarządzania Azure. Użytkownicy nie powinni odczyt lub zapis do tej właściwości. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania usługi Azure Active Directory. |
AzureActiveDirectoryLogin |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji usługi Azure Active Directory. |
AzureActiveDirectoryRegistration |
walidacja |
Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory. |
AzureActiveDirectoryValidation |
AzureActiveDirectoryLogin
Nazwa |
Opis |
Wartość |
disableWWAuthenticate |
<kod>true</code>, jeśli dostawca www-authentication powinien zostać pominięty w żądaniu; w przeciwnym razie kod <>false</code>. |
Bool |
loginParameters |
Parametry logowania wysyłane do punktu końcowego autoryzacji OpenID Connect podczas użytkownik loguje się. Każdy parametr musi mieć postać "key=value". |
string[] |
AzureActiveDirectoryRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta tej aplikacji jednostki uzależnionej, znany jako client_id. To ustawienie jest wymagane do włączenia uwierzytelniania połączenia OpenID za pomocą usługi Azure Active Directory lub innych dostawców openID Connect innych firm. Więcej informacji na temat openID Connect: http://openid.net/specs/openid-connect-core-1_0.html |
struna |
clientSecretCertificateIssuer |
Alternatywą dla odcisku palca wpisu tajnego klienta jest wystawca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie odcisku palca certyfikatu klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretCertificateSubjectAlternativeName |
Alternatywą dla odcisku palca wpisu tajnego klienta jest alternatywna nazwa podmiotu certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie odcisku palca certyfikatu klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretCertificateThumbprint |
Alternatywą dla klucza tajnego klienta jest odcisk palca certyfikatu używanego do celów podpisywania. Ta właściwość działa jako zastąpienie klucza tajnego klienta. Jest również opcjonalny. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta aplikacji jednostki uzależnionej. |
struna |
openIdIssuer |
Identyfikator URI wystawcy OpenID Connect reprezentujący jednostkę, która wystawia tokeny dostępu dla tej aplikacji. W przypadku korzystania z usługi Azure Active Directory ta wartość jest identyfikatorem URI dzierżawy katalogu, np. https://login.microsoftonline.com/v2.0/{tenant-guid}/. Ten identyfikator URI jest identyfikatorem z uwzględnieniem wielkości liter dla wystawcy tokenu. Więcej informacji na temat odnajdywania OpenID Connect: http://openid.net/specs/openid-connect-discovery-1_0.html |
struna |
AzureActiveDirectoryValidation
Nazwa |
Opis |
Wartość |
allowedAudiences |
Lista odbiorców, którzy mogą pomyślnie wysyłać żądania uwierzytelniania/autoryzacji. |
string[] |
defaultAuthorizationPolicy |
Ustawienia konfiguracji domyślnych zasad autoryzacji. |
DefaultAuthorizationPolicy |
jwtClaimChecks |
Ustawienia konfiguracji kontroli, które należy wykonać podczas weryfikowania oświadczeń JWT. |
JwtClaimChecks |
AzureStaticWebApps
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Azure Static Web Apps nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
rejestracja |
Ustawienia konfiguracji rejestracji usługi Azure Static Web Apps. |
AzureStaticWebAppsRegistration |
AzureStaticWebAppsRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
BlobStorageTokenStore
Nazwa |
Opis |
Wartość |
BlobContainerUri |
Identyfikator URI magazynu obiektów blob zawierający tokeny. Nie należy używać razem z elementem sasUrlSettingName. |
struna |
clientId |
Identyfikator klienta tożsamości zarządzanej User-Assigned. Nie należy używać go wraz z identyfikatorem managedIdentityResourceId. |
struna |
managedIdentityResourceId |
Identyfikator zasobu tożsamości zarządzanej User-Assigned. Nie należy używać razem z identyfikatorem clientId. |
struna |
sasUrlSettingName |
Nazwa wpisów tajnych aplikacji zawierających adres URL sygnatury dostępu współdzielonego magazynu obiektów blob zawierających tokeny. Nie należy używać go wraz z identyfikatorem blobContainerUri. |
struna |
ClientRegistration
Nazwa |
Opis |
Wartość |
clientId |
Identyfikator klienta aplikacji używanej do logowania. |
struna |
clientSecretSettingName |
Nazwa ustawienia aplikacji zawierająca klucz tajny klienta. |
struna |
CookieExpiration
Nazwa |
Opis |
Wartość |
konwencja |
Konwencja używana podczas określania wygaśnięcia pliku cookie sesji. |
"FixedTime" "IdentityProviderDerived" |
timeToExpiration |
Czas po wysłaniu żądania po wygaśnięciu pliku cookie sesji. |
struna |
CustomOpenIdConnectProvider
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli niestandardowy dostawca open ID nie powinien być włączony; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectLogin |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectRegistration |
DefaultAuthorizationPolicy
Nazwa |
Opis |
Wartość |
allowedApplications |
Ustawienia konfiguracji dozwolonych aplikacji usługi Azure Active Directory. |
string[] |
allowedPrincipals |
Ustawienia konfiguracji dozwolonych podmiotów zabezpieczeń usługi Azure Active Directory. |
AllowedPrincipals |
EncryptionSettings
Nazwa |
Opis |
Wartość |
containerAppAuthEncryptionSecretName |
Nazwa wpisu tajnego, do której odwołuje się klucz EncryptionKey. |
struna |
containerAppAuthSigningSecretName |
Nazwa wpisu tajnego, do której odwołuje się klucz podpisywania. |
struna |
Facebook
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca serwisu Facebook nie powinien być włączony pomimo rejestracji ustawionej; w przeciwnym razie <kod>true</code>. |
Bool |
graphApiVersion |
Wersja interfejsu API serwisu Facebook, która ma być używana podczas logowania. |
struna |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy serwisu Facebook. |
AppRegistration |
ForwardProxy
Nazwa |
Opis |
Wartość |
konwencja |
Konwencja używana do określania adresu URL wykonanego żądania. |
"Niestandardowy" "NoProxy" "Standardowa" |
customHostHeaderName |
Nazwa nagłówka zawierającego hosta żądania. |
struna |
customProtoHeaderName |
Nazwa nagłówka zawierającego schemat żądania. |
struna |
GitHub
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca Usługi GitHub nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi GitHub. |
ClientRegistration |
GlobalValidation
Nazwa |
Opis |
Wartość |
excludedPaths |
Ścieżki, dla których nieuwierzytelniony przepływ nie zostanie przekierowany do strony logowania. |
string[] |
redirectToProvider |
Domyślny dostawca uwierzytelniania używany podczas konfigurowania wielu dostawców. To ustawienie jest wymagane tylko w przypadku skonfigurowania wielu dostawców i nieuwierzytelnionego klienta akcja jest ustawiona na wartość "RedirectToLoginPage". |
struna |
nieuwierzytelnionyClientAction |
Akcja do wykonania, gdy nieuwierzytelniony klient próbuje uzyskać dostęp do aplikacji. |
"AllowAnonymous" "RedirectToLoginPage" "Return401" "Return403" |
Google
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca Google nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
login |
Ustawienia konfiguracji przepływu logowania. |
LoginScopes |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy Google. |
ClientRegistration |
walidacja |
Ustawienia konfiguracji przepływu weryfikacji tokenu usługi Azure Active Directory. |
AllowedAudiencesValidation |
HttpSettings
Nazwa |
Opis |
Wartość |
forwardProxy |
Ustawienia konfiguracji serwera proxy przesyłania dalej używane do tworzenia żądań. |
ForwardProxy |
requireHttps |
<kod>fałszywe</code>, jeśli dopuszczalne są odpowiedzi uwierzytelniania/autoryzacji bez schematu HTTPS; w przeciwnym razie <kod>true</code>. |
Bool |
Trasy |
Ustawienia konfiguracji ścieżek żądania HTTP. |
HttpSettingsRoutes |
HttpSettingsRoutes
Nazwa |
Opis |
Wartość |
apiPrefix |
Prefiks, który powinien poprzedzać wszystkie ścieżki uwierzytelniania/autoryzacji. |
struna |
IdentityProviders
Nazwa |
Opis |
Wartość |
jabłko |
Ustawienia konfiguracji dostawcy firmy Apple. |
Apple |
azureActiveDirectory |
Ustawienia konfiguracji dostawcy usługi Azure Active Directory. |
AzureActiveDirectory |
azureStaticWebApps |
Ustawienia konfiguracji dostawcy usługi Azure Static Web Apps. |
AzureStaticWebApps |
customOpenIdConnectProviders |
Mapa nazwy aliasu każdego niestandardowego dostawcy programu Open ID Connect ustawienia konfiguracji niestandardowego dostawcy programu Open ID Connect. |
IdentityProvidersCustomOpenIdConnectProviders |
facebook |
Ustawienia konfiguracji dostawcy serwisu Facebook. |
Facebook |
gitHub |
Ustawienia konfiguracji dostawcy GitHub. |
GitHub |
google |
Ustawienia konfiguracji dostawcy Google. |
Google |
świergot |
Ustawienia konfiguracji dostawcy usługi Twitter. |
Twitter |
IdentityProvidersCustomOpenIdConnectProviders
JwtClaimChecks
Nazwa |
Opis |
Wartość |
allowedClientApplications |
Lista dozwolonych aplikacji klienckich. |
string[] |
allowedGroups |
Lista dozwolonych grup. |
string[] |
Login
Nazwa |
Opis |
Wartość |
allowedExternalRedirectUrls |
Zewnętrzne adresy URL, do których można przekierować w ramach logowania lub wylogowywania się z aplikacji. Należy pamiętać, że część ciągu zapytania adresu URL jest ignorowana. Jest to zaawansowane ustawienie zwykle wymagane tylko przez zaplecza aplikacji ze Sklepu Windows. Należy pamiętać, że adresy URL w bieżącej domenie są zawsze niejawnie dozwolone. |
string[] |
cookieExpiration |
Ustawienia konfiguracji wygasania pliku cookie sesji. |
CookieExpiration |
nonce |
Ustawienia konfiguracji nieużytego w przepływie logowania. |
nonce |
preserveUrlFragmentsForLogins |
<kod>true</code>, jeśli fragmenty żądania są zachowywane po wykonaniu żądania logowania; w przeciwnym razie kod <>false</code>. |
Bool |
Trasy |
Trasy określające punkty końcowe używane do logowania i wylogowyywania żądań. |
LoginRoutes |
tokenStore |
Ustawienia konfiguracji magazynu tokenów. |
TokenStore |
LoginRoutes
Nazwa |
Opis |
Wartość |
wylogowywanie Punktu końcowego |
Punkt końcowy, w którym powinno zostać wykonane żądanie wylogowania. |
struna |
LoginScopes
Nazwa |
Opis |
Wartość |
Zakresów |
Lista zakresów, których należy zażądać podczas uwierzytelniania. |
string[] |
Microsoft.App/containerApps/authConfigs
Nazwa |
Opis |
Wartość |
nazwa |
Nazwa zasobu |
ciąg (wymagany) |
parent_id |
Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. |
Identyfikator zasobu typu: containerApps |
Właściwości |
Właściwości specyficzne dla zasobu AuthConfig |
AuthConfigProperties |
typ |
Typ zasobu |
"Microsoft.App/containerApps/authConfigs@2024-10-02-preview" |
Nonce
Nazwa |
Opis |
Wartość |
nonceExpirationInterval |
Czas po wysłaniu żądania, kiedy element nie powinien wygasać. |
struna |
validateNonce |
<kod>false</code>, jeśli nie powinny być weryfikowane podczas kończenia przepływu logowania; w przeciwnym razie <kod>true</code>. |
Bool |
OpenIdConnectClientCredential
Nazwa |
Opis |
Wartość |
clientSecretSettingName |
Ustawienie aplikacji zawierające wpis tajny klienta dla niestandardowego dostawcy programu Open ID Connect. |
struna |
metoda |
Metoda, która powinna służyć do uwierzytelniania użytkownika. |
"ClientSecretPost" |
OpenIdConnectConfig
Nazwa |
Opis |
Wartość |
authorizationEndpoint |
Punkt końcowy, który ma być używany do tworzenia żądania autoryzacji. |
struna |
certificationUri |
Punkt końcowy, który udostępnia klucze niezbędne do zweryfikowania tokenu. |
struna |
Emitenta |
Punkt końcowy, który wystawia token. |
struna |
tokenEndpoint |
Punkt końcowy, który ma być używany do żądania tokenu. |
struna |
wellKnownOpenIdConfiguration |
Punkt końcowy zawierający wszystkie punkty końcowe konfiguracji dostawcy. |
struna |
OpenIdConnectLogin
Nazwa |
Opis |
Wartość |
nameClaimType |
Nazwa oświadczenia zawierającego nazwę użytkowników. |
struna |
Zakresów |
Lista zakresów, których należy zażądać podczas uwierzytelniania. |
string[] |
OpenIdConnectRegistration
Nazwa |
Opis |
Wartość |
clientCredential |
Poświadczenia uwierzytelniania niestandardowego dostawcy open ID Connect. |
OpenIdConnectClientCredential |
clientId |
Identyfikator klienta niestandardowego dostawcy programu Open ID Connect. |
struna |
openIdConnectConfiguration |
Ustawienia konfiguracji punktów końcowych używanych dla niestandardowego dostawcy programu Open ID Connect. |
OpenIdConnectConfig |
Magazyn tokenów
Nazwa |
Opis |
Wartość |
azureBlobStorage |
Ustawienia konfiguracji magazynu tokenów, jeśli jest używany magazyn obiektów blob. |
BlobStorageTokenStore |
Włączone |
<kod>true</code> do trwałego przechowywania tokenów zabezpieczających specyficznych dla platformy, które są uzyskiwane podczas przepływów logowania; w przeciwnym razie kod <>false</code>. Wartość domyślna to kod <>false</code>. |
Bool |
tokenRefreshExtensionHours |
Liczba godzin po wygaśnięciu tokenu sesji, za pomocą którego można użyć tokenu sesji wywołaj interfejs API odświeżania tokenu. Wartość domyślna to 72 godziny. |
Int |
Nazwa |
Opis |
Wartość |
Włączone |
<kod>false</code>, jeśli dostawca usługi Twitter nie powinien być włączony pomimo rejestracji zestawu; w przeciwnym razie <kod>true</code>. |
Bool |
rejestracja |
Ustawienia konfiguracji rejestracji aplikacji dla dostawcy usługi Twitter. |
TwitterRegistration |
Nazwa |
Opis |
Wartość |
consumerKey |
Klucz użytkownika OAuth 1.0a aplikacji Twitter używany do logowania. To ustawienie jest wymagane do włączenia logowania w usłudze Twitter. Dokumentacja usługi Twitter Sign-In: https://dev.twitter.com/web/sign-in |
struna |
consumerSecretSettingName |
Nazwa ustawienia aplikacji zawierająca wpis tajny użytkownika OAuth 1.0a w usłudze Twitter aplikacja używana do logowania. |
struna |