Microsoft.Web sites/slots

  • 發行項

Bicep 資源定義

月臺/位置資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.Web/sites/slots 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.Web/sites/slots@2022-09-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  parent: resourceSymbolicName
  extendedLocation: {
    name: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    clientAffinityEnabled: bool
    clientCertEnabled: bool
    clientCertExclusionPaths: 'string'
    clientCertMode: 'string'
    cloningInfo: {
      appSettingsOverrides: {}
      cloneCustomHostNames: bool
      cloneSourceControl: bool
      configureLoadBalancing: bool
      correlationId: 'string'
      hostingEnvironment: 'string'
      overwrite: bool
      sourceWebAppId: 'string'
      sourceWebAppLocation: 'string'
      trafficManagerProfileId: 'string'
      trafficManagerProfileName: 'string'
    }
    containerSize: int
    customDomainVerificationId: 'string'
    dailyMemoryTimeQuota: int
    enabled: bool
    hostingEnvironmentProfile: {
      id: 'string'
    }
    hostNamesDisabled: bool
    hostNameSslStates: [
      {
        hostType: 'string'
        name: 'string'
        sslState: 'string'
        thumbprint: 'string'
        toUpdate: bool
        virtualIP: 'string'
      }
    ]
    httpsOnly: bool
    hyperV: bool
    isXenon: bool
    keyVaultReferenceIdentity: 'string'
    managedEnvironmentId: 'string'
    publicNetworkAccess: 'string'
    redundancyMode: 'string'
    reserved: bool
    scmSiteAlsoStopped: bool
    serverFarmId: 'string'
    siteConfig: {
      acrUseManagedIdentityCreds: bool
      acrUserManagedIdentityID: 'string'
      alwaysOn: bool
      apiDefinition: {
        url: 'string'
      }
      apiManagementConfig: {
        id: 'string'
      }
      appCommandLine: 'string'
      appSettings: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      autoHealEnabled: bool
      autoHealRules: {
        actions: {
          actionType: 'string'
          customAction: {
            exe: 'string'
            parameters: 'string'
          }
          minProcessExecutionTime: 'string'
        }
        triggers: {
          privateBytesInKB: int
          requests: {
            count: int
            timeInterval: 'string'
          }
          slowRequests: {
            count: int
            path: 'string'
            timeInterval: 'string'
            timeTaken: 'string'
          }
          slowRequestsWithPath: [
            {
              count: int
              path: 'string'
              timeInterval: 'string'
              timeTaken: 'string'
            }
          ]
          statusCodes: [
            {
              count: int
              path: 'string'
              status: int
              subStatus: int
              timeInterval: 'string'
              win32Status: int
            }
          ]
          statusCodesRange: [
            {
              count: int
              path: 'string'
              statusCodes: 'string'
              timeInterval: 'string'
            }
          ]
        }
      }
      autoSwapSlotName: 'string'
      azureStorageAccounts: {}
      connectionStrings: [
        {
          connectionString: 'string'
          name: 'string'
          type: 'string'
        }
      ]
      cors: {
        allowedOrigins: [
          'string'
        ]
        supportCredentials: bool
      }
      defaultDocuments: [
        'string'
      ]
      detailedErrorLoggingEnabled: bool
      documentRoot: 'string'
      elasticWebAppScaleLimit: int
      experiments: {
        rampUpRules: [
          {
            actionHostName: 'string'
            changeDecisionCallbackUrl: 'string'
            changeIntervalInMinutes: int
            changeStep: int
            maxReroutePercentage: int
            minReroutePercentage: int
            name: 'string'
            reroutePercentage: int
          }
        ]
      }
      ftpsState: 'string'
      functionAppScaleLimit: int
      functionsRuntimeScaleMonitoringEnabled: bool
      handlerMappings: [
        {
          arguments: 'string'
          extension: 'string'
          scriptProcessor: 'string'
        }
      ]
      healthCheckPath: 'string'
      http20Enabled: bool
      httpLoggingEnabled: bool
      ipSecurityRestrictions: [
        {
          action: 'string'
          description: 'string'
          headers: {}
          ipAddress: 'string'
          name: 'string'
          priority: int
          subnetMask: 'string'
          subnetTrafficTag: int
          tag: 'string'
          vnetSubnetResourceId: 'string'
          vnetTrafficTag: int
        }
      ]
      ipSecurityRestrictionsDefaultAction: 'string'
      javaContainer: 'string'
      javaContainerVersion: 'string'
      javaVersion: 'string'
      keyVaultReferenceIdentity: 'string'
      limits: {
        maxDiskSizeInMb: int
        maxMemoryInMb: int
        maxPercentageCpu: int
      }
      linuxFxVersion: 'string'
      loadBalancing: 'string'
      localMySqlEnabled: bool
      logsDirectorySizeLimit: int
      managedPipelineMode: 'string'
      managedServiceIdentityId: int
      metadata: [
        {
          name: 'string'
          value: 'string'
        }
      ]
      minimumElasticInstanceCount: int
      minTlsVersion: 'string'
      netFrameworkVersion: 'string'
      nodeVersion: 'string'
      numberOfWorkers: int
      phpVersion: 'string'
      powerShellVersion: 'string'
      preWarmedInstanceCount: int
      publicNetworkAccess: 'string'
      publishingUsername: 'string'
      push: {
        kind: 'string'
        properties: {
          dynamicTagsJson: 'string'
          isPushEnabled: bool
          tagsRequiringAuth: 'string'
          tagWhitelistJson: 'string'
        }
      }
      pythonVersion: 'string'
      remoteDebuggingEnabled: bool
      remoteDebuggingVersion: 'string'
      requestTracingEnabled: bool
      requestTracingExpirationTime: 'string'
      scmIpSecurityRestrictions: [
        {
          action: 'string'
          description: 'string'
          headers: {}
          ipAddress: 'string'
          name: 'string'
          priority: int
          subnetMask: 'string'
          subnetTrafficTag: int
          tag: 'string'
          vnetSubnetResourceId: 'string'
          vnetTrafficTag: int
        }
      ]
      scmIpSecurityRestrictionsDefaultAction: 'string'
      scmIpSecurityRestrictionsUseMain: bool
      scmMinTlsVersion: 'string'
      scmType: 'string'
      tracingOptions: 'string'
      use32BitWorkerProcess: bool
      virtualApplications: [
        {
          physicalPath: 'string'
          preloadEnabled: bool
          virtualDirectories: [
            {
              physicalPath: 'string'
              virtualPath: 'string'
            }
          ]
          virtualPath: 'string'
        }
      ]
      vnetName: 'string'
      vnetPrivatePortsCount: int
      vnetRouteAllEnabled: bool
      websiteTimeZone: 'string'
      webSocketsEnabled: bool
      windowsFxVersion: 'string'
      xManagedServiceIdentityId: int
    }
    storageAccountRequired: bool
    virtualNetworkSubnetId: 'string'
    vnetContentShareEnabled: bool
    vnetImagePullEnabled: bool
    vnetRouteAllEnabled: bool
  }
}

屬性值

sites/slots

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 字串 (必要)

字元限制：2-59

合法字元：
可對應至 Punycode 的英數位元、連字號及 Unicode 字元
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
kind 資源種類。 字串
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源之外宣告子資源時，才需要新增這個屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： sites
extendedLocation 擴充位置。 ExtendedLocation
身分識別 受控服務識別。 ManagedServiceIdentity
properties 網站資源特定屬性 SiteProperties

ExtendedLocation

名稱 描述 值
NAME 擴充位置的名稱。 字串

ManagedServiceIdentity

名稱 描述 值
類型 受控服務識別的類型。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者指派身分識別清單。 用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} 物件 (object)

SiteProperties

名稱 描述 值
clientAffinityEnabled true 表示啟用客戶端親和性; false 表示停止傳送會話親和性 Cookie，以將相同會話中的用戶端要求路由傳送至相同的實例。 預設為 true。 bool
clientCertEnabled true 啟用客戶端憑證驗證 (TLS 相互驗證) ;否則為 false。 預設為 false。 bool
clientCertExclusionPaths 用戶端憑證驗證逗號分隔排除路徑 字串
clientCertMode 這會使用 ClientCertEnabled 設定來撰寫。
- ClientCertEnabled：false 表示忽略 ClientCert。
- ClientCertEnabled：true 和 ClientCertMode：必要表示需要 ClientCert。
- ClientCertEnabled：true 和 ClientCertMode：選擇性表示 ClientCert 是選擇性或接受的。		 'Optional'
'OptionalInteractiveUser'
'Required'
複製Info 如果在應用程式建立期間指定，則會從來源應用程式複製應用程式。 CloningInfo
containerSize 函式容器的大小。 int
customDomainVerificationId 驗證指派給應用程式之自定義網域的唯一標識符。 客戶會將此標識元新增至 txt 記錄以進行驗證。 字串
dailyMemoryTimeQuota 動態應用程式) 上允許的每日記憶體時間配額上限 (。 int
已啟用 true 如果已啟用應用程式，則為 ;否則為 false。 將此值設定為 false 會停用應用程式 (讓應用程式離線) 。 bool
hostingEnvironmentProfile 要用於應用程式的 App Service 環境。 HostingEnvironmentProfile
hostNamesDisabled true 表示停用應用程式的公用主機名;否則為 false。
如果 true為，則只能透過 API 管理程式存取應用程式。		 bool
hostNameSslStates 主機名 SSL 狀態可用來管理應用程式主機名的 SSL 系結。 HostNameSslState[]
httpsOnly HttpsOnly：設定網站只接受 HTTPs 要求。 重新導向的問題
HTTP 要求		 bool
hyperV Hyper-V 沙盒。 bool
isXenon 過時：Hyper-V 沙盒。 bool
keyVaultReferenceIdentity 用於 金鑰保存庫 參考驗證的身分識別。 字串
managedEnvironmentId Azure Resource Manager 要裝載此應用程式之客戶所選受控環境的標識碼。 這必須是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} 的格式 字串
publicNetworkAccess 允許或封鎖所有公用流量的屬性。 允許的值：『Enabled』、『Disabled』 或空字串。 字串
redundancyMode 月臺備援模式 'ActiveActive'
'Failover'
'GeoRedundant'
'Manual'
'None'
reserved true 如果已保留，則為 ;否則為 false。 bool
scmSiteAlsoStopped true 表示在停止應用程式時停止 SCM (KUDU) 網站;否則為 false。 預設為 false。 bool
serverFarmId 相關聯 App Service 方案的資源標識符，格式為：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。 字串
siteConfig 應用程式的設定。 SiteConfig
storageAccountRequired 檢查客戶提供的記憶體帳戶是否需要 bool
virtualNetworkSubnetId Azure Resource Manager 區域 VNET 整合所要加入之虛擬網路和子網的標識碼。
這必須是 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} 的格式		 字串
vnetContentShareEnabled 啟用透過虛擬網路存取內容 bool
vnetImagePullEnabled 若要啟用透過 虛擬網路 提取映像 bool
vnetRouteAllEnabled 虛擬網路 已啟用 [全部路由]。 這會導致套用 虛擬網路 安全組和用戶定義路由的所有輸出流量。 bool

