PUT /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	Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
`extendedLocation`	Object	No	Extended Location.
`extendedLocation.name`	String	No	Name of extended location.
`extendedLocation.type`	String	No	Type of extended location.
`name`	String	No	The name of the resource
`sku`	Object	No	Description of a SKU for a scalable resource.
`sku.tier`	String	No	Service tier of the resource SKU.
`sku.family`	String	No	Family code of the resource SKU.
`sku.name`	String	No	Name of the resource SKU.
`sku.size`	String	No	Size specifier of the resource SKU.
`sku.locations[]`	Array	No	Locations of the SKU.
`sku.skuCapacity`	Object	No	Description of the App Service plan scale options.
`sku.skuCapacity.minimum`	Integer	No	Minimum number of workers for this App Service plan SKU.
`sku.skuCapacity.elasticMaximum`	Integer	No	Maximum number of Elastic workers for this App Service plan SKU.
`sku.skuCapacity.default`	Integer	No	Default number of workers for this App Service plan SKU.
`sku.skuCapacity.scaleType`	String	No	Available scale configurations for an App Service plan.
`sku.skuCapacity.maximum`	Integer	No	Maximum number of workers for this App Service plan SKU.
`sku.capacity`	Integer	No	Current number of instances assigned to the resource.
`sku.capabilities[]`	Array	No	Capabilities of the SKU, e.g., is traffic manager enabled?
`sku.capabilities[].name`	String	No	Name of the SKU capability.
`sku.capabilities[].value`	String	No	Value of the SKU capability.
`sku.capabilities[].reason`	String	No	Reason of the SKU capability.
`systemData`	Object	No	Metadata pertaining to creation and last modification of the resource.
`systemData.createdByType`	String	No	The type of identity that created the resource. Possible values: `"ManagedIdentity"` `"Key"` `"Application"` `"User"`
`systemData.lastModifiedAt`	String	No	The timestamp of resource last modification (UTC)
`systemData.createdAt`	String	No	The timestamp of resource creation (UTC).
`systemData.lastModifiedBy`	String	No	The identity that last modified the resource.
`systemData.lastModifiedByType`	String	No	The type of identity that last modified the resource. Possible values: `"ManagedIdentity"` `"Key"` `"Application"` `"User"`
`systemData.createdBy`	String	No	The identity that created the resource.
`properties`	Object	No	AppServicePlan resource specific properties
`properties.reserved`	Boolean	No	If Linux app service plan `true`, `false` otherwise. 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 `true`, this App Service Plan owns spot instances.
`properties.status`	String	No	App Service plan status. Possible values: `"Creating"` `"Pending"` `"Ready"`
`properties.perSiteScaling`	Boolean	No	If `true`, apps assigned to this App Service plan can be scaled independently. If `false`, apps assigned to this App Service plan will scale to all instances of the plan. Default value: false
`properties.hyperV`	Boolean	No	If Hyper-V container app service plan `true`, `false` otherwise. 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: `"Succeeded"` `"Deleting"` `"Canceled"` `"InProgress"` `"Failed"`
`properties.isXenon`	Boolean	No	Obsolete: If Hyper-V container app service plan `true`, `false` otherwise. 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 `true`, this App Service Plan will perform availability zone balancing. If `false`, this App Service Plan will not perform availability zone balancing. 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	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

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.