Share via

SitePatchResource interface

  • Reference
Package:
@azure/arm-appservice-profile-2020-09-01-hybrid

ARM resource for a site.

Extends
ProxyOnlyResource

Properties

availabilityState

Management information availability state for the app. NOTE: This property will not be serialized. It can only be populated by the server.
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
cloningInfo

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

Size of the function container.
dailyMemoryTimeQuota

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

Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
geoDistributions

GeoDistributions for this site
hostingEnvironmentProfile

App Service Environment to use for the app.
hostNames

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.
hostNamesDisabled

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

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

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

Hyper-V sandbox.
identity

Managed service identity.
inProgressOperationId

Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server.
isDefaultContainer

true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.
isXenon

Obsolete: Hyper-V sandbox.
lastModifiedTimeUtc

Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
maxNumberOfWorkers

Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
possibleOutboundIpAddresses

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
redundancyMode

Site redundancy mode
repositorySiteName

Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.
reserved

true if reserved; otherwise, false.
resourceGroup

Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
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. NOTE: This property will not be serialized. It can only be populated by the server.
state

Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.
suspendedTill

App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.
targetSwapSlot

Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
trafficManagerHostNames

Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.
usageState

State indicating whether the app has exceeded its quota usage. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

Inherited Properties

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.
kind

Kind of resource.
name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.
type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

Property Details

availabilityState

Management information availability state for the app. NOTE: This property will not be serialized. It can only be populated by the server.

availabilityState?: SiteAvailabilityState

Property Value

SiteAvailabilityState

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.

clientAffinityEnabled?: boolean

Property Value

boolean

clientCertEnabled

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

clientCertEnabled?: boolean

Property Value

boolean

clientCertExclusionPaths

client certificate authentication comma-separated exclusion paths

clientCertExclusionPaths?: string

Property Value

string

cloningInfo

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

cloningInfo?: CloningInfo

Property Value

CloningInfo

containerSize

Size of the function container.

containerSize?: number

Property Value

number

dailyMemoryTimeQuota

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

dailyMemoryTimeQuota?: number

Property Value

number

defaultHostName

Default hostname of the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

defaultHostName?: string

Property Value

string

enabled

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

enabled?: boolean

Property Value

boolean

enabledHostNames

Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. NOTE: This property will not be serialized. It can only be populated by the server.

enabledHostNames?: string[]

Property Value

string[]

geoDistributions

GeoDistributions for this site

geoDistributions?: GeoDistribution[]

Property Value

GeoDistribution[]

hostingEnvironmentProfile

App Service Environment to use for the app.

hostingEnvironmentProfile?: HostingEnvironmentProfile

Property Value

HostingEnvironmentProfile

hostNames

Hostnames associated with the app. NOTE: This property will not be serialized. It can only be populated by the server.

hostNames?: string[]

Property Value

string[]

hostNamesDisabled

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

hostNamesDisabled?: boolean

Property Value

boolean

hostNameSslStates

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

hostNameSslStates?: HostNameSslState[]

Property Value

HostNameSslState[]

httpsOnly

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

httpsOnly?: boolean

Property Value

boolean

hyperV

Hyper-V sandbox.

hyperV?: boolean

Property Value

boolean

identity

Managed service identity.

identity?: ManagedServiceIdentity

Property Value

ManagedServiceIdentity

inProgressOperationId

Specifies an operation id if this site has a pending operation. NOTE: This property will not be serialized. It can only be populated by the server.

inProgressOperationId?: string

Property Value

string

isDefaultContainer

true if the app is a default container; otherwise, false. NOTE: This property will not be serialized. It can only be populated by the server.

isDefaultContainer?: boolean

Property Value

boolean

isXenon

Obsolete: Hyper-V sandbox.

isXenon?: boolean

Property Value

boolean

lastModifiedTimeUtc

Last time the app was modified, in UTC. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

lastModifiedTimeUtc?: Date

Property Value

Date

maxNumberOfWorkers

Maximum number of workers. This only applies to Functions container. NOTE: This property will not be serialized. It can only be populated by the server.

maxNumberOfWorkers?: number

Property Value

number

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. NOTE: This property will not be serialized. It can only be populated by the server.

outboundIpAddresses?: string

Property Value

string

possibleOutboundIpAddresses

List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

possibleOutboundIpAddresses?: string

Property Value

string

redundancyMode

Site redundancy mode

redundancyMode?: RedundancyMode

Property Value

RedundancyMode

repositorySiteName

Name of the repository site. NOTE: This property will not be serialized. It can only be populated by the server.

repositorySiteName?: string

Property Value

string

reserved

true if reserved; otherwise, false.

reserved?: boolean

Property Value

boolean

resourceGroup

Name of the resource group the app belongs to. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

resourceGroup?: string

Property Value

string

scmSiteAlsoStopped

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

scmSiteAlsoStopped?: boolean

Property Value

boolean

serverFarmId

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

serverFarmId?: string

Property Value

string

siteConfig

Configuration of the app.

siteConfig?: SiteConfig

Property Value

SiteConfig

slotSwapStatus

Status of the last deployment slot swap operation. NOTE: This property will not be serialized. It can only be populated by the server.

slotSwapStatus?: SlotSwapStatus

Property Value

SlotSwapStatus

state

Current state of the app. NOTE: This property will not be serialized. It can only be populated by the server.

state?: string

Property Value

string

suspendedTill

App suspended till in case memory-time quota is exceeded. NOTE: This property will not be serialized. It can only be populated by the server.

suspendedTill?: Date

Property Value

Date

targetSwapSlot

Specifies which deployment slot this app will swap into. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

targetSwapSlot?: string

Property Value

string

trafficManagerHostNames

Azure Traffic Manager hostnames associated with the app. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

trafficManagerHostNames?: string[]

Property Value

string[]

usageState

State indicating whether the app has exceeded its quota usage. Read-only. NOTE: This property will not be serialized. It can only be populated by the server.

usageState?: UsageState

Property Value

UsageState

Inherited Property Details

id

Resource Id. NOTE: This property will not be serialized. It can only be populated by the server.

id?: string

Property Value

string

Inherited From ProxyOnlyResource.id

kind

Kind of resource.

kind?: string

Property Value

string

Inherited From ProxyOnlyResource.kind

name

Resource Name. NOTE: This property will not be serialized. It can only be populated by the server.

name?: string

Property Value

string

Inherited From ProxyOnlyResource.name

type

Resource type. NOTE: This property will not be serialized. It can only be populated by the server.

type?: string

Property Value

string

Inherited From ProxyOnlyResource.type