Site interface

套件:

@azure/arm-appservice

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

Extends

Resource

屬性

autoGeneratedDomainNameLabelScope	指定資源建立期間預設主機名的唯一性範圍
availabilityState	應用程式的管理資訊可用性狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
clientAffinityEnabled	true 啟用用戶端親和性;false 停止傳送會話親和性 Cookie，以將相同會話中的用戶端要求路由傳送至相同的實例。 預設值為 true。
clientAffinityPartitioningEnabled	true 要使用 CHIPS Cookie 啟用用戶端關聯分區，這會將屬性添加到 partitioned 關聯 Cookie 中; false 停止發送分區的關聯 Cookie。 預設值為 false。
clientAffinityProxyEnabled	true 使用 X-Forwarded-Host 請求標頭覆蓋用戶端關聯 Cookie 域。 false 以使用預設域。 預設值為 false。
clientCertEnabled	true 啟用用戶端憑證驗證（TLS 相互驗證）：否則，false。 預設值為 false。
clientCertExclusionPaths	用戶端憑證驗證逗號分隔排除路徑
clientCertMode	這會使用 ClientCertEnabled 設定來撰寫。 ClientCertEnabled：false 表示忽略 ClientCert。 ClientCertEnabled：true 和 ClientCertMode：必要表示需要 ClientCert。 ClientCertEnabled：true 和 ClientCertMode：選擇性表示 ClientCert 是選擇性或已接受。
cloningInfo	如果在應用程式建立期間指定，則會從來源應用程式複製應用程式。
containerSize	函式容器的大小。
customDomainVerificationId	驗證指派給應用程式之自定義網域的唯一標識符。 客戶會將此標識元新增至 txt 記錄以進行驗證。
dailyMemoryTimeQuota	允許的每日記憶體時間配額上限（僅適用於動態應用程式）。
daprConfig	應用程式的 Dapr 設定。
defaultHostName	應用程式的預設主機名。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
dnsConfiguration	屬性，可設定網站的各種 DNS 相關設定。
enabled	如果已啟用應用程式，true;否則，false。 將此值設定為 false 會停用應用程式（讓應用程式離線）。
enabledHostNames	已啟用應用程式的主機名。必須指派主機名（請參閱 HostNames） AND 已啟用。 否則，應用程式不會在這些主機名上提供。 注意：這個屬性不會串行化。 它只能由伺服器填入。
endToEndEncryptionEnabled	是否要使用前端與背景工作角色之間的端對端加密
extendedLocation	擴充位置。
functionAppConfig	Azure 函式應用程式的特定設定。
hostingEnvironmentProfile	要用於應用程式的App Service環境。
hostNames	與應用程式相關聯的主機名。 注意：這個屬性不會串行化。 它只能由伺服器填入。
hostNamesDisabled	true 停用應用程式的公用主機名;否則，false。 如果 true，則應用程式只能透過 API 管理程式存取。
hostNameSslStates	主機名 SSL 狀態可用來管理應用程式的主機名 SSL 系結。
httpsOnly	HttpsOnly：將網站設定為只接受 HTTPs 要求。 HTTP 要求的重新導向問題
hyperV	Hyper-V 沙箱。
identity	受控服務識別。
inProgressOperationId	如果此網站有擱置的作業，則指定作業標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。
ipMode	指定應用程式的IP模式。
isDefaultContainer	如果應用程式是預設容器，true;否則，false。 注意：這個屬性不會串行化。 它只能由伺服器填入。
isXenon	過時：Hyper-V 沙盒。
keyVaultReferenceIdentity	要用於 Key Vault 參考驗證的身分識別。
lastModifiedTimeUtc	上次以 UTC 修改應用程式的時間。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
managedEnvironmentId	要裝載此應用程式的客戶所選取受控環境的 Azure Resource Manager 識別符。 這必須是 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} 的格式
maxNumberOfWorkers	背景工作角色數目上限。 這隻適用於 Functions 容器。 注意：這個屬性不會串行化。 它只能由伺服器填入。
outboundIpAddresses	應用程式用於輸出連線的IP位址清單（例如資料庫存取）。 包含可從網站裝載目前設定之租使用者的VIP。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
outboundVnetRouting	用於透過虛擬網路為網站配置各種出站流量路由選項的屬性
possibleOutboundIpAddresses	應用程式用於輸出連線的IP位址清單（例如資料庫存取）。 包含所有租使用者中的VIP，但dataComponent除外。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
publicNetworkAccess	允許或封鎖所有公用流量的屬性。 允許的值：『Enabled』、『Disabled』 或空字串。
redundancyMode	月臺備援模式
repositorySiteName	存放庫網站的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
reserved	保留時 true;否則，false。
resourceConfig	函式應用程式資源需求。
resourceGroup	應用程式所屬的資源群組名稱。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
scmSiteAlsoStopped	true 停止應用程式時停止 SCM （KUDU） 網站;否則，false。 預設值為 false。
serverFarmId	相關聯 App Service 方案的資源標識符，格式為：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。
siteConfig	設定 App Service 應用程式。 此屬性不會在回應正常的創建和讀取請求時返回，因為它可能包含敏感資訊。
sku	以相關聯的 App Service 方案為基礎的應用程式目前 SKU。 某些有效的 SKU 值為 Free、Shared、Basic、Dynamic、FlexConsumption、Standard、Premium、PremiumV2、PremiumV3、Isolated、IsolatedV2 注意：此屬性將不會串行化。 它只能由伺服器填入。
slotSwapStatus	上次部署位置交換作業的狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
sshEnabled	是否啟用 ssh 存取。
state	應用程式的目前狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。
storageAccountRequired	檢查客戶提供的記憶體帳戶是否需要
suspendedTill	應用程式暫停，直到超過記憶體時間配額為止。 注意：這個屬性不會串行化。 它只能由伺服器填入。
targetSwapSlot	指定此應用程式要交換的部署位置。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
trafficManagerHostNames	與應用程式相關聯的 Azure 流量管理員主機名。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
usageState	指出應用程式是否已超過其配額使用量的狀態。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。
virtualNetworkSubnetId	要由區域 VNET 整合加入之虛擬網路和子網的 Azure Resource Manager 識別符。 這必須是 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName} 的格式
workloadProfileName	要執行之函式應用程式的工作負載配置檔名稱。