CloningInfo

名稱 描述 值
appSettingsOverrides 複製應用程式的應用程式設定覆寫。 如果指定，這些設定會覆寫複製的設定
來自來源應用程式。 否則，會保留來源應用程式的應用程式設定。		 物件 (object)
cloneCustomHostNames true 從來源應用程式複製自定義主機名;否則為 false。 bool
cloneSourceControl true 從來源應用程式複製原始檔控制;否則為 false。 bool
configureLoadBalancing true 設定來源和目的地應用程式的負載平衡。 bool
correlationId 複製作業的相互關聯標識碼。 此標識碼會系結多個複製作業
同時使用相同的快照集。		 字串
hostingEnvironment App Service 環境。 字串
overwrite true 表示覆寫目的地應用程式;否則為 false。 bool
sourceWebAppId 來源應用程式的 ARM 資源識別碼。 應用程式資源識別碼的格式為
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} 用於生產位置和
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} 適用於其他位置。		 字串 (必要)
sourceWebAppLocation 來源應用程式的位置，例如：美國西部或北歐 字串
trafficManagerProfileId 如果流量管理員配置檔存在，則為要使用的ARM資源識別碼。 流量管理員資源標識碼的格式為
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}。		 字串
trafficManagerProfileName 要建立的流量管理員配置檔名稱。 只有在流量管理員配置檔不存在時，才需要這麼做。 字串

HostingEnvironmentProfile

名稱 描述 值
id App Service 環境的資源標識碼。 字串

HostNameSslState

名稱 描述 值
hostType 指出主機名是否為標準或存放庫主機名。 'Repository'
'Standard'
NAME 主機名稱。 字串
sslState SSL 類型。 'Disabled'
'IpBasedEnabled'
'SniEnabled'
thumbprint SSL 憑證指紋。 字串
toUpdate 設定為 true 以更新現有的主機名。 bool
virtualIP 如果已啟用以IP為基礎的SSL，則指派給主機名的虛擬IP位址。 字串

SiteConfig

名稱 描述 值
acrUseManagedIdentityCreds 使用受控識別 Creds 進行 ACR 提取的旗標 bool
acrUserManagedIdentityID 如果使用使用者受控識別，則使用者受控識別 ClientId 字串
alwaysOn true如果已開啟 Always On 則為 ，false否則為 。 bool
apiDefinition 應用程式正式 API 定義的相關信息。 ApiDefinitionInfo
apiManagementConfig 連結至應用程式的 Azure API 管理設定。 ApiManagementConfig
appCommandLine 要啟動的應用程式命令行。 字串
appSettings 應用程式設定。 NameValuePair[]
autoHealEnabled true 如果已啟用自動修復，則為 ;否則為 false。 bool
autoHealRules 自動修復規則。 AutoHealRules
autoSwapSlotName 自動交換位置名稱。 字串
azureStorageAccounts Azure 記憶體帳戶清單。 物件 (object)
connectionStrings 連接字串。 ConnStringInfo[]
cors 跨原始來源資源分享 (CORS) 設定。 CorsSettings
defaultDocuments 默認檔。 string[]
detailedErrorLoggingEnabled true 如果已啟用詳細的錯誤記錄，則為 ;否則為 false。 bool
documentRoot 檔根目錄。 字串
elasticWebAppScaleLimit 網站可相應放大的背景工作角色數目上限。
此設定僅適用於 ElasticScaleEnabled 為方案中的應用程式 true		 int
experiments 這適用於多型類型。 實驗
ftpsState FTP / FTPS 服務的狀態 'AllAllowed'
'Disabled'
'FtpsOnly'
functionAppScaleLimit 網站可相應放大的背景工作角色數目上限。
此設定僅適用於取用和彈性進階方案		 int
functionsRuntimeScaleMonitoringEnabled 取得或設定值，指出是否啟用函式運行時間調整監視。 啟用時，
ScaleController 不會直接監視事件來源，而是會改為呼叫
運行時間以取得調整狀態。		 bool
handlerMappings 處理程序對應。 HandlerMapping[]
healthCheckPath 健康情況檢查路徑 字串
http20Enabled Http20Enabled：設定網站以允許用戶端透過 HTTP2.0 連線 bool
httpLoggingEnabled true 如果已啟用 HTTP 記錄，則為 ;否則為 false。 bool
ipSecurityRestrictions main 的IP安全性限制。 IpSecurityRestriction[]
ipSecurityRestrictionsDefaultAction 如果未比對任何規則，則主要存取限制的默認動作。 'Allow'
'Deny'
javaContainer Java 容器。 字串
javaContainerVersion Java 容器版本。 字串
javaVersion Java 版本。 字串
keyVaultReferenceIdentity 要用於 金鑰保存庫 參考驗證的身分識別。 字串
限制 網站限制。 SiteLimits
linuxFxVersion Linux App Framework 和版本 字串
負載平衡 網站負載平衡。 'LeastRequests'
'LeastResponseTime'
'PerSiteRoundRobin'
'RequestHash'
'WeightedRoundRobin'
'WeightedTotalTraffic'
localMySqlEnabled true 表示啟用本機 MySQL;否則為 false。 bool
logsDirectorySizeLimit HTTP 記錄目錄大小限制。 int
managedPipelineMode Managed 管線模式。 'Classic'
'Integrated'
managedServiceIdentityId 受控服務識別標識碼 int
中繼資料 應用程式元數據。 無法擷取這個屬性，因為它可能包含秘密。 NameValuePair[]
minimumElasticInstanceCount 月臺的最小實例計數數目
此設定僅適用於彈性方案		 int
minTlsVersion MinTlsVersion：設定 SSL 要求所需的最低 TLS 版本 '1.0'
'1.1'
'1.2'
netFrameworkVersion .NET Framework 版本。 字串
nodeVersion Node.js 的版本。 字串
numberOfWorkers 背景工作數目。 int
phpVersion PHP 版本。 字串
powerShellVersion PowerShell 的版本。 字串
preWarmedInstanceCount preWarmed 實例的數目。
此設定僅適用於取用和彈性方案		 int
publicNetworkAccess 允許或封鎖所有公用流量的屬性。 字串
publishingUsername 發佈用戶名稱。 字串
push 推送端點設定。 PushSettings
pythonVersion Python 的版本。 字串
remoteDebuggingEnabled true 如果已啟用遠端偵錯，則為 ;否則為 false。 bool
remoteDebuggingVersion 遠端偵錯版本。 字串
requestTracingEnabled true 如果已啟用要求追蹤，則為 ;否則為 false。 bool
requestTracingExpirationTime 要求追蹤到期時間。 字串
scmIpSecurityRestrictions scm 的IP安全性限制。 IpSecurityRestriction[]
scmIpSecurityRestrictionsDefaultAction 如果未比對任何規則，則為 scm 存取限制的預設動作。 'Allow'
'Deny'
scmIpSecurityRestrictionsUseMain scm 使用 main 的 IP 安全性限制。 bool
scmMinTlsVersion ScmMinTlsVersion：設定 SCM 網站 SSL 要求所需的最低 TLS 版本 '1.0'
'1.1'
'1.2'
scmType SCM 類型。 'BitbucketGit'
'BitbucketHg'
'CodePlexGit'
'CodePlexHg'
'Dropbox'
'ExternalGit'
'ExternalHg'
'GitHub'
'LocalGit'
'None'
'OneDrive'
'Tfs'
'VSO'
'VSTSRM'
tracingOptions 追蹤選項。 字串
use32BitWorkerProcess true 表示使用32位背景工作進程;否則為 false。 bool
virtualApplications 虛擬應用程式。 VirtualApplication[]
vnetName 虛擬網路 名稱。 字串
vnetPrivatePortsCount 指派給此應用程式的私人埠數目。 這些會在運行時間動態指派。 int
vnetRouteAllEnabled 虛擬網路 已啟用 [全部路由]。 這會導致套用 虛擬網路 安全組和用戶定義路由的所有輸出流量。 bool
websiteTimeZone 設定網站用來產生時間戳的時區。 與 Linux 和 Windows App Service 相容。 設定WEBSITE_TIME_ZONE應用程式設定的優先順序高於此設定。針對 Linux，需要 tz 資料庫值 https://www.iana.org/time-zones (快速參考，請參閱 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) 。 針對 Windows，預期其中一個時區列在 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 字串
webSocketsEnabled true 如果已啟用 WebSocket，則為 ;否則為 false。 bool
windowsFxVersion Xenon App Framework 和版本 字串
xManagedServiceIdentityId 明確受控服務識別標識碼 int

ApiDefinitionInfo

名稱 描述 值
url API 定義的 URL。 字串

ApiManagementConfig

名稱 描述 值
id APIM-Api 識別碼。 字串

NameValuePair

名稱 描述 值
NAME 配對名稱。 字串
value 配對值。 字串

AutoHealRules

名稱 描述 值
動作 觸發規則時要執行的動作。 AutoHealActions
觸發程序 描述何時執行自動修復動作的條件。 AutoHealTriggers

AutoHealActions

名稱 描述 值
actionType 要採取的預先定義動作。 'CustomAction'
'LogEvent'
'回收'
customAction 要採取的自定義動作。 AutoHealCustomAction
minProcessExecutionTime 進程必須執行的時間下限
採取動作之前
 字串

AutoHealCustomAction

名稱 描述 值
exe 要執行的可執行檔。 字串
參數 可執行文件的參數。 字串

AutoHealTriggers

名稱 描述 值
privateBytesInKB 以私用位元組為基礎的規則。 int
requests 以要求總數為基礎的規則。 RequestsBasedTrigger
slowRequests 根據要求運行時間的規則。 SlowRequestsBasedTrigger
slowRequestsWithPath 以具有路徑的多個慢速要求規則為基礎的規則 SlowRequestsBasedTrigger[]
statusCodes 以狀態代碼為基礎的規則。 StatusCodesBasedTrigger[]
statusCodesRange 以狀態代碼範圍為基礎的規則。 StatusCodesRangeBasedTrigger[]

RequestsBasedTrigger

名稱 描述 值
count 要求計數。 int
timeInterval 時間間隔。 字串

SlowRequestsBasedTrigger

名稱 描述 值
count 要求計數。 int
path 要求路徑。 字串
timeInterval 時間間隔。 字串
timeTaken 所花費的時間。 字串

StatusCodesBasedTrigger

