WebSiteSlot Class
Definition
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.
WebSiteSlot.
public class WebSiteSlot : Azure.Provisioning.Primitives.ProvisionableResource
public class WebSiteSlot : Azure.Provisioning.Primitives.Resource
type WebSiteSlot = class
inherit ProvisionableResource
type WebSiteSlot = class
inherit Resource
Public Class WebSiteSlot
Inherits ProvisionableResource
Public Class WebSiteSlot
Inherits Resource
- Inheritance
- Inheritance
Constructors
WebSiteSlot(String, String) |
Creates a new WebSiteSlot. |
Properties
AppServicePlanId |
Resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". |
AvailabilityState |
Management information availability state for the app. |
BicepIdentifier |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct) |
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). |
DaprConfig |
Dapr configuration of the app. |
DefaultHostName |
Default hostname of the app. Read-only. |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from ProvisionableResource) |
DependsOn |
Declares explicit dependencies on other resources. (Inherited from Resource) |
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. |
ExtendedLocation |
Extended Location. |
FunctionAppConfig |
Configuration specific of the Azure Function app. |
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 |
Gets the Id. |
IdentifierName |
Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisioningConstruct) |
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). |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource) |
IsExistingResource |
Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from Resource) |
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. |
IsVnetBackupRestoreEnabled |
To enable Backup and Restore operations over virtual network. |
IsVnetContentShareEnabled |
To enable accessing content over virtual network. |
IsVnetImagePullEnabled |
To enable pulling image over Virtual Network. |
IsVnetRouteAllEnabled |
Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. |
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 |
Gets or sets the 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}. |
MaxNumberOfWorkers |
Maximum number of workers. This only applies to Functions container. |
Name |
Gets the Name. |
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. |
Parent |
Gets or sets a reference to the parent WebSite. |
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. |
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. |
ResourceConfig |
Function app resource requirements. |
ResourceGroup |
Name of the resource group the app belongs to. Read-only. |
ResourceType |
Gets the type of the resource. (Inherited from ProvisionableResource) |
ResourceType |
Gets the type of the resource. (Inherited from Resource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from ProvisionableResource) |
ResourceVersion |
Gets or sets the version of the resource. (Inherited from Resource) |
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 |
Gets the SystemData. |
Tags |
Gets or sets the Tags. |
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} |
WorkloadProfileName |
Workload profile name for function app to execute on. |
Methods
AssignOrReplace<T>(T, T) | (Inherited from ProvisionableConstruct) |
Build(ProvisioningBuildOptions) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource) |
Build(ProvisioningContext) |
Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from Resource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource) |
Compile() |
Compile the resource into a set of Bicep statements. (Inherited from Resource) |
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineListProperty<T>(String, String[], Boolean, Boolean) | (Inherited from ProvisionableConstruct) |
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String) | (Inherited from ProvisionableConstruct) |
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String) | (Inherited from ProvisionableConstruct) |
DefineProvisionableProperties() |
Define all the provisionable properties of WebSiteSlot. |
DefineResource<T>(String, String[], Boolean, Boolean, T) | (Inherited from ProvisionableResource) |
FromExisting(String, String) |
Creates a reference to an existing WebSiteSlot. |
GetProvisionableResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
GetResources() |
Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable) |
Initialize() |
Initialize this construct. (Inherited from ProvisionableConstruct) |
OverrideWithExpression(BicepExpression) | (Inherited from ProvisionableConstruct) |
OverrideWithExpression(Expression) |
Set this construct to represent the result of an expression. This is
primarily meant to be called via |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct) |
Resolve(ProvisioningBuildOptions) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable) |
Resolve(ProvisioningContext) |
Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisioningConstruct) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from ProvisionableResource) |
Validate(ProvisioningBuildOptions) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Provisionable) |
Validate(ProvisioningContext) |
Validate the presence of any required members. (Inherited from Resource) |
Explicit Interface Implementations
IBicepValue.Assign(IBicepValue) |
Assign a value to this property. (Inherited from ProvisionableConstruct) |
IBicepValue.Compile() |
Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct) |
IBicepValue.Expression |
Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct) |
IBicepValue.IsEmpty |
Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct) |
IBicepValue.IsOutput |
Tracks whether this is an output only property. (Inherited from ProvisionableConstruct) |
IBicepValue.IsRequired |
Tracks whether this property is required. (Inherited from ProvisionableConstruct) |
IBicepValue.IsSecure |
Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct) |
IBicepValue.Kind |
Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct) |
IBicepValue.LiteralValue |
Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct) |
IBicepValue.Self |
Gets information about where this value was defined. (Inherited from ProvisionableConstruct) |
IBicepValue.SetReadOnly() |
Make this value readonly. (Inherited from ProvisionableConstruct) |
IBicepValue.Source |
Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct) |