---
title: Getting Started with Datadog
description: Datadog, the leading service for cloud-scale monitoring.
breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog
---

# azure_app_service{% #azure_app_service %}

## `availability_state`{% #availability_state %}

**Type**: `STRING`**Provider name**: `properties.availabilityState`**Description**: Management information availability state for the app.

## `client_affinity_enabled`{% #client_affinity_enabled %}

**Type**: `BOOLEAN`**Provider name**: `properties.clientAffinityEnabled`**Description**: `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`.

## `client_cert_enabled`{% #client_cert_enabled %}

**Type**: `BOOLEAN`**Provider name**: `properties.clientCertEnabled`**Description**: `true` to enable client certificate authentication (TLS mutual authentication); otherwise, `false`. Default is `false`.

## `client_cert_exclusion_paths`{% #client_cert_exclusion_paths %}

**Type**: `STRING`**Provider name**: `properties.clientCertExclusionPaths`**Description**: client certificate authentication comma-separated exclusion paths

## `client_cert_mode`{% #client_cert_mode %}

**Type**: `STRING`**Provider name**: `properties.clientCertMode`**Description**: 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.

## `container_size`{% #container_size %}

**Type**: `INT64`**Provider name**: `properties.containerSize`**Description**: Size of the function container.

## `custom_domain_verification_id`{% #custom_domain_verification_id %}

**Type**: `STRING`**Provider name**: `properties.customDomainVerificationId`**Description**: Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.

## `daily_memory_time_quota`{% #daily_memory_time_quota %}

**Type**: `INT64`**Provider name**: `properties.dailyMemoryTimeQuota`**Description**: Maximum allowed daily memory-time quota (applicable on dynamic apps only).

## `default_host_name`{% #default_host_name %}

**Type**: `STRING`**Provider name**: `properties.defaultHostName`**Description**: Default hostname of the app. Read-only.

## `enabled`{% #enabled %}

**Type**: `BOOLEAN`**Provider name**: `properties.enabled`**Description**: `true` if the app is enabled; otherwise, `false`. Setting this value to false disables the app (takes the app offline).

## `enabled_host_names`{% #enabled_host_names %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `properties.enabledHostNames`**Description**: Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,the app is not served on those hostnames.

## `extended_location`{% #extended_location %}

**Type**: `STRUCT`**Provider name**: `extendedLocation`

- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Name of extended location.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: Type of extended location.

## `host_names`{% #host_names %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `properties.hostNames`**Description**: Hostnames associated with the app.

## `host_names_disabled`{% #host_names_disabled %}

**Type**: `BOOLEAN`**Provider name**: `properties.hostNamesDisabled`**Description**: `true` to disable the public hostnames of the app; otherwise, `false`. If `true`, the app is only accessible via API management process.

## `https_only`{% #https_only %}

**Type**: `BOOLEAN`**Provider name**: `properties.httpsOnly`**Description**: HttpsOnly: configures a web site to accept only https requests. Issues redirect forhttp requests

## `hyper_v`{% #hyper_v %}

**Type**: `BOOLEAN`**Provider name**: `properties.hyperV`**Description**: Hyper-V sandbox.

## `id`{% #id %}

**Type**: `STRING`**Provider name**: `id`**Description**: Resource Id.

## `identity`{% #identity %}

**Type**: `STRUCT`**Provider name**: `identity`

- `principal_id`**Type**: `STRING`**Provider name**: `principalId`**Description**: Principal Id of managed service identity.
- `tenant_id`**Type**: `STRING`**Provider name**: `tenantId`**Description**: Tenant of managed service identity.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: Type of managed service identity.

## `in_progress_operation_id`{% #in_progress_operation_id %}

**Type**: `STRING`**Provider name**: `properties.inProgressOperationId`**Description**: Specifies an operation id if this site has a pending operation.

## `is_default_container`{% #is_default_container %}

**Type**: `BOOLEAN`**Provider name**: `properties.isDefaultContainer`**Description**: `true` if the app is a default container; otherwise, `false`.

