Share via


SitePatchInfo Class

Definition

ARM resource for a site.

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

SitePatchInfo()

Initializes a new instance of SitePatchInfo.

Properties

AvailabilityState

Management information availability state for the app.

ClientCertExclusionPaths

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

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

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.

DnsConfiguration

Property to configure various DNS related settings for a site.

EnabledHostNames

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

HostingEnvironmentProfile

App Service Environment to use for the app.

HostNames

Hostnames associated with the app.

HostNameSslStates

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

Id

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

(Inherited from ResourceData)
Identity

Managed service identity.

InProgressOperationId

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

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

IsClientCertEnabled

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

IsDefaultContainer

<code>true</code> if the app is a default container; otherwise, <code>false</code>.

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

IsHostNameDisabled

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

IsHttpsOnly

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

IsHyperV

Hyper-V sandbox.

IsReserved

<code>true</code> if reserved; otherwise, <code>false</code>.

IsScmSiteAlsoStopped

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

IsStorageAccountRequired

Checks if Customer provided storage account is required.

IsXenon

Obsolete: Hyper-V sandbox.

KeyVaultReferenceIdentity

Identity to use for Key Vault Reference authentication.

Kind

Kind of resource.

LastModifiedOn

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

MaxNumberOfWorkers

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

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.

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.

RedundancyMode

Site redundancy mode.

RepositorySiteName

Name of the repository site.

ResourceGroup

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

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

SiteConfig

Configuration of the app.

SlotSwapStatus

Status of the last deployment slot swap operation.

State

Current state of the app.

SuspendOn

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

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.

TrafficManagerHostNames

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

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

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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