web.azure.com/v1api20220301

"2022-03-01"

Url: The URL of the API definition.

Url: The URL of the API definition.

Reference: APIM-Api Identifier.

Id: APIM-Api Identifier.

ActionType: Predefined action to be taken.

CustomAction: Custom action to be taken.

MinProcessExecutionTime: Minimum time the process must execute before taking the action

"CustomAction"

"LogEvent"

"Recycle"

"CustomAction"

"LogEvent"

"Recycle"

ActionType: Predefined action to be taken.

CustomAction: Custom action to be taken.

MinProcessExecutionTime: Minimum time the process must execute before taking the action

Exe: Executable to be run.

Parameters: Parameters for the executable.

Exe: Executable to be run.

Parameters: Parameters for the executable.

Actions: Actions to be executed when a rule is triggered.

Triggers: Conditions that describe when to execute the auto-heal actions.

Actions: Actions to be executed when a rule is triggered.

Triggers: Conditions that describe when to execute the auto-heal actions.

PrivateBytesInKB: A rule based on private bytes.

Requests: A rule based on total requests.

SlowRequests: A rule based on request execution time.

SlowRequestsWithPath: A rule based on multiple Slow Requests Rule with path

StatusCodes: A rule based on status codes.

StatusCodesRange: A rule based on status codes ranges.

PrivateBytesInKB: A rule based on private bytes.

Requests: A rule based on total requests.

SlowRequests: A rule based on request execution time.

SlowRequestsWithPath: A rule based on multiple Slow Requests Rule with path

StatusCodes: A rule based on status codes.

StatusCodesRange: A rule based on status codes ranges.

AccessKey: Access key for the storage account.

AccountName: Name of the storage account.

MountPath: Path to mount the storage within the site’s runtime environment.

ShareName: Name of the file share (container name, for Blob storage).

Type: Type of storage.

AccountName: Name of the storage account.

MountPath: Path to mount the storage within the site’s runtime environment.

ShareName: Name of the file share (container name, for Blob storage).

State: State of the storage account.

Type: Type of storage.

"InvalidCredentials"

"InvalidShare"

"NotValidated"

"Ok"

"AzureBlob"

"AzureFiles"

"AzureBlob"

"AzureFiles"

Name: Name of the SKU capability.

Reason: Reason of the SKU capability.

Value: Value of the SKU capability.

Name: Name of the SKU capability.

Reason: Reason of the SKU capability.

Value: Value of the SKU capability.

AppSettingsOverrides: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

CloneCustomHostNames: true to clone custom hostnames from source app; otherwise, false.

CloneSourceControl: true to clone source control from source app; otherwise, false.

ConfigureLoadBalancing: true to configure load balancing for source and destination app.

CorrelationId: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

HostingEnvironment: App Service Environment.

Overwrite: true to overwrite destination app; otherwise, false.

SourceWebAppLocation: Location of source app ex: West US or North Europe

