POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate/?api-version=2023-01-01

Description for Validate if a resource can be created.

Servers

Path parameters

Name Type Required Description
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
name String Yes

Resource name to verify.

location String Yes

Expected location of the resource.

properties Object Yes

App properties used for validation.

properties.skuName String No

Name of the target SKU for the App Service plan.

properties.hostingEnvironment String No

Name of App Service Environment where app or App Service plan should be created.

properties.isSpot Boolean No

true if App Service plan is for Spot instances; otherwise, false.

properties.containerImageRepository String No

Repository name (image name)

properties.containerImagePlatform String No

Platform (windows or linux)

properties.containerRegistryPassword String No

Password for to access the container registry

properties.containerRegistryUsername String No

Username for to access the container registry

properties.serverFarmId String No

ARM resource ID of an App Service plan that would host the app.

properties.appServiceEnvironment Object No

Description of an App Service Environment.

properties.appServiceEnvironment.ipsslAddressCount Integer No

Number of IP SSL addresses reserved for the App Service Environment.

properties.appServiceEnvironment.multiSize String No

Front-end VM size, e.g. "Medium", "Large".

properties.appServiceEnvironment.dnsSuffix String No

DNS suffix of the App Service Environment.

properties.appServiceEnvironment.customDnsSuffixConfiguration Object No

Full view of the custom domain suffix configuration for ASEv3.

properties.appServiceEnvironment.customDnsSuffixConfiguration.id String No

Resource Id.

properties.appServiceEnvironment.customDnsSuffixConfiguration.name String No

Resource Name.

properties.appServiceEnvironment.customDnsSuffixConfiguration.properties Object No

CustomDnsSuffixConfiguration resource specific properties

properties.appServiceEnvironment.customDnsSuffixConfiguration.properties.dnsSuffix String No

The default custom domain suffix to use for all sites deployed on the ASE.

properties.appServiceEnvironment.customDnsSuffixConfiguration.properties.provisioningState String No

Possible values:

  • "Degraded"
  • "Succeeded"
  • "InProgress"
  • "Failed"
properties.appServiceEnvironment.customDnsSuffixConfiguration.properties.keyVaultReferenceIdentity String No

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.appServiceEnvironment.customDnsSuffixConfiguration.properties.provisioningDetails String No
properties.appServiceEnvironment.customDnsSuffixConfiguration.properties.certificateUrl String No

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.appServiceEnvironment.customDnsSuffixConfiguration.type String No

Resource type.

properties.appServiceEnvironment.customDnsSuffixConfiguration.kind String No

Kind of resource.

properties.appServiceEnvironment.suspended Boolean No

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).

properties.appServiceEnvironment.hasLinuxWorkers Boolean No

Flag that displays whether an ASE has linux workers or not

properties.appServiceEnvironment.maximumNumberOfMachines Integer No

Maximum number of VMs in the App Service Environment.

properties.appServiceEnvironment.frontEndScaleFactor Integer No

Scale factor for front-ends.

properties.appServiceEnvironment.status String No

Current status of the App Service Environment.

Possible values:

  • "Scaling"
  • "Preparing"
  • "Deleting"
  • "Ready"
properties.appServiceEnvironment.networkingConfiguration Object No

Full view of networking configuration for an ASE.

properties.appServiceEnvironment.networkingConfiguration.id String No

Resource Id.

properties.appServiceEnvironment.networkingConfiguration.name String No

Resource Name.

properties.appServiceEnvironment.networkingConfiguration.properties Object No

AseV3NetworkingConfiguration resource specific properties

properties.appServiceEnvironment.networkingConfiguration.properties.remoteDebugEnabled Boolean No

Property to enable and disable Remote Debug on ASEV3

properties.appServiceEnvironment.networkingConfiguration.properties.allowNewPrivateEndpointConnections Boolean No

Property to enable and disable new private endpoint connection creation on ASE

properties.appServiceEnvironment.networkingConfiguration.properties.ftpEnabled Boolean No

Property to enable and disable FTP on ASEV3

properties.appServiceEnvironment.networkingConfiguration.properties.inboundIpAddressOverride String No

Customer provided Inbound IP Address. Only able to be set on Ase create.

properties.appServiceEnvironment.networkingConfiguration.properties.internalInboundIpAddresses[] Array No
properties.appServiceEnvironment.networkingConfiguration.properties.windowsOutboundIpAddresses[] Array No
properties.appServiceEnvironment.networkingConfiguration.properties.linuxOutboundIpAddresses[] Array No
properties.appServiceEnvironment.networkingConfiguration.properties.externalInboundIpAddresses[] Array No
properties.appServiceEnvironment.networkingConfiguration.type String No

Resource type.

properties.appServiceEnvironment.networkingConfiguration.kind String No

Kind of resource.

properties.appServiceEnvironment.internalLoadBalancingMode String No

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

Possible values:

  • "Publishing"
  • "Web"
  • "None"
  • "Web, Publishing"
properties.appServiceEnvironment.userWhitelistedIpRanges[] Array No

User added ip ranges to whitelist on ASE db

properties.appServiceEnvironment.virtualNetwork Object Yes

Specification for using a Virtual Network.

properties.appServiceEnvironment.virtualNetwork.id String Yes

Resource id of the Virtual Network.

properties.appServiceEnvironment.virtualNetwork.name String No

Name of the Virtual Network (read-only).

properties.appServiceEnvironment.virtualNetwork.type String No

Resource type of the Virtual Network (read-only).

properties.appServiceEnvironment.virtualNetwork.subnet String No

Subnet within the Virtual Network.

properties.appServiceEnvironment.provisioningState String No

Provisioning state of the App Service Environment.

Possible values:

  • "Succeeded"
  • "Deleting"
  • "Canceled"
  • "InProgress"
  • "Failed"
properties.appServiceEnvironment.clusterSettings[] Array No

Custom settings for changing the behavior of the App Service Environment.

properties.appServiceEnvironment.clusterSettings[].name String No

Pair name.

properties.appServiceEnvironment.clusterSettings[].value String No

Pair value.

properties.appServiceEnvironment.multiRoleCount Integer No

Number of front-end instances.

properties.appServiceEnvironment.zoneRedundant Boolean No

Whether or not this App Service Environment is zone-redundant.

properties.appServiceEnvironment.upgradeAvailability String No

Whether an upgrade is available for this App Service Environment.

Possible values:

  • "None"
  • "Ready"
properties.appServiceEnvironment.upgradePreference String No

Upgrade Preference

Possible values:

  • "Manual"
  • "Late"
  • "None"
  • "Early"

Default value: "None"

properties.appServiceEnvironment.dedicatedHostCount Integer No

Dedicated Host Count

properties.needLinuxWorkers Boolean No

true if App Service plan is for Linux workers; otherwise, false.

properties.isXenon Boolean No

true if App Service plan is running as a windows container

properties.capacity Integer No

Target capacity of the App Service plan (number of VMs).

properties.containerImageTag String No

Image tag

properties.containerRegistryBaseUrl String No

Base URL of the container registry

type String Yes

Resource type used for verification.

Possible values:

  • "ServerFarm"
  • "Microsoft.Web/hostingEnvironments"
  • "Site"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.