GetWebAppResult

data class GetWebAppResult(val autoGeneratedDomainNameLabelScope: String? = null, val availabilityState: String, val azureApiVersion: String, val clientAffinityEnabled: Boolean? = null, val clientCertEnabled: Boolean? = null, val clientCertExclusionPaths: String? = null, val clientCertMode: String? = null, val containerSize: Int? = null, val customDomainVerificationId: String? = null, val dailyMemoryTimeQuota: Int? = null, val daprConfig: DaprConfigResponse? = null, val defaultHostName: String, val dnsConfiguration: SiteDnsConfigResponse? = null, val enabled: Boolean? = null, val enabledHostNames: List<String>, val endToEndEncryptionEnabled: Boolean? = null, val extendedLocation: ExtendedLocationResponse? = null, val functionAppConfig: FunctionAppConfigResponse? = null, val hostNameSslStates: List<HostNameSslStateResponse>? = null, val hostNames: List<String>, val hostNamesDisabled: Boolean? = null, val hostingEnvironmentProfile: HostingEnvironmentProfileResponse? = null, val httpsOnly: Boolean? = null, val hyperV: Boolean? = null, val id: String, val identity: ManagedServiceIdentityResponse? = null, val inProgressOperationId: String, val ipMode: String? = null, val isDefaultContainer: Boolean, val isXenon: Boolean? = null, val keyVaultReferenceIdentity: String? = null, val kind: String? = null, val lastModifiedTimeUtc: String, val location: String, val managedEnvironmentId: String? = null, val maxNumberOfWorkers: Int, val name: String, val outboundIpAddresses: String, val possibleOutboundIpAddresses: String, val publicNetworkAccess: String? = null, val redundancyMode: String? = null, val repositorySiteName: String, val reserved: Boolean? = null, val resourceConfig: ResourceConfigResponse? = null, val resourceGroup: String, val scmSiteAlsoStopped: Boolean? = null, val serverFarmId: String? = null, val siteConfig: SiteConfigResponse? = null, val sku: String, val slotSwapStatus: SlotSwapStatusResponse, val state: String, val storageAccountRequired: Boolean? = null, val suspendedTill: String, val tags: Map<String, String>? = null, val targetSwapSlot: String, val trafficManagerHostNames: List<String>, val type: String, val usageState: String, val virtualNetworkSubnetId: String? = null, val vnetBackupRestoreEnabled: Boolean? = null, val vnetContentShareEnabled: Boolean? = null, val vnetImagePullEnabled: Boolean? = null, val vnetRouteAllEnabled: Boolean? = null, val workloadProfileName: String? = null)

A web app, a mobile app backend, or an API app.

Constructors

