Share via


Microsoft.Web sites/slots/config 'authsettingsV2' 2020-10-01

Bicep リソース定義

サイト/スロット/構成リソースの種類は、次を対象とする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

name プロパティのオプション

sites/slots/config リソースは 、name プロパティの値に基づいて異なるプロパティを受け入れます。 この記事では、 を設定 name: 'authsettingsV2'するときに使用できるプロパティを示します。

その他のオプションについては、以下を参照してください。

リソース形式

Microsoft.Web/sites/slots/config リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Web/sites/slots/config@2020-10-01' = {
  name: 'authsettingsV2'
  kind: 'string'
  parent: resourceSymbolicName
  properties: {
    globalValidation: {
      kind: 'string'
      properties: {
        excludedPaths: [
          'string'
        ]
        redirectToProvider: 'string'
        requireAuthentication: bool
        unauthenticatedClientAction: 'string'
      }
    }
    httpSettings: {
      kind: 'string'
      properties: {
        forwardProxy: {
          kind: 'string'
          properties: {
            convention: 'string'
            customHostHeaderName: 'string'
            customProtoHeaderName: 'string'
          }
        }
        requireHttps: bool
        routes: {
          kind: 'string'
          properties: {
            apiPrefix: 'string'
          }
        }
      }
    }
    identityProviders: {
      kind: 'string'
      properties: {
        azureActiveDirectory: {
          kind: 'string'
          properties: {
            enabled: bool
            isAutoProvisioned: bool
            login: {
              kind: 'string'
              properties: {
                disableWWWAuthenticate: bool
                loginParameters: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                clientId: 'string'
                clientSecretCertificateThumbprint: 'string'
                clientSecretSettingName: 'string'
                openIdIssuer: 'string'
              }
            }
            validation: {
              kind: 'string'
              properties: {
                allowedAudiences: [
                  'string'
                ]
                jwtClaimChecks: {
                  kind: 'string'
                  properties: {
                    allowedClientApplications: [
                      'string'
                    ]
                    allowedGroups: [
                      'string'
                    ]
                  }
                }
              }
            }
          }
        }
        customOpenIdConnectProviders: {}
        facebook: {
          kind: 'string'
          properties: {
            enabled: bool
            graphApiVersion: 'string'
            login: {
              kind: 'string'
              properties: {
                scopes: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                appId: 'string'
                appSecretSettingName: 'string'
              }
            }
          }
        }
        gitHub: {
          kind: 'string'
          properties: {
            enabled: bool
            login: {
              kind: 'string'
              properties: {
                scopes: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                clientId: 'string'
                clientSecretSettingName: 'string'
              }
            }
          }
        }
        google: {
          kind: 'string'
          properties: {
            enabled: bool
            login: {
              kind: 'string'
              properties: {
                scopes: [
                  'string'
                ]
              }
            }
            registration: {
              kind: 'string'
              properties: {
                clientId: 'string'
                clientSecretSettingName: 'string'
              }
            }
            validation: {
              kind: 'string'
              properties: {
                allowedAudiences: [
                  'string'
                ]
              }
            }
          }
        }
        twitter: {
          kind: 'string'
          properties: {
            enabled: bool
            registration: {
              kind: 'string'
              properties: {
                consumerKey: 'string'
                consumerSecretSettingName: 'string'
              }
            }
          }
        }
      }
    }
    login: {
      kind: 'string'
      properties: {
        allowedExternalRedirectUrls: [
          'string'
        ]
        cookieExpiration: {
          kind: 'string'
          properties: {
            convention: 'string'
            timeToExpiration: 'string'
          }
        }
        nonce: {
          kind: 'string'
          properties: {
            nonceExpirationInterval: 'string'
            validateNonce: bool
          }
        }
        preserveUrlFragmentsForLogins: bool
        routes: {
          kind: 'string'
          properties: {
            logoutEndpoint: 'string'
          }
        }
        tokenStore: {
          kind: 'string'
          properties: {
            azureBlobStorage: {
              kind: 'string'
              properties: {
                sasUrlSettingName: 'string'
              }
            }
            enabled: bool
            fileSystem: {
              kind: 'string'
              properties: {
                directory: 'string'
              }
            }
            tokenRefreshExtensionHours: int
          }
        }
      }
    }
    platform: {
      kind: 'string'
      properties: {
        configFilePath: 'string'
        enabled: bool
        runtimeVersion: 'string'
      }
    }
  }
}

