你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

SitePatchResource interface

包:

@azure/arm-appservice

站点的 ARM 资源。

扩展

ProxyOnlyResource

属性

availabilityState	应用的管理信息可用性状态。 注意：此属性不会序列化。 它只能由服务器填充。
clientAffinityEnabled	true 启用客户端相关性;false 停止发送会话关联 Cookie，这会将同一会话中的客户端请求路由到同一实例。 默认值为 true。
clientCertEnabled	true 启用客户端证书身份验证（TLS 相互身份验证）：否则，false。 默认值为 false。
clientCertExclusionPaths	客户端证书身份验证逗号分隔排除路径
clientCertMode	此组合使用 ClientCertEnabled 设置。 ClientCertEnabled：false 表示忽略 ClientCert。 ClientCertEnabled：true 和 ClientCertMode：必需意味着需要 ClientCert。 ClientCertEnabled：true 和 ClientCertMode：可选意味着 ClientCert 是可选的或接受的。
cloningInfo	如果在创建应用期间指定，则会从源应用克隆应用。
containerSize	函数容器的大小。
customDomainVerificationId	验证分配给应用的自定义域的唯一标识符。 客户会将此 ID 添加到 txt 记录进行验证。
dailyMemoryTimeQuota	每日允许的最大内存时间配额（仅适用于动态应用）。
defaultHostName	应用的默认主机名。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
dnsConfiguration	用于为站点配置各种 DNS 相关设置的属性。
enabled	如果启用应用，true;否则，false。 将此值设置为 false 会禁用应用（使应用脱机）。
enabledHostNames	为应用启用了主机名。需要分配主机名（请参阅主机名）并启用。 否则，不会在这些主机名上提供应用。 注意：此属性不会序列化。 它只能由服务器填充。
hostingEnvironmentProfile	要用于应用的应用服务环境。
hostNames	与应用关联的主机名。 注意：此属性不会序列化。 它只能由服务器填充。
hostNamesDisabled	true 禁用应用的公共主机名;否则，false。 如果 true，则只能通过 API 管理过程访问应用。
hostNameSslStates	主机名 SSL 状态用于管理应用的主机名的 SSL 绑定。
httpsOnly	HttpsOnly：将网站配置为仅接受 https 请求。 http 请求重定向问题
hyperV	Hyper-V 沙盒。
identity	托管服务标识。
inProgressOperationId	如果此站点具有挂起的操作，则指定操作 ID。 注意：此属性不会序列化。 它只能由服务器填充。
isDefaultContainer	如果应用是默认容器，则 true;否则，false。 注意：此属性不会序列化。 它只能由服务器填充。
isXenon	已过时：Hyper-V 沙盒。
keyVaultReferenceIdentity	用于 Key Vault 参考身份验证的标识。
lastModifiedTimeUtc	上次修改应用的时间（UTC）。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
maxNumberOfWorkers	最大辅助角色数。 这仅适用于 Functions 容器。 注意：此属性不会序列化。 它只能由服务器填充。
outboundIpAddresses	应用用于出站连接的 IP 地址列表（例如数据库访问）。 包括可以使用当前设置托管站点的租户中的 VIP。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
possibleOutboundIpAddresses	应用用于出站连接的 IP 地址列表（例如数据库访问）。 包括除 dataComponent 以外的所有租户的 VIP。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
redundancyMode	站点冗余模式
repositorySiteName	存储库站点的名称。 注意：此属性不会序列化。 它只能由服务器填充。
reserved	如果保留，则为 true;否则，false。
resourceGroup	应用所属的资源组的名称。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
scmSiteAlsoStopped	true 停止应用时停止 SCM （KUDU） 站点;否则，false。 默认值为 false。
serverFarmId	关联的应用服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。
siteConfig	应用的配置。
slotSwapStatus	上次部署槽交换操作的状态。 注意：此属性不会序列化。 它只能由服务器填充。
state	应用的当前状态。 注意：此属性不会序列化。 它只能由服务器填充。
storageAccountRequired	检查客户提供的存储帐户是否是必需的
suspendedTill	应用暂停，直到超过内存时间配额。 注意：此属性不会序列化。 它只能由服务器填充。
targetSwapSlot	指定此应用将交换到哪个部署槽位。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
trafficManagerHostNames	与应用关联的 Azure 流量管理器主机名。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
usageState	指示应用是否已超过其配额使用情况的状态。 只读。 注意：此属性不会序列化。 它只能由服务器填充。
virtualNetworkSubnetId	要通过区域 VNET 集成加入的虚拟网络和子网的 Azure 资源管理器 ID。 这必须采用 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

继承属性

id	资源 ID。注意：此属性不会序列化。 它只能由服务器填充。
kind	资源类型。
name	资源名称。 注意：此属性不会序列化。 它只能由服务器填充。
type	资源类型。 注意：此属性不会序列化。 它只能由服务器填充。

