Description for Applies the configuration settings from the target slot onto the current slot.
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig?api-version=2024-04-01
URI Parameters
| Name |
In |
Required |
Type |
Description |
|
name
|
path |
True
|
string
|
Name of the app.
|
|
resourceGroupName
|
path |
True
|
string
|
Name of the resource group to which the resource belongs.
Regex pattern: ^[-\w\._\(\)]+[^\.]$
|
|
subscriptionId
|
path |
True
|
string
|
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
|
|
api-version
|
query |
True
|
string
|
API Version
|
Request Body
| Name |
Required |
Type |
Description |
|
preserveVnet
|
True
|
boolean
|
true to preserve Virtual Network to the slot during swap; otherwise, false.
|
|
targetSlot
|
True
|
string
|
Destination deployment slot during swap operation.
|
Responses
| Name |
Type |
Description |
|
200 OK
|
|
OK.
|
|
Other Status Codes
|
DefaultErrorResponse
|
App Service error response.
|
Security
azure_auth
Azure Active Directory OAuth2 Flow
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
| Name |
Description |
|
user_impersonation
|
impersonate your user account
|
Examples
Apply web app slot config
Sample request
POST https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/sites/sitef6141/applySlotConfig?api-version=2024-04-01
{
"targetSlot": "staging",
"preserveVnet": true
}
import com.azure.resourcemanager.appservice.models.CsmSlotEntity;
/**
* Samples for WebApps ApplySlotConfigToProduction.
*/
public final class Main {
/*
* x-ms-original-file:
* specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json
*/
/**
* Sample code: Apply web app slot config.
*
* @param azure The entry point for accessing resource management APIs in Azure.
*/
public static void applyWebAppSlotConfig(com.azure.resourcemanager.AzureResourceManager azure) {
azure.webApps().manager().serviceClient().getWebApps().applySlotConfigToProductionWithResponse("testrg123",
"sitef6141", new CsmSlotEntity().withTargetSlot("staging").withPreserveVnet(true),
com.azure.core.util.Context.NONE);
}
}
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/v4"
)
// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/b5d78da207e9c5d8f82e95224039867271f47cdf/specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json
func ExampleWebAppsClient_ApplySlotConfigToProduction() {
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)
}
_, err = clientFactory.NewWebAppsClient().ApplySlotConfigToProduction(ctx, "testrg123", "sitef6141", armappservice.CsmSlotEntity{
PreserveVnet: to.Ptr(true),
TargetSlot: to.Ptr("staging"),
}, nil)
if err != nil {
log.Fatalf("failed to finish the request: %v", err)
}
}
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.Collections.Generic;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;
// Generated from example definition: specification/web/resource-manager/Microsoft.Web/stable/2024-04-01/examples/ApplySlotConfig.json
// this example is just showing the usage of "WebApps_ApplySlotConfigToProduction" 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://learn.microsoft.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 WebSiteResource created on azure
// for more information of creating WebSiteResource, please refer to the document of WebSiteResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
string name = "sitef6141";
ResourceIdentifier webSiteResourceId = WebSiteResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, name);
WebSiteResource webSite = client.GetWebSiteResource(webSiteResourceId);
// invoke the operation
CsmSlotEntity slotSwapEntity = new CsmSlotEntity("staging", true);
await webSite.ApplySlotConfigToProductionAsync(slotSwapEntity);
Console.WriteLine("Succeeded");
To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue
Definitions
CsmSlotEntity
Deployment slot parameters.
| Name |
Type |
Description |
|
preserveVnet
|
boolean
|
true to preserve Virtual Network to the slot during swap; otherwise, false.
|
|
targetSlot
|
string
|
Destination deployment slot during swap operation.
|
DefaultErrorResponse
App Service error response.
| Name |
Type |
Description |
|
error
|
Error
|
Error model.
|
Details
| Name |
Type |
Description |
|
code
|
string
|
Standardized string to programmatically identify the error.
|
|
message
|
string
|
Detailed error description and debugging information.
|
|
target
|
string
|
Detailed error description and debugging information.
|
Error
Error model.
| Name |
Type |
Description |
|
code
|
string
|
Standardized string to programmatically identify the error.
|
|
details
|
Details[]
|
Detailed errors.
|
|
innererror
|
string
|
More information to debug error.
|
|
message
|
string
|
Detailed error description and debugging information.
|
|
target
|
string
|
Detailed error description and debugging information.
|