名稱 描述 值
count 要求計數。 int
path 要求路徑 字串
status HTTP 狀態碼。 int
子狀態 要求子狀態。 int
timeInterval 時間間隔。 字串
win32Status Win32 錯誤碼。 int

StatusCodesRangeBasedTrigger

名稱 描述 值
count 要求計數。 int
path 字串
statusCodes HTTP 狀態碼。 字串
timeInterval 時間間隔。 字串

ConnStringInfo

名稱 描述 值
connectionString 連接字串值。 字串
NAME 連接字串 的名稱。 字串
type 資料庫的類型。 'ApiHub'
'Custom'
'DocDb'
'EventHub'
'MySql'
'NotificationHub'
'PostgreSQL'
'RedisCache'
'SQLAzure'
'SQLServer'
'ServiceBus'

CorsSettings

名稱 描述 值
allowedOrigins 取得或設定應該允許建立跨原始來源的來源清單
呼叫 (例如： http://example.com:12345) 。 使用 "*" 可全部允許。		 string[]
supportCredentials 取得或設定是否允許具有認證的CORS要求。 請參閱
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials
。
 bool

實驗

名稱 描述 值
rampUpRules 向上坡形規則的清單。 RampUpRule[]

RampUpRule

名稱 描述 值
actionHostName 如果決定要重新導向流量的位置主機名。 例如 myapp-stage.azurewebsites.net。 字串
changeDecisionCallbackUrl 您可以在可指定 URL 的 TiPCallback 網站延伸模組中提供自訂決策演算法。 如需 Scaffold 和合約，請參閱 TiPCallback 網站延伸模組。
https://www.siteextensions.net/packages/TiPCallback/		 字串
changeIntervalInMinutes 指定重新評估 ReroutePercentage 的分鐘間隔。 int
changeStep 在自動增加案例中，這是新增/移除 ReroutePercentage 到 \nMinReroutePercentage 或
MaxReroutePercentage. 網站計量會每隔 N 分鐘檢查一次 .\n自定義決策演算法中指定的 ChangeIntervalInMinutes時間
可以在 TiPCallback 網站延伸模組中提供，您可以在 中 ChangeDecisionCallbackUrl指定 URL。		 int
maxReroutePercentage 指定 ReroutePercentage 將維持在下方的上限。 int
minReroutePercentage 指定 ReroutePercentage 將保留的下限。 int
NAME 路由規則的名稱。 建議的名稱是指向將接收實驗中流量的位置。 字串
reroutePercentage 將重新導向至 ActionHostName的流量百分比。 int

HandlerMapping

名稱 描述 值
引數 要傳遞至腳本處理器的命令行自變數。 字串
擴充功能 具有此擴充功能的要求將會使用指定的 FastCGI 應用程式來處理。 字串
scriptProcessor FastCGI 應用程式的絕對路徑。 字串

IpSecurityRestriction

名稱 描述 值
動作 允許或拒絕此IP範圍的存取。 字串
description IP 限制規則描述。 字串
headers IP 限制規則標頭。
X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples) 。
比對邏輯為 。。
- 如果屬性為 null 或空白 (預設) ，則允許所有主機 (或缺少) 。
- 使用序數-ignore-case 來比較值， (排除埠號碼) 。
- 允許子域通配符，但不符合根域。 例如，*.contoso.com 符合子域 foo.contoso.com
但不是根域 contoso.com 或多層級 foo.bar.contoso.com
- 允許 Unicode 主機名，但會轉換成 Punycode 以進行比對。

X-Forwarded-for (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples) 。
比對邏輯為 。。
- 如果屬性為 null 或空白 (預設) ，則允許任何轉送的鏈結 (或缺少) 。
- 如果鏈結中任何位址 (排除埠號碼) ， (逗號分隔) 符合 屬性所定義的 CIDR。

X-Azure-FDID 和 X-FD-HealthProbe。
比對邏輯完全相符。		 物件 (object)
ipAddress 安全性限制有效的IP位址。
其格式可以是純 ipv4 位址， (必要的 SubnetMask 屬性) 或
CIDR 表示法，例如 ipv4/mask (前置位比對) 。 針對 CIDR，
不可指定 SubnetMask 屬性。		 字串
NAME IP 限制規則名稱。 字串
priority IP 限制規則的優先順序。 int
subnetMask 限制有效之IP位址範圍的子網掩碼。 字串
subnetTrafficTag (內部) 子網流量捲標 int
標籤 定義此IP篩選條件將用於哪些專案。 這是為了支援 Proxy 上的IP篩選。 'Default'
'ServiceTag'
'XffProxy'
vnetSubnetResourceId 虛擬網路資源標識碼 字串
vnetTrafficTag (內部) Vnet 流量標籤 int

SiteLimits

名稱 描述 值
maxDiskSizeInMb 以 MB 為單位允許的磁碟大小使用量上限。 int
maxMemoryInMb MB 允許的最大記憶體使用量。 int
maxPercentageCpu 允許的CPU使用量百分比上限。 int

PushSettings

名稱 描述 值
kind 資源種類。 字串
properties PushSettings 資源特定屬性 PushSettingsProperties

PushSettingsProperties

名稱 描述 值
dynamicTagsJson 取得或設定 JSON 字串，其中包含將從推送註冊端點中的使用者宣告評估的動態標記清單。 字串
isPushEnabled 取得或設定旗標，指出是否啟用推送端點。 bool (必要)
tagsRequiringAuth 取得或設定 JSON 字串，其中包含需要在推送註冊端點中使用使用者驗證的標籤清單。
標記可以包含英數位元和下列專案：
'_', '@', '#', '.', ':', '-'.
驗證應該在 PushRequestHandler 上執行。		 字串
tagWhitelistJson 取得或設定 JSON 字串，其中包含推送註冊端點允許使用的標籤清單。 字串

VirtualApplication

名稱 描述 值
physicalPath 實體路徑。 字串
preloadEnabled true 如果已啟用預先載入，則為 ;否則為 false。 bool
virtualDirectories 虛擬應用程式的虛擬目錄。 VirtualDirectory[]
virtualPath 虛擬路徑。 字串

VirtualDirectory

名稱 描述 值
physicalPath 實體路徑。 字串
virtualPath 虛擬應用程式的路徑。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用部署位置布建取用方案函式

部署至 Azure		 此範本會在取用方案上布建函式應用程式，這是動態主控方案。 應用程式會視需要執行，且每個執行都會向您計費，且不會有常設資源承諾。 有其他範本可用於布建專用主控方案。
具有部署位置的 Azure 函式應用程式

部署至 Azure		 此範本會在具有生產位置的 Premium 方案上布建函式應用程式，以及額外的部署位置。
具有自定義部署位置的 Web 應用程式

部署至 Azure		 此範本提供在 Azure Web Apps 上使用自訂部署位置部署 Web 應用程式的簡單方式。
高可用性多區域 Web 應用程式

部署至 Azure		 此範本可讓您建立安全、高可用性、多區域端對端解決方案，並在 Azure Front Door 後方的不同區域中建立兩個 Web 應用程式
保護多層式 Web 應用程式

部署至 Azure		 此範本可讓您使用具有預備位置、前端和後端的兩個 Web 應用程式建立安全的端對端解決方案，前端會透過 VNet 插入和私人端點安全地取用後端

ARM 範本資源定義