## `is_xenon`{% #is_xenon %}

**Type**: `BOOLEAN`**Provider name**: `properties.isXenon`**Description**: Obsolete: Hyper-V sandbox.

## `key_vault_reference_identity`{% #key_vault_reference_identity %}

**Type**: `STRING`**Provider name**: `properties.keyVaultReferenceIdentity`**Description**: Identity to use for Key Vault Reference authentication.

## `kind`{% #kind %}

**Type**: `STRING`**Provider name**: `kind`**Description**: Kind of resource.

## `last_modified_time_utc`{% #last_modified_time_utc %}

**Type**: `STRING`**Provider name**: `properties.lastModifiedTimeUtc`**Description**: Last time the app was modified, in UTC. Read-only.

## `location`{% #location %}

**Type**: `STRING`**Provider name**: `location`**Description**: Resource Location.

## `max_number_of_workers`{% #max_number_of_workers %}

**Type**: `INT32`**Provider name**: `properties.maxNumberOfWorkers`**Description**: Maximum number of workers.This only applies to Functions container.

## `name`{% #name %}

**Type**: `STRING`**Provider name**: `name`**Description**: Resource Name.

## `outbound_ip_addresses`{% #outbound_ip_addresses %}

**Type**: `STRING`**Provider name**: `properties.outboundIpAddresses`**Description**: 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.

## `possible_outbound_ip_addresses`{% #possible_outbound_ip_addresses %}

**Type**: `STRING`**Provider name**: `properties.possibleOutboundIpAddresses`**Description**: List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

## `redundancy_mode`{% #redundancy_mode %}

**Type**: `STRING`**Provider name**: `properties.redundancyMode`**Description**: Site redundancy mode

## `repository_site_name`{% #repository_site_name %}

**Type**: `STRING`**Provider name**: `properties.repositorySiteName`**Description**: Name of the repository site.

## `reserved`{% #reserved %}

**Type**: `BOOLEAN`**Provider name**: `properties.reserved`**Description**: `true` if reserved; otherwise, `false`.

## `resource_group`{% #resource_group %}

**Type**: `STRING`

## `scm_site_also_stopped`{% #scm_site_also_stopped %}

**Type**: `BOOLEAN`**Provider name**: `properties.scmSiteAlsoStopped`**Description**: `true` to stop SCM (KUDU) site when the app is stopped; otherwise, `false`. The default is `false`.

## `server_farm_id`{% #server_farm_id %}

**Type**: `STRING`**Provider name**: `properties.serverFarmId`**Description**: Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}".

## `site_config`{% #site_config %}

**Type**: `STRUCT`**Provider name**: `properties.siteConfig`**Description**: Configuration of the app.