プロパティ値

sites/slots/config-authsettingsV2

名前 説明
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。
'authsettingsV2'
kind リソースの種類。 string
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。
種類のリソースのシンボル名: slots
properties SiteAuthSettingsV2 リソース固有のプロパティ SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

名前 説明
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
ログイン (login) Login
プラットフォーム AuthPlatform

GlobalValidation

名前 説明
kind リソースの種類。 string
properties GlobalValidation リソース固有のプロパティ GlobalValidationProperties

GlobalValidationProperties

名前 説明
excludedPaths string[]
redirectToProvider string
requireAuthentication [bool]
unauthenticatedClientAction 'AllowAnonymous'
'RedirectToLoginPage'
'Return401'
'Return403'

HttpSettings

名前 説明
kind リソースの種類。 string
properties HttpSettings リソース固有のプロパティ HttpSettingsProperties

HttpSettingsProperties

名前 説明
forwardProxy ForwardProxy
requireHttps [bool]
ルート HttpSettingsRoutes

ForwardProxy

名前 説明
kind リソースの種類。 string
properties ForwardProxy リソース固有のプロパティ ForwardProxyProperties

ForwardProxyProperties

名前 説明
コンベンション 'Custom'
'NoProxy'
'Standard'
customHostHeaderName string
customProtoHeaderName string

HttpSettingsRoutes

名前 説明
kind リソースの種類。 string
properties HttpSettingsRoutes リソース固有のプロパティ HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

名前 説明
apiPrefix string

IdentityProviders

名前 説明
kind リソースの種類。 string
properties IdentityProviders リソース固有のプロパティ IdentityProvidersProperties

IdentityProvidersProperties

名前 説明
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders {CustomOpenIdConnectProvider} の辞書 object
facebook Facebook
Github GitHub
Google Google
Twitter Twitter

AzureActiveDirectory

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectory リソース固有のプロパティ AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

名前 説明
enabled [bool]
isAutoProvisioned [bool]
ログイン (login) AzureActiveDirectoryLogin
登録 AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryLogin リソース固有のプロパティ AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

名前 説明
disableWWWAuthenticate [bool]
loginParameters string[]

AzureActiveDirectoryRegistration

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryRegistration リソース固有のプロパティ AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

名前 説明
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryValidation リソース固有のプロパティ AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

名前 説明
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

名前 説明
kind リソースの種類。 string
properties JwtClaimChecks リソース固有のプロパティ JwtClaimChecksProperties

JwtClaimChecksProperties

名前 説明
allowedClientApplications string[]
allowedGroups string[]

Facebook

名前 説明
kind リソースの種類。 string
properties Facebook リソース固有のプロパティ FacebookProperties

FacebookProperties

名前 説明
enabled [bool]
graphApiVersion string
ログイン (login) LoginScopes
登録 AppRegistration

LoginScopes

名前 説明
kind リソースの種類。 string
properties LoginScopes リソース固有のプロパティ LoginScopesProperties

LoginScopesProperties

名前 説明
スコープ string[]

AppRegistration

名前 説明
kind リソースの種類。 string
properties AppRegistration リソース固有のプロパティ AppRegistrationProperties

AppRegistrationProperties

名前 説明
appId string
appSecretSettingName string

GitHub

名前 説明
kind リソースの種類。 string
properties GitHub リソース固有のプロパティ GitHubProperties

GitHubProperties

名前 説明
enabled [bool]
ログイン (login) LoginScopes
登録 ClientRegistration

ClientRegistration

名前 説明
kind リソースの種類。 string
properties ClientRegistration リソース固有のプロパティ ClientRegistrationProperties

ClientRegistrationProperties

名前 説明
clientId string
clientSecretSettingName string

Google

名前 説明
kind リソースの種類。 string
properties Google リソース固有のプロパティ GoogleProperties

GoogleProperties

名前 説明
enabled [bool]
ログイン (login) LoginScopes
登録 ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

名前 説明
kind リソースの種類。 string
properties AllowedAudiencesValidation リソース固有のプロパティ AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

