你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Web Apps - Get
获取 Web、移动或 API 应用的详细信息的说明。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}?api-version=2023-12-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
name
|
path | True |
string |
应用的名称。 |
resource
|
path | True |
string |
资源所属的资源组的名称。 正则表达式模式: |
subscription
|
path | True |
string |
Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。 |
api-version
|
query | True |
string |
API 版本 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
没问题。 |
|
404 Not Found |
未找到。 |
|
Other Status Codes |
App 服务错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
类型:
oauth2
流向:
implicit
授权 URL:
https://login.microsoftonline.com/common/oauth2/authorize
作用域
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Get Web App
示例请求
示例响应
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141",
"name": "sitef6141",
"type": "Microsoft.Web/sites",
"kind": "app",
"location": "East US",
"properties": {
"state": "Running",
"hostNames": [
"sitef6141.azurewebsites.net"
],
"repositorySiteName": "sitef6141",
"usageState": "Normal",
"enabled": true,
"enabledHostNames": [
"sitef6141.azurewebsites.net",
"sitef6141.scm.azurewebsites.net"
],
"availabilityState": "Normal",
"hostNameSslStates": [
{
"name": "sitef6141.azurewebsites.net",
"sslState": "Disabled",
"hostType": "Standard"
},
{
"name": "sitef6141.scm.azurewebsites.net",
"sslState": "Disabled",
"hostType": "Repository"
}
],
"serverFarmId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/DefaultAsp",
"reserved": false,
"isXenon": false,
"hyperV": false,
"lastModifiedTimeUtc": "2020-03-04T17:33:11.641Z",
"vnetRouteAllEnabled": false,
"vnetImagePullEnabled": false,
"vnetContentShareEnabled": false,
"siteConfig": {
"numberOfWorkers": 1,
"defaultDocuments": [
"Default.htm",
"Default.html",
"Default.asp",
"index.htm",
"index.html",
"iisstart.htm",
"default.aspx",
"index.php",
"hostingstart.html"
],
"netFrameworkVersion": "v4.0",
"phpVersion": "5.6",
"pythonVersion": "",
"nodeVersion": "",
"powerShellVersion": "",
"linuxFxVersion": "",
"requestTracingEnabled": false,
"remoteDebuggingEnabled": false,
"httpLoggingEnabled": false,
"acrUseManagedIdentityCreds": false,
"logsDirectorySizeLimit": 35,
"detailedErrorLoggingEnabled": false,
"use32BitWorkerProcess": true,
"webSocketsEnabled": false,
"alwaysOn": false,
"appCommandLine": "",
"managedPipelineMode": "Integrated",
"virtualApplications": [
{
"virtualPath": "/",
"physicalPath": "site\\wwwroot",
"preloadEnabled": false
}
],
"loadBalancing": "LeastRequests",
"autoHealEnabled": false,
"vnetName": "",
"vnetRouteAllEnabled": false,
"vnetPrivatePortsCount": 0,
"http20Enabled": false,
"minTlsVersion": "1.2",
"scmMinTlsVersion": "1.2",
"ftpsState": "AllAllowed",
"functionAppScaleLimit": 0,
"functionsRuntimeScaleMonitoringEnabled": false,
"minimumElasticInstanceCount": 0,
"azureStorageAccounts": {}
},
"scmSiteAlsoStopped": false,
"clientAffinityEnabled": true,
"clientCertEnabled": false,
"clientCertMode": "Required",
"hostNamesDisabled": false,
"customDomainVerificationId": "7F3BB652450EF7AD0B6AA33064586E4A9CE823A46DF0B2EC6443A68086E84153",
"outboundIpAddresses": "70.37.102.201,20.225.43.144",
"possibleOutboundIpAddresses": "70.37.102.201,20.225.43.144,20.225.184.122,20.225.184.188",
"containerSize": 0,
"dailyMemoryTimeQuota": 0,
"resourceGroup": "testrg123",
"defaultHostName": "sitef6141.azurewebsites.net",
"httpsOnly": false,
"redundancyMode": "None",
"storageAccountRequired": false,
"keyVaultReferenceIdentity": "SystemAssigned",
"workloadProfileName": "myd4wp",
"resourceConfig": {
"cpu": 1,
"memory": "2.0Gi"
}
}
}
定义
名称 | 说明 |
---|---|
Api |
有关应用的正式 API 定义的信息。 |
Api |
Azure API 管理 (APIM) 链接到应用的配置。 |
Authentication |
用于访问用于部署的存储帐户的身份验证方法。 |
Authentication |
用于选择用于访问所选存储帐户的身份验证类型的属性。 可用选项:SystemAssignedIdentity、UserAssignedIdentity、StorageAccountConnectionString。 |
Auto |
触发规则时自动愈合模块要执行的操作。 |
Auto |
要执行的预定义操作。 |
Auto |
触发自动修复规则时要执行的自定义操作。 |
Auto |
可为自动愈合定义的规则。 |
Auto |
自动愈合的触发器。 |
Azure |
字典存储Azure 文件存储或 Blob 存储访问信息值。 |
Azure |
要用于存储帐户的装载协议。 |
Azure |
存储帐户的状态。 |
Azure |
存储类型。 |
Client |
这由 ClientCertEnabled 设置组成。
|
Cloning |
克隆操作所需的信息。 |
Connection |
数据库的类型。 |
Conn |
数据库连接字符串信息。 |
Cors |
跨域资源共享 (CORS) 应用的设置。 |
Dapr |
应用 Dapr 配置。 |
dapr |
设置 Dapr 挎斗的日志级别。 允许的值为 debug、info、warn、error。 默认值为信息。 |
Default |
如果未匹配任何规则,则main访问限制的默认操作。 |
Default |
App 服务错误响应。 |
Details | |
Error |
错误模型。 |
Experiments |
生产试验中的路由规则。 |
Extended |
扩展位置。 |
Ftps |
FTP/FTPS 服务的状态 |
Function |
函数应用配置。 |
Functions |
设置函数组或特定函数的“Always Ready”实例数。 |
Functions |
函数应用部署的配置部分。 |
Functions |
用于选择 Azure 存储类型的属性。 可用选项:blobContainer。 |
Functions |
函数应用运行时名称和版本。 |
Functions |
函数应用的缩放和并发设置。 |
Handler |
IIS 处理程序映射,用于定义哪个处理程序使用特定扩展处理 HTTP 请求。 例如,它用于配置 php-cgi.exe 进程以使用 *.php 扩展名处理所有 HTTP 请求。 |
Hosting |
要用于此资源的应用服务环境的规范。 |
Host |
已启用 SSL 的主机名。 |
Host |
指示主机名是标准主机名还是存储库主机名。 |
Http |
HTTP 触发器的缩放和并发设置。 |
Ip |
定义此 IP 筛选器的用途。 这是为了支持代理上的 IP 筛选。 |
Ip |
应用的 IP 安全限制。 |
Managed |
托管管道模式。 |
Managed |
托管服务标识。 |
Managed |
托管服务标识的类型。 |
Name |
名称值对。 |
Push |
应用的推送设置。 |
Ramp |
用于加速测试的路由规则。 此规则允许将静态流量百分比重定向到槽,或者根据性能逐渐更改路由百分比。 |
Redundancy |
站点冗余模式 |
Requests |
基于请求总数触发。 |
Resource |
函数应用资源要求。 |
Runtime |
函数应用运行时名称。 可用选项:dotnet-isolated、node、java、powershell、python、自定义 |
Scm |
SCM 类型。 |
Site |
Web 应用、移动应用后端或 API 应用。 |
Site |
应用的管理信息可用性状态。 |
Site |
App 服务应用的配置。 |
Site |
|
Site |
对应用设置的指标限制。 |
Site |
站点负载均衡。 |
Site |
应用的 MachineKey。 |
Slot |
上次成功的槽交换操作的状态。 |
Slow |
基于请求执行时间触发。 |
Ssl |
SSL 类型 |
Status |
基于状态代码触发。 |
Status |
基于状态代码范围触发。 |
Storage |
函数应用使用的已部署包的存储。 |
Supported |
MinTlsVersion:配置 SSL 请求所需的最低 TLS 版本 |
Tls |
应用程序允许的最小强度 TLS 密码套件 |
Triggers |
函数应用触发器的缩放和并发设置。 |
Usage |
指示应用是否已超出其配额使用情况的状态。 只读。 |
user |
用户分配的标识。 |
Virtual |
应用中的虚拟应用程序。 |
Virtual |
虚拟应用程序的目录。 |
ApiDefinitionInfo
有关应用的正式 API 定义的信息。
名称 | 类型 | 说明 |
---|---|---|
url |
string |
API 定义的 URL。 |
ApiManagementConfig
Azure API 管理 (APIM) 链接到应用的配置。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
APIM-Api 标识符。 |
Authentication
用于访问用于部署的存储帐户的身份验证方法。
名称 | 类型 | 说明 |
---|---|---|
storageAccountConnectionStringName |
string |
将此属性用于 StorageAccountConnectionString。 设置具有存储帐户连接字符串的应用设置的名称。 使用其他身份验证类型时,请勿为此属性设置值。 |
type |
用于选择用于访问所选存储帐户的身份验证类型的属性。 可用选项:SystemAssignedIdentity、UserAssignedIdentity、StorageAccountConnectionString。 |
|
userAssignedIdentityResourceId |
string |
将此属性用于 UserAssignedIdentity。 设置标识的资源 ID。 使用其他身份验证类型时,请勿为此属性设置值。 |
AuthenticationType
用于选择用于访问所选存储帐户的身份验证类型的属性。 可用选项:SystemAssignedIdentity、UserAssignedIdentity、StorageAccountConnectionString。
名称 | 类型 | 说明 |
---|---|---|
StorageAccountConnectionString |
string |
|
SystemAssignedIdentity |
string |
|
UserAssignedIdentity |
string |
AutoHealActions
触发规则时自动愈合模块要执行的操作。
名称 | 类型 | 说明 |
---|---|---|
actionType |
要执行的预定义操作。 |
|
customAction |
要执行的自定义操作。 |
|
minProcessExecutionTime |
string |
执行操作之前进程必须执行的最短时间 |
AutoHealActionType
要执行的预定义操作。
名称 | 类型 | 说明 |
---|---|---|
CustomAction |
string |
|
LogEvent |
string |
|
Recycle |
string |
AutoHealCustomAction
触发自动修复规则时要执行的自定义操作。
名称 | 类型 | 说明 |
---|---|---|
exe |
string |
要运行的可执行文件。 |
parameters |
string |
可执行文件的参数。 |
AutoHealRules
可为自动愈合定义的规则。
名称 | 类型 | 说明 |
---|---|---|
actions |
触发规则时要执行的操作。 |
|
triggers |
描述何时执行自动愈合操作的条件。 |
AutoHealTriggers
自动愈合的触发器。
名称 | 类型 | 说明 |
---|---|---|
privateBytesInKB |
integer |
基于专用字节的规则。 |
requests |
基于请求总数的规则。 |
|
slowRequests |
基于请求执行时间的规则。 |
|
slowRequestsWithPath |
基于具有路径的多个慢速请求规则的规则 |
|
statusCodes |
基于状态代码的规则。 |
|
statusCodesRange |
基于状态代码范围的规则。 |
AzureStorageInfoValue
字典存储Azure 文件存储或 Blob 存储访问信息值。
名称 | 类型 | 说明 |
---|---|---|
accessKey |
string |
存储帐户的访问密钥。 |
accountName |
string |
存储帐户的名称。 |
mountPath |
string |
在站点的运行时环境中装载存储的路径。 |
protocol |
要用于存储帐户的装载协议。 |
|
shareName |
string |
Blob 存储) 的文件共享 (容器名称。 |
state |
存储帐户的状态。 |
|
type |
存储类型。 |
AzureStorageProtocol
要用于存储帐户的装载协议。
名称 | 类型 | 说明 |
---|---|---|
Http |
string |
|
Nfs |
string |
|
Smb |
string |
AzureStorageState
存储帐户的状态。
名称 | 类型 | 说明 |
---|---|---|
InvalidCredentials |
string |
|
InvalidShare |
string |
|
NotValidated |
string |
|
Ok |
string |
AzureStorageType
存储类型。
名称 | 类型 | 说明 |
---|---|---|
AzureBlob |
string |
|
AzureFiles |
string |
ClientCertMode
这由 ClientCertEnabled 设置组成。
- ClientCertEnabled:false 表示忽略 ClientCert。
- ClientCertEnabled: true 和 ClientCertMode: Required 表示 ClientCert 是必需的。
- ClientCertEnabled: true 和 ClientCertMode: Optional 表示 ClientCert 为可选或已接受。
名称 | 类型 | 说明 |
---|---|---|
Optional |
string |
|
OptionalInteractiveUser |
string |
|
Required |
string |
CloningInfo
克隆操作所需的信息。
名称 | 类型 | 说明 |
---|---|---|
appSettingsOverrides |
object |
克隆应用的应用程序设置替代。 如果指定,这些设置将替代从源应用克隆的设置。 否则,将保留源应用中的应用程序设置。 |
cloneCustomHostNames |
boolean |
|
cloneSourceControl |
boolean |
|
configureLoadBalancing |
boolean |
|
correlationId |
string |
克隆操作的相关 ID。 此 ID 将多个克隆操作绑定在一起以使用相同的快照。 |
hostingEnvironment |
string |
应用服务环境。 |
overwrite |
boolean |
|
sourceWebAppId |
string |
源应用的 ARM 资源 ID。 对于生产槽,应用资源 ID 的格式为 /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 资源 ID(如果存在)。 流量管理器资源 ID 的格式为 /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}。 |
trafficManagerProfileName |
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 |
数据库的类型。 |
CorsSettings
跨域资源共享 (CORS) 应用的设置。
名称 | 类型 | 说明 |
---|---|---|
allowedOrigins |
string[] |
获取或设置应允许 (进行跨域调用的源列表,例如: http://example.com:12345) 。 使用“*”,允许所有来源。 |
supportCredentials |
boolean |
获取或设置是否允许具有凭据的 CORS 请求。 有关详细信息,请参阅 https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials 。 |
DaprConfig
应用 Dapr 配置。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
appId |
string |
Dapr 应用程序标识符 |
|
appPort |
integer |
告知 Dapr 应用程序正在侦听哪个端口 |
|
enableApiLogging |
boolean |
为 Dapr 挎斗启用 API 日志记录 |
|
enabled |
boolean |
False |
指示是否启用 Dapr 侧车的布尔值 |
httpMaxRequestSize |
integer |
增加请求正文 http 服务器参数的最大大小(以 MB 为单位)以处理大文件的上传。 默认值为 4 MB。 |
|
httpReadBufferSize |
integer |
发送多 KB 标头时要处理的 http 标头读取缓冲区的最大 Dapr 大小(以 KB 为单位)。 默认值为 65KB。 |
|
logLevel |
设置 Dapr 挎斗的日志级别。 允许的值为 debug、info、warn、error。 默认值为 info。 |
daprLogLevel
设置 Dapr 挎斗的日志级别。 允许的值为 debug、info、warn、error。 默认值为信息。
名称 | 类型 | 说明 |
---|---|---|
debug |
string |
|
error |
string |
|
info |
string |
|
warn |
string |
DefaultAction
如果未匹配任何规则,则main访问限制的默认操作。
名称 | 类型 | 说明 |
---|---|---|
Allow |
string |
|
Deny |
string |
DefaultErrorResponse
App 服务错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误模型。 |
Details
名称 | 类型 | 说明 |
---|---|---|
code |
string |
用于以编程方式识别错误的标准化字符串。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
Error
错误模型。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
标准化字符串,用于以编程方式标识错误。 |
details |
Details[] |
详细错误。 |
innererror |
string |
调试错误的详细信息。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
Experiments
生产试验中的路由规则。
名称 | 类型 | 说明 |
---|---|---|
rampUpRules |
增加规则的列表。 |
ExtendedLocation
扩展位置。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
扩展位置的名称。 |
type |
string |
扩展位置的类型。 |
FtpsState
FTP/FTPS 服务的状态
名称 | 类型 | 说明 |
---|---|---|
AllAllowed |
string |
|
Disabled |
string |
|
FtpsOnly |
string |
FunctionAppConfig
函数应用配置。
名称 | 类型 | 说明 |
---|---|---|
deployment |
函数应用部署配置。 |
|
runtime |
函数应用运行时设置。 |
|
scaleAndConcurrency |
函数应用缩放和并发设置。 |
FunctionsAlwaysReadyConfig
设置函数组或特定函数的“Always Ready”实例数。
名称 | 类型 | 说明 |
---|---|---|
instanceCount |
integer |
设置给定函数组或特定函数的“Always Ready”实例数。 有关其他信息,请参见 https://aka.ms/flexconsumption/alwaysready。 |
name |
string |
需要函数组或函数名称。 有关其他信息,请参见 https://aka.ms/flexconsumption/alwaysready。 |
FunctionsDeployment
函数应用部署的配置部分。
名称 | 类型 | 说明 |
---|---|---|
storage |
函数应用使用的已部署包的存储。 |
FunctionsDeploymentStorageType
用于选择 Azure 存储类型的属性。 可用选项:blobContainer。
名称 | 类型 | 说明 |
---|---|---|
blobContainer |
string |
FunctionsRuntime
函数应用运行时名称和版本。
名称 | 类型 | 说明 |
---|---|---|
name |
函数应用运行时名称。 可用选项:dotnet-isolated、node、java、powershell、python、自定义 |
|
version |
string |
函数应用运行时版本。 示例:8 个 (用于 dotnet 隔离) |
FunctionsScaleAndConcurrency
函数应用的缩放和并发设置。
名称 | 类型 | 说明 |
---|---|---|
alwaysReady |
函数应用的“Always Ready”配置。 |
|
instanceMemoryMB |
integer |
设置分配给函数应用的每个实例的内存量(以 MB 为单位)。 CPU 和网络带宽按比例分配。 |
maximumInstanceCount |
integer |
函数应用的最大实例数。 |
triggers |
函数应用触发器的缩放和并发设置。 |
HandlerMapping
IIS 处理程序映射,用于定义哪个处理程序使用特定扩展处理 HTTP 请求。 例如,它用于配置 php-cgi.exe 进程以使用 *.php 扩展名处理所有 HTTP 请求。
名称 | 类型 | 说明 |
---|---|---|
arguments |
string |
要传递给脚本处理器的命令行参数。 |
extension |
string |
使用此扩展的请求将使用指定的 FastCGI 应用程序进行处理。 |
scriptProcessor |
string |
FastCGI 应用程序的绝对路径。 |
HostingEnvironmentProfile
要用于此资源的应用服务环境的规范。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
应用服务环境的资源 ID。 |
name |
string |
应用服务环境的名称。 |
type |
string |
应用服务环境的资源类型。 |
HostNameSslState
已启用 SSL 的主机名。
名称 | 类型 | 说明 |
---|---|---|
hostType |
指示主机名是标准主机名还是存储库主机名。 |
|
name |
string |
主机名 |
sslState |
SSL 类型。 |
|
thumbprint |
string |
SSL 证书指纹。 |
toUpdate |
boolean |
|
virtualIP |
string |
如果启用了基于 IP 的 SSL,则分配给主机名的虚拟 IP 地址。 |
HostType
指示主机名是标准主机名还是存储库主机名。
名称 | 类型 | 说明 |
---|---|---|
Repository |
string |
|
Standard |
string |
Http
HTTP 触发器的缩放和并发设置。
名称 | 类型 | 说明 |
---|---|---|
perInstanceConcurrency |
integer |
每个实例的最大并发 HTTP 触发器调用数。 |
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) 。 匹配的逻辑为 。
X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples) 。 匹配的逻辑为 。
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 |
定义此 IP 筛选器的用途。 这是为了支持代理上的 IP 筛选。 |
|
vnetSubnetResourceId |
string |
虚拟网络资源 ID |
vnetTrafficTag |
integer |
(内部) Vnet 流量标记 |
ManagedPipelineMode
托管管道模式。
名称 | 类型 | 说明 |
---|---|---|
Classic |
string |
|
Integrated |
string |
ManagedServiceIdentity
托管服务标识。
名称 | 类型 | 说明 |
---|---|---|
principalId |
string |
托管服务标识的主体 ID。 |
tenantId |
string |
托管服务标识的租户。 |
type |
托管服务标识的类型。 |
|
userAssignedIdentities |
<string,
user |
与资源关联的用户分配标识的列表。 用户标识字典密钥引用将是采用以下格式的 ARM 资源 ID:'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} |
ManagedServiceIdentityType
托管服务标识的类型。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
SystemAssigned |
string |
|
SystemAssigned, UserAssigned |
string |
|
UserAssigned |
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 |
在自动加速方案中,这是从 |
maxReroutePercentage |
number |
指定 ReroutePercentage 将保留的上边界。 |
minReroutePercentage |
number |
指定 ReroutePercentage 将保留的下边界。 |
name |
string |
路由规则的名称。 建议的名称是指向将在试验中接收流量的槽。 |
reroutePercentage |
number |
将重定向到 |
RedundancyMode
站点冗余模式
名称 | 类型 | 说明 |
---|---|---|
ActiveActive |
string |
|
Failover |
string |
|
GeoRedundant |
string |
|
Manual |
string |
|
None |
string |
RequestsBasedTrigger
基于请求总数触发。
名称 | 类型 | 说明 |
---|---|---|
count |
integer |
请求计数。 |
timeInterval |
string |
时间间隔。 |
ResourceConfig
函数应用资源要求。
名称 | 类型 | 说明 |
---|---|---|
cpu |
number |
核心中所需的 CPU,例如 0.5 |
memory |
string |
所需内存,例如“1Gi” |
RuntimeName
函数应用运行时名称。 可用选项:dotnet-isolated、node、java、powershell、python、自定义
名称 | 类型 | 说明 |
---|---|---|
custom |
string |
|
dotnet-isolated |
string |
|
java |
string |
|
node |
string |
|
powershell |
string |
|
python |
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 |
Site
Web 应用、移动应用后端或 API 应用。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
extendedLocation |
扩展位置。 |
||
id |
string |
资源 ID。 |
|
identity |
托管服务标识。 |
||
kind |
string |
资源类型。 |
|
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.availabilityState |
应用的管理信息可用性状态。 |
||
properties.clientAffinityEnabled |
boolean |
|
|
properties.clientCertEnabled |
boolean |
|
|
properties.clientCertExclusionPaths |
string |
客户端证书身份验证逗号分隔的排除路径 |
|
properties.clientCertMode |
这由 ClientCertEnabled 设置组成。
|
||
properties.cloningInfo |
如果在应用创建过程中指定,则会从源应用克隆应用。 |
||
properties.containerSize |
integer |
函数容器的大小。 |
|
properties.customDomainVerificationId |
string |
验证分配给应用的自定义域的唯一标识符。 客户会将此 ID 添加到 txt 记录进行验证。 |
|
properties.dailyMemoryTimeQuota |
integer |
每日允许的最大内存时间配额 (仅适用于) 动态应用。 |
|
properties.daprConfig |
应用的 Dapr 配置。 |
||
properties.defaultHostName |
string |
应用的默认主机名。 只读。 |
|
properties.dnsConfiguration |
用于为站点配置各种 DNS 相关设置的属性。 |
||
properties.enabled |
boolean |
|
|
properties.enabledHostNames |
string[] |
为应用启用主机名。需要分配主机名 (请参阅 hostNames) and enabled。 否则,应用不会在这些主机名上提供。 |
|
properties.functionAppConfig |
特定于 Azure 函数应用的配置。 |
||
properties.hostNameSslStates |
主机名 SSL 状态用于管理应用的主机名的 SSL 绑定。 |
||
properties.hostNames |
string[] |
与应用关联的主机名。 |
|
properties.hostNamesDisabled |
boolean |
|
|
properties.hostingEnvironmentProfile |
应用服务环境用于应用。 |
||
properties.httpsOnly |
boolean |
HttpsOnly:将网站配置为仅接受 https 请求。 http 请求重定向的问题 |
|
properties.hyperV |
boolean |
False |
Hyper-V 沙盒。 |
properties.inProgressOperationId |
string |
如果此站点具有挂起的操作,则指定操作 ID。 |
|
properties.isDefaultContainer |
boolean |
|
|
properties.isXenon |
boolean |
False |
已过时:Hyper-V 沙盒。 |
properties.keyVaultReferenceIdentity |
string |
用于密钥保管库参考身份验证的标识。 |
|
properties.lastModifiedTimeUtc |
string |
上次修改应用的时间(UTC)。 只读。 |
|
properties.managedEnvironmentId |
string |
Azure 资源管理器要托管此应用的客户的选定托管环境的 ID。 此格式必须为 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName} |
|
properties.maxNumberOfWorkers |
integer |
最大辅助角色数。 这仅适用于 Functions 容器。 |
|
properties.outboundIpAddresses |
string |
应用用于出站连接的 IP 地址列表 (例如数据库访问) 。 包括来自可以使用当前设置托管站点的租户的 VIP。 只读。 |
|
properties.possibleOutboundIpAddresses |
string |
应用用于出站连接的 IP 地址列表 (例如数据库访问) 。 包括除 dataComponent 之外的所有租户的 VIP。 只读。 |
|
properties.publicNetworkAccess |
string |
允许或阻止所有公共流量的属性。 允许的值:“Enabled”、“Disabled”或空字符串。 |
|
properties.redundancyMode |
站点冗余模式 |
||
properties.repositorySiteName |
string |
存储库站点的名称。 |
|
properties.reserved |
boolean |
False |
|
properties.resourceConfig |
函数应用资源要求。 |
||
properties.resourceGroup |
string |
应用所属的资源组的名称。 只读。 |
|
properties.scmSiteAlsoStopped |
boolean |
False |
|
properties.serverFarmId |
string |
关联的App 服务计划的资源 ID,格式为:“/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}”。 |
|
properties.siteConfig |
应用的配置。 |
||
properties.slotSwapStatus |
上次部署槽交换操作的状态。 |
||
properties.state |
string |
应用的当前状态。 |
|
properties.storageAccountRequired |
boolean |
检查是否需要客户提供的存储帐户 |
|
properties.suspendedTill |
string |
应用暂停,直到超过内存时间配额。 |
|
properties.targetSwapSlot |
string |
指定此应用将交换到哪个部署槽位。 只读。 |
|
properties.trafficManagerHostNames |
string[] |
与应用关联的 Azure 流量管理器主机名。 只读。 |
|
properties.usageState |
指示应用是否已超出其配额使用情况的状态。 只读。 |
||
properties.virtualNetworkSubnetId |
string |
Azure 资源管理器要通过区域 VNET 集成加入的虚拟网络和子网的 ID。 此格式必须为 /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
应用的管理信息可用性状态。
名称 | 类型 | 说明 |
---|---|---|
DisasterRecoveryMode |
string |
|
Limited |
string |
|
Normal |
string |
SiteConfig
App 服务应用的配置。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
acrUseManagedIdentityCreds |
boolean |
使用托管标识 Creds 进行 ACR 拉取的标志 |
|
acrUserManagedIdentityID |
string |
如果使用用户托管标识,则为用户托管标识 ClientId |
|
alwaysOn |
boolean |
|
|
apiDefinition |
有关应用的正式 API 定义的信息。 |
||
apiManagementConfig |
链接到应用的 Azure API 管理设置。 |
||
appCommandLine |
string |
要启动的应用命令行。 |
|
appSettings |
应用程序设置。 |
||
autoHealEnabled |
boolean |
|
|
autoHealRules |
自动愈合规则。 |
||
autoSwapSlotName |
string |
自动交换槽名称。 |
|
azureStorageAccounts |
<string,
Azure |
Azure 存储帐户列表。 |
|
connectionStrings |
连接字符串。 |
||
cors |
跨域资源共享 (CORS) 设置。 |
||
defaultDocuments |
string[] |
默认文档。 |
|
detailedErrorLoggingEnabled |
boolean |
|
|
documentRoot |
string |
文档根目录。 |
|
elasticWebAppScaleLimit |
integer |
站点可以横向扩展到的最大辅助角色数。
此设置仅适用于 ElasticScaleEnabled 为 的计划中的应用 |
|
experiments |
这是多态类型的解决方法。 |
||
ftpsState |
FTP/FTPS 服务的状态 |
||
functionAppScaleLimit |
integer |
站点可以横向扩展到的最大辅助角色数。 此设置仅适用于消耗和弹性高级计划 |
|
functionsRuntimeScaleMonitoringEnabled |
boolean |
获取或设置一个值,该值指示是否启用函数运行时规模监视。 启用后,ScaleController 不会直接监视事件源,而是调用运行时以获取缩放状态。 |
|
handlerMappings |
处理程序映射。 |
||
healthCheckPath |
string |
运行状况检查路径 |
|
http20Enabled |
boolean |
True |
Http20Enabled:配置网站以允许客户端通过 http2.0 进行连接 |
httpLoggingEnabled |
boolean |
|
|
ipSecurityRestrictions |
main的 IP 安全限制。 |
||
ipSecurityRestrictionsDefaultAction |
如果未匹配任何规则,则main访问限制的默认操作。 |
||
javaContainer |
string |
Java 容器。 |
|
javaContainerVersion |
string |
Java 容器版本。 |
|
javaVersion |
string |
Java 版本。 |
|
keyVaultReferenceIdentity |
string |
用于密钥保管库参考身份验证的标识。 |
|
limits |
网站限制。 |
||
linuxFxVersion |
string |
Linux 应用框架和版本 |
|
loadBalancing |
站点负载均衡。 |
||
localMySqlEnabled |
boolean |
False |
|
logsDirectorySizeLimit |
integer |
HTTP 日志目录大小限制。 |
|
machineKey |
Site MachineKey。 |
||
managedPipelineMode |
托管管道模式。 |
||
managedServiceIdentityId |
integer |
托管服务标识 ID |
|
metadata |
应用程序元数据。 无法检索此属性,因为它可能包含机密。 |
||
minTlsCipherSuite |
应用程序允许的最低强度 TLS 密码套件 |
||
minTlsVersion |
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 |
推送终结点设置。 |
||
pythonVersion |
string |
Python 版本。 |
|
remoteDebuggingEnabled |
boolean |
|
|
remoteDebuggingVersion |
string |
远程调试版本。 |
|
requestTracingEnabled |
boolean |
|
|
requestTracingExpirationTime |
string |
请求跟踪过期时间。 |
|
scmIpSecurityRestrictions |
scm 的 IP 安全限制。 |
||
scmIpSecurityRestrictionsDefaultAction |
如果未匹配任何规则,则 scm 访问限制的默认操作。 |
||
scmIpSecurityRestrictionsUseMain |
boolean |
scm 使用main的 IP 安全限制。 |
|
scmMinTlsVersion |
ScmMinTlsVersion:配置 SCM 站点的 SSL 请求所需的最低 TLS 版本 |
||
scmType |
SCM 类型。 |
||
tracingOptions |
string |
跟踪选项。 |
|
use32BitWorkerProcess |
boolean |
|
|
virtualApplications |
虚拟应用程序。 |
||
vnetName |
string |
虚拟网络名称。 |
|
vnetPrivatePortsCount |
integer |
分配给此应用的专用端口数。 这些将在运行时动态分配。 |
|
vnetRouteAllEnabled |
boolean |
虚拟网络“全部路由”已启用。 这会导致所有出站流量都应用虚拟网络安全组和用户定义的路由。 |
|
webSocketsEnabled |
boolean |
|
|
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 下列出的时区之一 |
|
windowsFxVersion |
string |
Xenon 应用框架和版本 |
|
xManagedServiceIdentityId |
integer |
显式托管服务标识 ID |
SiteDnsConfig
名称 | 类型 | 说明 |
---|---|---|
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
对应用设置的指标限制。
名称 | 类型 | 说明 |
---|---|---|
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 |
验证密钥。 |
SlotSwapStatus
上次成功的槽交换操作的状态。
名称 | 类型 | 说明 |
---|---|---|
destinationSlotName |
string |
上次交换操作的目标槽。 |
sourceSlotName |
string |
上次交换操作的源槽。 |
timestampUtc |
string |
上次成功交换槽完成的时间。 |
SlowRequestsBasedTrigger
基于请求执行时间触发。
名称 | 类型 | 说明 |
---|---|---|
count |
integer |
请求计数。 |
path |
string |
请求路径。 |
timeInterval |
string |
时间间隔。 |
timeTaken |
string |
花费的时间。 |
SslState
SSL 类型
名称 | 类型 | 说明 |
---|---|---|
Disabled |
string |
|
IpBasedEnabled |
string |
|
SniEnabled |
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 |
时间间隔。 |
Storage
函数应用使用的已部署包的存储。
名称 | 类型 | 说明 |
---|---|---|
authentication |
用于访问用于部署的存储帐户的身份验证方法。 |
|
type |
用于选择 Azure 存储类型的属性。 可用选项:blobContainer。 |
|
value |
string |
属性,用于设置所选 Azure 存储类型的 URL。 示例:对于 blobContainer,值可以是 https://.blob.core.windows.net/. |
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 |
Triggers
函数应用触发器的缩放和并发设置。
名称 | 类型 | 说明 |
---|---|---|
http |
HTTP 触发器的缩放和并发设置。 |
UsageState
指示应用是否已超出其配额使用情况的状态。 只读。
名称 | 类型 | 说明 |
---|---|---|
Exceeded |
string |
|
Normal |
string |
userAssignedIdentity
用户分配的标识。
名称 | 类型 | 说明 |
---|---|---|
clientId |
string |
用户分配标识的客户端 ID |
principalId |
string |
用户分配标识的主体 ID |
VirtualApplication
应用中的虚拟应用程序。
名称 | 类型 | 说明 |
---|---|---|
physicalPath |
string |
物理路径。 |
preloadEnabled |
boolean |
|
virtualDirectories |
虚拟应用程序的虚拟目录。 |
|
virtualPath |
string |
虚拟路径。 |
VirtualDirectory
虚拟应用程序的目录。
名称 | 类型 | 说明 |
---|---|---|
physicalPath |
string |
物理路径。 |
virtualPath |
string |
虚拟应用程序的路径。 |