繼承的屬性

id	資源標識碼。注意：此屬性將不會串行化。 它只能由伺服器填入。
kind	資源種類。 如果資源是應用程式，您可以參考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 以取得種類支援的詳細值。
location	資源位置。
name	資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。
tags	資源標籤。
type	資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

屬性詳細資料

autoGeneratedDomainNameLabelScope

指定資源建立期間預設主機名的唯一性範圍

autoGeneratedDomainNameLabelScope?: AutoGeneratedDomainNameLabelScope

屬性值

AutoGeneratedDomainNameLabelScope

availabilityState

應用程式的管理資訊可用性狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

availabilityState?: SiteAvailabilityState

屬性值

SiteAvailabilityState

clientAffinityEnabled

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

clientAffinityEnabled?: boolean

屬性值

boolean

clientAffinityPartitioningEnabled

true 要使用 CHIPS Cookie 啟用用戶端關聯分區，這會將屬性添加到 partitioned 關聯 Cookie 中; false 停止發送分區的關聯 Cookie。 預設值為 false。

clientAffinityPartitioningEnabled?: boolean

屬性值

boolean

clientAffinityProxyEnabled

true 使用 X-Forwarded-Host 請求標頭覆蓋用戶端關聯 Cookie 域。 false 以使用預設域。 預設值為 false。

clientAffinityProxyEnabled?: boolean

屬性值

boolean

clientCertEnabled

true 啟用用戶端憑證驗證（TLS 相互驗證）：否則，false。 預設值為 false。

clientCertEnabled?: boolean

屬性值

boolean

clientCertExclusionPaths

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

clientCertExclusionPaths?: string