月臺/位置資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.Web/sites/slots 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.Web/sites/slots",
  "apiVersion": "2022-09-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "extendedLocation": {
    "name": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "clientAffinityEnabled": "bool",
    "clientCertEnabled": "bool",
    "clientCertExclusionPaths": "string",
    "clientCertMode": "string",
    "cloningInfo": {
      "appSettingsOverrides": {},
      "cloneCustomHostNames": "bool",
      "cloneSourceControl": "bool",
      "configureLoadBalancing": "bool",
      "correlationId": "string",
      "hostingEnvironment": "string",
      "overwrite": "bool",
      "sourceWebAppId": "string",
      "sourceWebAppLocation": "string",
      "trafficManagerProfileId": "string",
      "trafficManagerProfileName": "string"
    },
    "containerSize": "int",
    "customDomainVerificationId": "string",
    "dailyMemoryTimeQuota": "int",
    "enabled": "bool",
    "hostingEnvironmentProfile": {
      "id": "string"
    },
    "hostNamesDisabled": "bool",
    "hostNameSslStates": [
      {
        "hostType": "string",
        "name": "string",
        "sslState": "string",
        "thumbprint": "string",
        "toUpdate": "bool",
        "virtualIP": "string"
      }
    ],
    "httpsOnly": "bool",
    "hyperV": "bool",
    "isXenon": "bool",
    "keyVaultReferenceIdentity": "string",
    "managedEnvironmentId": "string",
    "publicNetworkAccess": "string",
    "redundancyMode": "string",
    "reserved": "bool",
    "scmSiteAlsoStopped": "bool",
    "serverFarmId": "string",
    "siteConfig": {
      "acrUseManagedIdentityCreds": "bool",
      "acrUserManagedIdentityID": "string",
      "alwaysOn": "bool",
      "apiDefinition": {
        "url": "string"
      },
      "apiManagementConfig": {
        "id": "string"
      },
      "appCommandLine": "string",
      "appSettings": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "autoHealEnabled": "bool",
      "autoHealRules": {
        "actions": {
          "actionType": "string",
          "customAction": {
            "exe": "string",
            "parameters": "string"
          },
          "minProcessExecutionTime": "string"
        },
        "triggers": {
          "privateBytesInKB": "int",
          "requests": {
            "count": "int",
            "timeInterval": "string"
          },
          "slowRequests": {
            "count": "int",
            "path": "string",
            "timeInterval": "string",
            "timeTaken": "string"
          },
          "slowRequestsWithPath": [
            {
              "count": "int",
              "path": "string",
              "timeInterval": "string",
              "timeTaken": "string"
            }
          ],
          "statusCodes": [
            {
              "count": "int",
              "path": "string",
              "status": "int",
              "subStatus": "int",
              "timeInterval": "string",
              "win32Status": "int"
            }
          ],
          "statusCodesRange": [
            {
              "count": "int",
              "path": "string",
              "statusCodes": "string",
              "timeInterval": "string"
            }
          ]
        }
      },
      "autoSwapSlotName": "string",
      "azureStorageAccounts": {},
      "connectionStrings": [
        {
          "connectionString": "string",
          "name": "string",
          "type": "string"
        }
      ],
      "cors": {
        "allowedOrigins": [ "string" ],
        "supportCredentials": "bool"
      },
      "defaultDocuments": [ "string" ],
      "detailedErrorLoggingEnabled": "bool",
      "documentRoot": "string",
      "elasticWebAppScaleLimit": "int",
      "experiments": {
        "rampUpRules": [
          {
            "actionHostName": "string",
            "changeDecisionCallbackUrl": "string",
            "changeIntervalInMinutes": "int",
            "changeStep": "int",
            "maxReroutePercentage": "int",
            "minReroutePercentage": "int",
            "name": "string",
            "reroutePercentage": "int"
          }
        ]
      },
      "ftpsState": "string",
      "functionAppScaleLimit": "int",
      "functionsRuntimeScaleMonitoringEnabled": "bool",
      "handlerMappings": [
        {
          "arguments": "string",
          "extension": "string",
          "scriptProcessor": "string"
        }
      ],
      "healthCheckPath": "string",
      "http20Enabled": "bool",
      "httpLoggingEnabled": "bool",
      "ipSecurityRestrictions": [
        {
          "action": "string",
          "description": "string",
          "headers": {},
          "ipAddress": "string",
          "name": "string",
          "priority": "int",
          "subnetMask": "string",
          "subnetTrafficTag": "int",
          "tag": "string",
          "vnetSubnetResourceId": "string",
          "vnetTrafficTag": "int"
        }
      ],
      "ipSecurityRestrictionsDefaultAction": "string",
      "javaContainer": "string",
      "javaContainerVersion": "string",
      "javaVersion": "string",
      "keyVaultReferenceIdentity": "string",
      "limits": {
        "maxDiskSizeInMb": "int",
        "maxMemoryInMb": "int",
        "maxPercentageCpu": "int"
      },
      "linuxFxVersion": "string",
      "loadBalancing": "string",
      "localMySqlEnabled": "bool",
      "logsDirectorySizeLimit": "int",
      "managedPipelineMode": "string",
      "managedServiceIdentityId": "int",
      "metadata": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "minimumElasticInstanceCount": "int",
      "minTlsVersion": "string",
      "netFrameworkVersion": "string",
      "nodeVersion": "string",
      "numberOfWorkers": "int",
      "phpVersion": "string",
      "powerShellVersion": "string",
      "preWarmedInstanceCount": "int",
      "publicNetworkAccess": "string",
      "publishingUsername": "string",
      "push": {
        "kind": "string",
        "properties": {
          "dynamicTagsJson": "string",
          "isPushEnabled": "bool",
          "tagsRequiringAuth": "string",
          "tagWhitelistJson": "string"
        }
      },
      "pythonVersion": "string",
      "remoteDebuggingEnabled": "bool",
      "remoteDebuggingVersion": "string",
      "requestTracingEnabled": "bool",
      "requestTracingExpirationTime": "string",
      "scmIpSecurityRestrictions": [
        {
          "action": "string",
          "description": "string",
          "headers": {},
          "ipAddress": "string",
          "name": "string",
          "priority": "int",
          "subnetMask": "string",
          "subnetTrafficTag": "int",
          "tag": "string",
          "vnetSubnetResourceId": "string",
          "vnetTrafficTag": "int"
        }
      ],
      "scmIpSecurityRestrictionsDefaultAction": "string",
      "scmIpSecurityRestrictionsUseMain": "bool",
      "scmMinTlsVersion": "string",
      "scmType": "string",
      "tracingOptions": "string",
      "use32BitWorkerProcess": "bool",
      "virtualApplications": [
        {
          "physicalPath": "string",
          "preloadEnabled": "bool",
          "virtualDirectories": [
            {
              "physicalPath": "string",
              "virtualPath": "string"
            }
          ],
          "virtualPath": "string"
        }
      ],
      "vnetName": "string",
      "vnetPrivatePortsCount": "int",
      "vnetRouteAllEnabled": "bool",
      "websiteTimeZone": "string",
      "webSocketsEnabled": "bool",
      "windowsFxVersion": "string",
      "xManagedServiceIdentityId": "int"
    },
    "storageAccountRequired": "bool",
    "virtualNetworkSubnetId": "string",
    "vnetContentShareEnabled": "bool",
    "vnetImagePullEnabled": "bool",
    "vnetRouteAllEnabled": "bool"
  }
}

屬性值

sites/slots

名稱 描述 值
類型 資源類型 'Microsoft.Web/sites/slots'
apiVersion 資源 API 版本 '2022-09-01'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。		 字串 (必要)

字元限制：2-59

合法字元：
可對應至 Punycode 的英數位元、連字號及 Unicode 字元
location 資源位置。 字串 (必要)
tags 資源標籤。 標記名稱和值的字典。 請參閱 範本中的標記
kind 資源種類。 字串
extendedLocation 擴充位置。 ExtendedLocation
身分識別 受控服務識別。 ManagedServiceIdentity
properties 網站資源特定屬性 SiteProperties

ExtendedLocation

名稱 描述 值
NAME 擴充位置的名稱。 字串

ManagedServiceIdentity

名稱 描述 值
類型 受控服務識別的類型。 'None'
'SystemAssigned'
'SystemAssigned，UserAssigned'
'UserAssigned'
userAssignedIdentities 與資源相關聯的使用者指派身分識別清單。 用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} 物件 (object)

SiteProperties

名稱 描述 值
clientAffinityEnabled true 表示啟用客戶端親和性; false 表示停止傳送會話親和性 Cookie，以將相同會話中的用戶端要求路由傳送至相同的實例。 預設為 true。 bool
clientCertEnabled true 啟用客戶端憑證驗證 (TLS 相互驗證) ;否則為 false。 預設為 false。 bool
clientCertExclusionPaths 用戶端憑證驗證逗號分隔排除路徑 字串
clientCertMode 這會使用 ClientCertEnabled 設定來撰寫。
- ClientCertEnabled：false 表示忽略 ClientCert。
- ClientCertEnabled：true 和 ClientCertMode：必要表示需要 ClientCert。
- ClientCertEnabled：true 和 ClientCertMode：選擇性表示 ClientCert 是選擇性或接受的。		 'Optional'
'OptionalInteractiveUser'
'Required'
複製Info 如果在應用程式建立期間指定，則會從來源應用程式複製應用程式。 複製Info
containerSize 函式容器的大小。 int
customDomainVerificationId 驗證指派給應用程式之自定義網域的唯一標識符。 客戶會將此標識元新增至 txt 記錄以進行驗證。 字串
dailyMemoryTimeQuota 每日記憶體時間配額上限 (僅適用於動態應用程式) 。 int
已啟用 true 如果已啟用應用程式，則為 ;否則為 false。 將此值設定為 false 會停用應用程式 (讓應用程式離線) 。 bool
hostingEnvironmentProfile 要用於應用程式的 App Service 環境。 HostingEnvironmentProfile
hostNamesDisabled true 表示停用應用程式的公用主機名;否則為 false。
如果 true為，則只能透過 API 管理程式存取應用程式。		 bool
hostNameSslStates 主機名 SSL 狀態可用來管理應用程式主機名的 SSL 系結。 HostNameSslState[]
httpsOnly HttpsOnly：設定網站只接受 HTTPs 要求。 重新導向的問題
HTTP 要求		 bool
hyperV Hyper-V 沙盒。 bool
isXenon 過時：Hyper-V 沙盒。 bool
keyVaultReferenceIdentity 用於 金鑰保存庫 參考驗證的身分識別。 字串
managedEnvironmentId Azure Resource Manager 要裝載此應用程式之客戶所選受控環境的標識碼。 這必須是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} 的格式 字串
publicNetworkAccess 允許或封鎖所有公用流量的屬性。 允許的值：『Enabled』、『Disabled』 或空字串。 字串
redundancyMode 月臺備援模式 'ActiveActive'
'Failover'
'GeoRedundant'
'Manual'
'None'
reserved true 如果已保留，則為 ;否則為 false。 bool
scmSiteAlsoStopped true 表示在停止應用程式時停止 SCM (KUDU) 網站;否則為 false。 預設為 false。 bool
serverFarmId 相關聯 App Service 方案的資源標識符，格式為：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。 字串
siteConfig 應用程式的設定。 SiteConfig
storageAccountRequired 檢查客戶提供的記憶體帳戶是否需要 bool
virtualNetworkSubnetId Azure Resource Manager 區域 VNET 整合所要加入之虛擬網路和子網的標識碼。
這必須是 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} 的格式		 字串
vnetContentShareEnabled 啟用透過虛擬網路存取內容 bool
vnetImagePullEnabled 若要啟用透過 虛擬網路 提取映像 bool
vnetRouteAllEnabled 虛擬網路 已啟用 [全部路由]。 這會導致套用 虛擬網路 安全組和用戶定義路由的所有輸出流量。 bool

CloningInfo

名稱 描述 值
appSettingsOverrides 複製應用程式的應用程式設定覆寫。 如果指定，這些設定會覆寫複製的設定
來自來源應用程式。 否則，會保留來源應用程式的應用程式設定。		 物件 (object)
cloneCustomHostNames true 從來源應用程式複製自定義主機名;否則為 false。 bool
cloneSourceControl true 從來源應用程式複製原始檔控制;否則為 false。 bool
configureLoadBalancing true 設定來源和目的地應用程式的負載平衡。 bool
correlationId 複製作業的相互關聯標識碼。 此標識碼會系結多個複製作業
一起使用相同的快照集。		 字串
hostingEnvironment App Service 環境。 字串
overwrite true 表示覆寫目的地應用程式;否則為 false。 bool
sourceWebAppId 來源應用程式的 ARM 資源識別碼。 應用程式資源識別碼的格式為
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} 用於生產位置和
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} 適用於其他位置。		 字串 (必要)
sourceWebAppLocation 來源應用程式的位置，例如：美國西部或北歐 字串
trafficManagerProfileId 如果流量管理員配置檔存在，則為要使用的ARM資源識別碼。 流量管理員資源標識碼的格式為
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}。		 字串
trafficManagerProfileName 要建立的流量管理員配置檔名稱。 只有在流量管理員配置檔不存在時，才需要這麼做。 字串

HostingEnvironmentProfile

名稱 描述 值
id App Service 環境的資源標識碼。 字串

HostNameSslState

名稱 描述 值
hostType 指出主機名是否為標準或存放庫主機名。 'Repository'
'Standard'
NAME 主機名稱。 字串
sslState SSL 類型。 'Disabled'
'IpBasedEnabled'
'SniEnabled'
thumbprint SSL 憑證指紋。 字串
toUpdate 設定為 true 以更新現有的主機名。 bool
virtualIP 如果已啟用以IP為基礎的SSL，則指派給主機名的虛擬IP位址。 字串

SiteConfig

