共用方式為


App Service Environments - Resume

繼續 App Service 環境 的描述。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume?api-version=2023-12-01

URI 參數

名稱 位於 必要 類型 Description
name
path True

string

App Service 環境 的名稱。

resourceGroupName
path True

string

資源所屬資源群組的名稱。

Regex 模式: ^[-\w\._\(\)]+[^\.]$

subscriptionId
path True

string

您的 Azure 訂用帳戶識別碼。 這是 GUID 格式的字串 (例如 000000000-0000-0000-0000-000000000000) 。

api-version
query True

string

API 版本

回應

名稱 類型 Description
200 OK

WebAppCollection

正常。

202 Accepted

WebAppCollection

作業正在進行中。

Other Status Codes

DefaultErrorResponse

App Service 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱 Description
user_impersonation 模擬您的用戶帳戶

範例

Resume an App Service Environment.

範例要求

POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/resume?api-version=2023-12-01

範例回覆

x-ms-routing-request-id: NORTHCENTRALUS:20220408T212612Z:79bd0bce-5524-4fd1-ada0-1d8c86263d17
Location: https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/operations/f6a27306-3ee3-4e6b-997d-3ba2024b85e6?api-version=2019-08-01
{
  "value": []
}
{
  "value": []
}

定義

名稱 Description
ApiDefinitionInfo

應用程式正式 API 定義的相關信息。

ApiManagementConfig

Azure API 管理 (APIM) 連結至應用程式的設定。

Authentication

用來存取記憶體帳戶以進行部署的驗證方法。

AuthenticationType

屬性,可選取驗證類型以存取選取的記憶體帳戶。 可用選項:SystemAssignedIdentity、UserAssignedIdentity、StorageAccountConnectionString。

AutoHealActions

觸發規則時,自動修復模組要採取的動作。

AutoHealActionType

要採取的預先定義動作。

AutoHealCustomAction

觸發自動修復規則時要執行的自定義動作。

AutoHealRules

可以定義用於自動修復的規則。

AutoHealTriggers

自動修復的觸發程式。

AzureStorageInfoValue

字典記憶體 Azure 檔案儲存體 或 Blob 記憶體存取資訊值。

AzureStorageProtocol

掛接通訊協定以用於記憶體帳戶。

AzureStorageState

記憶體帳戶的狀態。

AzureStorageType

記憶體的類型。

ClientCertMode

這會使用 ClientCertEnabled 設定來撰寫。

  • ClientCertEnabled:false 表示忽略 ClientCert。
  • ClientCertEnabled:true 和 ClientCertMode:必要表示需要 ClientCert。
  • ClientCertEnabled:true 和 ClientCertMode:選擇性表示 ClientCert 是選擇性或接受的。
CloningInfo

複製作業所需的資訊。

ConnectionStringType

資料庫的類型。

ConnStringInfo

資料庫 連接字串資訊。

CorsSettings

跨原始來源資源分享 (應用程式的 CORS) 設定。

DaprConfig

應用程式 Dapr 設定。

daprLogLevel

設定 Dapr sidecar 的記錄層級。 允許的值為偵錯、資訊、警告、錯誤。 預設值為資訊。

DefaultAction

如果沒有符合任何規則,則主要存取限制的默認動作。

DefaultErrorResponse

App Service 錯誤回應。

Details
Error

錯誤模型。

Experiments

生產實驗中的路由規則。

ExtendedLocation

擴充位置。

FtpsState

FTP / FTPS 服務的狀態

FunctionAppConfig

函式應用程式組態。

FunctionsAlwaysReadyConfig

設定函式群組或特定函式的『Always Ready』 實例數目。

FunctionsDeployment

函式應用程式部署的組態區段。

FunctionsDeploymentStorageType

要選取 [Azure 記憶體類型] 的屬性。 可用的選項:blobContainer。

FunctionsRuntime

函式應用程式運行時間名稱和版本。

FunctionsScaleAndConcurrency

調整函式應用程式的並行設定。

HandlerMapping

IIS 處理程式對應,用來定義哪些處理程式會處理具有特定擴充功能的 HTTP 要求。 例如,它會用來設定 php-cgi.exe 進程,以使用 *.php 擴充功能處理所有 HTTP 要求。

HostingEnvironmentProfile

用於此資源的 App Service 環境 規格。

HostNameSslState

已啟用 SSL 的主機名。

HostType

指出主機名是否為標準或存放庫主機名。

Http

調整 HTTP 觸發程式的並行設定。

IpFilterTag

定義此IP篩選器將用於哪些專案。 這是為了支援 Proxy 上的IP篩選。

IpSecurityRestriction

應用程式上的IP安全性限制。

ManagedPipelineMode

Managed 管線模式。

ManagedServiceIdentity

受控服務識別。

ManagedServiceIdentityType

受控服務識別的類型。

NameValuePair

名稱值組。

PushSettings

應用程式的推播設定。

RampUpRule

用於加速測試的路由規則。 此規則允許將靜態流量 % 重新導向至位置,或根據效能逐漸變更路由百分比。

RedundancyMode

網站備援模式

RequestsBasedTrigger

根據要求總數觸發。

ResourceConfig

函式應用程式資源需求。

RuntimeName

函式應用程式運行時間名稱。 可用選項:dotnet 隔離、節點、java、powershell、python、自定義

ScmType

SCM 類型。

Site

Web 應用程式、行動應用程式後端或 API 應用程式。

