App Service Environments - Update
App Service Environmentを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 |
App Service Environmentの名前。 |
resource
|
path | True |
string |
リソースが属しているリソース グループの名前。 Regex pattern: |
subscription
|
path | True |
string |
Azure のサブスクリプション ID。 これは GUID 形式の文字列です (たとえば、000000000-0000-0000-0000-000000000000000000000000000000000000000000000000000000000000、 |
api-version
|
query | True |
string |
API バージョン |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
properties.virtualNetwork | True |
Virtual Networkの説明。 |
|
kind |
string |
リソースの種類。 |
|
properties.clusterSettings |
App Service Environmentの動作を変更するためのカスタム設定。 |
||
properties.customDnsSuffixConfiguration |
ASEv3 のカスタム ドメイン サフィックス構成の完全なビュー。 |
||
properties.dedicatedHostCount |
integer |
専用ホスト数 |
|
properties.dnsSuffix |
string |
App Service Environmentの DNS サフィックス。 |
|
properties.frontEndScaleFactor |
integer |
フロントエンドのスケール ファクター。 |
|
properties.internalLoadBalancingMode |
App Service EnvironmentのVirtual Networkで内部的に提供するエンドポイントを指定します。 |
||
properties.ipsslAddressCount |
integer |
App Service Environment用に予約されている IP SSL アドレスの数。 |
|
properties.multiSize |
string |
フロントエンド VM のサイズ ("Medium"、"Large" など)。 |
|
properties.networkingConfiguration |
ASE のネットワーク構成の完全なビュー。 |
||
properties.upgradePreference |
アップグレードの基本設定 |
||
properties.userWhitelistedIpRanges |
string[] |
ユーザーが ASE db でホワイトリストに登録する IP 範囲を追加しました |
|
properties.zoneRedundant |
boolean |
このApp Service Environmentがゾーン冗長であるかどうか。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK |
|
201 Created |
作成済み |
|
202 Accepted |
操作が進行中です。 |
|
Other Status Codes |
エラー応答をApp Serviceします。 |
セキュリティ
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 |
App Service 環境の ARM リソース。 |
App |
ARM リソースをApp Service Environmentします。 |
AseV3Networking |
ASE のネットワーク構成の完全なビュー。 |
Custom |
ASEv3 のカスタム ドメイン サフィックス構成の完全なビュー。 |
Custom |
|
Default |
エラー応答をApp Serviceします。 |
Details | |
Error |
エラー モデル。 |
Hosting |
App Service Environmentの現在の状態。 |
Load |
App Service EnvironmentのVirtual Networkで内部的に提供するエンドポイントを指定します。 |
Name |
名前の値のペア。 |
Provisioning |
App Service Environmentのプロビジョニング状態。 |
Upgrade |
このApp Service Environmentでアップグレードを使用できるかどうか。 |
Upgrade |
アップグレードの基本設定 |
Virtual |
Virtual Networkを使用するための仕様。 |
AppServiceEnvironmentPatchResource
App Service 環境の ARM リソース。
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
id |
string |
リソース ID。 |
|
kind |
string |
リソースの種類。 |
|
name |
string |
リソース名。 |
|
properties.clusterSettings |
App Service Environmentの動作を変更するためのカスタム設定。 |
||
properties.customDnsSuffixConfiguration |
ASEv3 のカスタム ドメイン サフィックス構成の完全なビュー。 |
||
properties.dedicatedHostCount |
integer |
専用ホスト数 |
|
properties.dnsSuffix |
string |
App Service Environmentの DNS サフィックス。 |
|
properties.frontEndScaleFactor |
integer |
フロントエンドのスケール ファクター。 |
|
properties.hasLinuxWorkers |
boolean |
ASE に Linux ワーカーがあるかどうかを表示するフラグ |
|
properties.internalLoadBalancingMode |
App Service EnvironmentのVirtual Networkで内部的に提供するエンドポイントを指定します。 |
||
properties.ipsslAddressCount |
integer |
App Service Environment用に予約されている IP SSL アドレスの数。 |
|
properties.maximumNumberOfMachines |
integer |
App Service Environment内の VM の最大数。 |
|
properties.multiRoleCount |
integer |
フロントエンド インスタンスの数。 |
|
properties.multiSize |
string |
フロントエンド VM のサイズ ("Medium"、"Large" など)。 |
|
properties.networkingConfiguration |
ASE のネットワーク構成の完全なビュー。 |
||
properties.provisioningState |
App Service Environmentのプロビジョニング状態。 |
||
properties.status |
App Service Environmentの現在の状態。 |
||
properties.suspended |
boolean |
|
|
properties.upgradeAvailability |
このApp Service Environmentでアップグレードを使用できるかどうか。 |
||
properties.upgradePreference | None |
アップグレードの基本設定 |
|
properties.userWhitelistedIpRanges |
string[] |
ユーザーが ASE db でホワイトリストに登録する IP 範囲を追加しました |
|
properties.virtualNetwork |
Virtual Networkの説明。 |
||
properties.zoneRedundant |
boolean |
このApp Service Environmentがゾーン冗長であるかどうか。 |
|
type |
string |
リソースの種類。 |
AppServiceEnvironmentResource
ARM リソースをApp Service Environmentします。
名前 | 型 | 既定値 | 説明 |
---|---|---|---|
id |
string |
リソース ID。 |
|
kind |
string |
リソースの種類。 |
|
location |
string |
リソースの場所。 |
|
name |
string |
リソース名。 |
|
properties.clusterSettings |
App Service Environmentの動作を変更するためのカスタム設定。 |
||
properties.customDnsSuffixConfiguration |
ASEv3 のカスタム ドメイン サフィックス構成の完全なビュー。 |
||
properties.dedicatedHostCount |
integer |
専用ホスト数 |
|
properties.dnsSuffix |
string |
App Service Environmentの DNS サフィックス。 |
|
properties.frontEndScaleFactor |
integer |
フロントエンドのスケール ファクター。 |
|
properties.hasLinuxWorkers |
boolean |
ASE に Linux ワーカーがあるかどうかを表示するフラグ |
|
properties.internalLoadBalancingMode |
App Service EnvironmentのVirtual Networkで内部的に提供するエンドポイントを指定します。 |
||
properties.ipsslAddressCount |
integer |
App Service Environment用に予約されている IP SSL アドレスの数。 |
|
properties.maximumNumberOfMachines |
integer |
App Service Environment内の VM の最大数。 |
|
properties.multiRoleCount |
integer |
フロントエンド インスタンスの数。 |
|
properties.multiSize |
string |
フロントエンド VM のサイズ ("Medium"、"Large" など)。 |
|
properties.networkingConfiguration |
ASE のネットワーク構成の完全なビュー。 |
||
properties.provisioningState |
App Service Environmentのプロビジョニング状態。 |
||
properties.status |
App Service Environmentの現在の状態。 |
||
properties.suspended |
boolean |
|
|
properties.upgradeAvailability |
このApp Service Environmentでアップグレードを使用できるかどうか。 |
||
properties.upgradePreference | None |
アップグレードの基本設定 |
|
properties.userWhitelistedIpRanges |
string[] |
ユーザーが ASE db でホワイトリストに登録する IP 範囲を追加しました |
|
properties.virtualNetwork |
Virtual Networkの説明。 |
||
properties.zoneRedundant |
boolean |
このApp Service Environmentがゾーン冗長であるかどうか。 |
|
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 |
カスタム ドメイン サフィックスを持つサイトの既定の SSL/TLS 証明書として使用する必要がある Azure Key Vault証明書シークレットを参照する URL。 |
properties.dnsSuffix |
string |
ASE に展開されているすべてのサイトに使用する既定のカスタム ドメイン サフィックス。 |
properties.keyVaultReferenceIdentity |
string |
キー コンテナー証明書参照の解決に使用するユーザー割り当て ID。 指定しない場合は、システム割り当て ASE ID が使用可能な場合に使用されます。 |
properties.provisioningDetails |
string |
|
properties.provisioningState | ||
type |
string |
リソースの種類。 |
CustomDnsSuffixProvisioningState
名前 | 型 | 説明 |
---|---|---|
Degraded |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
DefaultErrorResponse
エラー応答をApp Serviceします。
名前 | 型 | 説明 |
---|---|---|
error |
エラー モデル。 |
Details
名前 | 型 | 説明 |
---|---|---|
code |
string |
プログラムによってエラーを識別するための標準化された文字列。 |
message |
string |
詳細なエラーの説明とデバッグ情報。 |
target |
string |
詳細なエラーの説明とデバッグ情報。 |
Error
エラー モデル。
名前 | 型 | 説明 |
---|---|---|
code |
string |
プログラムによってエラーを識別するための標準化された文字列。 |
details |
Details[] |
詳細なエラー。 |
innererror |
string |
エラーのデバッグに関する詳細情報。 |
message |
string |
詳細なエラーの説明とデバッグ情報。 |
target |
string |
詳細なエラーの説明とデバッグ情報。 |
HostingEnvironmentStatus
App Service Environmentの現在の状態。
名前 | 型 | 説明 |
---|---|---|
Deleting |
string |
|
Preparing |
string |
|
Ready |
string |
|
Scaling |
string |
LoadBalancingMode
App Service EnvironmentのVirtual Networkで内部的に提供するエンドポイントを指定します。
名前 | 型 | 説明 |
---|---|---|
None |
string |
|
Publishing |
string |
|
Web |
string |
|
Web, Publishing |
string |
NameValuePair
名前の値のペア。
名前 | 型 | 説明 |
---|---|---|
name |
string |
ペア名。 |
value |
string |
ペア値。 |
ProvisioningState
App Service Environmentのプロビジョニング状態。
名前 | 型 | 説明 |
---|---|---|
Canceled |
string |
|
Deleting |
string |
|
Failed |
string |
|
InProgress |
string |
|
Succeeded |
string |
UpgradeAvailability
このApp Service Environmentでアップグレードを使用できるかどうか。
名前 | 型 | 説明 |
---|---|---|
None |
string |
現在、このApp Service Environmentではアップグレードを使用できません |
Ready |
string |
アップグレードは、このApp Service Environmentで手動で開始する準備ができています |
UpgradePreference
アップグレードの基本設定
名前 | 型 | 説明 |
---|---|---|
Early |
string |
このApp Service Environmentは、アップグレード設定が "遅延" の同じリージョン内の他のユーザーの前にアップグレードされます |
Late |
string |
このApp Service Environmentは、アップグレード設定 'Early' を持つ同じリージョン内の他のユーザーの後にアップグレードされます |
Manual |
string |
ASEv3 のみ。 アップグレードが使用可能になると、このApp Service Environmentは、アップグレードが手動で開始されるまで 10 日間待機します。 10 日後にアップグレードが自動的に開始されます |
None |
string |
このApp Service Environmentをアップグレードするタイミングに関する設定はありません |
VirtualNetworkProfile
Virtual Networkを使用するための仕様。
名前 | 型 | 説明 |
---|---|---|
id |
string |
Virtual Networkのリソース ID。 |
name |
string |
Virtual Networkの名前 (読み取り専用)。 |
subnet |
string |
Virtual Network内のサブネット。 |
type |
string |
Virtual Networkのリソースの種類 (読み取り専用)。 |