你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
App Service Environments - Update
Create或更新应用服务环境的说明。
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}?api-version=2023-12-01
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
name
|
path | True |
string |
应用服务环境的名称。 |
resource
|
path | True |
string |
资源所属的资源组的名称。 Regex pattern: |
subscription
|
path | True |
string |
Azure 订阅 ID。 这是 GUID 格式的字符串 (例如 00000000-0000-0000-0000-0000-0000000000000) 。 |
api-version
|
query | True |
string |
API 版本 |
请求正文
名称 | 必需 | 类型 | 说明 |
---|---|---|---|
properties.virtualNetwork | True |
虚拟网络的说明。 |
|
kind |
string |
资源类型。 |
|
properties.clusterSettings |
用于更改应用服务环境行为的自定义设置。 |
||
properties.customDnsSuffixConfiguration |
ASEv3 的自定义域后缀配置的完整视图。 |
||
properties.dedicatedHostCount |
integer |
专用主机计数 |
|
properties.dnsSuffix |
string |
应用服务环境的 DNS 后缀。 |
|
properties.frontEndScaleFactor |
integer |
前端的比例因子。 |
|
properties.internalLoadBalancingMode |
指定要在虚拟网络内部为应用服务环境提供服务的终结点。 |
||
properties.ipsslAddressCount |
integer |
为应用服务环境保留的 IP SSL 地址数。 |
|
properties.multiSize |
string |
前端 VM 大小,例如“中等”、“大型”。 |
|
properties.networkingConfiguration |
ASE 网络配置的完整视图。 |
||
properties.upgradePreference |
升级首选项 |
||
properties.userWhitelistedIpRanges |
string[] |
用户已将 IP 范围添加到 ASE db 的允许列表 |
|
properties.zoneRedundant |
boolean |
此应用服务环境是否为区域冗余。 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
确定 |
|
201 Created |
创建 |
|
202 Accepted |
操作正在进行中。 |
|
Other Status Codes |
App 服务错误响应。 |
安全性
azure_auth
Azure Active Directory OAuth2 流
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
名称 | 说明 |
---|---|
user_impersonation | 模拟用户帐户 |
示例
Create or update an App Service Environment.
Sample Request
PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase?api-version=2023-12-01
{
"properties": {
"frontEndScaleFactor": 20,
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated"
}
}
}
Sample Response
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
"name": "test-ase",
"type": "Microsoft.Web/hostingEnvironments",
"kind": "ASEV3",
"location": "South Central US",
"tags": {},
"properties": {
"provisioningState": "Succeeded",
"status": "Ready",
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
"name": "delegated",
"type": "Microsoft.Network/virtualNetworks/subnets",
"subnet": ""
},
"internalLoadBalancingMode": "None",
"multiSize": "Standard_D2d_v4",
"multiRoleCount": null,
"ipsslAddressCount": 0,
"dnsSuffix": "test-ase.p.azurewebsites.net",
"maximumNumberOfMachines": 250,
"frontEndScaleFactor": 15,
"suspended": false,
"clusterSettings": null,
"userWhitelistedIpRanges": null,
"hasLinuxWorkers": true,
"dedicatedHostCount": 0,
"zoneRedundant": false,
"networkingConfiguration": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
"properties": {
"windowsOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"linuxOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"externalInboundIpAddresses": [
"52.153.248.36"
],
"internalInboundIpAddresses": [],
"allowNewPrivateEndpointConnections": false,
"ftpEnabled": false,
"remoteDebugEnabled": false,
"inboundIpAddressOverride": null
}
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
"name": "test-ase",
"type": "Microsoft.Web/hostingEnvironments",
"kind": "ASEV3",
"location": "South Central US",
"tags": {},
"properties": {
"provisioningState": "Succeeded",
"status": "Ready",
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
"name": "delegated",
"type": "Microsoft.Network/virtualNetworks/subnets",
"subnet": ""
},
"internalLoadBalancingMode": "None",
"multiSize": "Standard_D2d_v4",
"multiRoleCount": null,
"ipsslAddressCount": 0,
"dnsSuffix": "test-ase.p.azurewebsites.net",
"maximumNumberOfMachines": 250,
"frontEndScaleFactor": 15,
"suspended": false,
"clusterSettings": null,
"userWhitelistedIpRanges": null,
"hasLinuxWorkers": true,
"dedicatedHostCount": 0,
"zoneRedundant": false,
"networkingConfiguration": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
"properties": {
"windowsOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"linuxOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"externalInboundIpAddresses": [
"52.153.248.36"
],
"internalInboundIpAddresses": [],
"allowNewPrivateEndpointConnections": false,
"ftpEnabled": false,
"remoteDebugEnabled": false,
"inboundIpAddressOverride": null
}
}
}
}
{
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase",
"name": "test-ase",
"type": "Microsoft.Web/hostingEnvironments",
"kind": "ASEV3",
"location": "South Central US",
"tags": {},
"properties": {
"provisioningState": "Succeeded",
"status": "Ready",
"virtualNetwork": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Network/virtualNetworks/test-subnet/subnets/delegated",
"name": "delegated",
"type": "Microsoft.Network/virtualNetworks/subnets",
"subnet": ""
},
"internalLoadBalancingMode": "None",
"multiSize": "Standard_D2d_v4",
"multiRoleCount": null,
"ipsslAddressCount": 0,
"dnsSuffix": "test-ase.p.azurewebsites.net",
"maximumNumberOfMachines": 250,
"frontEndScaleFactor": 15,
"suspended": false,
"clusterSettings": null,
"userWhitelistedIpRanges": null,
"hasLinuxWorkers": true,
"dedicatedHostCount": 0,
"zoneRedundant": false,
"networkingConfiguration": {
"id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/test-rg/providers/Microsoft.Web/hostingEnvironments/test-ase/configurations/networking",
"properties": {
"windowsOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"linuxOutboundIpAddresses": [
"20.88.241.56",
"20.88.241.9"
],
"externalInboundIpAddresses": [
"52.153.248.36"
],
"internalInboundIpAddresses": [],
"allowNewPrivateEndpointConnections": false,
"ftpEnabled": false,
"remoteDebugEnabled": false,
"inboundIpAddressOverride": null
}
}
}
}
定义
名称 | 说明 |
---|---|
App |
应用服务环境的 ARM 资源。 |
App |
应用服务环境 ARM 资源。 |
AseV3Networking |
ASE 网络配置的完整视图。 |
Custom |
ASEv3 的自定义域后缀配置的完整视图。 |
Custom |
|
Default |
App 服务错误响应。 |
Details | |
Error |
错误模型。 |
Hosting |
应用服务环境的当前状态。 |
Load |
指定要在虚拟网络内部为应用服务环境提供服务的终结点。 |
Name |
名称值对。 |
Provisioning |
应用服务环境的预配状态。 |
Upgrade |
升级是否适用于此应用服务环境。 |
Upgrade |
升级首选项 |
Virtual |
使用虚拟网络的规范。 |
AppServiceEnvironmentPatchResource
应用服务环境的 ARM 资源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源 ID。 |
|
kind |
string |
资源类型。 |
|
name |
string |
资源名称。 |
|
properties.clusterSettings |
用于更改应用服务环境行为的自定义设置。 |
||
properties.customDnsSuffixConfiguration |
ASEv3 的自定义域后缀配置的完整视图。 |
||
properties.dedicatedHostCount |
integer |
专用主机计数 |
|
properties.dnsSuffix |
string |
应用服务环境的 DNS 后缀。 |
|
properties.frontEndScaleFactor |
integer |
前端的比例因子。 |
|
properties.hasLinuxWorkers |
boolean |
显示 ASE 是否具有 linux 辅助角色的标志 |
|
properties.internalLoadBalancingMode |
指定要在虚拟网络内部为应用服务环境提供服务的终结点。 |
||
properties.ipsslAddressCount |
integer |
为应用服务环境保留的 IP SSL 地址数。 |
|
properties.maximumNumberOfMachines |
integer |
应用服务环境中 VM 的最大数目。 |
|
properties.multiRoleCount |
integer |
前端实例数。 |
|
properties.multiSize |
string |
前端 VM 大小,例如“中等”、“大型”。 |
|
properties.networkingConfiguration |
ASE 网络配置的完整视图。 |
||
properties.provisioningState |
应用服务环境的预配状态。 |
||
properties.status |
应用服务环境的当前状态。 |
||
properties.suspended |
boolean |
|
|
properties.upgradeAvailability |
升级是否适用于此应用服务环境。 |
||
properties.upgradePreference | None |
升级首选项 |
|
properties.userWhitelistedIpRanges |
string[] |
用户已将 IP 范围添加到 ASE db 的允许列表 |
|
properties.virtualNetwork |
虚拟网络的说明。 |
||
properties.zoneRedundant |
boolean |
此应用服务环境是否为区域冗余。 |
|
type |
string |
资源类型。 |
AppServiceEnvironmentResource
应用服务环境 ARM 资源。
名称 | 类型 | 默认值 | 说明 |
---|---|---|---|
id |
string |
资源 ID。 |
|
kind |
string |
资源类型。 |
|
location |
string |
资源位置。 |
|
name |
string |
资源名称。 |
|
properties.clusterSettings |
用于更改应用服务环境行为的自定义设置。 |
||
properties.customDnsSuffixConfiguration |
ASEv3 的自定义域后缀配置的完整视图。 |
||
properties.dedicatedHostCount |
integer |
专用主机计数 |
|
properties.dnsSuffix |
string |
应用服务环境的 DNS 后缀。 |
|
properties.frontEndScaleFactor |
integer |
前端的比例因子。 |
|
properties.hasLinuxWorkers |
boolean |
显示 ASE 是否具有 linux 辅助角色的标志 |
|
properties.internalLoadBalancingMode |
指定要在虚拟网络内部为应用服务环境提供服务的终结点。 |
||
properties.ipsslAddressCount |
integer |
为应用服务环境保留的 IP SSL 地址数。 |
|
properties.maximumNumberOfMachines |
integer |
应用服务环境中 VM 的最大数目。 |
|
properties.multiRoleCount |
integer |
前端实例数。 |
|
properties.multiSize |
string |
前端 VM 大小,例如“中等”、“大型”。 |
|
properties.networkingConfiguration |
ASE 网络配置的完整视图。 |
||
properties.provisioningState |
应用服务环境的预配状态。 |
||
properties.status |
应用服务环境的当前状态。 |
||
properties.suspended |
boolean |
|
|
properties.upgradeAvailability |
升级是否适用于此应用服务环境。 |
||
properties.upgradePreference | None |
升级首选项 |
|
properties.userWhitelistedIpRanges |
string[] |
用户已将 IP 范围添加到 ASE db 的允许列表 |
|
properties.virtualNetwork |
虚拟网络的说明。 |
||
properties.zoneRedundant |
boolean |
此应用服务环境是否为区域冗余。 |
|
tags |
object |
资源标记。 |
|
type |
string |
资源类型。 |
AseV3NetworkingConfiguration
ASE 网络配置的完整视图。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
kind |
string |
资源类型。 |
name |
string |
资源名称。 |
properties.allowNewPrivateEndpointConnections |
boolean |
用于在 ASE 上启用和禁用新专用终结点连接创建的属性 |
properties.externalInboundIpAddresses |
string[] |
|
properties.ftpEnabled |
boolean |
用于在 ASEV3 上启用和禁用 FTP 的属性 |
properties.inboundIpAddressOverride |
string |
客户提供的入站 IP 地址。 只能在 Ase create 上设置。 |
properties.internalInboundIpAddresses |
string[] |
|
properties.linuxOutboundIpAddresses |
string[] |
|
properties.remoteDebugEnabled |
boolean |
用于在 ASEV3 上启用和禁用远程调试的属性 |
properties.windowsOutboundIpAddresses |
string[] |
|
type |
string |
资源类型。 |
CustomDnsSuffixConfiguration
ASEv3 的自定义域后缀配置的完整视图。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
资源 ID。 |
kind |
string |
资源类型。 |
name |
string |
资源名称。 |
properties.certificateUrl |
string |
引用 Azure 密钥保管库证书机密的 URL,该机密应用作具有自定义域后缀的站点的默认 SSL/TLS 证书。 |
properties.dnsSuffix |
string |
用于在 ASE 上部署的所有站点的默认自定义域后缀。 |
properties.keyVaultReferenceIdentity |
string |
用户分配的标识,用于解析密钥保管库证书引用。 如果未指定,将使用系统分配的 ASE 标识(如果可用)。 |
properties.provisioningDetails |
string |
|
properties.provisioningState | ||
type |
string |
资源类型。 |
CustomDnsSuffixProvisioningState
名称 | 类型 | 说明 |
---|---|---|
Degraded |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
DefaultErrorResponse
App 服务错误响应。
名称 | 类型 | 说明 |
---|---|---|
error |
错误模型。 |
Details
名称 | 类型 | 说明 |
---|---|---|
code |
string |
用于以编程方式识别错误的标准化字符串。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
Error
错误模型。
名称 | 类型 | 说明 |
---|---|---|
code |
string |
用于以编程方式识别错误的标准化字符串。 |
details |
Details[] |
详细错误。 |
innererror |
string |
调试错误的详细信息。 |
message |
string |
详细的错误说明和调试信息。 |
target |
string |
详细的错误说明和调试信息。 |
HostingEnvironmentStatus
应用服务环境的当前状态。
名称 | 类型 | 说明 |
---|---|---|
Deleting |
string |
|
Preparing |
string |
|
Ready |
string |
|
Scaling |
string |
LoadBalancingMode
指定要在虚拟网络内部为应用服务环境提供服务的终结点。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
|
Publishing |
string |
|
Web |
string |
|
Web, Publishing |
string |
NameValuePair
名称值对。
名称 | 类型 | 说明 |
---|---|---|
name |
string |
对名称。 |
value |
string |
配对值。 |
ProvisioningState
应用服务环境的预配状态。
名称 | 类型 | 说明 |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
UpgradeAvailability
升级是否适用于此应用服务环境。
名称 | 类型 | 说明 |
---|---|---|
None |
string |
此应用服务环境当前没有可用的升级 |
Ready |
string |
已准备好在此应用服务环境手动启动升级 |
UpgradePreference
升级首选项
名称 | 类型 | 说明 |
---|---|---|
Early |
string |
此应用服务环境将在同一区域中升级首选项为“延迟”的其他人之前升级 |
Late |
string |
此应用服务环境将在同一区域中具有“早期”升级首选项的其他人之后升级 |
Manual |
string |
仅限 ASEv3。 升级可用后,此应用服务环境将等待 10 天才能手动启动升级。 10 天后,升级将自动开始 |
None |
string |
升级此应用服务环境时没有首选项 |
VirtualNetworkProfile
使用虚拟网络的规范。
名称 | 类型 | 说明 |
---|---|---|
id |
string |
虚拟网络的资源 ID。 |
name |
string |
虚拟网络 (只读) 的名称。 |
subnet |
string |
虚拟网络中的子网。 |
type |
string |
虚拟网络 (只读) 的资源类型。 |