- `acr_use_managed_identity_creds`**Type**: `BOOLEAN`**Provider name**: `acrUseManagedIdentityCreds`**Description**: Flag to use Managed Identity Creds for ACR pull
- `acr_user_managed_identity_id`**Type**: `STRING`**Provider name**: `acrUserManagedIdentityID`**Description**: If using user managed identity, the user managed identity ClientId
- `always_on`**Type**: `BOOLEAN`**Provider name**: `alwaysOn`**Description**: `true` if Always On is enabled; otherwise, `false`.
- `app_command_line`**Type**: `STRING`**Provider name**: `appCommandLine`**Description**: App command line to launch.
- `auto_heal_enabled`**Type**: `BOOLEAN`**Provider name**: `autoHealEnabled`**Description**: `true` if Auto Heal is enabled; otherwise, `false`.
- `ftps_state`**Type**: `STRING`**Provider name**: `ftpsState`**Description**: State of FTP / FTPS service
- `function_app_scale_limit`**Type**: `INT64`**Provider name**: `functionAppScaleLimit`**Description**: Maximum number of workers that a site can scale out to.This setting only applies to the Consumption and Elastic Premium Plans
- `functions_runtime_scale_monitoring_enabled`**Type**: `BOOLEAN`**Provider name**: `functionsRuntimeScaleMonitoringEnabled`**Description**: 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 theruntime to get scale status.
- `http20_enabled`**Type**: `BOOLEAN`**Provider name**: `http20Enabled`**Description**: Http20Enabled: configures a web site to allow clients to connect over http2.0
- `http_logging_enabled`**Type**: `BOOLEAN`**Provider name**: `httpLoggingEnabled`**Description**: `true` if HTTP logging is enabled; otherwise, `false`.
- `java_container`**Type**: `STRING`**Provider name**: `javaContainer`**Description**: Java container.
- `java_container_version`**Type**: `STRING`**Provider name**: `javaContainerVersion`**Description**: Java container version.
- `java_version`**Type**: `STRING`**Provider name**: `javaVersion`**Description**: Java version.
- `limits`**Type**: `STRUCT`**Provider name**: `limits`**Description**: Site limits.
  - `max_disk_size_in_mb`**Type**: `INT64`**Provider name**: `maxDiskSizeInMb`**Description**: Maximum allowed disk size usage in MB.
  - `max_memory_in_mb`**Type**: `INT64`**Provider name**: `maxMemoryInMb`**Description**: Maximum allowed memory usage in MB.
  - `max_percentage_cpu`**Type**: `DOUBLE`**Provider name**: `maxPercentageCpu`**Description**: Maximum allowed CPU usage percentage.
- `linux_fx_version`**Type**: `STRING`**Provider name**: `linuxFxVersion`**Description**: Linux App Framework and version
- `load_balancing`**Type**: `STRING`**Provider name**: `loadBalancing`**Description**: Site load balancing.
- `local_my_sql_enabled`**Type**: `BOOLEAN`**Provider name**: `localMySqlEnabled`**Description**: `true` to enable local MySQL; otherwise, `false`.
- `logs_directory_size_limit`**Type**: `INT64`**Provider name**: `logsDirectorySizeLimit`**Description**: HTTP logs directory size limit.
- `machine_key`**Type**: `STRUCT`**Provider name**: `machineKey`**Description**: Site MachineKey.
  - `decryption`**Type**: `STRING`**Provider name**: `decryption`**Description**: Algorithm used for decryption.
  - `validation`**Type**: `STRING`**Provider name**: `validation`**Description**: MachineKey validation.