SiteAvailabilityState

應用程式的管理資訊可用性狀態。

SiteConfig

設定 App Service 應用程式。

SiteDnsConfig
SiteLimits

在應用程式上設定的計量限制。

SiteLoadBalancing

網站負載平衡。

SiteMachineKey

應用程式的 MachineKey。

SlotSwapStatus

上次成功位置交換作業的狀態。

SlowRequestsBasedTrigger

根據要求運行時間觸發。

SslState

SSL 類型。

StatusCodesBasedTrigger

根據狀態代碼觸發程式。

StatusCodesRangeBasedTrigger

根據狀態代碼的範圍觸發程式。

Storage

函式應用程式所使用的已部署套件記憶體。

SupportedTlsVersions

MinTlsVersion:設定 SSL 要求所需的最低 TLS 版本

TlsCipherSuites

應用程式允許的最小強度 TLS 加密套件

Triggers

函式應用程式觸發程式的調整和並行設定。

UsageState

指出應用程式是否已超過其配額使用量的狀態。 唯讀。

userAssignedIdentity

使用者指派的身分識別。

VirtualApplication

應用程式中的虛擬應用程式。

VirtualDirectory

虛擬應用程式的目錄。

WebAppCollection

App Service 應用程式的集合。

ApiDefinitionInfo

應用程式正式 API 定義的相關信息。

名稱 類型 Description
url

string

API 定義的 URL。

ApiManagementConfig

Azure API 管理 (APIM) 連結至應用程式的設定。

名稱 類型 Description
id

string

APIM-Api 識別碼。

Authentication

用來存取記憶體帳戶以進行部署的驗證方法。

名稱 類型 Description
storageAccountConnectionStringName

string

針對 StorageAccountConnectionString 使用此屬性。 設定具有記憶體帳戶 連接字串的應用程式設定名稱。 使用其他驗證類型時,請勿設定此屬性的值。

type

AuthenticationType

屬性,可選取驗證類型以存取選取的記憶體帳戶。 可用選項:SystemAssignedIdentity、UserAssignedIdentity、StorageAccountConnectionString。

userAssignedIdentityResourceId

string

針對 UserAssignedIdentity 使用此屬性。 設定身分識別的資源標識碼。 使用其他驗證類型時,請勿設定此屬性的值。

AuthenticationType

屬性,可選取驗證類型以存取選取的記憶體帳戶。 可用選項:SystemAssignedIdentity、UserAssignedIdentity、StorageAccountConnectionString。

名稱 類型 Description
StorageAccountConnectionString

string

SystemAssignedIdentity

string

UserAssignedIdentity

string

AutoHealActions

觸發規則時,自動修復模組要採取的動作。

名稱 類型 Description
actionType

AutoHealActionType

要採取的預先定義動作。

customAction

AutoHealCustomAction

要採取的自定義動作。

minProcessExecutionTime

string

執行動作之前,進程必須執行的時間下限

AutoHealActionType

要採取的預先定義動作。

名稱 類型 Description
CustomAction

string

LogEvent

string

Recycle

string

AutoHealCustomAction

觸發自動修復規則時要執行的自定義動作。

名稱 類型 Description
exe

string

要執行的可執行檔。

parameters

string

可執行文件的參數。

AutoHealRules

可以定義用於自動修復的規則。

名稱 類型 Description
actions

AutoHealActions

觸發規則時要執行的動作。

triggers

AutoHealTriggers

描述何時執行自動修復動作的條件。

AutoHealTriggers

自動修復的觸發程式。

名稱 類型 Description
privateBytesInKB

integer

以私用位元組為基礎的規則。

requests

RequestsBasedTrigger

以要求總數為基礎的規則。

slowRequests

SlowRequestsBasedTrigger

根據要求運行時間的規則。

slowRequestsWithPath

SlowRequestsBasedTrigger[]

以具有路徑的多個慢速要求規則為基礎的規則

statusCodes

StatusCodesBasedTrigger[]

以狀態代碼為基礎的規則。

statusCodesRange

StatusCodesRangeBasedTrigger[]

以狀態代碼範圍為基礎的規則。

AzureStorageInfoValue

字典記憶體 Azure 檔案儲存體 或 Blob 記憶體存取資訊值。

名稱 類型 Description
accessKey

string

儲存體帳戶的存取金鑰。

accountName

string

儲存體帳戶的名稱。

mountPath

string

在站臺運行時間環境中掛接記憶體的路徑。

protocol

AzureStorageProtocol

掛接通訊協定以用於記憶體帳戶。

shareName

string