名稱 描述 值
acrUseManagedIdentityCreds 使用受控識別 Creds 進行 ACR 提取的旗標 bool
acrUserManagedIdentityID 如果使用使用者受控識別，則使用者受控識別 ClientId 字串
alwaysOn true如果已開啟 Always On，則為 ，false否則為 。 bool
apiDefinition 應用程式正式 API 定義的相關信息。 ApiDefinitionInfo
apiManagementConfig 連結至應用程式的 Azure API 管理設定。 ApiManagementConfig
appCommandLine 要啟動的應用程式命令行。 字串
appSettings 應用程式設定。 NameValuePair[]
autoHealEnabled true 如果已啟用自動修復，則為 ;否則為 false。 bool
autoHealRules 自動修復規則。 AutoHealRules
autoSwapSlotName 自動交換位置名稱。 字串
azureStorageAccounts Azure 記憶體帳戶清單。 物件 (object)
connectionStrings 連接字串。 ConnStringInfo[]
cors 跨原始來源資源分享 (CORS) 設定。 CorsSettings
defaultDocuments 默認檔。 string[]
detailedErrorLoggingEnabled true 如果已啟用詳細的錯誤記錄，則為 ;否則為 false。 bool
documentRoot 檔根目錄。 字串
elasticWebAppScaleLimit 網站可相應放大的背景工作角色數目上限。
此設定僅適用於 ElasticScaleEnabled 所在方案中的應用程式 true		 int
experiments 這適用於多型類型。 實驗
ftpsState FTP / FTPS 服務的狀態 'AllAllowed'
'Disabled'
'FtpsOnly'
functionAppScaleLimit 網站可相應放大的背景工作角色數目上限。
此設定僅適用於取用和彈性進階方案		 int
functionsRuntimeScaleMonitoringEnabled 取得或設定值，指出是否啟用函式運行時間規模監視。 啟用時，
ScaleController 不會直接監視事件來源，而是改為呼叫
運行時間以取得調整狀態。		 bool
handlerMappings 處理程序對應。 HandlerMapping[]
healthCheckPath 健康情況檢查路徑 字串
http20Enabled Http20Enabled：設定網站以允許用戶端透過 HTTP2.0 連線 bool
httpLoggingEnabled true 如果已啟用 HTTP 記錄，則為 ;否則為 false。 bool
ipSecurityRestrictions 主要的IP安全性限制。 IpSecurityRestriction[]
ipSecurityRestrictionsDefaultAction 如果沒有符合任何規則，則主要存取限制的默認動作。 'Allow'
'Deny'
javaContainer Java 容器。 字串
javaContainerVersion Java 容器版本。 字串
javaVersion Java 版本。 字串
keyVaultReferenceIdentity 用於 金鑰保存庫 參考驗證的身分識別。 字串
限制 網站限制。 SiteLimits
linuxFxVersion Linux App Framework 和版本 字串
負載平衡 網站負載平衡。 'LeastRequests'
'LeastResponseTime'
'PerSiteRoundRobin'
'RequestHash'
'WeightedRoundRobin'
'WeightedTotalTraffic'
localMySqlEnabled true 表示啟用本機 MySQL;否則為 false。 bool
logsDirectorySizeLimit HTTP 記錄目錄大小限制。 int
managedPipelineMode Managed 管線模式。 'Classic'
'Integrated'
managedServiceIdentityId 受控服務識別標識碼 int
中繼資料 應用程式元數據。 無法擷取這個屬性，因為它可能包含秘密。 NameValuePair[]
minimumElasticInstanceCount 月臺的最小實例計數數目
此設定僅適用於彈性方案		 int
minTlsVersion MinTlsVersion：設定 SSL 要求所需的最低 TLS 版本 '1.0'
'1.1'
'1.2'
netFrameworkVersion .NET Framework 版本。 字串
nodeVersion Node.js 的版本。 字串
numberOfWorkers 背景工作數目。 int
phpVersion PHP 版本。 字串
powerShellVersion PowerShell 的版本。 字串
preWarmedInstanceCount preWarmed 實例的數目。
此設定僅適用於取用和彈性方案		 int
publicNetworkAccess 允許或封鎖所有公用流量的屬性。 字串
publishingUsername 發佈用戶名稱。 字串
push 推送端點設定。 PushSettings
pythonVersion Python 的版本。 字串
remoteDebuggingEnabled true 如果已啟用遠端偵錯，則為 ;否則為 false。 bool
remoteDebuggingVersion 遠端偵錯版本。 字串
requestTracingEnabled true 如果已啟用要求追蹤，則為 ;否則為 false。 bool
requestTracingExpirationTime 要求追蹤到期時間。 字串
scmIpSecurityRestrictions scm 的IP安全性限制。 IpSecurityRestriction[]
scmIpSecurityRestrictionsDefaultAction 如果未比對任何規則，則為 scm 存取限制的預設動作。 'Allow'
'Deny'
scmIpSecurityRestrictionsUseMain scm 使用 main 的 IP 安全性限制。 bool
scmMinTlsVersion ScmMinTlsVersion：設定 SCM 網站 SSL 要求所需的最低 TLS 版本 '1.0'
'1.1'
'1.2'
scmType SCM 類型。 'BitbucketGit'
'BitbucketHg'
'CodePlexGit'
'CodePlexHg'
'Dropbox'
'ExternalGit'
'ExternalHg'
'GitHub'
'LocalGit'
'None'
'OneDrive'
'Tfs'
'VSO'
'VSTSRM'
tracingOptions 追蹤選項。 字串
use32BitWorkerProcess true 表示使用32位背景工作進程;否則為 false。 bool
virtualApplications 虛擬應用程式。 VirtualApplication[]
vnetName 虛擬網路 名稱。 字串
vnetPrivatePortsCount 指派給此應用程式的私人埠數目。 這些會在運行時間動態指派。 int
vnetRouteAllEnabled 虛擬網路 已啟用 [全部路由]。 這會導致套用 虛擬網路 安全組和用戶定義路由的所有輸出流量。 bool
websiteTimeZone 設定網站用來產生時間戳的時區。 與 Linux 和 Windows App Service 相容。 設定WEBSITE_TIME_ZONE應用程式設定的優先順序高於此設定。針對 Linux，需要 tz 資料庫值 https://www.iana.org/time-zones (快速參考，請參閱 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) 。 針對 Windows，預期其中一個時區列在 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 字串
webSocketsEnabled true 如果已啟用 WebSocket，則為 ;否則為 false。 bool
windowsFxVersion Xenon App Framework 和版本 字串
xManagedServiceIdentityId 明確受控服務識別標識碼 int

ApiDefinitionInfo

名稱 描述 值
url API 定義的 URL。 字串

ApiManagementConfig

名稱 描述 值
id APIM-Api 識別碼。 字串

NameValuePair

名稱 描述 值
NAME 配對名稱。 字串
value 配對值。 字串

AutoHealRules

名稱 描述 值
動作 觸發規則時要執行的動作。 AutoHealActions
觸發程序 描述何時執行自動修復動作的條件。 AutoHealTriggers

AutoHealActions

名稱 描述 值
actionType 要採取的預先定義動作。 'CustomAction'
'LogEvent'
'回收'
customAction 要採取的自定義動作。 AutoHealCustomAction
minProcessExecutionTime 進程必須執行的時間下限
採取動作之前
 字串

AutoHealCustomAction

名稱 描述 值
exe 要執行的可執行檔。 字串
參數 可執行文件的參數。 字串

AutoHealTriggers

名稱 描述 值
privateBytesInKB 以私用位元組為基礎的規則。 int
requests 以要求總數為基礎的規則。 RequestsBasedTrigger
slowRequests 根據要求運行時間的規則。 SlowRequestsBasedTrigger
slowRequestsWithPath 以具有路徑的多個慢速要求規則為基礎的規則 SlowRequestsBasedTrigger[]
statusCodes 以狀態代碼為基礎的規則。 StatusCodesBasedTrigger[]
statusCodesRange 以狀態代碼範圍為基礎的規則。 StatusCodesRangeBasedTrigger[]

RequestsBasedTrigger

名稱 描述 值
count 要求計數。 int
timeInterval 時間間隔。 字串

SlowRequestsBasedTrigger

名稱 描述 值
count 要求計數。 int
path 要求路徑。 字串
timeInterval 時間間隔。 字串
timeTaken 所花費的時間。 字串

StatusCodesBasedTrigger

名稱 描述 值
count 要求計數。 int
path 要求路徑 字串
status HTTP 狀態碼。 int
子狀態 要求子狀態。 int
timeInterval 時間間隔。 字串
win32Status Win32 錯誤碼。 int

StatusCodesRangeBasedTrigger

名稱 描述 值
count 要求計數。 int
path 字串
statusCodes HTTP 狀態碼。 字串
timeInterval 時間間隔。 字串

ConnStringInfo

名稱 描述 值
connectionString 連接字串值。 字串
NAME 連接字串 的名稱。 字串
type 資料庫的類型。 'ApiHub'
'Custom'
'DocDb'
'EventHub'
'MySql'
'NotificationHub'
'PostgreSQL'
'RedisCache'
'SQLAzure'
'SQLServer'
'ServiceBus'

CorsSettings

名稱 描述 值
allowedOrigins 取得或設定應允許進行跨原始來源的來源清單
呼叫 (例如： http://example.com:12345) 。 使用 "*" 可全部允許。		 string[]
supportCredentials 取得或設定是否允許具有認證的CORS要求。 請參閱
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials
。
 bool

實驗

名稱 描述 值
rampUpRules 向上坡形規則的清單。 RampUpRule[]

RampUpRule

名稱 描述 值
actionHostName 如果決定要重新導向流量的位置主機名。 例如 myapp-stage.azurewebsites.net。 字串
changeDecisionCallbackUrl 您可以在可指定 URL 的 TiPCallback 網站延伸模組中提供自訂決策演算法。 如需 Scaffold 和合約，請參閱 TiPCallback 網站延伸模組。
https://www.siteextensions.net/packages/TiPCallback/		 字串
changeIntervalInMinutes 指定要重新評估 ReroutePercentage 的分鐘間隔。 int
changeStep 在自動增加案例中，這是新增/移除 ReroutePercentage 到 \nMinReroutePercentage 或
MaxReroutePercentage. 網站計量會每隔 N 分鐘 ChangeIntervalInMinutes檢查一次 .\n自定義決策演算法
可以在 TiPCallback 網站延伸模組中提供，您可以在 中 ChangeDecisionCallbackUrl指定 URL。		 int
maxReroutePercentage 指定 ReroutePercentage 將維持在下方的上限。 int
minReroutePercentage 指定在上方保留 ReroutePercentage 的下限。 int
NAME 路由規則的名稱。 建議的名稱是指向將接收實驗中流量的位置。 字串
reroutePercentage 將重新導向至 ActionHostName的流量百分比。 int

HandlerMapping

名稱 描述 值
引數 要傳遞至腳本處理器的命令行自變數。 字串
擴充功能 具有此延伸模組的要求將會使用指定的FastCGI應用程式來處理。 字串
scriptProcessor FastCGI 應用程式的絕對路徑。 字串

IpSecurityRestriction

名稱 描述 值
動作 允許或拒絕此IP範圍的存取。 字串
description IP 限制規則描述。 字串
headers IP 限制規則標頭。
X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples) 。
比對邏輯為 。。
- 如果屬性為 null 或空白 (預設) ，則允許所有主機 (或缺少) 。
- 使用序數-ignore-case 來比較值， (排除埠號碼) 。
- 允許子域通配符，但不符合根域。 例如，*.contoso.com 符合子域 foo.contoso.com
但不是根域 contoso.com 或多層級 foo.bar.contoso.com
- 允許 Unicode 主機名，但會轉換成 Punycode 以進行比對。

