PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/?api-version=2023-01-01
Description for Creates or updates an App Service Plan.
Servers
- https://management.azure.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
name |
String | Yes |
Name of the App Service plan. |
subscriptionId |
String | Yes |
Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). |
resourceGroupName |
String | Yes |
Name of the resource group to which the resource belongs. |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
id |
String | No |
Resource Id. |
name |
String | No |
Resource Name. |
properties |
Object | No |
AppServicePlanPatchResource resource specific properties |
properties.reserved |
Boolean | No |
If Linux app service plan Default value: false |
properties.hostingEnvironmentProfile |
Object | No |
Specification for an App Service Environment to use for this resource. |
properties.hostingEnvironmentProfile.id |
String | No |
Resource ID of the App Service Environment. |
properties.hostingEnvironmentProfile.name |
String | No |
Name of the App Service Environment. |
properties.hostingEnvironmentProfile.type |
String | No |
Resource type of the App Service Environment. |
properties.maximumElasticWorkerCount |
Integer | No |
Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan |
properties.workerTierName |
String | No |
Target worker tier assigned to the App Service plan. |
properties.subscription |
String | No |
App Service plan subscription. |
properties.kubeEnvironmentProfile |
Object | No |
Specification for a Kubernetes Environment to use for this resource. |
properties.kubeEnvironmentProfile.id |
String | No |
Resource ID of the Kubernetes Environment. |
properties.kubeEnvironmentProfile.name |
String | No |
Name of the Kubernetes Environment. |
properties.kubeEnvironmentProfile.type |
String | No |
Resource type of the Kubernetes Environment. |
properties.spotExpirationTime |
String | No |
The time when the server farm expires. Valid only if it is a spot server farm. |
properties.isSpot |
Boolean | No |
If |
properties.status |
String | No |
App Service plan status. Possible values:
|
properties.perSiteScaling |
Boolean | No |
If Default value: false |
properties.hyperV |
Boolean | No |
If Hyper-V container app service plan Default value: false |
properties.targetWorkerSizeId |
Integer | No |
Scaling worker size ID. |
properties.maximumNumberOfWorkers |
Integer | No |
Maximum number of instances that can be assigned to this App Service plan. |
properties.elasticScaleEnabled |
Boolean | No |
ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku |
properties.resourceGroup |
String | No |
Resource group of the App Service plan. |
properties.provisioningState |
String | No |
Provisioning state of the App Service Plan. Possible values:
|
properties.isXenon |
Boolean | No |
Obsolete: If Hyper-V container app service plan Default value: false |
properties.freeOfferExpirationTime |
String | No |
The time when the server farm free offer expires. |
properties.geoRegion |
String | No |
Geographical location for the App Service plan. |
properties.targetWorkerCount |
Integer | No |
Scaling worker count. |
properties.zoneRedundant |
Boolean | No |
If Default value: false |
properties.numberOfWorkers |
Integer | No |
The number of instances that are assigned to this App Service plan. |
properties.numberOfSites |
Integer | No |
Number of apps assigned to this App Service plan. |
type |
String | No |
Resource type. |
kind |
String | No |
Kind of resource. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.