Blob 記憶體) 的檔案共享 (容器名稱。

state

AzureStorageState

記憶體帳戶的狀態。

type

AzureStorageType

記憶體的類型。

AzureStorageProtocol

掛接通訊協定以用於記憶體帳戶。

名稱 類型 Description
Http

string

Nfs

string

Smb

string

AzureStorageState

記憶體帳戶的狀態。

名稱 類型 Description
InvalidCredentials

string

InvalidShare

string

NotValidated

string

Ok

string

AzureStorageType

記憶體的類型。

名稱 類型 Description
AzureBlob

string

AzureFiles

string

ClientCertMode

這會使用 ClientCertEnabled 設定來撰寫。

  • ClientCertEnabled:false 表示忽略 ClientCert。
  • ClientCertEnabled:true 和 ClientCertMode:必要表示需要 ClientCert。
  • ClientCertEnabled:true 和 ClientCertMode:選擇性表示 ClientCert 是選擇性或接受的。
名稱 類型 Description
Optional

string

OptionalInteractiveUser

string

Required

string

CloningInfo

複製作業所需的資訊。

名稱 類型 Description
appSettingsOverrides

object

複製應用程式的應用程式設定覆寫。 如果指定,這些設定會覆寫從來源應用程式複製的設定。 否則,會保留來源應用程式的應用程式設定。

cloneCustomHostNames

boolean

true 從來源應用程式複製自定義主機名;否則為 false

cloneSourceControl

boolean

true 從來源應用程式複製原始檔控制;否則為 false

configureLoadBalancing

boolean

true 設定來源和目的地應用程式的負載平衡。

correlationId

string

複製作業的相互關聯標識碼。 此標識碼會將多個複製作業系結在一起,以使用相同的快照集。

hostingEnvironment

string

App Service 環境。

overwrite

boolean

true 表示覆寫目的地應用程式;否則為 false

sourceWebAppId

string

來源應用程式的 ARM 資源識別碼。 應用程式資源標識符的格式為 /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName},適用於生產位置和 /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} 的其他位置。

sourceWebAppLocation

string

來源應用程式的位置,例如:美國西部或北歐

trafficManagerProfileId

string

如果流量管理員配置檔存在,則為要使用的ARM資源識別碼。 流量管理員資源標識符的格式為 /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}。

trafficManagerProfileName

string

要建立的流量管理員配置檔名稱。 只有在流量管理員配置檔不存在時,才需要這麼做。

ConnectionStringType

資料庫的類型。

名稱 類型 Description
ApiHub

string

Custom

string

DocDb

string

EventHub

string

MySql

string

NotificationHub

string

PostgreSQL

string

RedisCache

string

SQLAzure

string

SQLServer

string

ServiceBus

string

ConnStringInfo

資料庫 連接字串資訊。

名稱 類型 Description
connectionString

string

連接字串值。

name

string

連接字串 的名稱。

type

ConnectionStringType

資料庫的類型。

CorsSettings

跨原始來源資源分享 (應用程式的 CORS) 設定。

名稱 類型 Description
allowedOrigins

string[]