- `managed_pipeline_mode`**Type**: `STRING`**Provider name**: `managedPipelineMode`**Description**: Managed pipeline mode.
- `managed_service_identity_id`**Type**: `INT64`**Provider name**: `managedServiceIdentityId`**Description**: Managed Service Identity Id
- `min_tls_version`**Type**: `STRING`**Provider name**: `minTlsVersion`**Description**: MinTlsVersion: configures the minimum version of TLS required for SSL requests
- `minimum_elastic_instance_count`**Type**: `INT64`**Provider name**: `minimumElasticInstanceCount`**Description**: Number of minimum instance count for a siteThis setting only applies to the Elastic Plans
- `net_framework_version`**Type**: `STRING`**Provider name**: `netFrameworkVersion`**Description**: .NET Framework version.
- `node_version`**Type**: `STRING`**Provider name**: `nodeVersion`**Description**: Version of Node.js.
- `number_of_workers`**Type**: `INT64`**Provider name**: `numberOfWorkers`**Description**: Number of workers.
- `php_version`**Type**: `STRING`**Provider name**: `phpVersion`**Description**: Version of PHP.
- `power_shell_version`**Type**: `STRING`**Provider name**: `powerShellVersion`**Description**: Version of PowerShell.
- `pre_warmed_instance_count`**Type**: `INT64`**Provider name**: `preWarmedInstanceCount`**Description**: Number of preWarmed instances.This setting only applies to the Consumption and Elastic Plans
- `public_network_access`**Type**: `STRING`**Provider name**: `publicNetworkAccess`**Description**: Property to allow or block all public traffic.
- `publishing_username`**Type**: `STRING`**Provider name**: `publishingUsername`**Description**: Publishing user name.
- `python_version`**Type**: `STRING`**Provider name**: `pythonVersion`**Description**: Version of Python.
- `remote_debugging_enabled`**Type**: `BOOLEAN`**Provider name**: `remoteDebuggingEnabled`**Description**: `true` if remote debugging is enabled; otherwise, `false`.
- `remote_debugging_version`**Type**: `STRING`**Provider name**: `remoteDebuggingVersion`**Description**: Remote debugging version.
- `request_tracing_enabled`**Type**: `BOOLEAN`**Provider name**: `requestTracingEnabled`**Description**: `true` if request tracing is enabled; otherwise, `false`.
- `scm_ip_security_restrictions_use_main`**Type**: `BOOLEAN`**Provider name**: `scmIpSecurityRestrictionsUseMain`**Description**: IP security restrictions for scm to use main.
- `scm_min_tls_version`**Type**: `STRING`**Provider name**: `scmMinTlsVersion`**Description**: ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site
- `scm_type`**Type**: `STRING`**Provider name**: `scmType`**Description**: SCM type.
- `tracing_options`**Type**: `STRING`**Provider name**: `tracingOptions`**Description**: Tracing options.
- `use32_bit_worker_process`**Type**: `BOOLEAN`**Provider name**: `use32BitWorkerProcess`**Description**: `true` to use 32-bit worker process; otherwise, `false`.
- `vnet_name`**Type**: `STRING`**Provider name**: `vnetName`**Description**: Virtual Network name.
- `vnet_private_ports_count`**Type**: `INT32`**Provider name**: `vnetPrivatePortsCount`**Description**: The number of private ports assigned to this app. These will be assigned dynamically on runtime.
- `vnet_route_all_enabled`**Type**: `BOOLEAN`**Provider name**: `vnetRouteAllEnabled`**Description**: Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
- `web_sockets_enabled`**Type**: `BOOLEAN`**Provider name**: `webSocketsEnabled`**Description**: `true` if WebSocket is enabled; otherwise, `false`.
- `website_time_zone`**Type**: `STRING`**Provider name**: `websiteTimeZone`**Description**: 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](https://www.iana.org/time-zones) (for a quick reference see [https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones%29). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Time Zones
- `windows_fx_version`**Type**: `STRING`**Provider name**: `windowsFxVersion`**Description**: Xenon App Framework and version
- `x_managed_service_identity_id`**Type**: `INT64`**Provider name**: `xManagedServiceIdentityId`**Description**: Explicit Managed Service Identity Id

## `state`{% #state %}

**Type**: `STRING`**Provider name**: `properties.state`**Description**: Current state of the app.

## `storage_account_required`{% #storage_account_required %}

**Type**: `BOOLEAN`**Provider name**: `properties.storageAccountRequired`**Description**: Checks if Customer provided storage account is required

## `subscription_id`{% #subscription_id %}

**Type**: `STRING`

## `subscription_name`{% #subscription_name %}

**Type**: `STRING`

## `suspended_till`{% #suspended_till %}

**Type**: `STRING`**Provider name**: `properties.suspendedTill`**Description**: App suspended till in case memory-time quota is exceeded.

## `tags`{% #tags %}

**Type**: `UNORDERED_LIST_STRING`

## `target_swap_slot`{% #target_swap_slot %}

**Type**: `STRING`**Provider name**: `properties.targetSwapSlot`**Description**: Specifies which deployment slot this app will swap into. Read-only.

## `traffic_manager_host_names`{% #traffic_manager_host_names %}

**Type**: `UNORDERED_LIST_STRING`**Provider name**: `properties.trafficManagerHostNames`**Description**: Azure Traffic Manager hostnames associated with the app. Read-only.

## `type`{% #type %}

**Type**: `STRING`**Provider name**: `type`**Description**: Resource type.

## `usage_state`{% #usage_state %}

**Type**: `STRING`**Provider name**: `properties.usageState`**Description**: State indicating whether the app has exceeded its quota usage. Read-only.

## `virtual_network_subnet_id`{% #virtual_network_subnet_id %}

**Type**: `STRING`**Provider name**: `properties.virtualNetworkSubnetId`**Description**: 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}