名前 説明
allowedAudiences string[]

Twitter

名前 説明
kind リソースの種類。 string
properties Twitter リソース固有のプロパティ TwitterProperties

TwitterProperties

名前 説明
enabled [bool]
登録 TwitterRegistration

TwitterRegistration

名前 説明
kind リソースの種類。 string
properties TwitterRegistration リソース固有のプロパティ TwitterRegistrationProperties

TwitterRegistrationProperties

名前 説明
consumerKey string
consumerSecretSettingName string

ログイン

名前 説明
kind リソースの種類。 string
properties ログイン リソース固有のプロパティ LoginProperties

LoginProperties

名前 説明
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins [bool]
ルート LoginRoutes
tokenStore TokenStore

CookieExpiration

名前 説明
kind リソースの種類。 string
properties CookieExpiration リソース固有のプロパティ CookieExpirationProperties

CookieExpirationProperties

名前 説明
コンベンション 'FixedTime'
'IdentityProviderDerived'
timeToExpiration string

nonce

名前 説明
kind リソースの種類。 string
properties Nonce リソース固有のプロパティ NonceProperties

NonceProperties

名前 説明
nonceExpirationInterval string
validateNonce [bool]

LoginRoutes

名前 説明
kind リソースの種類。 string
properties LoginRoutes リソース固有のプロパティ LoginRoutesProperties

LoginRoutesProperties

名前 説明
logoutEndpoint string

TokenStore

名前 説明
kind リソースの種類。 string
properties TokenStore リソース固有のプロパティ TokenStoreProperties

TokenStoreProperties

名前 説明
azureBlobStorage BlobStorageTokenStore
enabled [bool]
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours INT

BlobStorageTokenStore

名前 説明
kind リソースの種類。 string
properties BlobStorageTokenStore リソース固有のプロパティ BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

名前 説明
sasUrlSettingName string

FileSystemTokenStore

名前 説明
kind リソースの種類。 string
properties FileSystemTokenStore リソース固有のプロパティ FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

名前 説明
directory string

AuthPlatform

名前 説明
kind リソースの種類。 string
properties AuthPlatform リソース固有のプロパティ AuthPlatformProperties

AuthPlatformProperties

名前 説明
configFilePath string
enabled [bool]
runtimeVersion string

ARM テンプレート リソース定義

サイト/スロット/構成リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

name プロパティのオプション

sites/slots/config リソースは 、name プロパティの値に基づいて異なるプロパティを受け入れます。 この記事では、 を設定 name: 'authsettingsV2'するときに使用できるプロパティを示します。

その他のオプションについては、以下を参照してください。

リソース形式