取得或設定應該允許在 (進行跨原始來源呼叫的來源清單,例如: http://example.com:12345) 。 使用 "*" 可全部允許。

supportCredentials

boolean

取得或設定是否允許具有認證的CORS要求。 如需更多詳細資料,請參閱 https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials \(英文\)。

DaprConfig

應用程式 Dapr 設定。

名稱 類型 預設值 Description
appId

string

Dapr 應用程式識別碼

appPort

integer

告訴 Dapr 您的應用程式正在接聽哪個埠

enableApiLogging

boolean

啟用 Dapr sidecar 的 API 記錄

enabled

boolean

False

布爾值,指出是否已啟用 Dapr 側車

httpMaxRequestSize

integer

以 MB 增加要求本文 HTTP 伺服器參數的大小上限,以處理大型檔案的上傳。 預設值為 4 MB。

httpReadBufferSize

integer

傳送多 KB 標頭時,在 KB 中要處理的 HTTP 標頭讀取緩衝區大小上限。 預設值為 65KB。

logLevel

daprLogLevel

設定 Dapr sidecar 的記錄層級。 允許的值是偵錯、資訊、警告、錯誤。 預設值為資訊。

daprLogLevel

設定 Dapr sidecar 的記錄層級。 允許的值為偵錯、資訊、警告、錯誤。 預設值為資訊。

名稱 類型 Description
debug

string

error

string

info

string

warn

string

DefaultAction

如果沒有符合任何規則,則主要存取限制的默認動作。

名稱 類型 Description
Allow

string

Deny

string

DefaultErrorResponse

App Service 錯誤回應。

名稱 類型 Description
error

Error

錯誤模型。

Details

名稱 類型 Description
code

string

標準化字串,以程序設計方式識別錯誤。

message

string

詳細的錯誤描述和偵錯資訊。

target

string

詳細的錯誤描述和偵錯資訊。

Error

錯誤模型。

名稱 類型 Description
code

string

標準化字串,以程序設計方式識別錯誤。

details

Details[]

詳細的錯誤。

innererror

string

偵錯錯誤的詳細資訊。

message

string

詳細的錯誤描述和偵錯資訊。

target

string

詳細的錯誤描述和偵錯資訊。

Experiments

生產實驗中的路由規則。

名稱 類型 Description
rampUpRules

RampUpRule[]

向上坡形規則的清單。

ExtendedLocation

擴充位置。

名稱 類型 Description
name

string

擴充位置的名稱。

type

string

擴充位置的類型。

FtpsState

FTP / FTPS 服務的狀態

名稱 類型 Description
AllAllowed

string

Disabled

string

FtpsOnly

string

FunctionAppConfig

函式應用程式組態。

名稱 類型 Description
deployment

FunctionsDeployment

函式應用程式部署組態。

runtime

FunctionsRuntime

函式應用程式運行時間設定。

scaleAndConcurrency

FunctionsScaleAndConcurrency

函式應用程式調整和並行設定。

FunctionsAlwaysReadyConfig

設定函式群組或特定函式的『Always Ready』 實例數目。

名稱 類型 Description
instanceCount

number

設定指定函式群組或特定函式的 『Always Ready』 實例數目。 如需詳細資訊,請參閱 https://aka.ms/flexconsumption/alwaysready

name

string

需要函式群組或函式名稱。 如需詳細資訊,請參閱 https://aka.ms/flexconsumption/alwaysready

FunctionsDeployment

函式應用程式部署的組態區段。

名稱 類型 Description
storage

Storage

函式應用程式所使用的已部署套件記憶體。

FunctionsDeploymentStorageType

要選取 [Azure 記憶體類型] 的屬性。 可用的選項:blobContainer。

名稱 類型 Description
blobContainer

string

FunctionsRuntime

函式應用程式運行時間名稱和版本。

名稱 類型 Description
name

RuntimeName

函式應用程式運行時間名稱。 可用選項:dotnet 隔離、節點、java、powershell、python、自定義

version

string

函式應用程式運行時間版本。 範例:dotnet 隔離) 的 8 個 (

FunctionsScaleAndConcurrency

調整函式應用程式的並行設定。

名稱 類型 Description
alwaysReady

FunctionsAlwaysReadyConfig[]

函式應用程式的 'Always Ready' 組態。

instanceMemoryMB

number

以 MB 為單位,設定設定給函式應用程式每個實例的記憶體數量。 CPU 和網路頻寬會按比例配置。

maximumInstanceCount

number

函式應用程式的實例數目上限。

triggers

Triggers

函式應用程式觸發程式的調整和並行設定。

HandlerMapping

IIS 處理程式對應,用來定義哪些處理程式會處理具有特定擴充功能的 HTTP 要求。 例如,它會用來設定 php-cgi.exe 進程,以使用 *.php 擴充功能處理所有 HTTP 要求。

名稱 類型 Description
arguments

string

要傳遞至腳本處理器的命令行自變數。

extension

string

具有此延伸模組的要求將會使用指定的FastCGI應用程式來處理。

scriptProcessor

string

FastCGI 應用程式的絕對路徑。

HostingEnvironmentProfile

用於此資源的 App Service 環境 規格。

名稱 類型 Description
id

string

App Service 環境的資源標識碼。

name

string

App Service 環境 的名稱。

type

string

App Service 環境的資源類型。

HostNameSslState

已啟用 SSL 的主機名。

名稱 類型 Description
hostType

HostType

指出主機名是標準或存放庫主機名。

name

string

主機名稱。

sslState

SslState

SSL 類型。

thumbprint

string

SSL 憑證指紋。

toUpdate

boolean

設定為 true 以更新現有的主機名。

virtualIP

string

如果已啟用以IP為基礎的SSL,指派給主機名的虛擬IP位址。

HostType

指出主機名是否為標準或存放庫主機名。

名稱 類型 Description
Repository

string

Standard

string

Http

調整 HTTP 觸發程式的並行設定。

名稱 類型 Description
perInstanceConcurrency

number

每個實例的並行 HTTP 觸發程式調用數目上限。

IpFilterTag

定義此IP篩選器將用於哪些專案。 這是為了支援 Proxy 上的IP篩選。

名稱 類型 Description
Default

string

ServiceTag

string

XffProxy

string

IpSecurityRestriction

應用程式上的IP安全性限制。

名稱 類型 Description
action

string

允許或拒絕此IP範圍的存取。

description

string

IP 限制規則描述。

headers

object

IP 限制規則標頭。 X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples) 。 比對邏輯為 。。

  • 如果屬性為 null 或空白 (預設) ,則會允許 (或缺少) 的所有主機。
  • 使用序數忽略大小寫 (排除埠號碼) 來比較值。
  • 允許使用子網域萬用字元,但不會比對出根網域。 例如,*.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。 比對邏輯完全相符。

ipAddress

string

安全性限制有效的IP位址。 其格式可以是純 ipv4 位址, (必要的 SubnetMask 屬性) 或 CIDR 表示法,例如 ipv4/mask (前置位比對) 。 針對 CIDR,不得指定 SubnetMask 屬性。

name

string

IP 限制規則名稱。

priority

integer

IP 限制規則的優先順序。

subnetMask

string

限制有效之IP位址範圍的子網掩碼。

subnetTrafficTag

integer

(內部) 子網流量捲標

tag

IpFilterTag

定義此IP篩選器將用於哪些專案。 這是為了支援 Proxy 上的IP篩選。

vnetSubnetResourceId

string

虛擬網路資源標識碼

vnetTrafficTag

integer

(內部) Vnet 流量標籤

ManagedPipelineMode

Managed 管線模式。

名稱 類型 Description
Classic

string

Integrated

string

ManagedServiceIdentity

受控服務識別。

名稱 類型 Description
principalId

string

受控服務識別的主要標識碼。

tenantId

string

受控服務識別的租使用者。

type

ManagedServiceIdentityType

受控服務識別的類型。

userAssignedIdentities

<string,  userAssignedIdentity>

與資源相關聯的使用者指派身分識別清單。 使用者身分識別字典索引鍵參考的格式為 ARM 資源標識符:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}

ManagedServiceIdentityType

受控服務識別的類型。

名稱 類型 Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

NameValuePair

名稱值組。

名稱 類型 Description
name

string

配對名稱。

value

string

配對值。

PushSettings

應用程式的推播設定。

名稱 類型 Description
id

string

資源標識碼。

kind

string

資源種類。

name

string

資源名稱。

properties.dynamicTagsJson

string