属性详细信息

availabilityState

应用的管理信息可用性状态。 注意：此属性不会序列化。 它只能由服务器填充。

availabilityState?: SiteAvailabilityState

属性值

SiteAvailabilityState

clientAffinityEnabled

true 启用客户端相关性;false 停止发送会话关联 Cookie，这会将同一会话中的客户端请求路由到同一实例。 默认值为 true。

clientAffinityEnabled?: 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

验证分配给应用的自定义域的唯一标识符。 客户会将此 ID 添加到 txt 记录进行验证。

customDomainVerificationId?: string

属性值

string

dailyMemoryTimeQuota

每日允许的最大内存时间配额（仅适用于动态应用）。

dailyMemoryTimeQuota?: number

属性值

number

defaultHostName

应用的默认主机名。 只读。 注意：此属性不会序列化。 它只能由服务器填充。

defaultHostName?: string

属性值

string

dnsConfiguration

用于为站点配置各种 DNS 相关设置的属性。

dnsConfiguration?: SiteDnsConfig

属性值

SiteDnsConfig

enabled

如果启用应用，true;否则，false。 将此值设置为 false 会禁用应用（使应用脱机）。

enabled?: boolean

属性值

boolean

enabledHostNames

为应用启用了主机名。需要分配主机名（请参阅主机名）并启用。 否则，不会在这些主机名上提供应用。 注意：此属性不会序列化。 它只能由服务器填充。

enabledHostNames?: string[]

属性值

string[]

hostingEnvironmentProfile

要用于应用的应用服务环境。

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

如果此站点具有挂起的操作，则指定操作 ID。 注意：此属性不会序列化。 它只能由服务器填充。

inProgressOperationId?: string

属性值

string

isDefaultContainer

如果应用是默认容器，则 true;否则，false。 注意：此属性不会序列化。 它只能由服务器填充。

isDefaultContainer?: boolean

属性值

boolean

isXenon

已过时：Hyper-V 沙盒。

isXenon?: boolean

属性值

boolean

keyVaultReferenceIdentity

用于 Key Vault 参考身份验证的标识。

keyVaultReferenceIdentity?: string

属性值

string

lastModifiedTimeUtc

上次修改应用的时间（UTC）。 只读。 注意：此属性不会序列化。 它只能由服务器填充。

lastModifiedTimeUtc?: Date

属性值

Date

maxNumberOfWorkers

最大辅助角色数。 这仅适用于 Functions 容器。 注意：此属性不会序列化。 它只能由服务器填充。

maxNumberOfWorkers?: number

属性值

number

outboundIpAddresses

应用用于出站连接的 IP 地址列表（例如数据库访问）。 包括可以使用当前设置托管站点的租户中的 VIP。 只读。 注意：此属性不会序列化。 它只能由服务器填充。

outboundIpAddresses?: string

属性值

string

possibleOutboundIpAddresses

应用用于出站连接的 IP 地址列表（例如数据库访问）。 包括除 dataComponent 以外的所有租户的 VIP。 只读。 注意：此属性不会序列化。 它只能由服务器填充。

possibleOutboundIpAddresses?: string

属性值

string

redundancyMode

站点冗余模式

redundancyMode?: RedundancyMode

属性值

RedundancyMode

repositorySiteName

存储库站点的名称。 注意：此属性不会序列化。 它只能由服务器填充。

repositorySiteName?: string

属性值

string

reserved

如果保留，则为 true;否则，false。

reserved?: boolean

属性值

boolean

resourceGroup

应用所属的资源组的名称。 只读。 注意：此属性不会序列化。 它只能由服务器填充。

resourceGroup?: string

属性值

string

scmSiteAlsoStopped

true 停止应用时停止 SCM （KUDU） 站点;否则，false。 默认值为 false。

scmSiteAlsoStopped?: boolean

属性值

boolean

serverFarmId

关联的应用服务计划的资源 ID，格式为：“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。

serverFarmId?: string

属性值

string

siteConfig

应用的配置。

siteConfig?: SiteConfig

属性值

SiteConfig

slotSwapStatus

上次部署槽交换操作的状态。 注意：此属性不会序列化。 它只能由服务器填充。

slotSwapStatus?: SlotSwapStatus

属性值

SlotSwapStatus

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 资源管理器 ID。 这必须采用 /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}

virtualNetworkSubnetId?: string

属性值

string

继承属性详细信息

id

资源 ID。注意：此属性不会序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自ProxyOnlyResource.id 的

kind

资源类型。

kind?: string

属性值

string

继承自ProxyOnlyResource.kind

name

资源名称。 注意：此属性不会序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自ProxyOnlyResource.name 的

type

资源类型。 注意：此属性不会序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自ProxyOnlyResource.type