How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure Functions AppServiceEnvironments API

The AppServiceEnvironments API from Microsoft Azure Functions — 36 operation(s) for appserviceenvironments.

Microsoft Azure Functions AppServiceEnvironments API is one of 23 APIs that Microsoft Azure Functions publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include AppServiceEnvironments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, an API reference, and authentication docs.

This API exposes 48 operations across 36 paths, and defines 152 schemas. It is described by OpenAPI 3.2.0, at version 2025-05-01.

Requests are made against a single base URL, https://management.azure.com.

48 operations 36 paths 152 schemas 3 DELETE30 GET3 PATCH6 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2025-05-01
Base URL
https://management.azure.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Microsoft Azure Functions AppServiceEnvironments API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (azure_auth) using the implicit flow, exposing 1 scope. By default, every request must be authenticated.

  • azure_auth — Azure Active Directory OAuth2 Flow.

Paths & Operations 48

Across 36 paths, the API surfaces 48 operations — 3 DELETE, 30 GET, 3 PATCH, 6 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

AppServiceEnvironments 48
GET
/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
Get all App Service Environments for a subscription.
AppServiceEnvironments_List 2 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
Get all App Service Environments in a resource group.
AppServiceEnvironments_ListByResourceGroup 3 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Get the properties of an App Service Environment.
AppServiceEnvironments_Get 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Create or update an App Service Environment.
AppServiceEnvironments_CreateOrUpdate 4 params body → 200201202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Create or update an App Service Environment.
AppServiceEnvironments_Update 4 params body → 200201202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
Delete an App Service Environment.
AppServiceEnvironments_Delete 5 params → 202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
Get the used, available, and total worker capacity an App Service Environment.
AppServiceEnvironments_ListCapacities 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
Get IP addresses assigned to an App Service Environment.
AppServiceEnvironments_GetVipInfo 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork
Move an App Service Environment to a different VNET.
AppServiceEnvironments_ChangeVnet 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
Get Custom Dns Suffix configuration of an App Service Environment
AppServiceEnvironments_GetAseCustomDnsSuffixConfiguration 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
Update Custom Dns Suffix configuration of an App Service Environment
AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration 4 params body → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix
Delete Custom Dns Suffix configuration of an App Service Environment
AppServiceEnvironments_DeleteAseCustomDnsSuffixConfiguration 4 params → 200204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking
Get networking configuration of an App Service Environment
AppServiceEnvironments_GetAseV3NetworkingConfiguration 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking
Update networking configuration of an App Service Environment
AppServiceEnvironments_UpdateAseNetworkingConfiguration 4 params body → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
Get diagnostic information for an App Service Environment.
AppServiceEnvironments_ListDiagnostics 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints
Get the network endpoints of all inbound dependencies of an App Service Environment.
AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
Get all multi-role pools.
AppServiceEnvironments_ListMultiRolePools 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Get properties of a multi-role pool.
AppServiceEnvironments_GetMultiRolePool 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Create or update a multi-role pool.
AppServiceEnvironments_CreateOrUpdateMultiRolePool 4 params body → 200202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
Create or update a multi-role pool.
AppServiceEnvironments_UpdateMultiRolePool 4 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
Get metric definitions for a multi-role pool of an App Service Environment.
AppServiceEnvironments_ListMultiRoleMetricDefinitions 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
Get available SKUs for scaling a multi-role pool.
AppServiceEnvironments_ListMultiRolePoolSkus 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
Get usage metrics for a multi-role pool of an App Service Environment.
AppServiceEnvironments_ListMultiRoleUsages 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
List all currently running operations on the App Service Environment.
AppServiceEnvironments_ListOperations 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints
Get the network endpoints of all outbound dependencies of an App Service Environment.
AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections
Gets the list of private endpoints associated with a hosting environment
AppServiceEnvironments_GetPrivateEndpointConnectionList 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
Gets a private endpoint connection
AppServiceEnvironments_GetPrivateEndpointConnection 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
Approves or rejects a private endpoint connection
AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection 5 params body → 200202default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}
Deletes a private endpoint connection
AppServiceEnvironments_DeletePrivateEndpointConnection 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources
Gets the private link resources
AppServiceEnvironments_GetPrivateLinkResources 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
Reboot all machines in an App Service Environment.
AppServiceEnvironments_Reboot 4 params → 202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
Resume an App Service Environment.
AppServiceEnvironments_Resume 4 params → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
Get all App Service plans in an App Service Environment.
AppServiceEnvironments_ListAppServicePlans 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
Get all apps in an App Service Environment.
AppServiceEnvironments_ListWebApps 5 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
Suspend an App Service Environment.
AppServiceEnvironments_Suspend 4 params → 200202default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification
Send a test notification that an upgrade is available for this App Service Environment.
AppServiceEnvironments_TestUpgradeAvailableNotification 4 params → 200default
POST
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade
Initiate an upgrade of an App Service Environment if one is available.
AppServiceEnvironments_Upgrade 4 params → 202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
Get global usage metrics of an App Service Environment.
AppServiceEnvironments_ListUsages 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
Get all worker pools of an App Service Environment.
AppServiceEnvironments_ListWorkerPools 4 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Get properties of a worker pool.
AppServiceEnvironments_GetWorkerPool 5 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Create or update a worker pool.
AppServiceEnvironments_CreateOrUpdateWorkerPool 5 params body → 200202default
PATCH
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
Create or update a worker pool.
AppServiceEnvironments_UpdateWorkerPool 5 params body → 200202default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
Get metric definitions for a worker pool of an App Service Environment.
AppServiceEnvironments_ListWebWorkerMetricDefinitions 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
Get available SKUs for scaling a worker pool.
AppServiceEnvironments_ListWorkerPoolSkus 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
Get usage metrics for a worker pool of an App Service Environment.
AppServiceEnvironments_ListWebWorkerUsages 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
Get a diagnostics item for an App Service Environment.
AppServiceEnvironments_GetDiagnosticsItem 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions
Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions 5 params → 200default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions
Get metric definitions for a specific instance of a worker pool of an App Service Environment.
AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions 6 params → 200default