取得或設定 JSON 字串,其中包含將從推送註冊端點中的使用者宣告評估的動態標籤清單。

properties.isPushEnabled

boolean

取得或設定旗標,指出是否啟用推送端點。

properties.tagWhitelistJson

string

取得或設定 JSON 字串,其中包含已列入允許清單以供推送註冊端點使用的標籤清單。

properties.tagsRequiringAuth

string

取得或設定 JSON 字串,其中包含需要使用者驗證在推送註冊端點中使用的標記清單。 標記可以包含英數位元和下列專案:'_'、'@'、'#'、'.'、':'、'-'。 驗證應該在 PushRequestHandler 上執行。

type

string

資源類型。

RampUpRule

用於加速測試的路由規則。 此規則允許將靜態流量 % 重新導向至位置,或根據效能逐漸變更路由百分比。

名稱 類型 Description
actionHostName

string

如果決定要重新導向流量的位置主機名。 例如 myapp-stage.azurewebsites.net。

changeDecisionCallbackUrl

string

您可以在可指定 URL 的 TiPCallback 網站延伸模組中提供自訂決策演算法。 如需 Scaffold 和合約,請參閱 TiPCallback 網站延伸模組。 https://www.siteextensions.net/packages/TiPCallback/

changeIntervalInMinutes

integer

指定重新評估 ReroutePercentage 的分鐘間隔。

changeStep

number

在自動增加案例中,這是新增/移除到 \nMinReroutePercentageMaxReroutePercentage之前新增/移除ReroutePercentage的步驟。 您可以在 TiPCallback 網站延伸模組中提供 .\n自定義決策演算法中指定的 ChangeIntervalInMinutes每 N 分鐘檢查網站計量,您可以在 中 ChangeDecisionCallbackUrl指定 URL。

maxReroutePercentage

number

指定 ReroutePercentage 將維持在下方的上限。

minReroutePercentage

number

指定 ReroutePercentage 將保留的下限。

name

string

路由規則的名稱。 建議的名稱是指向將接收實驗中流量的位置。

reroutePercentage

number

將重新導向至 ActionHostName的流量百分比。

RedundancyMode

網站備援模式

名稱 類型 Description
ActiveActive

string

Failover

string

GeoRedundant

string

Manual

string

None

string

RequestsBasedTrigger

根據要求總數觸發。

名稱 類型 Description
count

integer

要求計數。

timeInterval

string

時間間隔。

ResourceConfig

函式應用程式資源需求。

名稱 類型 Description
cpu

number

核心中必要的 CPU,例如 0.5

memory

string

必要的記憶體,例如 “1Gi”

RuntimeName

函式應用程式運行時間名稱。 可用選項:dotnet 隔離、節點、java、powershell、python、自定義

名稱 類型 Description
custom

string

dotnet-isolated

string

java

string

node

string

powershell

string

python

string

ScmType

SCM 類型。

名稱 類型 Description
BitbucketGit

string

BitbucketHg

string

CodePlexGit

string

CodePlexHg

string

Dropbox

string

ExternalGit

string

ExternalHg

string

GitHub

string

LocalGit

string

None

string

OneDrive

string

Tfs

string

VSO

string

VSTSRM

string

Site

Web 應用程式、行動應用程式後端或 API 應用程式。

名稱 類型 預設值 Description
extendedLocation

ExtendedLocation

擴充位置。

id

string

資源標識碼。

identity

ManagedServiceIdentity

受控服務識別。

kind

string

資源種類。

location

string

資源位置。

name

string

資源名稱。

properties.availabilityState

SiteAvailabilityState

應用程式的管理資訊可用性狀態。

properties.clientAffinityEnabled

boolean

true 表示啟用客戶端親和性; false 表示停止傳送會話親和性 Cookie,以將相同會話中的用戶端要求路由傳送至相同的實例。 預設為 true

properties.clientCertEnabled

boolean

true 啟用客戶端憑證驗證 (TLS 相互驗證) ;否則為 false。 預設為 false

properties.clientCertExclusionPaths

string

用戶端憑證驗證逗號分隔排除路徑

properties.clientCertMode

ClientCertMode

這會使用 ClientCertEnabled 設定來撰寫。

  • ClientCertEnabled:false 表示忽略 ClientCert。
  • ClientCertEnabled:true 和 ClientCertMode:必要表示需要 ClientCert。
  • ClientCertEnabled:true 和 ClientCertMode:選擇性表示 ClientCert 是選擇性或接受的。
properties.cloningInfo

CloningInfo

如果在應用程式建立期間指定,則會從來源應用程式複製應用程式。

properties.containerSize

integer

函式容器的大小。

properties.customDomainVerificationId

string

驗證指派給應用程式之自定義網域的唯一標識符。 客戶會將此標識元新增至 txt 記錄以進行驗證。

properties.dailyMemoryTimeQuota

integer

每日記憶體時間配額上限 (僅適用於動態應用程式) 。

properties.daprConfig

DaprConfig

應用程式的 Dapr 設定。

properties.defaultHostName

string

應用程式的預設主機名。 唯讀。

properties.dnsConfiguration

SiteDnsConfig

屬性,可設定月臺的各種 DNS 相關設定。

properties.enabled

boolean

true 如果已啟用應用程式,則為 ;否則為 false。 將此值設定為 false 會停用應用程式 (讓應用程式離線) 。

properties.enabledHostNames

string[]