## `web_auth_settings`{% #web_auth_settings %}

**Type**: `STRUCT`**Provider name**: `SiteAuthSettings`

- `aad_claims_authorization`**Type**: `STRING`**Provider name**: `properties.aadClaimsAuthorization`**Description**: Gets a JSON string containing the Azure AD Acl settings.
- `auth_file_path`**Type**: `STRING`**Provider name**: `properties.authFilePath`**Description**: The path of the config file containing auth settings.If the path is relative, base will the site's root directory.
- `client_id`**Type**: `STRING`**Provider name**: `properties.clientId`**Description**: The Client ID of this relying party application, known as the client_id.This setting is required for enabling OpenID Connection authentication with Azure Active Directory or other 3rd party OpenID Connect providers.More information on OpenID Connect: [http://openid.net/specs/openid-connect-core-1_0.html](http://openid.net/specs/openid-connect-core-1_0.html)
- `client_secret_setting_name`**Type**: `STRING`**Provider name**: `properties.clientSecretSettingName`**Description**: The app setting name that contains the client secret of the relying party application.
- `config_version`**Type**: `STRING`**Provider name**: `properties.configVersion`**Description**: The ConfigVersion of the Authentication / Authorization feature in use for the current app.The setting in this value can control the behavior of the control plane for Authentication / Authorization.
- `default_provider`**Type**: `STRING`**Provider name**: `properties.defaultProvider`**Description**: The default authentication provider to use when multiple providers are configured.This setting is only needed if multiple providers are configured and the unauthenticated clientaction is set to "RedirectToLoginPage".
- `enabled`**Type**: `BOOLEAN`**Provider name**: `properties.enabled`**Description**: `true` if the Authentication / Authorization feature is enabled for the current app; otherwise, `false`.
- `id`**Type**: `STRING`**Provider name**: `id`**Description**: Resource Id.
- `is_auth_from_file`**Type**: `STRING`**Provider name**: `properties.isAuthFromFile`**Description**: "true" if the auth config settings should be read from a file,"false" otherwise
- `issuer`**Type**: `STRING`**Provider name**: `properties.issuer`**Description**: The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.When using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.This URI is a case-sensitive identifier for the token issuer.More information on OpenID Connect Discovery: [http://openid.net/specs/openid-connect-discovery-1_0.html](http://openid.net/specs/openid-connect-discovery-1_0.html)
- `kind`**Type**: `STRING`**Provider name**: `kind`**Description**: Kind of resource.
- `name`**Type**: `STRING`**Provider name**: `name`**Description**: Resource Name.
- `runtime_version`**Type**: `STRING`**Provider name**: `properties.runtimeVersion`**Description**: The RuntimeVersion of the Authentication / Authorization feature in use for the current app.The setting in this value can control the behavior of certain features in the Authentication / Authorization module.
- `token_refresh_extension_hours`**Type**: `DOUBLE`**Provider name**: `properties.tokenRefreshExtensionHours`**Description**: The number of hours after session token expiration that a session token can be used tocall the token refresh API. The default is 72 hours.
- `token_store_enabled`**Type**: `BOOLEAN`**Provider name**: `properties.tokenStoreEnabled`**Description**: `true` to durably store platform-specific security tokens that are obtained during login flows; otherwise, `false`. The default is `false`.
- `type`**Type**: `STRING`**Provider name**: `type`**Description**: Resource type.
- `unauthenticated_client_action`**Type**: `STRING`**Provider name**: `properties.unauthenticatedClientAction`**Description**: The action to take when an unauthenticated client attempts to access the app.
- `validate_issuer`**Type**: `BOOLEAN`**Provider name**: `properties.validateIssuer`**Description**: Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.