X-Forwarded-for (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples) 。
比對邏輯為 。。
- 如果屬性為 null 或空白 (預設) ，則允許任何轉送的鏈結 (或缺少) 。
- 如果鏈結中任何位址 (排除埠號碼) ， (逗號分隔) 符合 屬性所定義的 CIDR。

X-Azure-FDID 和 X-FD-HealthProbe。
比對邏輯完全相符。		 物件 (object)
ipAddress 安全性限制有效的IP位址。
其格式可以是純 ipv4 位址， (必要的 SubnetMask 屬性) 或
CIDR 表示法，例如 ipv4/mask (前置位比對) 。 針對 CIDR，
不可指定 SubnetMask 屬性。		 字串
NAME IP 限制規則名稱。 字串
priority IP 限制規則的優先順序。 int
subnetMask 限制有效之IP位址範圍的子網掩碼。 字串
subnetTrafficTag (內部) 子網流量捲標 int
標籤 定義此IP篩選條件將用於哪些專案。 這是為了支援 Proxy 上的IP篩選。 'Default'
'ServiceTag'
'XffProxy'
vnetSubnetResourceId 虛擬網路資源標識碼 字串
vnetTrafficTag (內部) Vnet 流量標籤 int

SiteLimits

名稱 描述 值
maxDiskSizeInMb 以 MB 為單位允許的磁碟大小使用量上限。 int
maxMemoryInMb MB 允許的最大記憶體使用量。 int
maxPercentageCpu 允許的CPU使用量百分比上限。 int

PushSettings

名稱 描述 值
kind 資源種類。 字串
properties PushSettings 資源特定屬性 PushSettingsProperties

PushSettingsProperties

名稱 描述 值
dynamicTagsJson 取得或設定 JSON 字串，其中包含將從推送註冊端點中的使用者宣告評估的動態標記清單。 字串
isPushEnabled 取得或設定旗標，指出是否啟用推送端點。 bool (必要)
tagsRequiringAuth 取得或設定 JSON 字串，其中包含需要在推送註冊端點中使用使用者驗證的標籤清單。
標記可以包含英數位元和下列專案：
'_', '@', '#', '.', ':', '-'.
驗證應該在 PushRequestHandler 上執行。		 字串
tagWhitelistJson 取得或設定 JSON 字串，其中包含推送註冊端點允許使用的標籤清單。 字串

VirtualApplication

名稱 描述 值
physicalPath 實體路徑。 字串
preloadEnabled true 如果已啟用預先載入，則為 ;否則為 false。 bool
virtualDirectories 虛擬應用程式的虛擬目錄。 VirtualDirectory[]
virtualPath 虛擬路徑。 字串

VirtualDirectory

名稱 描述 值
physicalPath 實體路徑。 字串
virtualPath 虛擬應用程式的路徑。 字串

快速入門範本

下列快速入門範本會部署此資源類型。

範本 描述
使用部署位置布建取用方案函式

部署至 Azure		 此範本會在取用方案上布建函式應用程式，這是動態主控方案。 應用程式會視需要執行，且每個執行都會向您計費，且不會有常設資源承諾。 有其他範本可用於布建專用主控方案。
具有部署位置的 Azure 函式應用程式

部署至 Azure		 此範本會在具有生產位置的 Premium 方案上布建函式應用程式，以及額外的部署位置。
具有自定義部署位置的 Web 應用程式

部署至 Azure		 此範本提供在 Azure Web Apps 上使用自訂部署位置部署 Web 應用程式的簡單方式。
高可用性多區域 Web 應用程式

部署至 Azure		 此範本可讓您建立安全、高可用性、多區域端對端解決方案，並在 Azure Front Door 後方的不同區域中建立兩個 Web 應用程式
保護多層式 Web 應用程式

部署至 Azure		 此範本可讓您使用具有預備位置、前端和後端的兩個 Web 應用程式建立安全的端對端解決方案，前端會透過 VNet 插入和私人端點安全地取用後端

Terraform (AzAPI 提供者) 資源定義

月臺/位置資源類型可以使用目標作業來部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.Web/sites/slots 資源，請將下列 Terraform 新增至您的範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/slots@2022-09-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      clientAffinityEnabled = bool
      clientCertEnabled = bool
      clientCertExclusionPaths = "string"
      clientCertMode = "string"
      cloningInfo = {
        appSettingsOverrides = {}
        cloneCustomHostNames = bool
        cloneSourceControl = bool
        configureLoadBalancing = bool
        correlationId = "string"
        hostingEnvironment = "string"
        overwrite = bool
        sourceWebAppId = "string"
        sourceWebAppLocation = "string"
        trafficManagerProfileId = "string"
        trafficManagerProfileName = "string"
      }
      containerSize = int
      customDomainVerificationId = "string"
      dailyMemoryTimeQuota = int
      enabled = bool
      hostingEnvironmentProfile = {
        id = "string"
      }
      hostNamesDisabled = bool
      hostNameSslStates = [
        {
          hostType = "string"
          name = "string"
          sslState = "string"
          thumbprint = "string"
          toUpdate = bool
          virtualIP = "string"
        }
      ]
      httpsOnly = bool
      hyperV = bool
      isXenon = bool
      keyVaultReferenceIdentity = "string"
      managedEnvironmentId = "string"
      publicNetworkAccess = "string"
      redundancyMode = "string"
      reserved = bool
      scmSiteAlsoStopped = bool
      serverFarmId = "string"
      siteConfig = {
        acrUseManagedIdentityCreds = bool
        acrUserManagedIdentityID = "string"
        alwaysOn = bool
        apiDefinition = {
          url = "string"
        }
        apiManagementConfig = {
          id = "string"
        }
        appCommandLine = "string"
        appSettings = [
          {
            name = "string"
            value = "string"
          }
        ]
        autoHealEnabled = bool
        autoHealRules = {
          actions = {
            actionType = "string"
            customAction = {
              exe = "string"
              parameters = "string"
            }
            minProcessExecutionTime = "string"
          }
          triggers = {
            privateBytesInKB = int
            requests = {
              count = int
              timeInterval = "string"
            }
            slowRequests = {
              count = int
              path = "string"
              timeInterval = "string"
              timeTaken = "string"
            }
            slowRequestsWithPath = [
              {
                count = int
                path = "string"
                timeInterval = "string"
                timeTaken = "string"
              }
            ]
            statusCodes = [
              {
                count = int
                path = "string"
                status = int
                subStatus = int
                timeInterval = "string"
                win32Status = int
              }
            ]
            statusCodesRange = [
              {
                count = int
                path = "string"
                statusCodes = "string"
                timeInterval = "string"
              }
            ]
          }
        }
        autoSwapSlotName = "string"
        azureStorageAccounts = {}
        connectionStrings = [
          {
            connectionString = "string"
            name = "string"
            type = "string"
          }
        ]
        cors = {
          allowedOrigins = [
            "string"
          ]
          supportCredentials = bool
        }
        defaultDocuments = [
          "string"
        ]
        detailedErrorLoggingEnabled = bool
        documentRoot = "string"
        elasticWebAppScaleLimit = int
        experiments = {
          rampUpRules = [
            {
              actionHostName = "string"
              changeDecisionCallbackUrl = "string"
              changeIntervalInMinutes = int
              changeStep = int
              maxReroutePercentage = int
              minReroutePercentage = int
              name = "string"
              reroutePercentage = int
            }
          ]
        }
        ftpsState = "string"
        functionAppScaleLimit = int
        functionsRuntimeScaleMonitoringEnabled = bool
        handlerMappings = [
          {
            arguments = "string"
            extension = "string"
            scriptProcessor = "string"
          }
        ]
        healthCheckPath = "string"
        http20Enabled = bool
        httpLoggingEnabled = bool
        ipSecurityRestrictions = [
          {
            action = "string"
            description = "string"
            headers = {}
            ipAddress = "string"
            name = "string"
            priority = int
            subnetMask = "string"
            subnetTrafficTag = int
            tag = "string"
            vnetSubnetResourceId = "string"
            vnetTrafficTag = int
          }
        ]
        ipSecurityRestrictionsDefaultAction = "string"
        javaContainer = "string"
        javaContainerVersion = "string"
        javaVersion = "string"
        keyVaultReferenceIdentity = "string"
        limits = {
          maxDiskSizeInMb = int
          maxMemoryInMb = int
          maxPercentageCpu = int
        }
        linuxFxVersion = "string"
        loadBalancing = "string"
        localMySqlEnabled = bool
        logsDirectorySizeLimit = int
        managedPipelineMode = "string"
        managedServiceIdentityId = int
        metadata = [
          {
            name = "string"
            value = "string"
          }
        ]
        minimumElasticInstanceCount = int
        minTlsVersion = "string"
        netFrameworkVersion = "string"
        nodeVersion = "string"
        numberOfWorkers = int
        phpVersion = "string"
        powerShellVersion = "string"
        preWarmedInstanceCount = int
        publicNetworkAccess = "string"
        publishingUsername = "string"
        push = {
          kind = "string"
          properties = {
            dynamicTagsJson = "string"
            isPushEnabled = bool
            tagsRequiringAuth = "string"
            tagWhitelistJson = "string"
          }
        }
        pythonVersion = "string"
        remoteDebuggingEnabled = bool
        remoteDebuggingVersion = "string"
        requestTracingEnabled = bool
        requestTracingExpirationTime = "string"
        scmIpSecurityRestrictions = [
          {
            action = "string"
            description = "string"
            headers = {}
            ipAddress = "string"
            name = "string"
            priority = int
            subnetMask = "string"
            subnetTrafficTag = int
            tag = "string"
            vnetSubnetResourceId = "string"
            vnetTrafficTag = int
          }
        ]
        scmIpSecurityRestrictionsDefaultAction = "string"
        scmIpSecurityRestrictionsUseMain = bool
        scmMinTlsVersion = "string"
        scmType = "string"
        tracingOptions = "string"
        use32BitWorkerProcess = bool
        virtualApplications = [
          {
            physicalPath = "string"
            preloadEnabled = bool
            virtualDirectories = [
              {
                physicalPath = "string"
                virtualPath = "string"
              }
            ]
            virtualPath = "string"
          }
        ]
        vnetName = "string"
        vnetPrivatePortsCount = int
        vnetRouteAllEnabled = bool
        websiteTimeZone = "string"
        webSocketsEnabled = bool
        windowsFxVersion = "string"
        xManagedServiceIdentityId = int
      }
      storageAccountRequired = bool
      virtualNetworkSubnetId = "string"
      vnetContentShareEnabled = bool
      vnetImagePullEnabled = bool
      vnetRouteAllEnabled = bool
    }
    kind = "string"
    extendedLocation = {
      name = "string"
    }
  })
}

