Share via


ISitePatchResource Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.SitePatchResourceTypeConverter))]
public interface ISitePatchResource : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.IProxyOnlyResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.SitePatchResourceTypeConverter))>]
type ISitePatchResource = interface
    interface IJsonSerializable
    interface IProxyOnlyResource
Public Interface ISitePatchResource
Implements IProxyOnlyResource
Derived
Attributes
Implements

Properties

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.

ClientCertExclusionPath

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.
CloningInfoAppSettingsOverride

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.

CloningInfoCloneCustomHostName

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

CloningInfoCloneSourceControl

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

CloningInfoConfigureLoadBalancing

true to configure load balancing for source and destination app.

CloningInfoCorrelationId

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

CloningInfoHostingEnvironment

App Service Environment.

CloningInfoOverwrite

true to overwrite destination app; otherwise, false.

CloningInfoSourceWebAppId

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.

CloningInfoSourceWebAppLocation

Location of source app ex: West US or North Europe

CloningInfoTrafficManagerProfileId

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}.

CloningInfoTrafficManagerProfileName

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

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.

DnsConfigurationDnsAltServer

Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting.

DnsConfigurationDnsLegacySortOrder

Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.

DnsConfigurationDnsMaxCacheTimeout

Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled.

DnsConfigurationDnsRetryAttemptCount

Total number of retries for dns lookup. Allowed range: 1-5. Default is 3.

DnsConfigurationDnsRetryAttemptTimeout

Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3.

DnsConfigurationDnsServer

List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set.

Enabled

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

EnabledHostName

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

HostingEnvironmentProfileId

Resource ID of the App Service Environment.

HostingEnvironmentProfileName

Name of the App Service Environment.

HostingEnvironmentProfileType

Resource type of the App Service Environment.

HostName

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.

HostNameSslState

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.

Id

Resource Id.

(Inherited from IProxyOnlyResource)
IdentityPrincipalId

Principal Id of managed service identity.

IdentityTenantId

Tenant of managed service identity.

IdentityType

Type of managed service identity.

IdentityUserAssignedIdentity

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}

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.

(Inherited from IProxyOnlyResource)
LastModifiedTimeUtc

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

MaxNumberOfWorker

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

Name

Resource Name.

(Inherited from IProxyOnlyResource)
OutboundIPAddress

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.

PossibleOutboundIPAddress

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

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.

SlotSwapStatusDestinationSlotName

The destination slot of the last swap operation.

SlotSwapStatusSourceSlotName

The source slot of the last swap operation.

SlotSwapStatusTimestampUtc

The time the last successful slot swap completed.

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.

TargetSwapSlot

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

TrafficManagerHostName

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

Type

Resource type.

(Inherited from IProxyOnlyResource)
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}

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to