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

Web Apps - Get Configuration Slot

服务:

App Service

API 版本:

2023-12-01

获取应用配置的说明，例如平台版本和位数、默认文档、虚拟应用程序Always On等。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web?api-version=2023-12-01

URI 参数

名称	在	必需	类型	说明
name	path	True	string	应用的名称。
resourceGroupName	path	True	string	资源所属的资源组的名称。 正则表达式模式: ^[-\w\._\(\)]+[^\.]$
slot	path	True	string	部署槽的名称。 如果未指定槽，API 将返回生产槽的配置。
subscriptionId	path	True	string	Azure 订阅 ID。 这是一个 GUID 格式的字符串， (例如 00000000-0000-0000-0000-0000000000000) 。
api-version	query	True	string	API 版本

响应

名称	类型	说明
200 OK	SiteConfigResource	确定
Other Status Codes	DefaultErrorResponse	App 服务错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
user_impersonation	模拟用户帐户

定义

名称	说明
ApiDefinitionInfo	有关应用的正式 API 定义的信息。
ApiManagementConfig	Azure API 管理 (APIM) 链接到应用的配置。
AutoHealActions	触发规则时自动愈合模块要执行的操作。
AutoHealActionType	要执行的预定义操作。
AutoHealCustomAction	触发自动修复规则时要执行的自定义操作。
AutoHealRules	可为自动愈合定义的规则。
AutoHealTriggers	用于自动愈合的触发器。
AzureStorageInfoValue	字典存储Azure 文件存储或 Blob 存储访问信息值。
AzureStorageProtocol	要用于存储帐户的装载协议。
AzureStorageState	存储帐户的状态。
AzureStorageType	存储类型。
ConnectionStringType	数据库的类型。
ConnStringInfo	数据库连接字符串信息。
CorsSettings	跨域资源共享 (CORS) 应用的设置。
DefaultAction	如果未匹配任何规则，则main访问限制的默认操作。
DefaultErrorResponse	App 服务错误响应。
Details
Error	错误模型。
Experiments	生产试验中的路由规则。
FtpsState	FTP/FTPS 服务的状态
HandlerMapping	IIS 处理程序映射，用于定义哪些处理程序使用特定扩展处理 HTTP 请求。 例如，它用于配置 php-cgi.exe 进程，以使用 *.php 扩展处理所有 HTTP 请求。
IpFilterTag	定义此 IP 筛选器的用途。 这是为了支持代理上的 IP 筛选。
IpSecurityRestriction	应用的 IP 安全限制。
ManagedPipelineMode	托管管道模式。
NameValuePair	名称值对。
PushSettings	应用的推送设置。
RampUpRule	用于加速测试的路由规则。 此规则允许将静态流量百分比重定向到槽，或者根据性能逐渐更改路由百分比。
RequestsBasedTrigger	基于请求总数触发。
ScmType	SCM 类型。
SiteConfigResource	Web 应用配置 ARM 资源。
SiteLimits	对应用设置的指标限制。
SiteLoadBalancing	站点负载均衡。
SiteMachineKey	应用的 MachineKey。
SlowRequestsBasedTrigger	基于请求执行时间触发。
StatusCodesBasedTrigger	基于状态代码触发。
StatusCodesRangeBasedTrigger	基于状态代码范围触发。
SupportedTlsVersions	MinTlsVersion：配置 SSL 请求所需的最低 TLS 版本
TlsCipherSuites	应用程序允许的最小强度 TLS 密码套件
VirtualApplication	应用中的虚拟应用程序。
VirtualDirectory	虚拟应用程序的目录。

ApiDefinitionInfo

有关应用的正式 API 定义的信息。

名称	类型	说明
url	string	API 定义的 URL。

ApiManagementConfig

Azure API 管理 (APIM) 链接到应用的配置。

名称	类型	说明
id	string	APIM-Api 标识符。

AutoHealActions

触发规则时自动愈合模块要执行的操作。

名称	类型	说明
actionType	AutoHealActionType	要执行的预定义操作。
customAction	AutoHealCustomAction	要执行的自定义操作。
minProcessExecutionTime	string	执行操作之前进程必须执行的最短时间

AutoHealActionType