為應用程式啟用主機名。 (必須指派主機名,請參閱已啟用 HostNames) AND。 否則,應用程式不會在這些主機名上提供。

properties.functionAppConfig

FunctionAppConfig

Azure 函式應用程式的特定設定。

properties.hostNameSslStates

HostNameSslState[]

主機名 SSL 狀態可用來管理應用程式主機名的 SSL 系結。

properties.hostNames

string[]

與應用程式相關聯的主機名。

properties.hostNamesDisabled

boolean

true 表示停用應用程式的公用主機名;否則為 false。 如果 true為,則應用程式只能透過 API 管理程式存取。

properties.hostingEnvironmentProfile

HostingEnvironmentProfile

App Service 環境 用於應用程式。

properties.httpsOnly

boolean

HttpsOnly:將網站設定為只接受 HTTPs 要求。 HTTP 要求的重新導向問題

properties.hyperV

boolean

False

Hyper-V 沙盒。

properties.inProgressOperationId

string

如果此網站有擱置的作業,則指定作業標識碼。

properties.isDefaultContainer

boolean

true 如果應用程式是預設容器,則為 ;否則為 false

properties.isXenon

boolean

False

過時:Hyper-V 沙盒。

properties.keyVaultReferenceIdentity

string

要用於 金鑰保存庫 參考驗證的身分識別。

properties.lastModifiedTimeUtc

string

上次以 UTC 修改應用程式的時間。 唯讀。

properties.managedEnvironmentId

string

Azure Resource Manager 要裝載此應用程式的客戶所選取受控環境的標識碼。 這必須是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} 的格式

properties.maxNumberOfWorkers

integer

背景工作角色的數目上限。 這隻適用於 Functions 容器。

properties.outboundIpAddresses

string

應用程式用於輸出連線的IP位址清單 (,例如資料庫存取) 。 包含可裝載目前設定之租使用者中的VIP。 唯讀。

properties.possibleOutboundIpAddresses

string

應用程式用於輸出連線的IP位址清單 (,例如資料庫存取) 。 包含來自所有租使用者的VIP,但dataComponent除外。 唯讀。

properties.publicNetworkAccess

string

允許或封鎖所有公用流量的屬性。 允許的值:『Enabled』、『Disabled』 或空字串。

properties.redundancyMode

RedundancyMode

網站備援模式

properties.repositorySiteName

string

存放庫網站的名稱。

properties.reserved

boolean

False

true 如果保留則為 ;否則為 false

properties.resourceConfig

ResourceConfig

函式應用程式資源需求。

properties.resourceGroup

string

應用程式所屬的資源群組名稱。 唯讀。

properties.scmSiteAlsoStopped

boolean

False

true 表示停止應用程式時停止 SCM (KUDU) 網站;否則為 false。 預設值為 false

properties.serverFarmId

string

相關聯 App Service 方案的資源標識符,格式為:“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。

properties.siteConfig

SiteConfig

應用程式的組態。

properties.slotSwapStatus

SlotSwapStatus

上次部署位置交換作業的狀態。

properties.state

string

應用程式的目前狀態。

properties.storageAccountRequired

boolean

檢查客戶提供的記憶體帳戶是否為必要

properties.suspendedTill

string

超過記憶體時間配額時,應用程式會暫停。

properties.targetSwapSlot

string

指定此應用程式要交換的部署位置。 唯讀。

properties.trafficManagerHostNames

string[]

與應用程式相關聯的 Azure 流量管理員主機名。 唯讀。

properties.usageState

UsageState

指出應用程式是否已超過其配額使用量的狀態。 唯讀。

properties.virtualNetworkSubnetId

string

Azure Resource Manager 要由區域 VNET 整合加入的虛擬網路和子網標識碼。 這必須是 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} 格式

properties.vnetBackupRestoreEnabled

boolean

透過虛擬網路啟用備份和還原作業

properties.vnetContentShareEnabled

boolean

啟用透過虛擬網路存取內容

properties.vnetImagePullEnabled

boolean

若要在 虛擬網路 上啟用提取映像

properties.vnetRouteAllEnabled

boolean

虛擬網路 已啟用 [路由全部]。 這會導致所有輸出流量 虛擬網路 套用安全組和使用者定義路由。

properties.workloadProfileName

string

要執行之函式應用程式的工作負載配置檔名稱。

tags

object

資源標籤。

type

string

資源類型。

SiteAvailabilityState

應用程式的管理資訊可用性狀態。

名稱 類型 Description
DisasterRecoveryMode

string

Limited

string

Normal

string

SiteConfig

設定 App Service 應用程式。

名稱 類型 預設值 Description
acrUseManagedIdentityCreds

boolean

針對 ACR 提取使用受控識別 Creds 的旗標

acrUserManagedIdentityID

string

如果使用使用者受控識別,則使用者受控識別 ClientId

alwaysOn

boolean

true如果已開啟 Always On,則為 ,否則為 false

apiDefinition

ApiDefinitionInfo

應用程式正式 API 定義的相關信息。

apiManagementConfig

ApiManagementConfig

連結至應用程式的 Azure API 管理設定。

appCommandLine

string

要啟動的應用程式命令行。

appSettings

NameValuePair[]

應用程式設定。

autoHealEnabled

boolean

true 如果已啟用自動修復,則為 ;否則為 false

autoHealRules

AutoHealRules

自動修復規則。

autoSwapSlotName

string

自動交換位置名稱。

