Web Apps - Create Or Update Configuration

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web?api-version=2023-12-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": {}
  }
}

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/2023-12-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;
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_site_config.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.web_apps.create_or_update_configuration(
        resource_group_name="testrg123",
        name="sitef6141",
        site_config={
            "properties": {
                "acrUseManagedIdentityCreds": False,
                "alwaysOn": False,
                "appCommandLine": "",
                "autoHealEnabled": False,
                "azureStorageAccounts": {},
                "defaultDocuments": [
                    "Default.htm",
                    "Default.html",
                    "Default.asp",
                    "index.htm",
                    "index.html",
                    "iisstart.htm",
                    "default.aspx",
                    "index.php",
                    "hostingstart.html",
                ],
                "detailedErrorLoggingEnabled": False,
                "ftpsState": "AllAllowed",
                "functionAppScaleLimit": 0,
                "functionsRuntimeScaleMonitoringEnabled": False,
                "http20Enabled": False,
                "httpLoggingEnabled": False,
                "linuxFxVersion": "",
                "loadBalancing": "LeastRequests",
                "logsDirectorySizeLimit": 35,
                "managedPipelineMode": "Integrated",
                "minTlsVersion": "1.2",
                "minimumElasticInstanceCount": 0,
                "netFrameworkVersion": "v4.0",
                "nodeVersion": "",
                "numberOfWorkers": 1,
                "phpVersion": "5.6",
                "powerShellVersion": "",
                "pythonVersion": "",
                "remoteDebuggingEnabled": False,
                "requestTracingEnabled": False,
                "scmMinTlsVersion": "1.2",
                "use32BitWorkerProcess": True,
                "virtualApplications": [{"physicalPath": "site\\wwwroot", "preloadEnabled": False, "virtualPath": "/"}],
                "vnetName": "",
                "vnetPrivatePortsCount": 0,
                "vnetRouteAllEnabled": False,
                "webSocketsEnabled": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdateSiteConfig.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/de1f3772629b6f4d3ac01548a5f6d719bfb97c9e/specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdateSiteConfig.json
func ExampleWebAppsClient_CreateOrUpdateConfiguration() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewWebAppsClient().CreateOrUpdateConfiguration(ctx, "testrg123", "sitef6141", armappservice.SiteConfigResource{
		Properties: &armappservice.SiteConfig{
			AcrUseManagedIdentityCreds: to.Ptr(false),
			AlwaysOn:                   to.Ptr(false),
			AppCommandLine:             to.Ptr(""),
			AutoHealEnabled:            to.Ptr(false),
			AzureStorageAccounts:       map[string]*armappservice.AzureStorageInfoValue{},
			DefaultDocuments: []*string{
				to.Ptr("Default.htm"),
				to.Ptr("Default.html"),
				to.Ptr("Default.asp"),
				to.Ptr("index.htm"),
				to.Ptr("index.html"),
				to.Ptr("iisstart.htm"),
				to.Ptr("default.aspx"),
				to.Ptr("index.php"),
				to.Ptr("hostingstart.html")},
			DetailedErrorLoggingEnabled:            to.Ptr(false),
			FtpsState:                              to.Ptr(armappservice.FtpsStateAllAllowed),
			FunctionAppScaleLimit:                  to.Ptr[int32](0),
			FunctionsRuntimeScaleMonitoringEnabled: to.Ptr(false),
			Http20Enabled:                          to.Ptr(false),
			HTTPLoggingEnabled:                     to.Ptr(false),
			LinuxFxVersion:                         to.Ptr(""),
			LoadBalancing:                          to.Ptr(armappservice.SiteLoadBalancingLeastRequests),
			LogsDirectorySizeLimit:                 to.Ptr[int32](35),
			ManagedPipelineMode:                    to.Ptr(armappservice.ManagedPipelineModeIntegrated),
			MinTLSVersion:                          to.Ptr(armappservice.SupportedTLSVersionsOne2),
			MinimumElasticInstanceCount:            to.Ptr[int32](0),
			NetFrameworkVersion:                    to.Ptr("v4.0"),
			NodeVersion:                            to.Ptr(""),
			NumberOfWorkers:                        to.Ptr[int32](1),
			PhpVersion:                             to.Ptr("5.6"),
			PowerShellVersion:                      to.Ptr(""),
			PythonVersion:                          to.Ptr(""),
			RemoteDebuggingEnabled:                 to.Ptr(false),
			RequestTracingEnabled:                  to.Ptr(false),
			ScmMinTLSVersion:                       to.Ptr(armappservice.SupportedTLSVersionsOne2),
			Use32BitWorkerProcess:                  to.Ptr(true),
			VirtualApplications: []*armappservice.VirtualApplication{
				{
					PhysicalPath:   to.Ptr("site\\wwwroot"),
					PreloadEnabled: to.Ptr(false),
					VirtualPath:    to.Ptr("/"),
				}},
			VnetName:              to.Ptr(""),
			VnetPrivatePortsCount: to.Ptr[int32](0),
			VnetRouteAllEnabled:   to.Ptr(false),
			WebSocketsEnabled:     to.Ptr(false),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.SiteConfigResource = armappservice.SiteConfigResource{
	// 	Name: to.Ptr("web"),
	// 	Type: to.Ptr("Microsoft.Web/sites/config"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/config/web"),
	// 	Kind: to.Ptr("app"),
	// 	Properties: &armappservice.SiteConfig{
	// 		AcrUseManagedIdentityCreds: to.Ptr(false),
	// 		AlwaysOn: to.Ptr(false),
	// 		AppCommandLine: to.Ptr(""),
	// 		AutoHealEnabled: to.Ptr(false),
	// 		AzureStorageAccounts: map[string]*armappservice.AzureStorageInfoValue{
	// 		},
	// 		DefaultDocuments: []*string{
	// 			to.Ptr("Default.htm"),
	// 			to.Ptr("Default.html"),
	// 			to.Ptr("Default.asp"),
	// 			to.Ptr("index.htm"),
	// 			to.Ptr("index.html"),
	// 			to.Ptr("iisstart.htm"),
	// 			to.Ptr("default.aspx"),
	// 			to.Ptr("index.php"),
	// 			to.Ptr("hostingstart.html")},
	// 			DetailedErrorLoggingEnabled: to.Ptr(false),
	// 			FtpsState: to.Ptr(armappservice.FtpsStateAllAllowed),
	// 			FunctionAppScaleLimit: to.Ptr[int32](0),
	// 			FunctionsRuntimeScaleMonitoringEnabled: to.Ptr(false),
	// 			Http20Enabled: to.Ptr(false),
	// 			HTTPLoggingEnabled: to.Ptr(false),
	// 			LinuxFxVersion: to.Ptr(""),
	// 			LoadBalancing: to.Ptr(armappservice.SiteLoadBalancingLeastRequests),
	// 			LogsDirectorySizeLimit: to.Ptr[int32](35),
	// 			ManagedPipelineMode: to.Ptr(armappservice.ManagedPipelineModeIntegrated),
	// 			MinTLSVersion: to.Ptr(armappservice.SupportedTLSVersionsOne2),
	// 			MinimumElasticInstanceCount: to.Ptr[int32](0),
	// 			NetFrameworkVersion: to.Ptr("v4.0"),
	// 			NodeVersion: to.Ptr(""),
	// 			NumberOfWorkers: to.Ptr[int32](1),
	// 			PhpVersion: to.Ptr("5.6"),
	// 			PowerShellVersion: to.Ptr(""),
	// 			PythonVersion: to.Ptr(""),
	// 			RemoteDebuggingEnabled: to.Ptr(false),
	// 			RequestTracingEnabled: to.Ptr(false),
	// 			ScmMinTLSVersion: to.Ptr(armappservice.SupportedTLSVersionsOne2),
	// 			Use32BitWorkerProcess: to.Ptr(true),
	// 			VirtualApplications: []*armappservice.VirtualApplication{
	// 				{
	// 					PhysicalPath: to.Ptr("site\\wwwroot"),
	// 					PreloadEnabled: to.Ptr(false),
	// 					VirtualPath: to.Ptr("/"),
	// 			}},
	// 			VnetName: to.Ptr(""),
	// 			VnetPrivatePortsCount: to.Ptr[int32](0),
	// 			VnetRouteAllEnabled: to.Ptr(false),
	// 			WebSocketsEnabled: to.Ptr(false),
	// 		},
	// 	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Updates the configuration of an app.
 *
 * @summary Description for Updates the configuration of an app.
 * x-ms-original-file: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdateSiteConfig.json
 */
async function updateSiteConfig() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const name = "sitef6141";
  const siteConfig = {
    acrUseManagedIdentityCreds: false,
    alwaysOn: false,
    appCommandLine: "",
    autoHealEnabled: false,
    azureStorageAccounts: {},
    defaultDocuments: [
      "Default.htm",
      "Default.html",
      "Default.asp",
      "index.htm",
      "index.html",
      "iisstart.htm",
      "default.aspx",
      "index.php",
      "hostingstart.html",
    ],
    detailedErrorLoggingEnabled: false,
    ftpsState: "AllAllowed",
    functionAppScaleLimit: 0,
    functionsRuntimeScaleMonitoringEnabled: false,
    http20Enabled: false,
    httpLoggingEnabled: false,
    linuxFxVersion: "",
    loadBalancing: "LeastRequests",
    logsDirectorySizeLimit: 35,
    managedPipelineMode: "Integrated",
    minTlsVersion: "1.2",
    minimumElasticInstanceCount: 0,
    netFrameworkVersion: "v4.0",
    nodeVersion: "",
    numberOfWorkers: 1,
    phpVersion: "5.6",
    powerShellVersion: "",
    pythonVersion: "",
    remoteDebuggingEnabled: false,
    requestTracingEnabled: false,
    scmMinTlsVersion: "1.2",
    use32BitWorkerProcess: true,
    virtualApplications: [
      {
        physicalPath: "site\\wwwroot",
        preloadEnabled: false,
        virtualPath: "/",
      },
    ],
    vnetName: "",
    vnetPrivatePortsCount: 0,
    vnetRouteAllEnabled: false,
    webSocketsEnabled: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.webApps.createOrUpdateConfiguration(
    resourceGroupName,
    name,
    siteConfig,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2023-12-01/examples/UpdateSiteConfig.json
// this example is just showing the usage of "WebApps_CreateOrUpdateConfiguration" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://video2.skills-academy.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this WebSiteConfigResource created on azure
// for more information of creating WebSiteConfigResource, please refer to the document of WebSiteConfigResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteConfigResourceId = WebSiteConfigResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteConfigResource webSiteConfig = client.GetWebSiteConfigResource(webSiteConfigResourceId);

// invoke the operation
SiteConfigData data = new SiteConfigData()
{
    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 = "",
    IsRequestTracingEnabled = false,
    IsRemoteDebuggingEnabled = false,
    IsHttpLoggingEnabled = false,
    UseManagedIdentityCreds = false,
    LogsDirectorySizeLimit = 35,
    IsDetailedErrorLoggingEnabled = false,
    Use32BitWorkerProcess = true,
    IsWebSocketsEnabled = false,
    IsAlwaysOn = false,
    AppCommandLine = "",
    ManagedPipelineMode = ManagedPipelineMode.Integrated,
    VirtualApplications =
    {
    new VirtualApplication()
    {
    VirtualPath = "/",
    PhysicalPath = "site\\wwwroot",
    IsPreloadEnabled = false,
    }
    },
    LoadBalancing = SiteLoadBalancing.LeastRequests,
    IsAutoHealEnabled = false,
    VnetName = "",
    IsVnetRouteAllEnabled = false,
    VnetPrivatePortsCount = 0,
    IsHttp20Enabled = false,
    MinTlsVersion = AppServiceSupportedTlsVersion.Tls1_2,
    ScmMinTlsVersion = AppServiceSupportedTlsVersion.Tls1_2,
    FtpsState = AppServiceFtpsState.AllAllowed,
    FunctionAppScaleLimit = 0,
    IsFunctionsRuntimeScaleMonitoringEnabled = false,
    MinimumElasticInstanceCount = 0,
    AzureStorageAccounts =
    {
    },
};
ArmOperation<WebSiteConfigResource> lro = await webSiteConfig.CreateOrUpdateAsync(WaitUntil.Completed, data);
WebSiteConfigResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
SiteConfigData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue