Validate - Validate

Service:

App Service

API Version:

2023-12-01

Description for Validate if a resource can be created.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
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
location	True	string	Expected location of the resource.
name	True	string	Resource name to verify.
type	True	ValidateResourceTypes	Resource type used for verification.
properties.appServiceEnvironment		AppServiceEnvironment	App Service Environment Properties
properties.capacity		integer	Target capacity of the App Service plan (number of VMs).
properties.containerImagePlatform		string	Platform (windows or linux)
properties.containerImageRepository		string	Repository name (image name)
properties.containerImageTag		string	Image tag
properties.containerRegistryBaseUrl		string	Base URL of the container registry
properties.containerRegistryPassword		string	Password for to access the container registry
properties.containerRegistryUsername		string	Username for to access the container registry
properties.hostingEnvironment		string	Name of App Service Environment where app or App Service plan should be created.
properties.isSpot		boolean	true if App Service plan is for Spot instances; otherwise, false.
properties.isXenon		boolean	true if App Service plan is running as a windows container
properties.needLinuxWorkers		boolean	true if App Service plan is for Linux workers; otherwise, false.
properties.serverFarmId		string	ARM resource ID of an App Service plan that would host the app.
properties.skuName		string	Name of the target SKU for the App Service plan.

Responses

Name	Type	Description
200 OK	ValidateResponse	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

Definitions

Name	Description
AppServiceEnvironment	Description of an App Service Environment.
AseV3NetworkingConfiguration	Full view of networking configuration for an ASE.
CustomDnsSuffixConfiguration	Full view of the custom domain suffix configuration for ASEv3.
CustomDnsSuffixProvisioningState
DefaultErrorResponse	App Service error response.
Details
Error	Error model.
HostingEnvironmentStatus	Current status of the App Service Environment.
LoadBalancingMode	Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
NameValuePair	Name value pair.
ProvisioningState	Provisioning state of the App Service Environment.
UpgradeAvailability	Whether an upgrade is available for this App Service Environment.
UpgradePreference	Upgrade Preference
ValidateRequest	Resource validation request content.
ValidateResourceTypes	Resource type used for verification.
ValidateResponse	Describes the result of resource validation.
ValidateResponseError	Error details for when validation fails.
VirtualNetworkProfile	Specification for using a Virtual Network.

AppServiceEnvironment

Description of an App Service Environment.

Name	Type	Default Value	Description
clusterSettings	NameValuePair[]		Custom settings for changing the behavior of the App Service Environment.
customDnsSuffixConfiguration	CustomDnsSuffixConfiguration		Full view of the custom domain suffix configuration for ASEv3.
dedicatedHostCount	integer		Dedicated Host Count
dnsSuffix	string		DNS suffix of the App Service Environment.
frontEndScaleFactor	integer		Scale factor for front-ends.
hasLinuxWorkers	boolean		Flag that displays whether an ASE has linux workers or not
internalLoadBalancingMode	LoadBalancingMode		Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
ipsslAddressCount	integer		Number of IP SSL addresses reserved for the App Service Environment.
maximumNumberOfMachines	integer		Maximum number of VMs in the App Service Environment.
multiRoleCount	integer		Number of front-end instances.
multiSize	string		Front-end VM size, e.g. "Medium", "Large".
networkingConfiguration	AseV3NetworkingConfiguration		Full view of networking configuration for an ASE.
provisioningState	ProvisioningState		Provisioning state of the App Service Environment.
status	HostingEnvironmentStatus		Current status of the App Service Environment.
suspended	boolean		true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available (most likely because NSG blocked the incoming traffic).
upgradeAvailability	UpgradeAvailability		Whether an upgrade is available for this App Service Environment.
upgradePreference	UpgradePreference	None	Upgrade Preference
userWhitelistedIpRanges	string[]		User added ip ranges to whitelist on ASE db
virtualNetwork	VirtualNetworkProfile		Description of the Virtual Network.
zoneRedundant	boolean		Whether or not this App Service Environment is zone-redundant.

AseV3NetworkingConfiguration