azureStorageAccounts

<string,  AzureStorageInfoValue>

Azure 記憶體帳戶清單。

connectionStrings

ConnStringInfo[]

連接字串。

cors

CorsSettings

跨原始來源資源分享 (CORS) 設定。

defaultDocuments

string[]

默認檔。

detailedErrorLoggingEnabled

boolean

true 如果已啟用詳細的錯誤記錄,則為 ;否則為 false

documentRoot

string

檔根目錄。

elasticWebAppScaleLimit

integer

網站可相應放大的背景工作角色數目上限。 此設定僅適用於 ElasticScaleEnabled 為方案中的應用程式 true

experiments

Experiments

這適用於多型類型。

ftpsState

FtpsState

FTP / FTPS 服務的狀態

functionAppScaleLimit

integer

網站可相應放大的背景工作角色數目上限。 此設定僅適用於取用和彈性進階方案

functionsRuntimeScaleMonitoringEnabled

boolean

取得或設定值,指出是否啟用函式運行時間調整監視。 啟用時,ScaleController 不會直接監視事件來源,而是會呼叫運行時間以取得調整狀態。

handlerMappings

HandlerMapping[]

處理程序對應。

healthCheckPath

string

健康情況檢查路徑

http20Enabled

boolean

True

Http20Enabled:設定網站以允許用戶端透過 HTTP2.0 連線

httpLoggingEnabled

boolean

true 如果已啟用 HTTP 記錄,則為 ;否則為 false

ipSecurityRestrictions

IpSecurityRestriction[]

主要的IP安全性限制。

ipSecurityRestrictionsDefaultAction

DefaultAction

如果沒有符合任何規則,則主要存取限制的默認動作。

javaContainer

string

Java 容器。

javaContainerVersion

string

Java 容器版本。

javaVersion

string

Java 版本。

keyVaultReferenceIdentity

string

用於 金鑰保存庫 參考驗證的身分識別。

limits

SiteLimits

網站限制。

linuxFxVersion

string

Linux App Framework 和版本

loadBalancing

SiteLoadBalancing

網站負載平衡。

localMySqlEnabled

boolean

False

true 表示啟用本機 MySQL;否則為 false

logsDirectorySizeLimit

integer

HTTP 記錄目錄大小限制。

machineKey

SiteMachineKey

Site MachineKey。

managedPipelineMode

ManagedPipelineMode

Managed 管線模式。

managedServiceIdentityId

integer

受控服務識別標識碼

metadata

NameValuePair[]

應用程式元數據。 無法擷取這個屬性,因為它可能包含秘密。

minTlsCipherSuite

TlsCipherSuites

應用程式允許的最小強度 TLS 加密套件

minTlsVersion

SupportedTlsVersions

MinTlsVersion:設定 SSL 要求所需的最低 TLS 版本

minimumElasticInstanceCount

integer

月臺的最小實例計數 此設定僅適用於彈性方案

netFrameworkVersion

string

v4.6

.NET Framework 版本。

nodeVersion

string

Node.js 的版本。

numberOfWorkers

integer

背景工作數目。

phpVersion

string

PHP 版本。

powerShellVersion

string

PowerShell 的版本。

preWarmedInstanceCount

integer

預先警告實例的數目。 此設定僅適用於取用和彈性方案

publicNetworkAccess

string

允許或封鎖所有公用流量的屬性。

publishingUsername

string

發佈用戶名稱。

push

PushSettings

推送端點設定。

pythonVersion

string

Python 的版本。

remoteDebuggingEnabled

boolean

true 如果已啟用遠端偵錯,則為 ;否則為 false

remoteDebuggingVersion

string

遠端偵錯版本。

requestTracingEnabled

boolean

true 如果已啟用要求追蹤,則為 ;否則為 false

requestTracingExpirationTime

string

要求追蹤到期時間。

scmIpSecurityRestrictions

IpSecurityRestriction[]

scm 的IP安全性限制。

scmIpSecurityRestrictionsDefaultAction

DefaultAction

如果未比對任何規則,則為 scm 存取限制的預設動作。

scmIpSecurityRestrictionsUseMain

boolean

scm 使用 main 的 IP 安全性限制。

scmMinTlsVersion

SupportedTlsVersions

ScmMinTlsVersion:設定 SCM 網站 SSL 要求所需的最低 TLS 版本

scmType

ScmType

SCM 類型。

tracingOptions

string

追蹤選項。

use32BitWorkerProcess

boolean

true 表示使用32位背景工作進程;否則為 false

virtualApplications

VirtualApplication[]

虛擬應用程式。

vnetName

string

虛擬網路 名稱。

vnetPrivatePortsCount

integer

指派給此應用程式的私人埠數目。 這些會在運行時間動態指派。

vnetRouteAllEnabled

boolean

虛擬網路 已啟用 [全部路由]。 這會導致套用 虛擬網路 安全組和用戶定義路由的所有輸出流量。

webSocketsEnabled

boolean

true 如果已啟用 WebSocket,則為 ;否則為 false

websiteTimeZone

string

設定網站用來產生時間戳的時區。 與 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

windowsFxVersion

string

Xenon App Framework 和版本

xManagedServiceIdentityId

integer

明確受控服務識別標識碼

SiteDnsConfig

名稱 類型 Description
dnsAltServer

string

應用程式要使用的替代 DNS 伺服器。 此屬性會復寫WEBSITE_DNS_ALT_SERVER應用程式設定。

