The identity and technical contract details declared by the specification.
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
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure Functions publishes across the network.