要执行的预定义操作。

名称	类型	说明
CustomAction	string
LogEvent	string
Recycle	string

AutoHealCustomAction

触发自动修复规则时要执行的自定义操作。

名称	类型	说明
exe	string	要运行的可执行文件。
parameters	string	可执行文件的参数。

AutoHealRules

可为自动愈合定义的规则。

名称	类型	说明
actions	AutoHealActions	触发规则时要执行的操作。
triggers	AutoHealTriggers	描述何时执行自动愈合操作的条件。

AutoHealTriggers

用于自动愈合的触发器。

名称	类型	说明
privateBytesInKB	integer	基于专用字节的规则。
requests	RequestsBasedTrigger	基于请求总数的规则。
slowRequests	SlowRequestsBasedTrigger	基于请求执行时间的规则。
slowRequestsWithPath	SlowRequestsBasedTrigger[]	基于具有路径的多个慢速请求规则的规则
statusCodes	StatusCodesBasedTrigger[]	基于状态代码的规则。
statusCodesRange	StatusCodesRangeBasedTrigger[]	基于状态代码范围的规则。

AzureStorageInfoValue

字典存储Azure 文件存储或 Blob 存储访问信息值。

名称	类型	说明
accessKey	string	存储帐户的访问密钥。
accountName	string	存储帐户的名称。
mountPath	string	在站点的运行时环境中装载存储的路径。
protocol	AzureStorageProtocol	要用于存储帐户的装载协议。
shareName	string	Blob 存储) 的文件共享 (容器名称。
state	AzureStorageState	存储帐户的状态。
type	AzureStorageType	存储类型。

AzureStorageProtocol

要用于存储帐户的装载协议。

名称	类型	说明
Http	string
Nfs	string
Smb	string

AzureStorageState

存储帐户的状态。

名称	类型	说明
InvalidCredentials	string
InvalidShare	string
NotValidated	string
Ok	string

AzureStorageType

存储类型。

名称	类型	说明
AzureBlob	string
AzureFiles	string

ConnectionStringType

数据库的类型。

名称	类型	说明
ApiHub	string
Custom	string
DocDb	string
EventHub	string
MySql	string
NotificationHub	string
PostgreSQL	string
RedisCache	string
SQLAzure	string
SQLServer	string
ServiceBus	string

ConnStringInfo

数据库连接字符串信息。

名称	类型	说明
connectionString	string	连接字符串值。
name	string	连接字符串的名称。
type	ConnectionStringType	数据库的类型。

CorsSettings

跨域资源共享 (CORS) 应用的设置。

名称	类型	说明
allowedOrigins	string[]	获取或设置应允许 (进行跨域调用的源列表，例如： http://example.com:12345) 。 使用“*”，允许所有来源。
supportCredentials	boolean	获取或设置是否允许具有凭据的 CORS 请求。 有关详细信息，请参阅 https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials 。

DefaultAction

如果未匹配任何规则，则main访问限制的默认操作。

名称	类型	说明
Allow	string
Deny	string

DefaultErrorResponse

App 服务错误响应。

名称	类型	说明
error	Error	错误模型。

Details

名称	类型	说明
code	string	标准化字符串，用于以编程方式标识错误。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Error

错误模型。

名称	类型	说明
code	string	用于以编程方式识别错误的标准化字符串。
details	Details[]	详细错误。
innererror	string	调试错误的详细信息。
message	string	详细的错误说明和调试信息。
target	string	详细的错误说明和调试信息。

Experiments

生产试验中的路由规则。

名称	类型	说明
rampUpRules	RampUpRule[]	加速规则列表。

FtpsState

FTP/FTPS 服务的状态

名称	类型	说明
AllAllowed	string
Disabled	string
FtpsOnly	string

HandlerMapping

IIS 处理程序映射，用于定义哪些处理程序使用特定扩展处理 HTTP 请求。 例如，它用于配置 php-cgi.exe 进程，以使用 *.php 扩展处理所有 HTTP 请求。

名称	类型	说明
arguments	string	要传递给脚本处理器的命令行参数。
extension	string	将使用指定的 FastCGI 应用程序处理具有此扩展的请求。
scriptProcessor	string	FastCGI 应用程序的绝对路径。

IpFilterTag

定义此 IP 筛选器的用途。 这是为了支持代理上的 IP 筛选。

名称	类型	说明
Default	string
ServiceTag	string
XffProxy	string

IpSecurityRestriction

应用的 IP 安全限制。

名称	类型	说明
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 或空 (默认) ，则允许所有主机 (或缺少) 。 使用序号-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 或空 (默认) ，则允许任何转发的 for 链 (或缺少) 。 如果任何地址 (链中不包括端口号) (逗号分隔) 与 属性定义的 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 筛选器的用途。 这是为了支持代理上的 IP 筛选。
vnetSubnetResourceId	string	虚拟网络资源 ID
vnetTrafficTag	integer	(内部) Vnet 流量标记

ManagedPipelineMode

托管管道模式。

名称	类型	说明
Classic	string
Integrated	string

NameValuePair

名称值对。

名称	类型	说明
name	string	对名称。
value	string	对值。

PushSettings

应用的推送设置。

名称	类型	说明
id	string	资源 ID。
kind	string	资源类型。
name	string	资源名称。
properties.dynamicTagsJson	string	获取或设置一个 JSON 字符串，其中包含将从推送注册终结点中的用户声明评估的动态标记列表。
properties.isPushEnabled	boolean	获取或设置一个标志，指示是否启用推送终结点。
properties.tagWhitelistJson	string	获取或设置一个 JSON 字符串，其中包含允许列表供推送注册终结点使用的标记列表。
properties.tagsRequiringAuth	string	获取或设置一个 JSON 字符串，其中包含需要在推送注册终结点中使用用户身份验证的标记列表。 标记可以包含字母数字字符和以下字符：“_”、“@”、“#”、“.”、“：”、“-”。 应在 PushRequestHandler 中执行验证。
type	string	资源类型。

RampUpRule

用于加速测试的路由规则。 此规则允许将静态流量百分比重定向到槽，或者根据性能逐渐更改路由百分比。

名称	类型	说明
actionHostName	string	流量将重定向到的槽的主机名（如果确定）。 例如，myapp-stage.azurewebsites.net。
changeDecisionCallbackUrl	string	可以在 TiPCallback 站点扩展中提供可指定 URL 的自定义决策算法。 有关基架和合同，请参阅 TiPCallback 站点扩展。 https://www.siteextensions.net/packages/TiPCallback/
changeIntervalInMinutes	integer	指定重新计算 ReroutePercentage 的间隔（以分钟为单位）。
changeStep	number	在自动加速方案中，这是从 ReroutePercentage 中添加/删除的步骤，直到达到 \nMinReroutePercentage 或 MaxReroutePercentage。 每隔 N 分钟 ChangeIntervalInMinutes检查一次站点指标。\n可以在 TiPCallback 站点扩展中提供自定义决策算法，该 URL 可在 中 ChangeDecisionCallbackUrl指定。
maxReroutePercentage	number	指定 ReroutePercentage 将保留的上限。
minReroutePercentage	number	指定 ReroutePercentage 将保留的下限。
name	string	路由规则的名称。 建议的名称是指向将在试验中接收流量的槽。
reroutePercentage	number	将重定向到 ActionHostName的流量的百分比。

RequestsBasedTrigger

基于请求总数触发。

名称	类型	说明
count	integer	请求计数。
timeInterval	string	时间间隔。

ScmType

SCM 类型。

名称	类型	说明
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

SiteConfigResource

Web 应用配置 ARM 资源。

名称	类型	默认值	说明
id	string		资源 ID。
kind	string		资源类型。
name	string		资源名称。
properties.acrUseManagedIdentityCreds	boolean		使用托管标识 Creds 进行 ACR 拉取的标志
properties.acrUserManagedIdentityID	string		如果使用用户托管标识，则为用户托管标识 ClientId
properties.alwaysOn	boolean		true如果启用Always On，则为 ;否则为 false。
properties.apiDefinition	ApiDefinitionInfo		有关应用的正式 API 定义的信息。
properties.apiManagementConfig	ApiManagementConfig		链接到应用的 Azure API 管理设置。
properties.appCommandLine	string		要启动的应用命令行。
properties.appSettings	NameValuePair[]		应用程序设置。
properties.autoHealEnabled	boolean		true 如果启用自动愈合，则为 ;否则为 false。
properties.autoHealRules	AutoHealRules		自动愈合规则。
properties.autoSwapSlotName	string		自动交换槽名称。
properties.azureStorageAccounts	<string,  AzureStorageInfoValue>		Azure 存储帐户列表。
properties.connectionStrings	ConnStringInfo[]		连接字符串。
properties.cors	CorsSettings		跨域资源共享 (CORS) 设置。
properties.defaultDocuments	string[]		默认文档。
properties.detailedErrorLoggingEnabled	boolean		true 如果启用了详细错误日志记录，则为 ;否则为 false。
properties.documentRoot	string		文档根目录。
properties.elasticWebAppScaleLimit	integer		站点可以横向扩展到的最大辅助角色数。 此设置仅适用于 ElasticScaleEnabled 为 的计划中的应用 true
properties.experiments	Experiments		这是多态类型的解决方法。
properties.ftpsState	FtpsState		FTP/FTPS 服务的状态
properties.functionAppScaleLimit	integer		站点可以横向扩展到的最大辅助角色数。 此设置仅适用于消耗和弹性高级计划
properties.functionsRuntimeScaleMonitoringEnabled	boolean		获取或设置一个值，该值指示是否启用函数运行时规模监视。 启用后，ScaleController 不会直接监视事件源，而是调用运行时以获取缩放状态。
properties.handlerMappings	HandlerMapping[]		处理程序映射。
properties.healthCheckPath	string		运行状况检查路径
properties.http20Enabled	boolean	True	Http20Enabled：配置网站以允许客户端通过 http2.0 进行连接
properties.httpLoggingEnabled	boolean		true 如果启用了 HTTP 日志记录，则为 ;否则为 false。
properties.ipSecurityRestrictions	IpSecurityRestriction[]		main的 IP 安全限制。
properties.ipSecurityRestrictionsDefaultAction	DefaultAction		如果未匹配任何规则，则main访问限制的默认操作。
properties.javaContainer	string		Java 容器。
properties.javaContainerVersion	string		Java 容器版本。
properties.javaVersion	string		Java 版本。
properties.keyVaultReferenceIdentity	string		用于密钥保管库参考身份验证的标识。
properties.limits	SiteLimits		网站限制。
properties.linuxFxVersion	string		Linux 应用框架和版本
properties.loadBalancing	SiteLoadBalancing		站点负载均衡。
properties.localMySqlEnabled	boolean	False	true 启用本地 MySQL;否则为 false。
properties.logsDirectorySizeLimit	integer		HTTP 日志目录大小限制。
properties.machineKey	SiteMachineKey		Site MachineKey。
properties.managedPipelineMode	ManagedPipelineMode		托管管道模式。
properties.managedServiceIdentityId	integer		托管服务标识 ID
properties.metadata	NameValuePair[]		应用程序元数据。 无法检索此属性，因为它可能包含机密。
properties.minTlsCipherSuite	TlsCipherSuites		应用程序允许的最低强度 TLS 密码套件
properties.minTlsVersion	SupportedTlsVersions		MinTlsVersion：配置 SSL 请求所需的最低 TLS 版本
properties.minimumElasticInstanceCount	integer		站点的最小实例计数 此设置仅适用于弹性计划
properties.netFrameworkVersion	string	v4.6	.NET Framework版本。
properties.nodeVersion	string		Node.js 的版本。
properties.numberOfWorkers	integer		工作线程数。
properties.phpVersion	string		PHP 的版本。
properties.powerShellVersion	string		PowerShell 的版本。
properties.preWarmedInstanceCount	integer		预热实例数。 此设置仅适用于消耗和弹性计划
properties.publicNetworkAccess	string		允许或阻止所有公共流量的属性。
properties.publishingUsername	string		发布用户名。
properties.push	PushSettings		推送终结点设置。
properties.pythonVersion	string		Python 版本。
properties.remoteDebuggingEnabled	boolean		true 如果启用了远程调试，则为 ;否则为 false。
properties.remoteDebuggingVersion	string		远程调试版本。
properties.requestTracingEnabled	boolean		true 如果启用了请求跟踪，则为 ;否则为 false。
properties.requestTracingExpirationTime	string		请求跟踪过期时间。
properties.scmIpSecurityRestrictions	IpSecurityRestriction[]		scm 的 IP 安全限制。
properties.scmIpSecurityRestrictionsDefaultAction	DefaultAction		如果未匹配任何规则，则 scm 访问限制的默认操作。
properties.scmIpSecurityRestrictionsUseMain	boolean		scm 使用main的 IP 安全限制。
properties.scmMinTlsVersion	SupportedTlsVersions		ScmMinTlsVersion：配置 SCM 站点的 SSL 请求所需的最低 TLS 版本
properties.scmType	ScmType		SCM 类型。
properties.tracingOptions	string		跟踪选项。
properties.use32BitWorkerProcess	boolean		true 使用 32 位工作进程;否则为 false。
properties.virtualApplications	VirtualApplication[]		虚拟应用程序。
properties.vnetName	string		虚拟网络名称。
properties.vnetPrivatePortsCount	integer		分配给此应用的专用端口数。 这些将在运行时动态分配。
properties.vnetRouteAllEnabled	boolean		虚拟网络“全部路由”已启用。 这会导致所有出站流量都应用虚拟网络安全组和用户定义的路由。
properties.webSocketsEnabled	boolean		true 如果启用了 WebSocket，则为 ;否则为 false。
properties.websiteTimeZone	string		设置站点用于生成时间戳的时区。 与 Linux 和 Windows App 服务兼容。 设置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 下列出的时区之一
properties.windowsFxVersion	string		Xenon 应用框架和版本
properties.xManagedServiceIdentityId	integer		显式托管服务标识 ID
type	string		资源类型。

SiteLimits

对应用设置的指标限制。

名称	类型	说明
maxDiskSizeInMb	integer	允许的最大磁盘大小使用量（以 MB 为单位）。
maxMemoryInMb	integer	允许的最大内存使用量（以 MB 为单位）。
maxPercentageCpu	number	允许的最大 CPU 使用率百分比。

SiteLoadBalancing

站点负载均衡。

名称	类型	说明
LeastRequests	string
LeastResponseTime	string
PerSiteRoundRobin	string
RequestHash	string
WeightedRoundRobin	string
WeightedTotalTraffic	string

SiteMachineKey

应用的 MachineKey。

名称	类型	说明
decryption	string	用于解密的算法。
decryptionKey	string	解密密钥。
validation	string	MachineKey 验证。
validationKey	string	验证密钥。

SlowRequestsBasedTrigger

基于请求执行时间触发。

名称	类型	说明
count	integer	请求计数。
path	string	请求路径。
timeInterval	string	时间间隔。
timeTaken	string	花费的时间。

StatusCodesBasedTrigger

基于状态代码触发。

名称	类型	说明
count	integer	请求计数。
path	string	请求路径
status	integer	HTTP 状态代码。
subStatus	integer	请求子状态。
timeInterval	string	时间间隔。
win32Status	integer	Win32 错误代码。

StatusCodesRangeBasedTrigger

基于状态代码范围触发。

名称	类型	说明
count	integer	请求计数。
path	string
statusCodes	string	HTTP 状态代码。
timeInterval	string	时间间隔。

SupportedTlsVersions

MinTlsVersion：配置 SSL 请求所需的最低 TLS 版本

名称	类型	说明
1.0	string
1.1	string
1.2	string
1.3	string

TlsCipherSuites

应用程序允许的最小强度 TLS 密码套件

名称	类型	说明
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

VirtualApplication

应用中的虚拟应用程序。

名称	类型	说明
physicalPath	string	物理路径。
preloadEnabled	boolean	true 如果启用了预加载，则为 ;否则为 false。
virtualDirectories	VirtualDirectory[]	虚拟应用程序的虚拟目录。
virtualPath	string	虚拟路径。

VirtualDirectory

虚拟应用程序的目录。

名称	类型	说明
physicalPath	string	物理路径。
virtualPath	string	虚拟应用程序的路径。