Microsoft.Web/sites/slots/config リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Web/sites/slots/config",
  "apiVersion": "2020-10-01",
  "name": "authsettingsV2",
  "kind": "string",
  "properties": {
    "globalValidation": {
      "kind": "string",
      "properties": {
        "excludedPaths": [ "string" ],
        "redirectToProvider": "string",
        "requireAuthentication": "bool",
        "unauthenticatedClientAction": "string"
      }
    },
    "httpSettings": {
      "kind": "string",
      "properties": {
        "forwardProxy": {
          "kind": "string",
          "properties": {
            "convention": "string",
            "customHostHeaderName": "string",
            "customProtoHeaderName": "string"
          }
        },
        "requireHttps": "bool",
        "routes": {
          "kind": "string",
          "properties": {
            "apiPrefix": "string"
          }
        }
      }
    },
    "identityProviders": {
      "kind": "string",
      "properties": {
        "azureActiveDirectory": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "isAutoProvisioned": "bool",
            "login": {
              "kind": "string",
              "properties": {
                "disableWWWAuthenticate": "bool",
                "loginParameters": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "clientId": "string",
                "clientSecretCertificateThumbprint": "string",
                "clientSecretSettingName": "string",
                "openIdIssuer": "string"
              }
            },
            "validation": {
              "kind": "string",
              "properties": {
                "allowedAudiences": [ "string" ],
                "jwtClaimChecks": {
                  "kind": "string",
                  "properties": {
                    "allowedClientApplications": [ "string" ],
                    "allowedGroups": [ "string" ]
                  }
                }
              }
            }
          }
        },
        "customOpenIdConnectProviders": {},
        "facebook": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "graphApiVersion": "string",
            "login": {
              "kind": "string",
              "properties": {
                "scopes": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "appId": "string",
                "appSecretSettingName": "string"
              }
            }
          }
        },
        "gitHub": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "login": {
              "kind": "string",
              "properties": {
                "scopes": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "clientId": "string",
                "clientSecretSettingName": "string"
              }
            }
          }
        },
        "google": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "login": {
              "kind": "string",
              "properties": {
                "scopes": [ "string" ]
              }
            },
            "registration": {
              "kind": "string",
              "properties": {
                "clientId": "string",
                "clientSecretSettingName": "string"
              }
            },
            "validation": {
              "kind": "string",
              "properties": {
                "allowedAudiences": [ "string" ]
              }
            }
          }
        },
        "twitter": {
          "kind": "string",
          "properties": {
            "enabled": "bool",
            "registration": {
              "kind": "string",
              "properties": {
                "consumerKey": "string",
                "consumerSecretSettingName": "string"
              }
            }
          }
        }
      }
    },
    "login": {
      "kind": "string",
      "properties": {
        "allowedExternalRedirectUrls": [ "string" ],
        "cookieExpiration": {
          "kind": "string",
          "properties": {
            "convention": "string",
            "timeToExpiration": "string"
          }
        },
        "nonce": {
          "kind": "string",
          "properties": {
            "nonceExpirationInterval": "string",
            "validateNonce": "bool"
          }
        },
        "preserveUrlFragmentsForLogins": "bool",
        "routes": {
          "kind": "string",
          "properties": {
            "logoutEndpoint": "string"
          }
        },
        "tokenStore": {
          "kind": "string",
          "properties": {
            "azureBlobStorage": {
              "kind": "string",
              "properties": {
                "sasUrlSettingName": "string"
              }
            },
            "enabled": "bool",
            "fileSystem": {
              "kind": "string",
              "properties": {
                "directory": "string"
              }
            },
            "tokenRefreshExtensionHours": "int"
          }
        }
      }
    },
    "platform": {
      "kind": "string",
      "properties": {
        "configFilePath": "string",
        "enabled": "bool",
        "runtimeVersion": "string"
      }
    }
  }
}

プロパティ値

sites/slots/config-authsettingsV2

名前 説明
type リソースの種類 'Microsoft.Web/sites/slots/config'
apiVersion リソース API のバージョン '2020-10-01'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。
'authsettingsV2'
kind リソースの種類。 string
properties SiteAuthSettingsV2 リソース固有のプロパティ SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

名前 説明
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
ログイン (login) Login
プラットフォーム AuthPlatform

GlobalValidation

名前 説明
kind リソースの種類。 string
properties GlobalValidation リソース固有のプロパティ GlobalValidationProperties

GlobalValidationProperties

名前 説明
excludedPaths string[]
redirectToProvider string
requireAuthentication [bool]
unauthenticatedClientAction 'AllowAnonymous'
'RedirectToLoginPage'
'Return401'
'Return403'

HttpSettings

名前 説明
kind リソースの種類。 string
properties HttpSettings リソース固有のプロパティ HttpSettingsProperties

HttpSettingsProperties

名前 説明
forwardProxy ForwardProxy
requireHttps [bool]
ルート HttpSettingsRoutes

ForwardProxy

名前 説明
kind リソースの種類。 string
properties ForwardProxy リソース固有のプロパティ ForwardProxyProperties

ForwardProxyProperties

名前 説明
コンベンション 'Custom'
'NoProxy'
'Standard'
customHostHeaderName string
customProtoHeaderName string

HttpSettingsRoutes

名前 説明
kind リソースの種類。 string
properties HttpSettingsRoutes リソース固有のプロパティ HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

名前 説明
apiPrefix string

IdentityProviders

名前 説明
kind リソースの種類。 string
properties IdentityProviders リソース固有のプロパティ IdentityProvidersProperties

IdentityProvidersProperties

名前 説明
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders {CustomOpenIdConnectProvider} の辞書 object
facebook Facebook
Github GitHub
Google Google
Twitter Twitter

AzureActiveDirectory

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectory リソース固有のプロパティ AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