SourceWebAppReference: ARM resource ID of the source app. App resource ID is of the form /​subscriptions/​{subId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Web/​sites/​{siteName} for production slots and /​subscriptions/​{subId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Web/​sites/​{siteName}/​slots/​{slotName} for other slots.

TrafficManagerProfileName: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

TrafficManagerProfileReference: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /​subscriptions/​{subId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​trafficManagerProfiles/​{profileName}.

AppSettingsOverrides: Application setting overrides for cloned app. If specified, these settings override the settings cloned from source app. Otherwise, application settings from source app are retained.

CloneCustomHostNames: true to clone custom hostnames from source app; otherwise, false.

CloneSourceControl: true to clone source control from source app; otherwise, false.

ConfigureLoadBalancing: true to configure load balancing for source and destination app.

CorrelationId: Correlation ID of cloning operation. This ID ties multiple cloning operations together to use the same snapshot.

HostingEnvironment: App Service Environment.

Overwrite: true to overwrite destination app; otherwise, false.

SourceWebAppId: ARM resource ID of the source app. App resource ID is of the form /​subscriptions/​{subId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Web/​sites/​{siteName} for production slots and /​subscriptions/​{subId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Web/​sites/​{siteName}/​slots/​{slotName} for other slots.

SourceWebAppLocation: Location of source app ex: West US or North Europe

TrafficManagerProfileId: ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form /​subscriptions/​{subId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.Network/​trafficManagerProfiles/​{profileName}.

TrafficManagerProfileName: Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.

ConnectionString: Connection string value.

Name: Name of connection string.

Type: Type of database.

ConnectionString: Connection string value.

Name: Name of connection string.

Type: Type of database.

"ApiHub"

"Custom"

"DocDb"

"EventHub"

"MySql"

"NotificationHub"

"PostgreSQL"

"RedisCache"

"SQLAzure"

"SQLServer"

"ServiceBus"

"ApiHub"

"Custom"

"DocDb"

"EventHub"

"MySql"

"NotificationHub"

"PostgreSQL"

"RedisCache"

"SQLAzure"

"SQLServer"

"ServiceBus"

AllowedOrigins: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all.

SupportCredentials: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details.

AllowedOrigins: Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use “*” to allow all.

SupportCredentials: Gets or sets whether CORS requests with credentials are allowed. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials for more details.

RampUpRules: List of ramp-up rules.

RampUpRules: List of ramp-up rules.

Name: Name of extended location.

Name: Name of extended location.

Type: Type of extended location.

Arguments: Command-line arguments to be passed to the script processor.

Extension: Requests with this extension will be handled using the specified FastCGI application.

ScriptProcessor: The absolute path to the FastCGI application.

Arguments: Command-line arguments to be passed to the script processor.

Extension: Requests with this extension will be handled using the specified FastCGI application.

ScriptProcessor: The absolute path to the FastCGI application.

HostType: Indicates whether the hostname is a standard or repository hostname.

Name: Hostname.

SslState: SSL type.

Thumbprint: SSL certificate thumbprint.

ToUpdate: Set to true to update existing hostname.

VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled.

"Repository"

"Standard"

"Repository"

"Standard"

HostType: Indicates whether the hostname is a standard or repository hostname.

Name: Hostname.

SslState: SSL type.

Thumbprint: SSL certificate thumbprint.

ToUpdate: Set to true to update existing hostname.

VirtualIP: Virtual IP address assigned to the hostname if IP based SSL is enabled.

"Disabled"

"IpBasedEnabled"

"SniEnabled"

"Disabled"

"IpBasedEnabled"

"SniEnabled"

Reference: Resource ID of the App Service Environment.

Id: Resource ID of the App Service Environment.

Name: Name of the App Service Environment.

Type: Resource type of the App Service Environment.

Action: Allow or Deny access for this IP range.

Description: IP restriction rule description.

Headers: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.

IpAddress: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

Name: IP restriction rule name.

Priority: Priority of IP restriction rule.

SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for.

SubnetTrafficTag: (internal) Subnet traffic tag

Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies.

VnetSubnetResourceReference: Virtual network resource id

VnetTrafficTag: (internal) Vnet traffic tag

Action: Allow or Deny access for this IP range.

Description: IP restriction rule description.

Headers: IP restriction rule headers. X-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). The matching logic is .. - If the property is null or empty (default), all hosts(or lack of) are allowed. - A value is compared using ordinal-ignore-case (excluding port number). - Subdomain wildcards are permitted but don’t match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com but not the root domain contoso.com or multi-level foo.bar.contoso.com - Unicode host names are allowed but are converted to Punycode for matching. X-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples). The matching logic is .. - If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed. - If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property. X-Azure-FDID and X-FD-HealthProbe. The matching logic is exact match.

IpAddress: IP address the security restriction is valid for. It can be in form of pure ipv4 address (required SubnetMask property) or CIDR notation such as ipv4/mask (leading bit match). For CIDR, SubnetMask property must not be specified.

Name: IP restriction rule name.

Priority: Priority of IP restriction rule.

SubnetMask: Subnet mask for the range of IP addresses the restriction is valid for.

SubnetTrafficTag: (internal) Subnet traffic tag

Tag: Defines what this IP filter will be used for. This is to support IP filtering on proxies.

VnetSubnetResourceId: Virtual network resource id

VnetTrafficTag: (internal) Vnet traffic tag

"Default"

"ServiceTag"

"XffProxy"

"Default"

"ServiceTag"

"XffProxy"

Reference: Resource ID of the Kubernetes Environment.

Id: Resource ID of the Kubernetes Environment.

Name: Name of the Kubernetes Environment.

Type: Resource type of the Kubernetes Environment.

Type: Type of managed service identity.

UserAssignedIdentities: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}

PrincipalId: Principal Id of managed service identity.

TenantId: Tenant of managed service identity.

Type: Type of managed service identity.

UserAssignedIdentities: The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: ‘/​subscriptions/​{subscriptionId}/​resourceGroups/​{resourceGroupName}/​providers/​Microsoft.ManagedIdentity/​userAssignedIdentities/​{identityName}

"None"

"SystemAssigned"

"SystemAssigned, UserAssigned"

"UserAssigned"

"None"

"SystemAssigned"

"SystemAssigned, UserAssigned"

"UserAssigned"

Name: Pair name.

Value: Pair value.

Name: Pair name.

Value: Pair value.

DynamicTagsJson: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled.

Kind: Kind of resource.

TagWhitelistJson: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.

TagsRequiringAuth: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: ‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. Validation should be performed at the PushRequestHandler.

DynamicTagsJson: Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint.

Id: Resource Id.

IsPushEnabled: Gets or sets a flag indicating whether the Push endpoint is enabled.

Kind: Kind of resource.

Name: Resource Name.

TagWhitelistJson: Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.

TagsRequiringAuth: Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint. Tags can consist of alphanumeric characters and the following: ‘_’, ‘@’, ‘#’, ‘.’, ‘:’, ‘-’. Validation should be performed at the PushRequestHandler.

Type: Resource type.

ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

ChangeDecisionCallbackUrl: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage.

ChangeStep: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay.

MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay.

Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

ReroutePercentage: Percentage of the traffic which will be redirected to ActionHostName.

ActionHostName: Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.

ChangeDecisionCallbackUrl: Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts. https://www.siteextensions.net/packages/TiPCallback/

ChangeIntervalInMinutes: Specifies interval in minutes to reevaluate ReroutePercentage.

ChangeStep: In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.

MaxReroutePercentage: Specifies upper boundary below which ReroutePercentage will stay.

MinReroutePercentage: Specifies lower boundary above which ReroutePercentage will stay.

Name: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.

ReroutePercentage: Percentage of the traffic which will be redirected to ActionHostName.

Count: Request Count.

TimeInterval: Time interval.

Count: Request Count.

TimeInterval: Time interval.

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

Conditions: The observed state of the resource

ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

ExtendedLocation: Extended Location.

FreeOfferExpirationTime: The time when the server farm free offer expires.

GeoRegion: Geographical location for the App Service plan.

HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

HyperV: If Hyper-V container app service plan true, false otherwise.

Id: Resource Id.

IsSpot: If true, this App Service Plan owns spot instances.

IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

Kind: Kind of resource.

KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

Location: Resource Location.

MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

MaximumNumberOfWorkers: Maximum number of instances that can be assigned to this App Service plan.

Name: Resource Name.

NumberOfSites: Number of apps assigned to this App Service plan.

NumberOfWorkers: The number of instances that are assigned to this App Service plan.

PerSiteScaling: If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.

ProvisioningState: Provisioning state of the App Service Plan.

Reserved: If Linux app service plan true, false otherwise.

ResourceGroup: Resource group of the App Service plan.

Sku: Description of a SKU for a scalable resource.

SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

Status: App Service plan status.

Subscription: App Service plan subscription.

Tags: Resource tags.

TargetWorkerCount: Scaling worker count.

TargetWorkerSizeId: Scaling worker size ID.

Type: Resource type.

WorkerTierName: Target worker tier assigned to the App Service plan.

ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

ElasticScaleEnabled: ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku

ExtendedLocation: Extended Location.

FreeOfferExpirationTime: The time when the server farm free offer expires.

HostingEnvironmentProfile: Specification for the App Service Environment to use for the App Service plan.

HyperV: If Hyper-V container app service plan true, false otherwise.

IsSpot: If true, this App Service Plan owns spot instances.

IsXenon: Obsolete: If Hyper-V container app service plan true, false otherwise.

Kind: Kind of resource.

KubeEnvironmentProfile: Specification for the Kubernetes Environment to use for the App Service plan.

Location: Resource Location.

MaximumElasticWorkerCount: Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan

OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

PerSiteScaling: If true, apps assigned to this App Service plan can be scaled independently. If false, apps assigned to this App Service plan will scale to all instances of the plan.

Reserved: If Linux app service plan true, false otherwise.

Sku: Description of a SKU for a scalable resource.

SpotExpirationTime: The time when the server farm expires. Valid only if it is a spot server farm.

Tags: Resource tags.

TargetWorkerCount: Scaling worker count.

TargetWorkerSizeId: Scaling worker size ID.

WorkerTierName: Target worker tier assigned to the App Service plan.

ZoneRedundant: If true, this App Service Plan will perform availability zone balancing. If false, this App Service Plan will not perform availability zone balancing.

"Canceled"

"Deleting"

"Failed"

"InProgress"

"Succeeded"

"Creating"

"Pending"

"Ready"

AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull

AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId

AlwaysOn: true if Always On is enabled; otherwise, false.

ApiDefinition: Information about the formal API definition for the app.

ApiManagementConfig: Azure API management settings linked to the app.

AppCommandLine: App command line to launch.

AppSettings: Application settings.

AutoHealEnabled: true if Auto Heal is enabled; otherwise, false.

AutoHealRules: Auto Heal rules.

AutoSwapSlotName: Auto-swap slot name.

AzureStorageAccounts: List of Azure Storage Accounts.

ConnectionStrings: Connection strings.

Cors: Cross-Origin Resource Sharing (CORS) settings.

DefaultDocuments: Default documents.

DetailedErrorLoggingEnabled: true if detailed error logging is enabled; otherwise, false.

DocumentRoot: Document root.

Experiments: This is work around for polymorphic types.

FtpsState: State of FTP / FTPS service

FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

FunctionsRuntimeScaleMonitoringEnabled: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status.

HandlerMappings: Handler mappings.

HealthCheckPath: Health check path

Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0

HttpLoggingEnabled: true if HTTP logging is enabled; otherwise, false.

IpSecurityRestrictions: IP security restrictions for main.

JavaContainer: Java container.

JavaContainerVersion: Java container version.

JavaVersion: Java version.

KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

Limits: Site limits.

LinuxFxVersion: Linux App Framework and version

LoadBalancing: Site load balancing.

LocalMySqlEnabled: true to enable local MySQL; otherwise, false.

LogsDirectorySizeLimit: HTTP logs directory size limit.

ManagedPipelineMode: Managed pipeline mode.

ManagedServiceIdentityId: Managed Service Identity Id

MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests

MinimumElasticInstanceCount: Number of minimum instance count for a site This setting only applies to the Elastic Plans

NetFrameworkVersion: .NET Framework version.

NodeVersion: Version of Node.js.

NumberOfWorkers: Number of workers.

PhpVersion: Version of PHP.

PowerShellVersion: Version of PowerShell.

PreWarmedInstanceCount: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

PublicNetworkAccess: Property to allow or block all public traffic.

PublishingUsername: Publishing user name.

Push: Push endpoint settings.

PythonVersion: Version of Python.

RemoteDebuggingEnabled: true if remote debugging is enabled; otherwise, false.

RemoteDebuggingVersion: Remote debugging version.

RequestTracingEnabled: true if request tracing is enabled; otherwise, false.

RequestTracingExpirationTime: Request tracing expiration time.

ScmIpSecurityRestrictions: IP security restrictions for scm.

ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main.

ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

ScmType: SCM type.

TracingOptions: Tracing options.

Use32BitWorkerProcess: true to use 32-bit worker process; otherwise, false.

VirtualApplications: Virtual applications.

VnetName: Virtual Network name.

VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime.

VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

WebSocketsEnabled: true if WebSocket is enabled; otherwise, false.

WebsiteTimeZone: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones

WindowsFxVersion: Xenon App Framework and version

XManagedServiceIdentityId: Explicit Managed Service Identity Id

"AllAllowed"

"Disabled"

"FtpsOnly"

"AllAllowed"

"Disabled"

"FtpsOnly"

"LeastRequests"

"LeastResponseTime"

"PerSiteRoundRobin"

"RequestHash"

"WeightedRoundRobin"

"WeightedTotalTraffic"

"LeastRequests"

"LeastResponseTime"

"PerSiteRoundRobin"

"RequestHash"

"WeightedRoundRobin"

"WeightedTotalTraffic"

"Classic"

"Integrated"

"Classic"

"Integrated"

"1.0"

"1.1"

"1.2"

"1.0"

"1.1"

"1.2"

AcrUseManagedIdentityCreds: Flag to use Managed Identity Creds for ACR pull

AcrUserManagedIdentityID: If using user managed identity, the user managed identity ClientId

AlwaysOn: true if Always On is enabled; otherwise, false.

ApiDefinition: Information about the formal API definition for the app.

ApiManagementConfig: Azure API management settings linked to the app.

AppCommandLine: App command line to launch.

AppSettings: Application settings.

AutoHealEnabled: true if Auto Heal is enabled; otherwise, false.

AutoHealRules: Auto Heal rules.

AutoSwapSlotName: Auto-swap slot name.

AzureStorageAccounts: List of Azure Storage Accounts.

ConnectionStrings: Connection strings.

Cors: Cross-Origin Resource Sharing (CORS) settings.

DefaultDocuments: Default documents.

DetailedErrorLoggingEnabled: true if detailed error logging is enabled; otherwise, false.

DocumentRoot: Document root.

Experiments: This is work around for polymorphic types.

FtpsState: State of FTP / FTPS service

FunctionAppScaleLimit: Maximum number of workers that a site can scale out to. This setting only applies to the Consumption and Elastic Premium Plans

FunctionsRuntimeScaleMonitoringEnabled: Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled, the ScaleController will not monitor event sources directly, but will instead call to the runtime to get scale status.

HandlerMappings: Handler mappings.

HealthCheckPath: Health check path

Http20Enabled: Http20Enabled: configures a web site to allow clients to connect over http2.0

HttpLoggingEnabled: true if HTTP logging is enabled; otherwise, false.

IpSecurityRestrictions: IP security restrictions for main.

JavaContainer: Java container.

JavaContainerVersion: Java container version.

JavaVersion: Java version.

KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

Limits: Site limits.

LinuxFxVersion: Linux App Framework and version

LoadBalancing: Site load balancing.

LocalMySqlEnabled: true to enable local MySQL; otherwise, false.

LogsDirectorySizeLimit: HTTP logs directory size limit.

MachineKey: Site MachineKey.

ManagedPipelineMode: Managed pipeline mode.

ManagedServiceIdentityId: Managed Service Identity Id

MinTlsVersion: MinTlsVersion: configures the minimum version of TLS required for SSL requests

MinimumElasticInstanceCount: Number of minimum instance count for a site This setting only applies to the Elastic Plans

NetFrameworkVersion: .NET Framework version.

NodeVersion: Version of Node.js.

NumberOfWorkers: Number of workers.

PhpVersion: Version of PHP.

PowerShellVersion: Version of PowerShell.

PreWarmedInstanceCount: Number of preWarmed instances. This setting only applies to the Consumption and Elastic Plans

PublicNetworkAccess: Property to allow or block all public traffic.

PublishingUsername: Publishing user name.

Push: Push endpoint settings.

PythonVersion: Version of Python.

RemoteDebuggingEnabled: true if remote debugging is enabled; otherwise, false.

RemoteDebuggingVersion: Remote debugging version.

RequestTracingEnabled: true if request tracing is enabled; otherwise, false.

RequestTracingExpirationTime: Request tracing expiration time.

ScmIpSecurityRestrictions: IP security restrictions for scm.

ScmIpSecurityRestrictionsUseMain: IP security restrictions for scm to use main.

ScmMinTlsVersion: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site

ScmType: SCM type.

TracingOptions: Tracing options.

Use32BitWorkerProcess: true to use 32-bit worker process; otherwise, false.

VirtualApplications: Virtual applications.

VnetName: Virtual Network name.

VnetPrivatePortsCount: The number of private ports assigned to this app. These will be assigned dynamically on runtime.

VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

WebSocketsEnabled: true if WebSocket is enabled; otherwise, false.

WebsiteTimeZone: Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones

WindowsFxVersion: Xenon App Framework and version

XManagedServiceIdentityId: Explicit Managed Service Identity Id

"1.0"

"1.1"

"1.2"

"1.0"

"1.1"

"1.2"

"BitbucketGit"

"BitbucketHg"

"CodePlexGit"

"CodePlexHg"

"Dropbox"

"ExternalGit"

"ExternalHg"

"GitHub"

"LocalGit"

"None"

"OneDrive"

"Tfs"

"VSO"

"VSTSRM"

"BitbucketGit"

"BitbucketHg"

"CodePlexGit"

"CodePlexHg"

"Dropbox"

"ExternalGit"

"ExternalHg"

"GitHub"

"LocalGit"

"None"

"OneDrive"

"Tfs"

"VSO"

"VSTSRM"

MaxDiskSizeInMb: Maximum allowed disk size usage in MB.

MaxMemoryInMb: Maximum allowed memory usage in MB.

MaxPercentageCpu: Maximum allowed CPU usage percentage.

MaxDiskSizeInMb: Maximum allowed disk size usage in MB.

MaxMemoryInMb: Maximum allowed memory usage in MB.

MaxPercentageCpu: Maximum allowed CPU usage percentage.

Decryption: Algorithm used for decryption.

DecryptionKey: Decryption key.

Validation: MachineKey validation.

ValidationKey: Validation key.

ConfigMapExpressions: configures where to place operator written dynamic ConfigMaps (created with CEL expressions).

SecretExpressions: configures where to place operator written dynamic secrets (created with CEL expressions).

"DisasterRecoveryMode"

"Limited"

"Normal"

"Optional"

"OptionalInteractiveUser"

"Required"

"Optional"

"OptionalInteractiveUser"

"Required"

"ActiveActive"

"Failover"

"GeoRedundant"

"Manual"

"None"

"ActiveActive"

"Failover"

"GeoRedundant"

"Manual"

"None"

"Exceeded"

"Normal"

AvailabilityState: Management information availability state for the app.

ClientAffinityEnabled: 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.

ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

ClientCertMode: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.

CloningInfo: If specified during app creation, the app is cloned from a source app.

Conditions: The observed state of the resource

ContainerSize: Size of the function container.

CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

DefaultHostName: Default hostname of the app. Read-only.

Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

EnabledHostNames: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames.

ExtendedLocation: Extended Location.

HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

HostNames: Hostnames associated with the app.

HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

HostingEnvironmentProfile: App Service Environment to use for the app.

HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

HyperV: Hyper-V sandbox.

Id: Resource Id.

Identity: Managed service identity.

InProgressOperationId: Specifies an operation id if this site has a pending operation.

IsDefaultContainer: true if the app is a default container; otherwise, false.

IsXenon: Obsolete: Hyper-V sandbox.

KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

Kind: Kind of resource.

LastModifiedTimeUtc: Last time the app was modified, in UTC. Read-only.

Location: Resource Location.

MaxNumberOfWorkers: Maximum number of workers. This only applies to Functions container.

Name: Resource Name.

OutboundIpAddresses: 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: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

RedundancyMode: Site redundancy mode

RepositorySiteName: Name of the repository site.

Reserved: true if reserved; otherwise, false.

ResourceGroup: Name of the resource group the app belongs to. Read-only.

ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

ServerFarmId: Resource ID of the associated App Service plan, formatted as: “/​subscriptions/​{subscriptionID}/​resourceGroups/​{groupName}/​providers/​Microsoft.Web/​serverfarms/​{appServicePlanName}”.

SiteConfig: Configuration of the app.

SlotSwapStatus: Status of the last deployment slot swap operation.

State: Current state of the app.

StorageAccountRequired: Checks if Customer provided storage account is required

SuspendedTill: App suspended till in case memory-time quota is exceeded.

Tags: Resource tags.

TargetSwapSlot: Specifies which deployment slot this app will swap into. Read-only.

TrafficManagerHostNames: Azure Traffic Manager hostnames associated with the app. Read-only.

Type: Resource type.

UsageState: State indicating whether the app has exceeded its quota usage. Read-only.

VirtualNetworkSubnetId: 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}/​providers/​Microsoft.Network/​virtualNetworks/​{vnetName}/​subnets/​{subnetName}

VnetContentShareEnabled: To enable accessing content over virtual network

VnetImagePullEnabled: To enable pulling image over Virtual Network

VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

AzureName: The name of the resource in Azure. This is often the same as the name of the resource in Kubernetes but it doesn’t have to be.

ClientAffinityEnabled: 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.

ClientCertEnabled: true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.

ClientCertExclusionPaths: client certificate authentication comma-separated exclusion paths

ClientCertMode: This composes with ClientCertEnabled setting. - ClientCertEnabled: false means ClientCert is ignored. - ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required. - ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.

CloningInfo: If specified during app creation, the app is cloned from a source app.

ContainerSize: Size of the function container.

CustomDomainVerificationId: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

DailyMemoryTimeQuota: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

Enabled: true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).

ExtendedLocation: Extended Location.

HostNameSslStates: Hostname SSL states are used to manage the SSL bindings for app’s hostnames.

HostNamesDisabled: true to disable the public hostnames of the app; otherwise, false. If true, the app is only accessible via API management process.

HostingEnvironmentProfile: App Service Environment to use for the app.

HttpsOnly: HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests

HyperV: Hyper-V sandbox.

Identity: Managed service identity.

IsXenon: Obsolete: Hyper-V sandbox.

KeyVaultReferenceIdentity: Identity to use for Key Vault Reference authentication.

Kind: Kind of resource.

Location: Resource Location.

OperatorSpec: The specification for configuring operator behavior. This field is interpreted by the operator and not passed directly to Azure

Owner: The owner of the resource. The owner controls where the resource goes when it is deployed. The owner also controls the resources lifecycle. When the owner is deleted the resource will also be deleted. Owner is expected to be a reference to a resources.azure.com/ResourceGroup resource

PublicNetworkAccess: Property to allow or block all public traffic. Allowed Values: ‘Enabled’, ‘Disabled’ or an empty string.

RedundancyMode: Site redundancy mode

Reserved: true if reserved; otherwise, false.

ScmSiteAlsoStopped: true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.

ServerFarmReference: Resource ID of the associated App Service plan, formatted as: “/​subscriptions/​{subscriptionID}/​resourceGroups/​{groupName}/​providers/​Microsoft.Web/​serverfarms/​{appServicePlanName}”.

SiteConfig: Configuration of the app.

StorageAccountRequired: Checks if Customer provided storage account is required

Tags: Resource tags.

VirtualNetworkSubnetReference: 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}/​providers/​Microsoft.Network/​virtualNetworks/​{vnetName}/​subnets/​{subnetName}

