Microsoft Azure Functions · Schema
SiteProperties
Site resource specific properties
AzureCloudComputeEvent-DrivenMicrosoftServerless
Properties
| Name | Type | Description |
|---|---|---|
| state | string | Current state of the app. |
| hostNames | array | Hostnames associated with the app. |
| repositorySiteName | string | Name of the repository site. |
| usageState | object | State indicating whether the app has exceeded its quota usage. Read-only. |
| enabled | boolean | true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline). |
| enabledHostNames | array | Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. |
| availabilityState | object | Management information availability state for the app. |
| hostNameSslStates | array | Hostname SSL states are used to manage the SSL bindings for app's hostnames. |
| serverFarmId | string | Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
| reserved | boolean | true if reserved; otherwise, false. |
| isXenon | boolean | Obsolete: Hyper-V sandbox. |
| hyperV | boolean | Hyper-V sandbox. |
| lastModifiedTimeUtc | string | Last time the app was modified, in UTC. Read-only. |
| dnsConfiguration | object | Property to configure various DNS related settings for a site. |
| outboundVnetRouting | object | Property to configure various outbound traffic routing options over virtual network for a site |
| siteConfig | object | Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. |
| functionAppConfig | object | Configuration specific of the Azure Function app. |
| daprConfig | object | Dapr configuration of the app. |
| workloadProfileName | string | Workload profile name for function app to execute on. |
| resourceConfig | object | Function app resource requirements. |
| trafficManagerHostNames | array | Azure Traffic Manager hostnames associated with the app. Read-only. |
| scmSiteAlsoStopped | boolean | true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false. |
| targetSwapSlot | string | Specifies which deployment slot this app will swap into. Read-only. |
| hostingEnvironmentProfile | object | App Service Environment to use for the app. |
| clientAffinityEnabled | boolean | true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true
|
| clientAffinityPartitioningEnabled | boolean | true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitione |
| clientAffinityProxyEnabled | boolean | true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false. |
| clientCertEnabled | boolean | true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false. |
| clientCertMode | object | This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertE |
| clientCertExclusionPaths | string | client certificate authentication comma-separated exclusion paths |
| ipMode | object | Specifies the IP mode of the app. |
| endToEndEncryptionEnabled | boolean | Whether to use end to end encryption between the FrontEnd and the Worker |
| sshEnabled | boolean | Whether to enable ssh access. |
| hostNamesDisabled | boolean | true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process. |
| customDomainVerificationId | string | Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. |
| outboundIpAddresses | string | List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only. |
| possibleOutboundIpAddresses | string | List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. |
| containerSize | integer | Size of the function container. |
| dailyMemoryTimeQuota | integer | Maximum allowed daily memory-time quota (applicable on dynamic apps only). |
| suspendedTill | string | App suspended till in case memory-time quota is exceeded. |
| maxNumberOfWorkers | integer | Maximum number of workers. This only applies to Functions container. |
| cloningInfo | object | If specified during app creation, the app is cloned from a source app. |
| resourceGroup | string | Name of the resource group the app belongs to. Read-only. |
| isDefaultContainer | boolean | true if the app is a default container; otherwise, false. |
| defaultHostName | string | Default hostname of the app. Read-only. |
| slotSwapStatus | object | Status of the last deployment slot swap operation. |
| httpsOnly | boolean | HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests |
| redundancyMode | object | Site redundancy mode |
| inProgressOperationId | string | Specifies an operation id if this site has a pending operation. |
| publicNetworkAccess | string | Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. |
| storageAccountRequired | boolean | Checks if Customer provided storage account is required |
| keyVaultReferenceIdentity | string | Identity to use for Key Vault Reference authentication. |
| autoGeneratedDomainNameLabelScope | object | Specifies the scope of uniqueness for the default hostname during resource creation |
| virtualNetworkSubnetId | string | Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/pro |
| managedEnvironmentId | string | Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Mi |
| sku | string | Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 |