Web Apps - Create Or Update Configuration

參考

服務:: App Service

API 版本:: 2024-04-01

更新應用程式設定的描述。

HTTP

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web?api-version=2024-04-01

URI 參數

名稱	位於	必要	類型	Description
name	path	True	string	應用程式的名稱。
resourceGroupName	path	True	string	資源所屬的資源群組名稱。 Regex 模式: `^[-\w\._]+[^\.]$`
subscriptionId	path	True	string	您的 Azure 訂用帳戶標識碼。這是 GUID 格式的字串（例如 0000000000-0000-0000-0000-0000000000000000）。
api-version	query	True	string	API 版本

要求本文

名稱	類型	Description
kind	string	資源種類。
properties.acrUseManagedIdentityCreds	boolean	使用受控識別 Creds 進行 ACR 提取的旗標
properties.acrUserManagedIdentityID	string	如果使用使用者受控識別，則使用者受控識別 ClientId
properties.alwaysOn	boolean	如果已啟用 Always On，`true`;否則，`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	Http20Enabled：設定網站以允許用戶端透過 HTTP2.0 連線
properties.httpLoggingEnabled	boolean	如果已啟用 HTTP 記錄，`true`;否則，`false`。
properties.ipSecurityRestrictions	IpSecurityRestriction[]	main 的IP安全性限制。
properties.ipSecurityRestrictionsDefaultAction	DefaultAction	如果沒有符合任何規則，則主要存取限制的默認動作。
properties.javaContainer	string	Java 容器。
properties.javaContainerVersion	string	Java 容器版本。
properties.javaVersion	string	Java 版本。
properties.keyVaultReferenceIdentity	string	要用於 Key Vault 參考驗證的身分識別。
properties.limits	SiteLimits	網站限制。
properties.linuxFxVersion	string	Linux 應用程式架構和版本
properties.loadBalancing	SiteLoadBalancing	網站負載平衡。
properties.localMySqlEnabled	boolean	`true` 啟用本機 MySQL;否則，`false`。
properties.logsDirectorySizeLimit	integer	HTTP 記錄目錄大小限制。
properties.managedPipelineMode	ManagedPipelineMode	受控管線模式。
properties.managedServiceIdentityId	integer	受控服務識別標識碼
properties.metadata	NameValuePair[]	應用程式元數據。無法擷取這個屬性，因為它可能包含秘密。
properties.minTlsCipherSuite	TlsCipherSuites	應用程式允許的最小強度 TLS 加密套件
properties.minTlsVersion	SupportedTlsVersions	MinTlsVersion：設定 SSL 要求所需的最低 TLS 版本
properties.minimumElasticInstanceCount	integer	月臺的最低實例計數數目此設定僅適用於彈性方案
properties.netFrameworkVersion	string	.NET Framework 版本。
properties.nodeVersion	string	Node.js的版本。
properties.numberOfWorkers	integer	背景工作角色數目。
properties.phpVersion	string	PHP 版本。
properties.powerShellVersion	string	PowerShell 版本。
properties.preWarmedInstanceCount	integer	預先Warmed 實例的數目。此設定僅適用於取用和彈性方案
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	如果已啟用 WebSocket，`true`;否則，`false`。
properties.websiteTimeZone	string	設定網站用來產生時間戳的時區。與 Linux 和 Windows App Service 相容。設定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 App Framework 和版本
properties.xManagedServiceIdentityId	integer	明確受控服務識別標識碼

回應

名稱	類型	Description
200 OK	SiteConfigResource	還行
Other Status Codes	DefaultErrorResponse	App Service 錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

Update Site Config

範例要求

HTTP

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web?api-version=2024-04-01

{
  "properties": {
    "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": {}
  }
}

Java


import com.azure.resourcemanager.appservice.fluent.models.SiteConfigResourceInner;
import com.azure.resourcemanager.appservice.models.FtpsState;
import com.azure.resourcemanager.appservice.models.ManagedPipelineMode;
import com.azure.resourcemanager.appservice.models.SiteLoadBalancing;
import com.azure.resourcemanager.appservice.models.SupportedTlsVersions;
import com.azure.resourcemanager.appservice.models.VirtualApplication;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

/**
 * Samples for WebApps CreateOrUpdateConfiguration.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/UpdateSiteConfig.json
     */
    /**
     * Sample code: Update Site Config.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateSiteConfig(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getWebApps().createOrUpdateConfiguration("testrg123", "sitef6141",
            new SiteConfigResourceInner().withNumberOfWorkers(1)
                .withDefaultDocuments(Arrays.asList("Default.htm", "Default.html", "Default.asp", "index.htm",
                    "index.html", "iisstart.htm", "default.aspx", "index.php", "hostingstart.html"))
                .withNetFrameworkVersion("v4.0").withPhpVersion("5.6").withPythonVersion("").withNodeVersion("")
                .withPowerShellVersion("").withLinuxFxVersion("").withRequestTracingEnabled(false)
                .withRemoteDebuggingEnabled(false).withHttpLoggingEnabled(false).withAcrUseManagedIdentityCreds(false)
                .withLogsDirectorySizeLimit(35).withDetailedErrorLoggingEnabled(false).withUse32BitWorkerProcess(true)
                .withWebSocketsEnabled(false).withAlwaysOn(false).withAppCommandLine("")
                .withManagedPipelineMode(ManagedPipelineMode.INTEGRATED)
                .withVirtualApplications(Arrays.asList(new VirtualApplication().withVirtualPath("/")
                    .withPhysicalPath("site\\wwwroot").withPreloadEnabled(false)))
                .withLoadBalancing(SiteLoadBalancing.LEAST_REQUESTS).withAutoHealEnabled(false).withVnetName("")
                .withVnetRouteAllEnabled(false).withVnetPrivatePortsCount(0).withHttp20Enabled(false)
                .withMinTlsVersion(SupportedTlsVersions.ONE_TWO).withScmMinTlsVersion(SupportedTlsVersions.ONE_TWO)
                .withFtpsState(FtpsState.ALL_ALLOWED).withFunctionAppScaleLimit(0)
                .withFunctionsRuntimeScaleMonitoringEnabled(false).withMinimumElasticInstanceCount(0)
                .withAzureStorageAccounts(mapOf()),
            com.azure.core.util.Context.NONE);
    }

    // Use "Map.of" if available
    @SuppressWarnings("unchecked")
    private static <T> Map<String, T> mapOf(Object... inputs) {
        Map<String, T> map = new HashMap<>();
        for (int i = 0; i < inputs.length; i += 2) {
            String key = (String) inputs[i];
            T value = (T) inputs[i + 1];
            map.put(key, value);
        }
        return map;
    }
}