Microsoft Azure Functions · Schema
ValidateRequest
Resource validation request content.
Microsoft AzureCloudComputeEvent-DrivenMicrosoftServerless
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Resource name to verify. |
| type | object | Resource type used for verification. |
| location | string | Expected location of the resource. |
| properties | object | Properties of the resource to validate. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://artifacts.apis.io/microsoft-azure-functions/json-schema/microsoft-azure-functions-validate-request-schema.json",
"title": "ValidateRequest",
"description": "Resource validation request content.",
"x-generated": "2026-11-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/microsoft-azure-functions-subscriptions-api-openapi.yml#/components/schemas/ValidateRequest",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Resource name to verify."
},
"type": {
"$ref": "#/$defs/ValidateResourceTypes",
"description": "Resource type used for verification."
},
"location": {
"type": "string",
"description": "Expected location of the resource."
},
"properties": {
"$ref": "#/$defs/ValidateProperties",
"description": "Properties of the resource to validate.",
"x-ms-client-flatten": true
}
},
"required": [
"name",
"type",
"location",
"properties"
],
"$defs": {
"AppServiceEnvironment": {
"type": "object",
"description": "Description of an App Service Environment.",
"properties": {
"provisioningState": {
"$ref": "#/$defs/ProvisioningState",
"description": "Provisioning state of the App Service Environment.",
"readOnly": true
},
"status": {
"$ref": "#/$defs/HostingEnvironmentStatus",
"description": "Current status of the App Service Environment.",
"readOnly": true
},
"virtualNetwork": {
"$ref": "#/$defs/VirtualNetworkProfile",
"description": "Description of the Virtual Network."
},
"internalLoadBalancingMode": {
"$ref": "#/$defs/LoadBalancingMode",
"description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."
},
"multiSize": {
"type": "string",
"description": "Front-end VM size, e.g. \"Medium\", \"Large\"."
},
"multiRoleCount": {
"type": "integer",
"format": "int32",
"description": "Number of front-end instances.",
"readOnly": true
},
"ipsslAddressCount": {
"type": "integer",
"format": "int32",
"description": "Number of IP SSL addresses reserved for the App Service Environment."
},
"dnsSuffix": {
"type": "string",
"description": "DNS suffix of the App Service Environment."
},
"maximumNumberOfMachines": {
"type": "integer",
"format": "int32",
"description": "Maximum number of VMs in the App Service Environment.",
"readOnly": true
},
"frontEndScaleFactor": {
"type": "integer",
"format": "int32",
"description": "Scale factor for front-ends."
},
"suspended": {
"type": "boolean",
"description": "<code>true</code> if the App Service Environment is suspended; otherwise, <code>false</code>. The environment can be suspended, e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
"readOnly": true
},
"clusterSettings": {
"type": "array",
"description": "Custom settings for changing the behavior of the App Service Environment.",
"items": {
"$ref": "#/$defs/NameValuePair"
},
"x-ms-identifiers": [
"name"
]
},
"userWhitelistedIpRanges": {
"type": "array",
"description": "User added ip ranges to whitelist on ASE db",
"items": {
"type": "string"
}
},
"hasLinuxWorkers": {
"type": "boolean",
"description": "Flag that displays whether an ASE has linux workers or not",
"readOnly": true
},
"upgradePreference": {
"type": "string",
"description": "Upgrade Preference",
"default": "None",
"enum": [
"None",
"Early",
"Late",
"Manual"
],
"x-ms-enum": {
"name": "UpgradePreference",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No preference on when this App Service Environment will be upgraded"
},
{
"name": "Early",
"value": "Early",
"description": "This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'"
},
{
"name": "Late",
"value": "Late",
"description": "This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'"
},
{
"name": "Manual",
"value": "Manual",
"description": "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"
}
]
}
},
"dedicatedHostCount": {
"type": "integer",
"format": "int32",
"description": "Dedicated Host Count"
},
"zoneRedundant": {
"type": "boolean",
"description": "Whether or not this App Service Environment is zone-redundant."
},
"customDnsSuffixConfiguration": {
"$ref": "#/$defs/CustomDnsSuffixConfiguration",
"description": "Full view of the custom domain suffix configuration for ASEv3."
},
"networkingConfiguration": {
"$ref": "#/$defs/AseV3NetworkingConfiguration",
"description": "Full view of networking configuration for an ASE."
},
"upgradeAvailability": {
"$ref": "#/$defs/UpgradeAvailability",
"description": "Whether an upgrade is available for this App Service Environment.",
"readOnly": true
}
},
"required": [
"virtualNetwork"
]
},
"AseV3NetworkingConfiguration": {
"type": "object",
"description": "Full view of networking configuration for an ASE.",
"properties": {
"properties": {
"$ref": "#/$defs/AseV3NetworkingConfigurationProperties",
"description": "AseV3NetworkingConfiguration resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"AseV3NetworkingConfigurationProperties": {
"type": "object",
"description": "AseV3NetworkingConfiguration resource specific properties",
"properties": {
"windowsOutboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"linuxOutboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"externalInboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"internalInboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"allowNewPrivateEndpointConnections": {
"type": "boolean",
"description": "Property to enable and disable new private endpoint connection creation on ASE"
},
"ftpEnabled": {
"type": "boolean",
"description": "Property to enable and disable FTP on ASEV3"
},
"remoteDebugEnabled": {
"type": "boolean",
"description": "Property to enable and disable Remote Debug on ASEV3"
},
"inboundIpAddressOverride": {
"type": "string",
"description": "Customer provided Inbound IP Address. Only able to be set on Ase create."
}
}
},
"CustomDnsSuffixConfiguration": {
"type": "object",
"description": "Full view of the custom domain suffix configuration for ASEv3.",
"properties": {
"properties": {
"$ref": "#/$defs/CustomDnsSuffixConfigurationProperties",
"description": "CustomDnsSuffixConfiguration resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"CustomDnsSuffixConfigurationProperties": {
"type": "object",
"description": "CustomDnsSuffixConfiguration resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/$defs/CustomDnsSuffixProvisioningState",
"readOnly": true
},
"provisioningDetails": {
"type": "string",
"readOnly": true
},
"dnsSuffix": {
"type": "string",
"description": "The default custom domain suffix to use for all sites deployed on the ASE."
},
"certificateUrl": {
"type": "string",
"description": "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."
},
"keyVaultReferenceIdentity": {
"type": "string",
"description": "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."
}
}
},
"CustomDnsSuffixProvisioningState": {
"type": "string",
"enum": [
"Succeeded",
"Failed",
"Degraded",
"InProgress"
],
"x-ms-enum": {
"name": "CustomDnsSuffixProvisioningState",
"modelAsString": false
}
},
"HostingEnvironmentStatus": {
"type": "string",
"description": "Current status of the App Service Environment.",
"enum": [
"Preparing",
"Ready",
"Scaling",
"Deleting"
],
"x-ms-enum": {
"name": "HostingEnvironmentStatus",
"modelAsString": false
}
},
"LoadBalancingMode": {
"type": "string",
"description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
"enum": [
"None",
"Web",
"Publishing",
"Web, Publishing"
],
"x-ms-enum": {
"name": "LoadBalancingMode",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "Web",
"value": "Web"
},
{
"name": "Publishing",
"value": "Publishing"
},
{
"name": "Web, Publishing",
"value": "Web, Publishing"
}
]
}
},
"NameValuePair": {
"type": "object",
"description": "Name value pair.",
"properties": {
"name": {
"type": "string",
"description": "Pair name."
},
"value": {
"type": "string",
"description": "Pair value."
}
}
},
"ProvisioningState": {
"type": "string",
"description": "Provisioning state of the App Service Plan.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": false
}
},
"UpgradeAvailability": {
"type": "string",
"description": "Whether an upgrade is available for this App Service Environment.",
"enum": [
"None",
"Ready"
],
"x-ms-enum": {
"name": "UpgradeAvailability",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No upgrade is currently available for this App Service Environment"
},
{
"name": "Ready",
"value": "Ready",
"description": "An upgrade is ready to be manually initiated on this App Service Environment"
}
]
}
},
"ValidateProperties": {
"type": "object",
"description": "App properties used for validation.",
"properties": {
"serverFarmId": {
"type": "string",
"description": "ARM resource ID of an App Service plan that would host the app."
},
"skuName": {
"type": "string",
"description": "Name of the target SKU for the App Service plan."
},
"needLinuxWorkers": {
"type": "boolean",
"description": "<code>true</code> if App Service plan is for Linux workers; otherwise, <code>false</code>."
},
"isSpot": {
"type": "boolean",
"description": "<code>true</code> if App Service plan is for Spot instances; otherwise, <code>false</code>."
},
"capacity": {
"type": "integer",
"format": "int32",
"description": "Target capacity of the App Service plan (number of VMs).",
"minimum": 1
},
"hostingEnvironment": {
"type": "string",
"description": "Name of App Service Environment where app or App Service plan should be created."
},
"isXenon": {
"type": "boolean",
"description": "<code>true</code> if App Service plan is running as a windows container"
},
"containerRegistryBaseUrl": {
"type": "string",
"description": "Base URL of the container registry"
},
"containerRegistryUsername": {
"type": "string",
"description": "Username for to access the container registry"
},
"containerRegistryPassword": {
"type": "string",
"description": "Password for to access the container registry"
},
"containerImageRepository": {
"type": "string",
"description": "Repository name (image name)"
},
"containerImageTag": {
"type": "string",
"description": "Image tag"
},
"containerImagePlatform": {
"type": "string",
"description": "Platform (windows or linux)"
},
"appServiceEnvironment": {
"$ref": "#/$defs/AppServiceEnvironment",
"description": "App Service Environment Properties"
}
}
},
"ValidateResourceTypes": {
"type": "string",
"description": "Resource type used for verification.",
"enum": [
"ServerFarm",
"Site",
"Microsoft.Web/hostingEnvironments"
],
"x-ms-enum": {
"name": "ValidateResourceTypes",
"modelAsString": true,
"values": [
{
"name": "ServerFarm",
"value": "ServerFarm"
},
{
"name": "Site",
"value": "Site"
},
{
"name": "Microsoft.Web/hostingEnvironments",
"value": "Microsoft.Web/hostingEnvironments"
}
]
}
},
"VirtualNetworkProfile": {
"type": "object",
"description": "Specification for using a Virtual Network.",
"properties": {
"id": {
"type": "string",
"description": "Resource id of the Virtual Network."
},
"name": {
"type": "string",
"description": "Name of the Virtual Network (read-only).",
"readOnly": true
},
"type": {
"type": "string",
"description": "Resource type of the Virtual Network (read-only).",
"readOnly": true
},
"subnet": {
"type": "string",
"description": "Subnet within the Virtual Network."
}
},
"required": [
"id"
]
}
}
}
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/microsoft-azure-functions-validate-request"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.