Site Class

Reference

Definition

Namespace:: Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801

Assembly:: Az.Functions.private.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

[Microsoft.Azure.PowerShell.Cmdlets.Functions.DoNotFormat]
[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.SiteTypeConverter))]
public class Site : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IValidates

[<Microsoft.Azure.PowerShell.Cmdlets.Functions.DoNotFormat>]
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.SiteTypeConverter))>]
type Site = class
    interface ISite
    interface IJsonSerializable
    interface IResource
    interface IValidates

Public Class Site
Implements ISite, IValidates

Inheritance: Object
Site

Attributes: DoNotFormatAttribute TypeConverterAttribute

Implements: IResource ISite IJsonSerializable IValidates

Constructors

Site()

Creates an new Site instance.

Properties

ApplicationSettings
AppServicePlan
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
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.
Config	Configuration of the 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.
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.
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.
Kind	Kind of resource.
LastModifiedTimeUtc	Last time the app was modified, in UTC. Read-only.
Location	Resource Location.
MaxNumberOfWorker	Maximum number of workers. This only applies to Functions container.
Name	Resource Name.
OSType
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.
Runtime
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
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.
SuspendedTill	App suspended till in case memory-time quota is exceeded.
Tag	Resource tags.
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.
UsageState	State indicating whether the app has exceeded its quota usage. Read-only.

Methods

DeserializeFromDictionary(IDictionary)	Deserializes a IDictionary into an instance of Site.
DeserializeFromPSObject(PSObject)	Deserializes a PSObject into an instance of Site.
FromJson(JsonNode)	Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190801.ISite.
FromJsonString(String)	Creates a new instance of Site, deserializing the content from a json string.
ToJson(JsonObject, SerializationMode)	Serializes this instance of Site into a JsonNode.
ToJsonString()	Serializes this instance to a json string.
Validate(IEventListener)	Validates that this object meets the validation criteria.

Applies to