Site Class

Definition

Namespace:

Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201

Assembly:

Az.Functions.private.dll

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.Api20231201.SiteTypeConverter))]
public class Site : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20231201.ISite, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IHeaderSerializable, Microsoft.Azure.PowerShell.Cmdlets.Functions.Runtime.IValidates

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

Public Class Site
Implements IHeaderSerializable, ISite, IValidates

Inheritance

Object

Site

Attributes

DoNotFormatAttribute TypeConverterAttribute

Implements

IResource ISite IHeaderSerializable IJsonSerializable IValidates

Constructors

Site()

Creates an new Site instance.

Properties

ApplicationSettings
AppServicePlan
AuthenticationStorageAccountConnectionStringName	Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type.
AuthenticationType	Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.
AuthenticationUserAssignedIdentityResourceId	Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type.
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.
Config	Configuration of the 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).
DaprConfigAppId	Dapr application identifier
DaprConfigAppPort	Tells Dapr which port your application is listening on
DaprConfigEnableApiLogging	Enables API logging for the Dapr sidecar
DaprConfigEnabled	Boolean indicating if the Dapr side car is enabled
DaprConfigHttpMaxRequestSize	Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB.
DaprConfigHttpReadBufferSize	Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB.
DaprConfigLogLevel	Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.
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.
ExtendedLocationName	Name of extended location.
ExtendedLocationType	Type of extended location.
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.
HttpPerInstanceConcurrency	The maximum number of concurrent HTTP trigger invocations per instance.
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.
KeyVaultReferenceIdentity	Identity to use for Key Vault Reference authentication.
Kind	Kind of resource.
LastModifiedTimeUtc	Last time the app was modified, in UTC. Read-only.
Location	Resource Location.
ManagedEnvironmentId	Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}
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.
PublicNetworkAccess	Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string.
RedundancyMode	Site redundancy mode
RepositorySiteName	Name of the repository site.
Reserved	true if reserved; otherwise, false.
ResourceConfigCpu	Required CPU in cores, e.g. 0.5
ResourceConfigMemory	Required memory, e.g. "1Gi"
ResourceGroup	Name of the resource group the app belongs to. Read-only.
Runtime
RuntimeName	Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom
RuntimeVersion	Function app runtime version. Example: 8 (for dotnet-isolated)
ScaleAndConcurrencyAlwaysReady	'Always Ready' configuration for the function app.
ScaleAndConcurrencyInstanceMemoryMb	Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally.
ScaleAndConcurrencyMaximumInstanceCount	The maximum number of instances for the function app.
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.
StorageAccountRequired	Checks if Customer provided storage account is required
StorageType	Property to select Azure Storage type. Available options: blobContainer.
StorageValue
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.
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}
VnetBackupRestoreEnabled	To enable Backup and Restore operations over virtual network
VnetContentShareEnabled	To enable accessing content over virtual network
VnetImagePullEnabled	To enable pulling image over Virtual Network
VnetRouteAllEnabled	Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.
WorkloadProfileName	Workload profile name for function app to execute on.

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

Explicit Interface Implementations

IHeaderSerializable.ReadHeaders(HttpResponseHeaders)