Full view of networking configuration for an ASE.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.allowNewPrivateEndpointConnections	boolean	Property to enable and disable new private endpoint connection creation on ASE
properties.externalInboundIpAddresses	string[]
properties.ftpEnabled	boolean	Property to enable and disable FTP on ASEV3
properties.inboundIpAddressOverride	string	Customer provided Inbound IP Address. Only able to be set on Ase create.
properties.internalInboundIpAddresses	string[]
properties.linuxOutboundIpAddresses	string[]
properties.remoteDebugEnabled	boolean	Property to enable and disable Remote Debug on ASEV3
properties.windowsOutboundIpAddresses	string[]
type	string	Resource type.

CustomDnsSuffixConfiguration

Full view of the custom domain suffix configuration for ASEv3.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.certificateUrl	string	The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix.
properties.dnsSuffix	string	The default custom domain suffix to use for all sites deployed on the ASE.
properties.keyVaultReferenceIdentity	string	The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available.
properties.provisioningDetails	string
properties.provisioningState	CustomDnsSuffixProvisioningState
type	string	Resource type.

CustomDnsSuffixProvisioningState

Name	Type	Description
Degraded	string
Failed	string
InProgress	string
Succeeded	string

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.

HostingEnvironmentStatus

Current status of the App Service Environment.

Name	Type	Description
Deleting	string
Preparing	string
Ready	string
Scaling	string

LoadBalancingMode

Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.

Name	Type	Description
None	string
Publishing	string
Web	string
Web, Publishing	string

NameValuePair

Name value pair.

Name	Type	Description
name	string	Pair name.
value	string	Pair value.

ProvisioningState

Provisioning state of the App Service Environment.

Name	Type	Description
Canceled	string
Deleting	string
Failed	string
InProgress	string
Succeeded	string

UpgradeAvailability

Whether an upgrade is available for this App Service Environment.

Name	Type	Description
None	string	No upgrade is currently available for this App Service Environment
Ready	string	An upgrade is ready to be manually initiated on this App Service Environment

UpgradePreference

Upgrade Preference

Name	Type	Description
Early	string	This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'
Late	string	This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'
Manual	string	ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically
None	string	No preference on when this App Service Environment will be upgraded

ValidateRequest

Resource validation request content.

Name	Type	Description
location	string	Expected location of the resource.
name	string	Resource name to verify.
properties.appServiceEnvironment	AppServiceEnvironment	App Service Environment Properties
properties.capacity	integer	Target capacity of the App Service plan (number of VMs).
properties.containerImagePlatform	string	Platform (windows or linux)
properties.containerImageRepository	string	Repository name (image name)
properties.containerImageTag	string	Image tag
properties.containerRegistryBaseUrl	string	Base URL of the container registry
properties.containerRegistryPassword	string	Password for to access the container registry
properties.containerRegistryUsername	string	Username for to access the container registry
properties.hostingEnvironment	string	Name of App Service Environment where app or App Service plan should be created.
properties.isSpot	boolean	true if App Service plan is for Spot instances; otherwise, false.
properties.isXenon	boolean	true if App Service plan is running as a windows container
properties.needLinuxWorkers	boolean	true if App Service plan is for Linux workers; otherwise, false.
properties.serverFarmId	string	ARM resource ID of an App Service plan that would host the app.
properties.skuName	string	Name of the target SKU for the App Service plan.
type	ValidateResourceTypes	Resource type used for verification.

ValidateResourceTypes

Resource type used for verification.

Name	Type	Description
Microsoft.Web/hostingEnvironments	string
ServerFarm	string
Site	string

ValidateResponse

Describes the result of resource validation.

Name	Type	Description
error	ValidateResponseError	Error details for the case when validation fails.
status	string	Result of validation.

ValidateResponseError

Error details for when validation fails.

Name	Type	Description
code	string	Validation error code.
message	string	Validation error message.

VirtualNetworkProfile

Specification for using a Virtual Network.

Name	Type	Description
id	string	Resource id of the Virtual Network.
name	string	Name of the Virtual Network (read-only).
subnet	string	Subnet within the Virtual Network.
type	string	Resource type of the Virtual Network (read-only).