名前 説明
enabled [bool]
isAutoProvisioned [bool]
ログイン (login) AzureActiveDirectoryLogin
登録 AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryLogin リソース固有のプロパティ AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

名前 説明
disableWWWAuthenticate [bool]
loginParameters string[]

AzureActiveDirectoryRegistration

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryRegistration リソース固有のプロパティ AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

名前 説明
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryValidation リソース固有のプロパティ AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

名前 説明
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

名前 説明
kind リソースの種類。 string
properties JwtClaimChecks リソース固有のプロパティ JwtClaimChecksProperties

JwtClaimChecksProperties

名前 説明
allowedClientApplications string[]
allowedGroups string[]

Facebook

名前 説明
kind リソースの種類。 string
properties Facebook リソース固有のプロパティ FacebookProperties

FacebookProperties

名前 説明
enabled [bool]
graphApiVersion string
ログイン (login) LoginScopes
登録 AppRegistration

LoginScopes

名前 説明
kind リソースの種類。 string
properties LoginScopes リソース固有のプロパティ LoginScopesProperties

LoginScopesProperties

名前 説明
スコープ string[]

AppRegistration

名前 説明
kind リソースの種類。 string
properties AppRegistration リソース固有のプロパティ AppRegistrationProperties

AppRegistrationProperties

名前 説明
appId string
appSecretSettingName string

GitHub

名前 説明
kind リソースの種類。 string
properties GitHub リソース固有のプロパティ GitHubProperties

GitHubProperties

名前 説明
enabled [bool]
ログイン (login) LoginScopes
登録 ClientRegistration

ClientRegistration

名前 説明
kind リソースの種類。 string
properties ClientRegistration リソース固有のプロパティ ClientRegistrationProperties

ClientRegistrationProperties

名前 説明
clientId string
clientSecretSettingName string

Google

名前 説明
kind リソースの種類。 string
properties Google リソース固有のプロパティ GoogleProperties

GoogleProperties

名前 説明
enabled [bool]
ログイン (login) LoginScopes
登録 ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

名前 説明
kind リソースの種類。 string
properties AllowedAudiencesValidation リソース固有のプロパティ AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

名前 説明
allowedAudiences string[]

Twitter

名前 説明
kind リソースの種類。 string
properties Twitter リソース固有のプロパティ TwitterProperties

TwitterProperties

名前 説明
enabled [bool]
登録 TwitterRegistration

TwitterRegistration

名前 説明
kind リソースの種類。 string
properties TwitterRegistration リソース固有のプロパティ TwitterRegistrationProperties

TwitterRegistrationProperties

名前 説明
consumerKey string
consumerSecretSettingName string

ログイン

名前 説明
kind リソースの種類。 string
properties ログイン リソース固有のプロパティ LoginProperties

LoginProperties

名前 説明
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins [bool]
ルート LoginRoutes
tokenStore TokenStore

CookieExpiration

名前 説明
kind リソースの種類。 string
properties CookieExpiration リソース固有のプロパティ CookieExpirationProperties

CookieExpirationProperties

名前 説明
コンベンション 'FixedTime'
'IdentityProviderDerived'
timeToExpiration string

nonce

名前 説明
kind リソースの種類。 string
properties Nonce リソース固有のプロパティ NonceProperties

NonceProperties

名前 説明
nonceExpirationInterval string
validateNonce [bool]

LoginRoutes

名前 説明
kind リソースの種類。 string
properties LoginRoutes リソース固有のプロパティ LoginRoutesProperties

LoginRoutesProperties

名前 説明
logoutEndpoint string

TokenStore

名前 説明
kind リソースの種類。 string
properties TokenStore リソース固有のプロパティ TokenStoreProperties

TokenStoreProperties

名前 説明
azureBlobStorage BlobStorageTokenStore
enabled [bool]
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours INT

BlobStorageTokenStore

名前 説明
kind リソースの種類。 string
properties BlobStorageTokenStore リソース固有のプロパティ BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

名前 説明
sasUrlSettingName string

FileSystemTokenStore

名前 説明
kind リソースの種類。 string
properties FileSystemTokenStore リソース固有のプロパティ FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

名前 説明
directory string

AuthPlatform