屬性值

sites/slots

名稱 描述 值
類型 資源類型 “Microsoft.Web/sites/slots@2022-09-01”
NAME 資源名稱 字串 (必要)

字元限制：2-59

合法字元：
可對應至 Punycode 的英數位元、連字號及 Unicode 字元
location 資源位置。 字串 (必要)
parent_id 此資源之父系的資源標識碼。 類型資源的標識碼： 網站
tags 資源標籤。 標記名稱和值的字典。
kind 資源種類。 字串
extendedLocation 擴充位置。 ExtendedLocation
身分識別 受控服務識別。 ManagedServiceIdentity
properties 網站資源特定屬性 SiteProperties

ExtendedLocation

名稱 描述 值
NAME 擴充位置的名稱。 字串

ManagedServiceIdentity

名稱 描述 值
類型 受控服務識別的類型。 “SystemAssigned”
“SystemAssigned， UserAssigned”
“UserAssigned”
identity_ids 與資源相關聯的使用者指派身分識別清單。 用戶識別字典索引鍵參考的格式為 ARM 資源標識符：'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} 使用者身分識別標識碼的陣列。

SiteProperties

名稱 描述 值
clientAffinityEnabled true 表示啟用客戶端親和性; false 表示停止傳送會話親和性 Cookie，以將相同會話中的用戶端要求路由傳送至相同的實例。 預設為 true。 bool
clientCertEnabled true 啟用客戶端憑證驗證 (TLS 相互驗證) ;否則為 false。 預設為 false。 bool
clientCertExclusionPaths 用戶端憑證驗證逗號分隔排除路徑 字串
clientCertMode 這會使用 ClientCertEnabled 設定來撰寫。
- ClientCertEnabled：false 表示忽略 ClientCert。
- ClientCertEnabled：true 和 ClientCertMode：必要表示需要 ClientCert。
- ClientCertEnabled：true 和 ClientCertMode：選擇性表示 ClientCert 是選擇性或接受的。		 “選擇性”
“OptionalInteractiveUser”
“必要”
複製Info 如果在應用程式建立期間指定，則會從來源應用程式複製應用程式。 複製Info
containerSize 函式容器的大小。 int
customDomainVerificationId 驗證指派給應用程式之自定義網域的唯一標識符。 客戶會將此標識元新增至 txt 記錄以進行驗證。 字串
dailyMemoryTimeQuota 每日記憶體時間配額上限 (僅適用於動態應用程式) 。 int
已啟用 true 如果已啟用應用程式，則為 ;否則為 false。 將此值設定為 false 會停用應用程式 (讓應用程式離線) 。 bool
hostingEnvironmentProfile App Service 環境 用於應用程式。 HostingEnvironmentProfile
hostNamesDisabled true 表示停用應用程式的公用主機名;否則為 false。
如果 true為，則應用程式只能透過 API 管理程式存取。		 bool
hostNameSslStates 主機名 SSL 狀態可用來管理應用程式主機名的 SSL 系結。 HostNameSslState[]
httpsOnly HttpsOnly：將網站設定為只接受 HTTPs 要求。 重新導向的問題
HTTP 要求		 bool
hyperV Hyper-V 沙盒。 bool
isXenon 過時：Hyper-V 沙盒。 bool
keyVaultReferenceIdentity 要用於 金鑰保存庫 參考驗證的身分識別。 字串
managedEnvironmentId Azure Resource Manager 要裝載此應用程式的客戶所選取受控環境的標識碼。 這必須是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} 的格式 字串
publicNetworkAccess 允許或封鎖所有公用流量的屬性。 允許的值：『Enabled』、『Disabled』 或空字串。 字串
redundancyMode 網站備援模式 “ActiveActive”
“故障轉移”
“GeoRedundant”
“Manual”
"None"
reserved true 如果保留則為 ;否則為 false。 bool
scmSiteAlsoStopped true 表示停止應用程式時停止 SCM (KUDU) 網站;否則為 false。 預設為 false。 bool
serverFarmId 相關聯 App Service 方案的資源標識符，格式為：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。 字串
siteConfig 應用程式的組態。 SiteConfig
storageAccountRequired 檢查客戶提供的記憶體帳戶是否為必要 bool
virtualNetworkSubnetId Azure Resource Manager 區域 VNET 整合所要加入的虛擬網路和子網標識碼。
這必須是 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} 格式		 字串
vnetContentShareEnabled 啟用透過虛擬網路存取內容 bool
vnetImagePullEnabled 啟用透過 虛擬網路 提取映像 bool
vnetRouteAllEnabled 虛擬網路 [路由全部] 已啟用。 這會導致所有輸出流量套用 虛擬網路 安全組和用戶定義路由。 bool

複製Info

名稱 描述 值
appSettingsOverrides 複製應用程式的應用程式設定覆寫。 如果指定，這些設定會覆寫複製的設定
來自來源應用程式。 否則，會保留來源應用程式的應用程式設定。		 物件 (object)
cloneCustomHostNames true 從來源應用程式複製自定義主機名;否則為 false。 bool
cloneSourceControl true 從來源應用程式複製原始檔控制;否則為 false。 bool
configureLoadBalancing true 設定來源和目的地應用程式的負載平衡。 bool
correlationId 複製作業的相互關聯標識碼。 此標識碼會系結多個複製作業
同時使用相同的快照集。		 字串
hostingEnvironment App Service 環境。 字串
overwrite true 表示覆寫目的地應用程式;否則為 false。 bool
sourceWebAppId 來源應用程式的 ARM 資源識別碼。 應用程式資源識別碼的格式為
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} 用於生產位置和
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} 適用於其他位置。		 字串 (必要)
sourceWebAppLocation 來源應用程式的位置，例如：美國西部或北歐 字串
trafficManagerProfileId 如果流量管理員配置檔存在，則為要使用的ARM資源識別碼。 流量管理員資源標識碼的格式為
/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}。		 字串
trafficManagerProfileName 要建立的流量管理員配置檔名稱。 只有在流量管理員配置檔不存在時，才需要這麼做。 字串

HostingEnvironmentProfile

名稱 描述 值
id App Service 環境的資源標識碼。 字串

HostNameSslState

名稱 描述 值
hostType 指出主機名是否為標準或存放庫主機名。 “存放庫”
“Standard”
NAME 主機名稱。 字串
sslState SSL 類型。 “Disabled”
“IpBasedEnabled”
“SniEnabled”
thumbprint SSL 憑證指紋。 字串
toUpdate 設定為 true 以更新現有的主機名。 bool
virtualIP 如果已啟用以IP為基礎的SSL，則指派給主機名的虛擬IP位址。 字串

SiteConfig

名稱 描述 值
acrUseManagedIdentityCreds 使用受控識別 Creds 進行 ACR 提取的旗標 bool
acrUserManagedIdentityID 如果使用使用者受控識別，則使用者受控識別 ClientId 字串
alwaysOn true如果已開啟 Always On 則為 ，false否則為 。 bool
apiDefinition 應用程式正式 API 定義的相關信息。 ApiDefinitionInfo
apiManagementConfig 連結至應用程式的 Azure API 管理設定。 ApiManagementConfig
appCommandLine 要啟動的應用程式命令行。 字串
appSettings 應用程式設定。 NameValuePair[]
autoHealEnabled true 如果已啟用自動修復，則為 ;否則為 false。 bool
autoHealRules 自動修復規則。 AutoHealRules
autoSwapSlotName 自動交換位置名稱。 字串
azureStorageAccounts Azure 記憶體帳戶清單。 物件 (object)
connectionStrings 連接字串。 ConnStringInfo[]
cors 跨原始來源資源分享 (CORS) 設定。 CorsSettings
defaultDocuments 默認檔。 string[]
detailedErrorLoggingEnabled true 如果已啟用詳細的錯誤記錄，則為 ;否則為 false。 bool
documentRoot 檔根目錄。 字串
elasticWebAppScaleLimit 網站可相應放大的背景工作角色數目上限。
此設定僅適用於 ElasticScaleEnabled 為方案中的應用程式 true		 int
experiments 這適用於多型類型。 實驗
ftpsState FTP / FTPS 服務的狀態 “AllAllowed”
“Disabled”
“FtpsOnly”
functionAppScaleLimit 網站可相應放大的背景工作角色數目上限。
此設定僅適用於取用和彈性進階方案		 int
functionsRuntimeScaleMonitoringEnabled 取得或設定值，指出是否啟用函式運行時間規模監視。 啟用時，
ScaleController 不會直接監視事件來源，而是改為呼叫
運行時間以取得調整狀態。		 bool
handlerMappings 處理程序對應。 HandlerMapping[]
healthCheckPath 健康情況檢查路徑 字串
http20Enabled Http20Enabled：設定網站以允許用戶端透過 HTTP2.0 連線 bool
httpLoggingEnabled true 如果已啟用 HTTP 記錄，則為 ;否則為 false。 bool
ipSecurityRestrictions 主要的IP安全性限制。 IpSecurityRestriction[]
ipSecurityRestrictionsDefaultAction 如果沒有符合任何規則，則主要存取限制的默認動作。 “允許”
“拒絕”
javaContainer Java 容器。 字串
javaContainerVersion Java 容器版本。 字串
javaVersion Java 版本。 字串
keyVaultReferenceIdentity 用於 金鑰保存庫 參考驗證的身分識別。 字串
限制 網站限制。 SiteLimits
linuxFxVersion Linux App Framework 和版本 字串
負載平衡 網站負載平衡。 “LeastRequests”
“LeastResponseTime”
“PerSiteRoundRobin”
“RequestHash”
“WeightedRoundRobin”
“WeightedTotalTraffic”
localMySqlEnabled true 表示啟用本機 MySQL;否則為 false。 bool
logsDirectorySizeLimit HTTP 記錄目錄大小限制。 int
managedPipelineMode Managed 管線模式。 “傳統”
“Integrated”
managedServiceIdentityId 受控服務識別標識碼 int
中繼資料 應用程式元數據。 無法擷取這個屬性，因為它可能包含秘密。 NameValuePair[]
minimumElasticInstanceCount 月臺的最小實例計數數目
此設定僅適用於彈性方案		 int
minTlsVersion MinTlsVersion：設定 SSL 要求所需的最低 TLS 版本 "1.0"
"1.1"
"1.2"
netFrameworkVersion .NET Framework 版本。 字串
nodeVersion Node.js 的版本。 字串
numberOfWorkers 背景工作數目。 int
phpVersion PHP 版本。 字串
powerShellVersion PowerShell 的版本。 字串
preWarmedInstanceCount preWarmed 實例的數目。
此設定僅適用於取用和彈性方案		 int
publicNetworkAccess 允許或封鎖所有公用流量的屬性。 字串
publishingUsername 發佈用戶名稱。 字串
push 推送端點設定。 PushSettings
pythonVersion Python 的版本。 字串
remoteDebuggingEnabled true 如果已啟用遠端偵錯，則為 ;否則為 false。 bool
remoteDebuggingVersion 遠端偵錯版本。 字串
requestTracingEnabled true 如果已啟用要求追蹤，則為 ;否則為 false。 bool
requestTracingExpirationTime 要求追蹤到期時間。 字串
scmIpSecurityRestrictions scm 的IP安全性限制。 IpSecurityRestriction[]
scmIpSecurityRestrictionsDefaultAction 如果未比對任何規則，則為 scm 存取限制的預設動作。 “Allow”
“Deny”
scmIpSecurityRestrictionsUseMain scm 使用 main 的 IP 安全性限制。 bool
scmMinTlsVersion ScmMinTlsVersion：設定 SCM 月臺 SSL 要求所需的最低 TLS 版本 "1.0"
"1.1"
"1.2"
scmType SCM 類型。 “BitbucketGit”
“BitbucketHg”
“CodePlexGit”
“CodePlexHg”
“Dropbox”
“ExternalGit”
“ExternalHg”
“GitHub”
“LocalGit”
"None"
“OneDrive”
“Tfs”
“VSO”
“VSTSRM”
tracingOptions 追蹤選項。 字串
use32BitWorkerProcess true 表示使用32位背景工作進程;否則為 false。 bool
virtualApplications 虛擬應用程式。 VirtualApplication[]
vnetName 虛擬網路 名稱。 字串
vnetPrivatePortsCount 指派給此應用程式的私人埠數目。 這些會在運行時間動態指派。 int
vnetRouteAllEnabled 虛擬網路 已啟用 [路由全部]。 這會導致所有輸出流量套用 虛擬網路 安全組和用戶定義路由。 bool
websiteTimeZone 設定網站用來產生時間戳的時區。 與 Linux 和 Windows App Service 相容。 設定WEBSITE_TIME_ZONE應用程式設定的優先順序高於此設定。針對 Linux，預期 tz 資料庫值 https://www.iana.org/time-zones (快速參考，請參閱 https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) 。 針對 Windows，預期其中一個時區列在 HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones 字串
webSocketsEnabled true 如果已啟用 WebSocket，則為 ;否則為 false。 bool
windowsFxVersion Xenon App Framework 和版本 字串
xManagedServiceIdentityId 明確受控服務識別標識碼 int