Schemas 152

The contract defines 152 schemas that model the data the API accepts and returns. The most detailed are SiteConfig (73 properties), SiteProperties (56 properties), AppServicePlanProperties (31 properties), AppServiceEnvironment (20 properties). Each schema is shown below with its type and property counts.

FtpsState
string
State of FTP / FTPS service
StorageMount
object
Server farm storage mount configuration.
5 properties
ResourceMetricDefinition
object
Metadata for the metrics.
1 property
ResourceMetricAvailability
object
Metrics availability and retention.
2 properties
Operation
object
An operation on a resource.
8 properties
RemotePrivateEndpointConnectionARMResourceProperties
object
RemotePrivateEndpointConnectionARMResource resource specific properties
4 properties
ManagedServiceIdentityType
string
Type of managed service identity.
ArmIdWrapper
object
A wrapper for an ARM resource id
1 property
UpgradeAvailability
string
Whether an upgrade is available for this App Service Environment.
CustomDnsSuffixProvisioningState
string
SlowRequestsBasedTrigger
object
Trigger based on request execution time.
4 properties
KeyVaultReferenceWithStatus
object
Object to hold key vault reference and the resolution status
2 properties
FunctionsRuntime
object
Function app runtime name and version.
2 properties
Site
object
A web app, a mobile app backend, or an API app.
4 properties
DefaultErrorResponseErrorDetailsItem
object
Detailed errors.
3 properties
AutoHealActions
object
Actions which to take by the auto-heal module when a rule is triggered.
3 properties
Capability
object
Describes the capabilities/features allowed for a specific SKU.
3 properties
InboundEnvironmentEndpoint
object
The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.
3 properties
AutoHealRules
object
Rules that can be defined for auto-heal.
2 properties
RequestsBasedTrigger
object
Trigger based on total requests.
2 properties
UsageCollection
object
Collection of usages.
2 properties 1 required
WebAppCollection
object
Collection of App Service apps.
2 properties 1 required
OutboundEnvironmentEndpoint
object
Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.
2 properties
NameValuePair
object
Name value pair.
2 properties
FunctionsDeploymentStorage
object
Storage for deployed package used by the function app.
3 properties
EndpointDetail
object
Current TCP connectivity information from the App Service Environment to a single endpoint.
4 properties
KubeEnvironmentProfile
object
Specification for a Kubernetes Environment to use for this resource.
3 properties
RemotePrivateEndpointConnectionARMResource
object
Remote Private Endpoint Connection ARM resource.
2 properties
ResourceConfig
object
Function app resource requirements.
2 properties
HostingEnvironmentStatus
string
Current status of the App Service Environment.
AppServiceEnvironmentResource
object
App Service Environment ARM resource.
2 properties
PrivateLinkResourceProperties
object
Properties of a private link resource
3 properties
OperationStatus
string
The current status of the operation.
TlsCipherSuites
string
The minimum strength TLS cipher suite allowed for an application
WorkerPool
object
Worker pool of an App Service Environment.
5 properties
AppServicePlanProperties
object
AppServicePlan resource specific properties
31 properties
ExtendedLocation
object
Extended Location.
2 properties
FunctionAppConfig
object
Function app configuration.
4 properties
CsmUsageQuota
object
Usage of the quota resource.
5 properties
Experiments
object
Routing rules in production experiments.
1 property
StampCapacity
object
Stamp capacity information.
11 properties
SiteUpdateStrategyType
string
Function app site update strategy type. Available options: Recreate, RollingUpdate
EndpointDependency
object
A domain name that a service is reached at, including details of the current connection status.
2 properties
AppServicePlan
object
App Service plan.
5 properties
InstallScriptSource
object
Object to hold install script reference.
2 properties
DefaultErrorResponse
object
App Service error response.
1 property
ManagedPipelineMode
string
Managed pipeline mode.
RegistryAdapter
object
Server farm registry adapter configuration.
3 properties
DefaultErrorResponseError
object
Error model.
5 properties
ConnectionStringType
string
Type of database.
ResourceMetricDefinitionCollection
object
Collection of metric definitions.
2 properties 1 required
AutoGeneratedDomainNameLabelScope
string
Specifies the scope of uniqueness for the default hostname during resource creation
DaprLogLevel
string
Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
DaprConfig
object
App Dapr configuration.
7 properties
OutboundEnvironmentEndpointCollection
object
Paged collection of OutboundEnvironmentEndpoint items
2 properties 1 required
AzureStorageState
string
State of the storage account.
StatusCodesBasedTrigger
object
Trigger based on status code.
6 properties
ErrorEntity
object
Body of the error response returned from the API.
8 properties
ProxyOnlyResource
object
Azure proxy only resource. This resource is not tracked by Azure Resource Manager.
4 properties
FunctionsDeploymentStorageAuthentication
object
Authentication method to access the storage account for deployment.
3 properties
StorageMountType
string
Type of the storage mount.
AzureStorageInfoValue
object
Azure Files or Blob Storage access information value for dictionary storage.
7 properties
RampUpRule
object
Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.
8 properties
PrivateLinkConnectionState
object
The state of a private link connection
3 properties
ManagedServiceIdentity
object
Managed service identity.
4 properties
SkuDescription
object
Description of a SKU for a scalable resource.
8 properties
AddressResponseProperties
object
AddressResponse resource specific properties
4 properties
RuntimeName
string
Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom
ComputeModeOptions
string
Shared/dedicated workers.
AzureStorageProtocol
string
Mounting protocol to use for the storage account.
WorkerSizeOptions
string
Size of the machines.
InstallScriptType
string
Type of the install script.
IpSecurityRestriction
object
IP security restriction on an app.
11 properties
HostingEnvironmentDiagnostics
object
Diagnostics for an App Service Environment.
2 properties
PrivateLinkResourcesWrapper
object
Wrapper for a collection of private link resources
1 property 1 required
SupportedTlsVersions
string
MinTlsVersion: configures the minimum version of TLS required for SSL requests
AppServiceEnvironmentCollection
object
Collection of App Service Environments.
2 properties 1 required
StatusOptions
string
App Service plan status.
AseV3NetworkingConfiguration
object
Full view of networking configuration for an ASE.
2 properties
SiteMachineKey
object
MachineKey of an app.
4 properties
AutoHealTriggers
object
Triggers for auto-heal.
6 properties
SkuInfoCollection
object
Paged collection of SkuInfo items
2 properties 1 required
ClientCertMode
string
This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required me…
SiteAvailabilityState
string
Management information availability state for the app.
VirtualNetworkProfile
object
Specification for using a Virtual Network.
4 properties 1 required
SslState
string
SSL type
IPMode
string
Specifies the IP mode of the app.
FunctionsAlwaysReadyConfig
object
Sets the number of 'Always Ready' instances for a function group or a specific function.
2 properties
PushSettings
object
Push settings for the App.
1 property
OutboundVnetRouting
object
Outbound traffic options over virtual network.
5 properties
PrivateEndpointConnectionCollection
object
Paged collection of RemotePrivateEndpointConnectionARMResource items
2 properties 1 required
SiteLimits
object
Metric limits set on an app.
3 properties
RegistryAdapterType
string
Type of the registry adapter.
WorkerPoolResource
object
Worker pool of an App Service Environment ARM resource.
3 properties
AppServiceEnvironmentPatchResource
object
ARM resource for a app service environment.
1 property
LoadBalancingMode
string
Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.
SiteProperties
object
Site resource specific properties
56 properties
HostingEnvironmentProfile
object
Specification for an App Service Environment to use for this resource.
3 properties
DefaultAction
string
Default action for main access restriction if no rules are matched.
Usage
object
Usage of the quota resource.
1 property
SkuInfo
object
SKU discovery information.
3 properties
SlotSwapStatus
object
The status of the last successful slot swap operation.
3 properties
UserAssignedIdentity
object
User Assigned identity.
2 properties
UsageProperties
object
Usage resource specific properties
8 properties
AutoHealCustomAction
object
Custom action to be executed when an auto heal rule is triggered.
2 properties
IpFilterTag
string
Defines what this IP filter will be used for. This is to support IP filtering on proxies.
FunctionsDeploymentStorageType
string
Property to select Azure Storage type. Available options: blobContainer.
PrivateLinkResource
object
A private link resource
4 properties 4 required
HostNameSslState
object
SSL-enabled hostname.
6 properties
RedundancyMode
string
Site redundancy mode
FunctionsScaleAndConcurrencyTriggers
object
Scale and concurrency settings for the function app triggers.
1 property
CsmUsageQuotaCollection
object
Paged collection of CsmUsageQuota items
2 properties 1 required
VirtualIPMapping
object
Virtual IP mapping.
5 properties
StampCapacityCollection
object
Paged collection of StampCapacity items
2 properties 1 required
PushSettingsProperties
object
PushSettings resource specific properties
4 properties 1 required
AutoHealActionType
string
Predefined action to be taken.
ConnStringInfo
object
Database connection string information.
3 properties
UsageState
string
State indicating whether the app has exceeded its quota usage. Read-only.
ResourceMetricDefinitionProperties
object
ResourceMetricDefinition resource specific properties
5 properties
CorsSettings
object
Cross-Origin Resource Sharing (CORS) settings for the app.
2 properties
ServerFarmNetworkSettings
object
Network settings for an app service plan.
1 property
ApiDefinitionInfo
object
Information about the formal API definition for the app.
1 property
CloningInfo
object
Information needed for cloning operation.
11 properties 1 required
AppServicePlanCollection
object
Collection of App Service plans.
2 properties 1 required
AddressResponse
object
Describes main public IP address and any extra virtual IPs.
2 properties
ApiManagementConfig
object
Azure API management (APIM) configuration linked to the app.
1 property
VirtualDirectory
object
Directory for virtual application.
2 properties
ProvisioningState
string
Provisioning state of the App Service Plan.
StatusCodesRangeBasedTrigger
object
Trigger based on range of status codes.
4 properties
LocalizableString
object
Localizable string object containing the name and a localized value.
2 properties
SiteLoadBalancing
string
Site load balancing.
VirtualApplication
object
Virtual application in an app.
4 properties
AuthenticationType
string
Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountC…
AzureStorageType
string
Type of storage.
SkuCapacity
object
Description of the App Service plan scale options.
5 properties
CustomDnsSuffixConfigurationProperties
object
CustomDnsSuffixConfiguration resource specific properties
5 properties
InstallScript
object
Server farm install script configuration.
2 properties
FunctionsSiteUpdateStrategy
object
Function app site update strategy configuration for deployments and site config updates.
1 property
SiteConfig
object
Configuration of an App Service app.
73 properties
AppServiceEnvironment
object
Description of an App Service Environment.
20 properties 1 required
SiteDnsConfig
object
6 properties
CustomDnsSuffixConfiguration
object
Full view of the custom domain suffix configuration for ASEv3.
2 properties
AseV3NetworkingConfigurationProperties
object
AseV3NetworkingConfiguration resource specific properties
8 properties
FunctionsScaleAndConcurrencyTriggersHttp
object
Scale and concurrency settings for the HTTP trigger.
1 property
InboundEnvironmentEndpointCollection
object
Collection of Inbound Environment Endpoints
2 properties 1 required
HostType
string
Indicates whether the hostname is a standard or repository hostname.
WorkerPoolCollection
object
Collection of worker pools.
2 properties 1 required
FunctionsDeployment
object
Configuration section for the function app deployment.
1 property
FunctionsScaleAndConcurrency
object
Scale and concurrency settings for the function app.
4 properties
DefaultIdentity
object
2 properties
HandlerMapping
object
The IIS handler mappings used to define which handler processes HTTP requests with certain extension. For example, it is used to configure php-cgi.exe process…
3 properties
ScmType
string
SCM type.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-functions-appserviceenvironments-api-openapi.yml Raw ↑

Other APIs Microsoft Azure Functions publishes across the network.

Azure Functions Runtime API
Microsoft Azure Functions AppServicePlans API
Microsoft Azure Functions Certificates API
Microsoft Azure Functions DeletedWebApps API
Microsoft Azure Functions Diagnostics API
Microsoft Azure Functions Global API
Microsoft Azure Functions KubeEnvironments API
Microsoft Azure Functions Operations API
Microsoft Azure Functions Provider API
Microsoft Azure Functions Providers API
Microsoft Azure Functions Recommendations API
Microsoft Azure Functions ResourceHealthMetadata API
Where this information came from

This is an independent, third-party profile of Microsoft Azure Functions AppServiceEnvironments API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.