名前 説明
kind リソースの種類。 string
properties AuthPlatform リソース固有のプロパティ AuthPlatformProperties

AuthPlatformProperties

名前 説明
configFilePath string
enabled [bool]
runtimeVersion string

Terraform (AzAPI プロバイダー) リソース定義

サイト/スロット/構成リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

name プロパティのオプション

sites/slots/config リソースは 、name プロパティの値に基づいて異なるプロパティを受け入れます。 この記事では、 を設定 name: 'authsettingsV2'するときに使用できるプロパティを示します。

その他のオプションについては、以下を参照してください。

リソース形式

Microsoft.Web/sites/slots/config リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots/config@2020-10-01"
  name = "authsettingsV2"
  parent_id = "string"
  body = jsonencode({
    properties = {
      globalValidation = {
        kind = "string"
        properties = {
          excludedPaths = [
            "string"
          ]
          redirectToProvider = "string"
          requireAuthentication = bool
          unauthenticatedClientAction = "string"
        }
      }
      httpSettings = {
        kind = "string"
        properties = {
          forwardProxy = {
            kind = "string"
            properties = {
              convention = "string"
              customHostHeaderName = "string"
              customProtoHeaderName = "string"
            }
          }
          requireHttps = bool
          routes = {
            kind = "string"
            properties = {
              apiPrefix = "string"
            }
          }
        }
      }
      identityProviders = {
        kind = "string"
        properties = {
          azureActiveDirectory = {
            kind = "string"
            properties = {
              enabled = bool
              isAutoProvisioned = bool
              login = {
                kind = "string"
                properties = {
                  disableWWWAuthenticate = bool
                  loginParameters = [
                    "string"
                  ]
                }
              }
              registration = {
                kind = "string"
                properties = {
                  clientId = "string"
                  clientSecretCertificateThumbprint = "string"
                  clientSecretSettingName = "string"
                  openIdIssuer = "string"
                }
              }
              validation = {
                kind = "string"
                properties = {
                  allowedAudiences = [
                    "string"
                  ]
                  jwtClaimChecks = {
                    kind = "string"
                    properties = {
                      allowedClientApplications = [
                        "string"
                      ]
                      allowedGroups = [
                        "string"
                      ]
                    }
                  }
                }
              }
            }
          }
          customOpenIdConnectProviders = {}
          facebook = {
            kind = "string"
            properties = {
              enabled = bool
              graphApiVersion = "string"
              login = {
                kind = "string"
                properties = {
                  scopes = [
                    "string"
                  ]
                }
              }
              registration = {
                kind = "string"
                properties = {
                  appId = "string"
                  appSecretSettingName = "string"
                }
              }
            }
          }
          gitHub = {
            kind = "string"
            properties = {
              enabled = bool
              login = {
                kind = "string"
                properties = {
                  scopes = [
                    "string"
                  ]
                }
              }
              registration = {
                kind = "string"
                properties = {
                  clientId = "string"
                  clientSecretSettingName = "string"
                }
              }
            }
          }
          google = {
            kind = "string"
            properties = {
              enabled = bool
              login = {
                kind = "string"
                properties = {
                  scopes = [
                    "string"
                  ]
                }
              }
              registration = {
                kind = "string"
                properties = {
                  clientId = "string"
                  clientSecretSettingName = "string"
                }
              }
              validation = {
                kind = "string"
                properties = {
                  allowedAudiences = [
                    "string"
                  ]
                }
              }
            }
          }
          twitter = {
            kind = "string"
            properties = {
              enabled = bool
              registration = {
                kind = "string"
                properties = {
                  consumerKey = "string"
                  consumerSecretSettingName = "string"
                }
              }
            }
          }
        }
      }
      login = {
        kind = "string"
        properties = {
          allowedExternalRedirectUrls = [
            "string"
          ]
          cookieExpiration = {
            kind = "string"
            properties = {
              convention = "string"
              timeToExpiration = "string"
            }
          }
          nonce = {
            kind = "string"
            properties = {
              nonceExpirationInterval = "string"
              validateNonce = bool
            }
          }
          preserveUrlFragmentsForLogins = bool
          routes = {
            kind = "string"
            properties = {
              logoutEndpoint = "string"
            }
          }
          tokenStore = {
            kind = "string"
            properties = {
              azureBlobStorage = {
                kind = "string"
                properties = {
                  sasUrlSettingName = "string"
                }
              }
              enabled = bool
              fileSystem = {
                kind = "string"
                properties = {
                  directory = "string"
                }
              }
              tokenRefreshExtensionHours = int
            }
          }
        }
      }
      platform = {
        kind = "string"
        properties = {
          configFilePath = "string"
          enabled = bool
          runtimeVersion = "string"
        }
      }
    }
    kind = "string"
  })
}