VnetContentShareEnabled: To enable accessing content over virtual network

VnetImagePullEnabled: To enable pulling image over Virtual Network

VnetRouteAllEnabled: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.

Default: Default number of workers for this App Service plan SKU.

ElasticMaximum: Maximum number of Elastic workers for this App Service plan SKU.

Maximum: Maximum number of workers for this App Service plan SKU.

Minimum: Minimum number of workers for this App Service plan SKU.

ScaleType: Available scale configurations for an App Service plan.

Default: Default number of workers for this App Service plan SKU.

ElasticMaximum: Maximum number of Elastic workers for this App Service plan SKU.

Maximum: Maximum number of workers for this App Service plan SKU.

Minimum: Minimum number of workers for this App Service plan SKU.

ScaleType: Available scale configurations for an App Service plan.

Capabilities: Capabilities of the SKU, e.g., is traffic manager enabled?

Capacity: Current number of instances assigned to the resource.

Family: Family code of the resource SKU.

Locations: Locations of the SKU.

Name: Name of the resource SKU.

Size: Size specifier of the resource SKU.

SkuCapacity: Min, max, and default scale values of the SKU.

Tier: Service tier of the resource SKU.

Capabilities: Capabilities of the SKU, e.g., is traffic manager enabled?

Capacity: Current number of instances assigned to the resource.

