This table represents the App Service resource from Microsoft Azure.

azure.app_service

Fields

TitleIDTypeData TypeDescription
_keycorestring
availability_statecorestringManagement information availability state for the app.
client_affinity_enabledcorebool<code>true</code> to enable client affinity; <code>false</code> to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is <code>true</code>.
client_cert_enabledcorebool<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>.
client_cert_exclusion_pathscorestringclient certificate authentication comma-separated exclusion paths
client_cert_modecorestringThis 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.
container_sizecoreint64Size of the function container.
custom_domain_verification_idcorestringUnique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.
daily_memory_time_quotacoreint64Maximum allowed daily memory-time quota (applicable on dynamic apps only).
default_host_namecorestringDefault hostname of the app. Read-only.
enabledcorebool<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline).
enabled_host_namescorearray<string>Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,the app is not served on those hostnames.
extended_locationcorejson
host_namescorearray<string>Hostnames associated with the app.
host_names_disabledcorebool<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>. If <code>true</code>, the app is only accessible via API management process.
https_onlycoreboolHttpsOnly: configures a web site to accept only https requests. Issues redirect forhttp requests
hyper_vcoreboolHyper-V sandbox.
idcorestringResource Id.
identitycorejson
in_progress_operation_idcorestringSpecifies an operation id if this site has a pending operation.
is_default_containercorebool<code>true</code> if the app is a default container; otherwise, <code>false</code>.
is_xenoncoreboolObsolete: Hyper-V sandbox.
key_vault_reference_identitycorestringIdentity to use for Key Vault Reference authentication.
kindcorestringKind of resource.
last_modified_time_utccorestringLast time the app was modified, in UTC. Read-only.
locationcorestringResource Location.
max_number_of_workerscoreint64Maximum number of workers.This only applies to Functions container.
namecorestringResource Name.
outbound_ip_addressescorestringList 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.
possible_outbound_ip_addressescorestringList of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.
redundancy_modecorestringSite redundancy mode
repository_site_namecorestringName of the repository site.
reservedcorebool<code>true</code> if reserved; otherwise, <code>false</code>.
resource_groupcorestring
scm_site_also_stoppedcorebool<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>.
server_farm_idcorestringResource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".
site_configcorejsonConfiguration of the app.
statecorestringCurrent state of the app.
storage_account_requiredcoreboolChecks if Customer provided storage account is required
subscription_idcorestring
subscription_namecorestring
suspended_tillcorestringApp suspended till in case memory-time quota is exceeded.
tagscorehstore
target_swap_slotcorestringSpecifies which deployment slot this app will swap into. Read-only.
traffic_manager_host_namescorearray<string>Azure Traffic Manager hostnames associated with the app. Read-only.
typecorestringResource type.
usage_statecorestringState indicating whether the app has exceeded its quota usage. Read-only.
virtual_network_subnet_idcorestringAzure 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}
web_auth_settingscorejson