屬性值

string

clientCertMode

這會使用 ClientCertEnabled 設定來撰寫。

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

clientCertMode?: ClientCertMode

屬性值

ClientCertMode

cloningInfo

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

cloningInfo?: CloningInfo

屬性值

CloningInfo

containerSize

函式容器的大小。

containerSize?: number

屬性值

number

customDomainVerificationId

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

customDomainVerificationId?: string

屬性值

string

dailyMemoryTimeQuota

允許的每日記憶體時間配額上限（僅適用於動態應用程式）。

dailyMemoryTimeQuota?: number

屬性值

number

daprConfig

應用程式的 Dapr 設定。

daprConfig?: DaprConfig

屬性值

DaprConfig

defaultHostName

應用程式的預設主機名。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

defaultHostName?: string

屬性值

string

dnsConfiguration

屬性，可設定網站的各種 DNS 相關設定。

dnsConfiguration?: SiteDnsConfig

屬性值

SiteDnsConfig

enabled

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

enabled?: boolean

屬性值

boolean

enabledHostNames

已啟用應用程式的主機名。必須指派主機名（請參閱 HostNames） AND 已啟用。 否則，應用程式不會在這些主機名上提供。 注意：這個屬性不會串行化。 它只能由伺服器填入。

enabledHostNames?: string[]

屬性值

string[]

endToEndEncryptionEnabled

是否要使用前端與背景工作角色之間的端對端加密

endToEndEncryptionEnabled?: boolean

屬性值

boolean

extendedLocation

擴充位置。

extendedLocation?: ExtendedLocation

屬性值

ExtendedLocation

functionAppConfig

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

functionAppConfig?: FunctionAppConfig

屬性值

FunctionAppConfig

hostingEnvironmentProfile

要用於應用程式的App Service環境。

hostingEnvironmentProfile?: HostingEnvironmentProfile

屬性值

HostingEnvironmentProfile

hostNames

與應用程式相關聯的主機名。 注意：這個屬性不會串行化。 它只能由伺服器填入。

hostNames?: string[]

屬性值

string[]

hostNamesDisabled

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

hostNamesDisabled?: boolean

屬性值

boolean

hostNameSslStates

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

hostNameSslStates?: HostNameSslState[]

屬性值

HostNameSslState[]

httpsOnly

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

httpsOnly?: boolean

屬性值

boolean

hyperV

Hyper-V 沙箱。

hyperV?: boolean

屬性值

boolean

identity

受控服務識別。

identity?: ManagedServiceIdentity

屬性值

ManagedServiceIdentity

inProgressOperationId

如果此網站有擱置的作業，則指定作業標識碼。 注意：這個屬性不會串行化。 它只能由伺服器填入。

inProgressOperationId?: string

屬性值

string

ipMode

指定應用程式的IP模式。

ipMode?: IPMode

屬性值

IPMode

isDefaultContainer

如果應用程式是預設容器，true;否則，false。 注意：這個屬性不會串行化。 它只能由伺服器填入。

isDefaultContainer?: boolean

屬性值

boolean

isXenon

過時：Hyper-V 沙盒。

isXenon?: boolean

屬性值

boolean

keyVaultReferenceIdentity

要用於 Key Vault 參考驗證的身分識別。

keyVaultReferenceIdentity?: string

屬性值

string

lastModifiedTimeUtc

上次以 UTC 修改應用程式的時間。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

lastModifiedTimeUtc?: Date

屬性值

Date

managedEnvironmentId

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

managedEnvironmentId?: string

屬性值

string

maxNumberOfWorkers

背景工作角色數目上限。 這隻適用於 Functions 容器。 注意：這個屬性不會串行化。 它只能由伺服器填入。

maxNumberOfWorkers?: number

屬性值

number

outboundIpAddresses

應用程式用於輸出連線的IP位址清單（例如資料庫存取）。 包含可從網站裝載目前設定之租使用者的VIP。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

outboundIpAddresses?: string

屬性值

string

outboundVnetRouting