Family: Family code of the resource SKU.

Locations: Locations of the SKU.

Name: Name of the resource SKU.

Size: Size specifier of the resource SKU.

SkuCapacity: Min, max, and default scale values of the SKU.

Tier: Service tier of the resource SKU.

DestinationSlotName: The destination slot of the last swap operation.

SourceSlotName: The source slot of the last swap operation.

TimestampUtc: The time the last successful slot swap completed.

Count: Request Count.

Path: Request Path.

TimeInterval: Time interval.

TimeTaken: Time taken.

Count: Request Count.

Path: Request Path.

TimeInterval: Time interval.

TimeTaken: Time taken.

Count: Request Count.

Path: Request Path

Status: HTTP status code.

SubStatus: Request Sub Status.

TimeInterval: Time interval.

Win32Status: Win32 error code.

Count: Request Count.

Path: Request Path

Status: HTTP status code.

SubStatus: Request Sub Status.

TimeInterval: Time interval.

Win32Status: Win32 error code.

Count: Request Count.

StatusCodes: HTTP status code.

TimeInterval: Time interval.

Count: Request Count.

StatusCodes: HTTP status code.

TimeInterval: Time interval.

ClientId: Client Id of user assigned identity

PrincipalId: Principal Id of user assigned identity

PhysicalPath: Physical path.

PreloadEnabled: true if preloading is enabled; otherwise, false.

VirtualDirectories: Virtual directories for virtual application.

VirtualPath: Virtual path.

PhysicalPath: Physical path.

PreloadEnabled: true if preloading is enabled; otherwise, false.

VirtualDirectories: Virtual directories for virtual application.

VirtualPath: Virtual path.

PhysicalPath: Physical path.

VirtualPath: Path to virtual application.

PhysicalPath: Physical path.

VirtualPath: Path to virtual application.