プロパティ値

sites/slots/config-authsettingsV2

名前 説明
type リソースの種類 "Microsoft.Web/sites/slots/config@2020-10-01"
name リソース名 "authsettingsV2"
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: スロット
kind リソースの種類。 string
properties SiteAuthSettingsV2 リソース固有のプロパティ SiteAuthSettingsV2Properties

SiteAuthSettingsV2Properties

名前 説明
globalValidation GlobalValidation
httpSettings HttpSettings
identityProviders IdentityProviders
ログイン (login) Login
プラットフォーム AuthPlatform

GlobalValidation

名前 説明
kind リソースの種類。 string
properties GlobalValidation リソース固有のプロパティ GlobalValidationProperties

GlobalValidationProperties

名前 説明
excludedPaths string[]
redirectToProvider string
requireAuthentication [bool]
unauthenticatedClientAction "AllowAnonymous"
"RedirectToLoginPage"
"Return401"
"Return403"

HttpSettings

名前 説明
kind リソースの種類。 string
properties HttpSettings リソース固有のプロパティ HttpSettingsProperties

HttpSettingsProperties

名前 説明
forwardProxy ForwardProxy
requireHttps [bool]
ルート HttpSettingsRoutes

ForwardProxy

名前 説明
kind リソースの種類。 string
properties ForwardProxy リソース固有のプロパティ ForwardProxyProperties

ForwardProxyProperties

名前 説明
コンベンション "Custom"
"NoProxy"
"Standard"
customHostHeaderName string
customProtoHeaderName string

HttpSettingsRoutes

名前 説明
kind リソースの種類。 string
properties HttpSettingsRoutes リソース固有のプロパティ HttpSettingsRoutesProperties

HttpSettingsRoutesProperties

名前 説明
apiPrefix string

IdentityProviders

名前 説明
kind リソースの種類。 string
properties IdentityProviders リソース固有のプロパティ IdentityProvidersProperties

IdentityProvidersProperties

名前 説明
azureActiveDirectory AzureActiveDirectory
customOpenIdConnectProviders {CustomOpenIdConnectProvider} の辞書 object
facebook Facebook
Github GitHub
Google Google
Twitter Twitter

AzureActiveDirectory

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectory リソース固有のプロパティ AzureActiveDirectoryProperties

AzureActiveDirectoryProperties

名前 説明
enabled [bool]
isAutoProvisioned [bool]
ログイン (login) AzureActiveDirectoryLogin
登録 AzureActiveDirectoryRegistration
validation AzureActiveDirectoryValidation

AzureActiveDirectoryLogin

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryLogin リソース固有のプロパティ AzureActiveDirectoryLoginProperties

AzureActiveDirectoryLoginProperties

名前 説明
disableWWWAuthenticate [bool]
loginParameters string[]

AzureActiveDirectoryRegistration

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryRegistration リソース固有のプロパティ AzureActiveDirectoryRegistrationProperties

AzureActiveDirectoryRegistrationProperties

名前 説明
clientId string
clientSecretCertificateThumbprint string
clientSecretSettingName string
openIdIssuer string

AzureActiveDirectoryValidation

名前 説明
kind リソースの種類。 string
properties AzureActiveDirectoryValidation リソース固有のプロパティ AzureActiveDirectoryValidationProperties

AzureActiveDirectoryValidationProperties

名前 説明
allowedAudiences string[]
jwtClaimChecks JwtClaimChecks

JwtClaimChecks

名前 説明
kind リソースの種類。 string
properties JwtClaimChecks リソース固有のプロパティ JwtClaimChecksProperties

JwtClaimChecksProperties

名前 説明
allowedClientApplications string[]
allowedGroups string[]

Facebook