用於透過虛擬網路為網站配置各種出站流量路由選項的屬性

outboundVnetRouting?: OutboundVnetRouting

屬性值

OutboundVnetRouting

possibleOutboundIpAddresses

應用程式用於輸出連線的IP位址清單（例如資料庫存取）。 包含所有租使用者中的VIP，但dataComponent除外。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

possibleOutboundIpAddresses?: string

屬性值

string

publicNetworkAccess

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

publicNetworkAccess?: string

屬性值

string

redundancyMode

月臺備援模式

redundancyMode?: RedundancyMode

屬性值

RedundancyMode

repositorySiteName

存放庫網站的名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

repositorySiteName?: string

屬性值

string

reserved

保留時 true;否則，false。

reserved?: boolean

屬性值

boolean

resourceConfig

函式應用程式資源需求。

resourceConfig?: ResourceConfig

屬性值

ResourceConfig

resourceGroup

應用程式所屬的資源群組名稱。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

resourceGroup?: string

屬性值

string

scmSiteAlsoStopped

true 停止應用程式時停止 SCM （KUDU） 網站;否則，false。 預設值為 false。

scmSiteAlsoStopped?: boolean

屬性值

boolean

serverFarmId

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

serverFarmId?: string

屬性值

string

siteConfig

設定 App Service 應用程式。 此屬性不會在回應正常的創建和讀取請求時返回，因為它可能包含敏感資訊。

siteConfig?: SiteConfig

屬性值

SiteConfig

sku

以相關聯的 App Service 方案為基礎的應用程式目前 SKU。 某些有效的 SKU 值為 Free、Shared、Basic、Dynamic、FlexConsumption、Standard、Premium、PremiumV2、PremiumV3、Isolated、IsolatedV2 注意：此屬性將不會串行化。 它只能由伺服器填入。

sku?: string

屬性值

string

slotSwapStatus

上次部署位置交換作業的狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

slotSwapStatus?: SlotSwapStatus

屬性值

SlotSwapStatus

sshEnabled

是否啟用 ssh 存取。

sshEnabled?: boolean

屬性值

boolean

state

應用程式的目前狀態。 注意：這個屬性不會串行化。 它只能由伺服器填入。

state?: string

屬性值

string

storageAccountRequired

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

storageAccountRequired?: boolean

屬性值

boolean

suspendedTill

應用程式暫停，直到超過記憶體時間配額為止。 注意：這個屬性不會串行化。 它只能由伺服器填入。

suspendedTill?: Date

屬性值

Date

targetSwapSlot

指定此應用程式要交換的部署位置。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

targetSwapSlot?: string

屬性值

string

trafficManagerHostNames

與應用程式相關聯的 Azure 流量管理員主機名。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

trafficManagerHostNames?: string[]

屬性值

string[]

usageState

指出應用程式是否已超過其配額使用量的狀態。 唯讀的。 注意：這個屬性不會串行化。 它只能由伺服器填入。

usageState?: UsageState

屬性值

UsageState

virtualNetworkSubnetId

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

virtualNetworkSubnetId?: string

屬性值

string

workloadProfileName

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

workloadProfileName?: string

屬性值

string

繼承的屬性詳細資料

id

資源標識碼。注意：此屬性將不會串行化。 它只能由伺服器填入。

id?: string

屬性值

string

繼承自Resource.id

kind

資源種類。 如果資源是應用程式，您可以參考 https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference 以取得種類支援的詳細值。

kind?: string

屬性值

string

繼承自Resource.kind

location

資源位置。

location: string

屬性值

string

繼承自Resource.location

name

資源名稱。 注意：這個屬性不會串行化。 它只能由伺服器填入。

name?: string

屬性值

string

繼承自Resource.name

tags

資源標籤。

tags?: {[propertyName: string]: string}

屬性值

{[propertyName: string]: string}

繼承自Resource.tags

type

資源類型。 注意：這個屬性不會串行化。 它只能由伺服器填入。

type?: string

屬性值

string

繼承自Resource.type