SitePatchInfo Class

Definition

ARM resource for a site. Serialized Name: SitePatchResource

public class SitePatchInfo : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppService.Models.SitePatchInfo>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppService.Models.SitePatchInfo>
type SitePatchInfo = class
    inherit ResourceData
    interface IJsonModel<SitePatchInfo>
    interface IPersistableModel<SitePatchInfo>
Public Class SitePatchInfo
Inherits ResourceData
Implements IJsonModel(Of SitePatchInfo), IPersistableModel(Of SitePatchInfo)
Inheritance
SitePatchInfo
Implements

Constructors

Name Description
SitePatchInfo()

Initializes a new instance of SitePatchInfo.

Properties

Name Description
AvailabilityState

Management information availability state for the app. Serialized Name: SitePatchResource.properties.availabilityState

ClientCertExclusionPaths

client certificate authentication comma-separated exclusion paths Serialized Name: SitePatchResource.properties.clientCertExclusionPaths

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. Serialized Name: SitePatchResource.properties.clientCertMode
CloningInfo

If specified during app creation, the app is cloned from a source app. Serialized Name: SitePatchResource.properties.cloningInfo

ContainerSize

Size of the function container. Serialized Name: SitePatchResource.properties.containerSize

CustomDomainVerificationId

Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. Serialized Name: SitePatchResource.properties.customDomainVerificationId

DailyMemoryTimeQuota

Maximum allowed daily memory-time quota (applicable on dynamic apps only). Serialized Name: SitePatchResource.properties.dailyMemoryTimeQuota

DefaultHostName

Default hostname of the app. Read-only. Serialized Name: SitePatchResource.properties.defaultHostName

DnsConfiguration

Property to configure various DNS related settings for a site. Serialized Name: SitePatchResource.properties.dnsConfiguration

EnabledHostNames

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

HostingEnvironmentProfile

App Service Environment to use for the app. Serialized Name: SitePatchResource.properties.hostingEnvironmentProfile

HostNames

Hostnames associated with the app. Serialized Name: SitePatchResource.properties.hostNames

HostNameSslStates

Hostname SSL states are used to manage the SSL bindings for app's hostnames. Serialized Name: SitePatchResource.properties.hostNameSslStates

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
Identity

Managed service identity. Serialized Name: SitePatchResource.identity

InProgressOperationId

Specifies an operation id if this site has a pending operation. Serialized Name: SitePatchResource.properties.inProgressOperationId

IsClientAffinityEnabled

<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>. Serialized Name: SitePatchResource.properties.clientAffinityEnabled

IsClientAffinityProxyEnabled

<code>true</code> to override client affinity cookie domain with X-Forwarded-Host request header. <code>false</code> to use default domain. Default is <code>false</code>. Serialized Name: SitePatchResource.properties.clientAffinityProxyEnabled

IsClientCertEnabled

<code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. Serialized Name: SitePatchResource.properties.clientCertEnabled

IsDefaultContainer

<code>true</code> if the app is a default container; otherwise, <code>false</code>. Serialized Name: SitePatchResource.properties.isDefaultContainer

IsEnabled

<code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). Serialized Name: SitePatchResource.properties.enabled

IsHostNameDisabled

<code>true</code> to disable the public hostnames of the app; otherwise, <code>false</code>.\n If <code>true</code>, the app is only accessible via API management process. Serialized Name: SitePatchResource.properties.hostNamesDisabled

IsHttpsOnly

HttpsOnly: configures a web site to accept only https requests. Issues redirect for http requests Serialized Name: SitePatchResource.properties.httpsOnly

IsHyperV

Hyper-V sandbox. Serialized Name: SitePatchResource.properties.hyperV

IsReserved

<code>true</code> if reserved; otherwise, <code>false</code>. Serialized Name: SitePatchResource.properties.reserved

IsScmSiteAlsoStopped

<code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. Serialized Name: SitePatchResource.properties.scmSiteAlsoStopped

IsStorageAccountRequired

Checks if Customer provided storage account is required Serialized Name: SitePatchResource.properties.storageAccountRequired

IsXenon

Obsolete: Hyper-V sandbox. Serialized Name: SitePatchResource.properties.isXenon

KeyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication. Serialized Name: SitePatchResource.properties.keyVaultReferenceIdentity

Kind

Kind of resource. Serialized Name: ProxyOnlyResource.kind

LastModifiedOn

Last time the app was modified, in UTC. Read-only. Serialized Name: SitePatchResource.properties.lastModifiedTimeUtc

MaxNumberOfWorkers

Maximum number of workers. This only applies to Functions container. Serialized Name: SitePatchResource.properties.maxNumberOfWorkers

Name

The name of the resource.

(Inherited from ResourceData)
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. Serialized Name: SitePatchResource.properties.outboundIpAddresses

PossibleOutboundIPAddresses

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

PublicNetworkAccess

Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. Serialized Name: SitePatchResource.properties.publicNetworkAccess

RedundancyMode

Site redundancy mode Serialized Name: SitePatchResource.properties.redundancyMode

RepositorySiteName

Name of the repository site. Serialized Name: SitePatchResource.properties.repositorySiteName

ResourceGroup

Name of the resource group the app belongs to. Read-only. Serialized Name: SitePatchResource.properties.resourceGroup

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
ServerFarmId

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

SiteConfig

Configuration of the app. Serialized Name: SitePatchResource.properties.siteConfig

SlotSwapStatus

Status of the last deployment slot swap operation. Serialized Name: SitePatchResource.properties.slotSwapStatus

State

Current state of the app. Serialized Name: SitePatchResource.properties.state

SuspendOn

App suspended till in case memory-time quota is exceeded. Serialized Name: SitePatchResource.properties.suspendedTill

SystemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
TargetSwapSlot

Specifies which deployment slot this app will swap into. Read-only. Serialized Name: SitePatchResource.properties.targetSwapSlot

TrafficManagerHostNames

Azure Traffic Manager hostnames associated with the app. Read-only. Serialized Name: SitePatchResource.properties.trafficManagerHostNames

UsageState

State indicating whether the app has exceeded its quota usage. Read-only. Serialized Name: SitePatchResource.properties.usageState

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} Serialized Name: SitePatchResource.properties.virtualNetworkSubnetId

Methods

Name Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<SitePatchInfo>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<SitePatchInfo>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<SitePatchInfo>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<SitePatchInfo>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<SitePatchInfo>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to