名前 説明
kind リソースの種類。 string
properties Facebook リソース固有のプロパティ FacebookProperties

FacebookProperties

名前 説明
enabled [bool]
graphApiVersion string
ログイン (login) LoginScopes
登録 AppRegistration

LoginScopes

名前 説明
kind リソースの種類。 string
properties LoginScopes リソース固有のプロパティ LoginScopesProperties

LoginScopesProperties

名前 説明
スコープ string[]

AppRegistration

名前 説明
kind リソースの種類。 string
properties AppRegistration リソース固有のプロパティ AppRegistrationProperties

AppRegistrationProperties

名前 説明
appId string
appSecretSettingName string

GitHub

名前 説明
kind リソースの種類。 string
properties GitHub リソース固有のプロパティ GitHubProperties

GitHubProperties

名前 説明
enabled [bool]
ログイン (login) LoginScopes
登録 ClientRegistration

ClientRegistration

名前 説明
kind リソースの種類。 string
properties ClientRegistration リソース固有のプロパティ ClientRegistrationProperties

ClientRegistrationProperties

名前 説明
clientId string
clientSecretSettingName string

Google

名前 説明
kind リソースの種類。 string
properties Google リソース固有のプロパティ GoogleProperties

GoogleProperties

名前 説明
enabled [bool]
ログイン (login) LoginScopes
登録 ClientRegistration
validation AllowedAudiencesValidation

AllowedAudiencesValidation

名前 説明
kind リソースの種類。 string
properties AllowedAudiencesValidation リソース固有のプロパティ AllowedAudiencesValidationProperties

AllowedAudiencesValidationProperties

名前 説明
allowedAudiences string[]

Twitter

名前 説明
kind リソースの種類。 string
properties Twitter リソース固有のプロパティ TwitterProperties

TwitterProperties

名前 説明
enabled [bool]
登録 TwitterRegistration

TwitterRegistration

名前 説明
kind リソースの種類。 string
properties TwitterRegistration リソース固有のプロパティ TwitterRegistrationProperties

TwitterRegistrationProperties

名前 説明
consumerKey string
consumerSecretSettingName string

ログイン

名前 説明
kind リソースの種類。 string
properties ログイン リソース固有のプロパティ LoginProperties

LoginProperties

名前 説明
allowedExternalRedirectUrls string[]
cookieExpiration CookieExpiration
nonce Nonce
preserveUrlFragmentsForLogins [bool]
ルート LoginRoutes
tokenStore TokenStore

CookieExpiration

名前 説明
kind リソースの種類。 string
properties CookieExpiration リソース固有のプロパティ CookieExpirationProperties

CookieExpirationProperties

名前 説明
コンベンション "FixedTime"
"IdentityProviderDerived"
timeToExpiration string

nonce

名前 説明
kind リソースの種類。 string
properties Nonce リソース固有のプロパティ NonceProperties

NonceProperties

名前 説明
nonceExpirationInterval string
validateNonce [bool]

LoginRoutes

名前 説明
kind リソースの種類。 string
properties LoginRoutes リソース固有のプロパティ LoginRoutesProperties

LoginRoutesProperties

名前 説明
logoutEndpoint string

TokenStore

名前 説明
kind リソースの種類。 string
properties TokenStore リソース固有のプロパティ TokenStoreProperties

TokenStoreProperties

名前 説明
azureBlobStorage BlobStorageTokenStore
enabled [bool]
fileSystem FileSystemTokenStore
tokenRefreshExtensionHours INT

BlobStorageTokenStore

名前 説明
kind リソースの種類。 string
properties BlobStorageTokenStore リソース固有のプロパティ BlobStorageTokenStoreProperties

BlobStorageTokenStoreProperties

名前 説明
sasUrlSettingName string

FileSystemTokenStore

名前 説明
kind リソースの種類。 string
properties FileSystemTokenStore リソース固有のプロパティ FileSystemTokenStoreProperties

FileSystemTokenStoreProperties

名前 説明
directory string

AuthPlatform

名前 説明
kind リソースの種類。 string
properties AuthPlatform リソース固有のプロパティ AuthPlatformProperties

AuthPlatformProperties

名前 説明
configFilePath string
enabled [bool]
runtimeVersion string