ApiDefinitionInfo

名稱 描述 值
url API 定義的 URL。 字串

ApiManagementConfig

名稱 描述 值
id APIM-Api 識別碼。 字串

NameValuePair

名稱 描述 值
NAME 配對名稱。 字串
value 配對值。 字串

AutoHealRules

名稱 描述 值
動作 觸發規則時要執行的動作。 AutoHealActions
觸發程序 描述何時執行自動修復動作的條件。 AutoHealTriggers

AutoHealActions

名稱 描述 值
actionType 要採取的預先定義動作。 “CustomAction”
“LogEvent”
“回收”
customAction 要採取的自定義動作。 AutoHealCustomAction
minProcessExecutionTime 進程必須執行的時間下限
採取動作之前
 字串

AutoHealCustomAction

名稱 描述 值
exe 要執行的可執行檔。 字串
參數 可執行文件的參數。 字串

AutoHealTriggers

名稱 描述 值
privateBytesInKB 以私用位元組為基礎的規則。 int
requests 根據要求總數的規則。 RequestsBasedTrigger
slowRequests 根據要求運行時間的規則。 SlowRequestsBasedTrigger
slowRequestsWithPath 以具有路徑的多個慢速要求規則為基礎的規則 SlowRequestsBasedTrigger[]
statusCodes 根據狀態代碼的規則。 StatusCodesBasedTrigger[]
statusCodesRange 根據狀態代碼範圍的規則。 StatusCodesRangeBasedTrigger[]

RequestsBasedTrigger

名稱 描述 值
count 要求計數。 int
timeInterval 時間間隔。 字串

SlowRequestsBasedTrigger

名稱 描述 值
count 要求計數。 int
path 要求路徑。 字串
timeInterval 時間間隔。 字串
timeTaken 所花費的時間。 字串

StatusCodesBasedTrigger

名稱 描述 值
count 要求計數。 int
path 要求路徑 字串
status HTTP 狀態碼。 int
子狀態 要求子狀態。 int
timeInterval 時間間隔。 字串
win32Status Win32 錯誤碼。 int

StatusCodesRangeBasedTrigger

名稱 描述 值
count 要求計數。 int
path 字串
statusCodes HTTP 狀態碼。 字串
timeInterval 時間間隔。 字串

ConnStringInfo

名稱 描述 值
connectionString 連接字串值。 字串
NAME 連接字串 的名稱。 字串
type 資料庫的類型。 “ApiHub”
"Custom"
“DocDb”
“EventHub”
“MySql”
“NotificationHub”
“PostgreSQL”
“RedisCache”
“SQLAzure”
“SQLServer”
“ServiceBus”

CorsSettings

名稱 描述 值
allowedOrigins 取得或設定應該允許建立跨原始來源的來源清單
呼叫 (例如： http://example.com:12345) 。 使用 "*" 可全部允許。		 string[]
supportCredentials 取得或設定是否允許具有認證的CORS要求。 請參閱
https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials
。
 bool

實驗

名稱 描述 值
rampUpRules 向上提升規則的清單。 RampUpRule[]

RampUpRule

名稱 描述 值
actionHostName 如果決定要重新導向流量的位置主機名。 例如 myapp-stage.azurewebsites.net。 字串
changeDecisionCallbackUrl 您可以在可指定 URL 的 TiPCallback 網站延伸模組中提供自訂決策演算法。 如需 Scaffold 和合約，請參閱 TiPCallback 網站延伸模組。
https://www.siteextensions.net/packages/TiPCallback/		 字串
changeIntervalInMinutes 指定要重新評估 ReroutePercentage 的分鐘間隔。 int
changeStep 在自動增加案例中，這是新增/移除 ReroutePercentage 到 \nMinReroutePercentage 或
MaxReroutePercentage. 網站計量會每隔 N 分鐘 ChangeIntervalInMinutes檢查一次 .\n自定義決策演算法
可以在 TiPCallback 網站延伸模組中提供，您可以在 中 ChangeDecisionCallbackUrl指定 URL。		 int
maxReroutePercentage 指定 ReroutePercentage 將維持在下方的上限。 int
minReroutePercentage 指定在上方保留 ReroutePercentage 的下限。 int
NAME 路由規則的名稱。 建議的名稱是指向將接收實驗中流量的位置。 字串
reroutePercentage 將重新導向至 ActionHostName的流量百分比。 int

HandlerMapping

名稱 描述 值
引數 要傳遞至腳本處理器的命令行自變數。 字串
擴充功能 具有此延伸模組的要求將會使用指定的FastCGI應用程式來處理。 字串
scriptProcessor FastCGI 應用程式的絕對路徑。 字串

IpSecurityRestriction

名稱 描述 值
動作 允許或拒絕此IP範圍的存取。 字串
description IP 限制規則描述。 字串
headers IP 限制規則標頭。
X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples) 。
比對邏輯為 。。
- 如果屬性為 null 或空白 (預設) ，則允許所有主機 (或缺少) 。
- 使用序數-ignore-case 來比較值， (排除埠號碼) 。
- 允許子域通配符，但不符合根域。 例如，*.contoso.com 符合子域 foo.contoso.com
但不是根域 contoso.com 或多層級 foo.bar.contoso.com
- 允許 Unicode 主機名，但會轉換成 Punycode 以進行比對。

X-Forwarded-for (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples) 。
比對邏輯為 。。
- 如果屬性為 null 或空白 (預設) ，則允許任何轉送的鏈結 (或缺少) 。
- 如果鏈結中任何位址 (排除埠號碼) ， (逗號分隔) 符合 屬性所定義的 CIDR。

X-Azure-FDID 和 X-FD-HealthProbe。
比對邏輯完全相符。		 物件 (object)
ipAddress 安全性限制有效的IP位址。
其格式可以是純 ipv4 位址， (必要的 SubnetMask 屬性) 或
CIDR 表示法，例如 ipv4/mask (前置位比對) 。 針對 CIDR，
不可指定 SubnetMask 屬性。		 字串
NAME IP 限制規則名稱。 字串
priority IP 限制規則的優先順序。 int
subnetMask 限制有效之IP位址範圍的子網掩碼。 字串
subnetTrafficTag (內部) 子網流量捲標 int
標籤 定義此IP篩選條件將用於哪些專案。 這是為了支援 Proxy 上的IP篩選。 “Default”
“ServiceTag”
“XffProxy”
vnetSubnetResourceId 虛擬網路資源標識碼 字串
vnetTrafficTag (內部) Vnet 流量標籤 int

SiteLimits

名稱 描述 值
maxDiskSizeInMb 以 MB 為單位允許的磁碟大小使用量上限。 int
maxMemoryInMb MB 允許的最大記憶體使用量。 int
maxPercentageCpu 允許的CPU使用量百分比上限。 int

PushSettings

名稱 描述 值
kind 資源種類。 字串
properties PushSettings 資源特定屬性 PushSettingsProperties

PushSettingsProperties

名稱 描述 值
dynamicTagsJson 取得或設定 JSON 字串，其中包含將從推送註冊端點中的使用者宣告評估的動態標籤清單。 字串
isPushEnabled 取得或設定旗標，指出是否啟用推送端點。 bool (必要)
tagsRequiringAuth 取得或設定 JSON 字串，其中包含需要使用者驗證在推送註冊端點中使用的標記清單。
標記可以包含英數位元和下列專案：
'_', '@', '#', '.', ':', '-'.
驗證應該在 PushRequestHandler 上執行。		 字串
tagWhitelistJson 取得或設定 JSON 字串，其中包含推送註冊端點允許使用的標記清單。 字串

VirtualApplication

名稱 描述 值
physicalPath 實體路徑。 字串
preloadEnabled true 如果已啟用預先載入，則為 ;否則為 false。 bool
virtualDirectories 虛擬應用程式的虛擬目錄。 VirtualDirectory[]
virtualPath 虛擬路徑。 字串

VirtualDirectory

名稱 描述 值
physicalPath 實體路徑。 字串
virtualPath 虛擬應用程式的路徑。 字串