Link copied to clipboard
constructor(autoGeneratedDomainNameLabelScope: String? = null, availabilityState: String, azureApiVersion: String, clientAffinityEnabled: Boolean? = null, clientCertEnabled: Boolean? = null, clientCertExclusionPaths: String? = null, clientCertMode: String? = null, containerSize: Int? = null, customDomainVerificationId: String? = null, dailyMemoryTimeQuota: Int? = null, daprConfig: DaprConfigResponse? = null, defaultHostName: String, dnsConfiguration: SiteDnsConfigResponse? = null, enabled: Boolean? = null, enabledHostNames: List<String>, endToEndEncryptionEnabled: Boolean? = null, extendedLocation: ExtendedLocationResponse? = null, functionAppConfig: FunctionAppConfigResponse? = null, hostNameSslStates: List<HostNameSslStateResponse>? = null, hostNames: List<String>, hostNamesDisabled: Boolean? = null, hostingEnvironmentProfile: HostingEnvironmentProfileResponse? = null, httpsOnly: Boolean? = null, hyperV: Boolean? = null, id: String, identity: ManagedServiceIdentityResponse? = null, inProgressOperationId: String, ipMode: String? = null, isDefaultContainer: Boolean, isXenon: Boolean? = null, keyVaultReferenceIdentity: String? = null, kind: String? = null, lastModifiedTimeUtc: String, location: String, managedEnvironmentId: String? = null, maxNumberOfWorkers: Int, name: String, outboundIpAddresses: String, possibleOutboundIpAddresses: String, publicNetworkAccess: String? = null, redundancyMode: String? = null, repositorySiteName: String, reserved: Boolean? = null, resourceConfig: ResourceConfigResponse? = null, resourceGroup: String, scmSiteAlsoStopped: Boolean? = null, serverFarmId: String? = null, siteConfig: SiteConfigResponse? = null, sku: String, slotSwapStatus: SlotSwapStatusResponse, state: String, storageAccountRequired: Boolean? = null, suspendedTill: String, tags: Map<String, String>? = null, targetSwapSlot: String, trafficManagerHostNames: List<String>, type: String, usageState: String, virtualNetworkSubnetId: String? = null, vnetBackupRestoreEnabled: Boolean? = null, vnetContentShareEnabled: Boolean? = null, vnetImagePullEnabled: Boolean? = null, vnetRouteAllEnabled: Boolean? = null, workloadProfileName: String? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Specifies the scope of uniqueness for the default hostname during resource creation

Link copied to clipboard

Management information availability state for the app.

Link copied to clipboard

The Azure API version of the resource.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

client certificate authentication comma-separated exclusion paths

Link copied to clipboard
val clientCertMode: String? = null

This composes with ClientCertEnabled setting.

Link copied to clipboard
val containerSize: Int? = null

Size of the function container.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Dapr configuration of the app.

Link copied to clipboard

Default hostname of the app. Read-only.

Link copied to clipboard

Property to configure various DNS related settings for a site.

Link copied to clipboard
val enabled: Boolean? = null

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

Link copied to clipboard

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

Link copied to clipboard

Whether to use end to end encryption between the FrontEnd and the Worker

Link copied to clipboard

Extended Location.

Link copied to clipboard

Configuration specific of the Azure Function app.

Link copied to clipboard

App Service Environment to use for the app.

Link copied to clipboard

Hostnames associated with the app.

Link copied to clipboard

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

Link copied to clipboard

Hostname SSL states are used to manage the SSL bindings for app's hostnames.

Link copied to clipboard
val httpsOnly: Boolean? = null

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

Link copied to clipboard
val hyperV: Boolean? = null

Hyper-V sandbox.

Link copied to clipboard
val id: String

Resource Id.

Link copied to clipboard

Managed service identity.

Link copied to clipboard

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

Link copied to clipboard
val ipMode: String? = null

Specifies the IP mode of the app.

Link copied to clipboard

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

Link copied to clipboard
val isXenon: Boolean? = null

Obsolete: Hyper-V sandbox.

Link copied to clipboard

Identity to use for Key Vault Reference authentication.

Link copied to clipboard
val kind: String? = null

Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.

Link copied to clipboard

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

Link copied to clipboard

Resource Location.

Link copied to clipboard

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/Microsoft.App/managedEnvironments/{managedEnvironmentName}

Link copied to clipboard

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

Link copied to clipboard

Resource Name.

Link copied to clipboard

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.

Link copied to clipboard

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.

Link copied to clipboard

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

Link copied to clipboard
val redundancyMode: String? = null

Site redundancy mode

Link copied to clipboard

Name of the repository site.

Link copied to clipboard
val reserved: Boolean? = null

true if reserved; otherwise, false.

Link copied to clipboard

Function app resource requirements.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
val serverFarmId: String? = null

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

Link copied to clipboard

Configuration of the app.

Link copied to clipboard
val 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

Link copied to clipboard

Status of the last deployment slot swap operation.

Link copied to clipboard

Current state of the app.

Link copied to clipboard

Checks if Customer provided storage account is required

Link copied to clipboard

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

Link copied to clipboard
val tags: Map<String, String>? = null

Resource tags.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Resource type.

Link copied to clipboard

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

Link copied to clipboard

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}

Link copied to clipboard

To enable Backup and Restore operations over virtual network

Link copied to clipboard

To enable accessing content over virtual network

Link copied to clipboard

To enable pulling image over Virtual Network

Link copied to clipboard

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

Link copied to clipboard

Workload profile name for function app to execute on.