dnsLegacySortOrder

boolean

指出使用虛擬網路自定義 DNS 伺服器的月臺仍在排序 DNS 伺服器清單。 唯讀。

dnsMaxCacheTimeout

integer

DNS 的自定義時間,以秒為單位快取。 允許的範圍:0-60。 預設值為 30 秒。 0 表示已停用快取。

dnsRetryAttemptCount

integer

DNS 查閱的重試總數。 允許的範圍:1-5。 預設為 3。

dnsRetryAttemptTimeout

integer

以秒為單位的單一 DNS 查閱逾時。 允許的範圍:1-30。 預設為 3。

dnsServers

string[]

應用程式要用於查閱的自定義 DNS 伺服器清單。 最多可以設定 5 部 DNS 伺服器。

SiteLimits

在應用程式上設定的計量限制。

名稱 類型 Description
maxDiskSizeInMb

integer

允許的磁碟大小使用量上限,以 MB 為單位。

maxMemoryInMb

integer

以 MB 為單位允許的記憶體使用量上限。

maxPercentageCpu

number

允許的CPU使用量百分比上限。

SiteLoadBalancing

網站負載平衡。

名稱 類型 Description
LeastRequests

string

LeastResponseTime

string

PerSiteRoundRobin

string

RequestHash

string

WeightedRoundRobin

string

WeightedTotalTraffic

string

SiteMachineKey

應用程式的 MachineKey。

名稱 類型 Description
decryption

string

用於解密的演算法。

decryptionKey

string

解金鑰。

validation

string

MachineKey 驗證。

validationKey

string

驗證金鑰。

SlotSwapStatus

上次成功位置交換作業的狀態。

名稱 類型 Description
destinationSlotName

string

上次交換作業的目的地位置。

sourceSlotName

string

上次交換作業的來源位置。

timestampUtc

string

上次成功交換位置的時間。

SlowRequestsBasedTrigger

根據要求運行時間觸發。

名稱 類型 Description
count

integer

要求計數。

path

string

要求路徑。

timeInterval

string

時間間隔。

timeTaken

string

所花費的時間。

SslState

SSL 類型。

名稱 類型 Description
Disabled

string

IpBasedEnabled

string

SniEnabled

string

StatusCodesBasedTrigger

根據狀態代碼觸發程式。

名稱 類型 Description
count

integer

要求計數。

path

string

要求路徑

status

integer

HTTP 狀態碼。

subStatus

integer

要求子狀態。

timeInterval

string

時間間隔。

win32Status

integer

Win32 錯誤碼。

StatusCodesRangeBasedTrigger

根據狀態代碼的範圍觸發程式。

名稱 類型 Description
count

integer

要求計數。

path

string

statusCodes

string

HTTP 狀態碼。

timeInterval

string

時間間隔。

Storage

函式應用程式所使用的已部署套件記憶體。

名稱 類型 Description
authentication

Authentication

用來存取記憶體帳戶以進行部署的驗證方法。

type

FunctionsDeploymentStorageType

要選取 [Azure 記憶體類型] 的屬性。 可用的選項:blobContainer。

value

string

屬性,可設定所選 Azure 記憶體類型的 URL。 範例:針對 blobContainer,此值可以是 https://.blob.core.windows.net/.

SupportedTlsVersions

MinTlsVersion:設定 SSL 要求所需的最低 TLS 版本

名稱 類型 Description
1.0

string

1.1

string

1.2

string

1.3

string

TlsCipherSuites

應用程式允許的最小強度 TLS 加密套件

名稱 類型 Description
TLS_AES_128_GCM_SHA256

string

TLS_AES_256_GCM_SHA384

string

TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256

string

TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256

string

TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384

string

TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA

string

TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256

string

TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256

string

TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA

string

TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384

string

TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384

string

TLS_RSA_WITH_AES_128_CBC_SHA

string

TLS_RSA_WITH_AES_128_CBC_SHA256

string

TLS_RSA_WITH_AES_128_GCM_SHA256

string

TLS_RSA_WITH_AES_256_CBC_SHA

string

TLS_RSA_WITH_AES_256_CBC_SHA256

string

TLS_RSA_WITH_AES_256_GCM_SHA384

string

Triggers

函式應用程式觸發程式的調整和並行設定。

名稱 類型 Description
http

Http

調整 HTTP 觸發程式的並行設定。

UsageState

指出應用程式是否已超過其配額使用量的狀態。 唯讀。

名稱 類型 Description
Exceeded

string

Normal

string

userAssignedIdentity

使用者指派的身分識別。

名稱 類型 Description
clientId

string

使用者指派身分識別的用戶端標識碼

principalId

string

使用者指派身分識別的主體標識碼

VirtualApplication

應用程式中的虛擬應用程式。

名稱 類型 Description
physicalPath

string

實體路徑。

preloadEnabled

boolean

true 如果已啟用預先載入,則為 ;否則為 false

virtualDirectories

VirtualDirectory[]

虛擬應用程式的虛擬目錄。

virtualPath

string

虛擬路徑。

VirtualDirectory

虛擬應用程式的目錄。

名稱 類型 Description
physicalPath

string

實體路徑。

virtualPath

string

虛擬應用程式的路徑。

WebAppCollection

App Service 應用程式的集合。

名稱 類型 Description
nextLink

string

連結至下一頁的資源。

value

Site[]

資源的集合。