PSSite 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.
public class PSSite : Microsoft.Azure.Management.WebSites.Models.Site
type PSSite = class
inherit Site
Public Class PSSite
Inherits Site
- Inheritance
Constructors
| Name | Description |
|---|---|
| PSSite(Site) | |
Properties
| Name | Description |
|---|---|
| AutoGeneratedDomainNameLabelScope |
Gets or sets specifies the scope of uniqueness for the default hostname during resource creation Possible values include: 'TenantReuse', 'SubscriptionReuse', 'ResourceGroupReuse', 'NoReuse' (Inherited from Site) |
| AvailabilityState |
Gets management information availability state for the app. Possible values include: 'Normal', 'Limited', 'DisasterRecoveryMode' (Inherited from Site) |
| AzureStorageAccounts | |
| AzureStoragePath | |
| ClientAffinityEnabled |
Gets or sets <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>. (Inherited from Site) |
| ClientAffinityPartitioningEnabled |
Gets or sets <code>true</code> to enable client affinity partitioning using CHIPS cookies, this will add the <code>partitioned</code> property to the affinity cookies; <code>false</code> to stop sending partitioned affinity cookies. Default is <code>false</code>. (Inherited from Site) |
| ClientAffinityProxyEnabled |
Gets or sets <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>. (Inherited from Site) |
| ClientCertEnabled |
Gets or sets <code>true</code> to enable client certificate authentication (TLS mutual authentication); otherwise, <code>false</code>. Default is <code>false</code>. (Inherited from Site) |
| ClientCertExclusionPaths |
Gets or sets client certificate authentication comma-separated exclusion paths (Inherited from Site) |
| ClientCertMode |
Gets or sets this composes with ClientCertEnabled setting.
|
| CloningInfo |
Gets or sets if specified during app creation, the app is cloned from a source app. (Inherited from Site) |
| ContainerSize |
Gets or sets size of the function container. (Inherited from Site) |
| CustomDomainVerificationId |
Gets or sets unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification. (Inherited from Site) |
| DailyMemoryTimeQuota |
Gets or sets maximum allowed daily memory-time quota (applicable on dynamic apps only). (Inherited from Site) |
| DaprConfig |
Gets or sets dapr configuration of the app. (Inherited from Site) |
| DefaultHostName |
Gets default hostname of the app. Read-only. (Inherited from Site) |
| DnsConfiguration |
Gets or sets property to configure various DNS related settings for a site. (Inherited from Site) |
| Enabled |
Gets or sets <code>true</code> if the app is enabled; otherwise, <code>false</code>. Setting this value to false disables the app (takes the app offline). (Inherited from Site) |
| EnabledHostNames |
Gets enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise, the app is not served on those hostnames. (Inherited from Site) |
| EndToEndEncryptionEnabled |
Gets or sets whether to use end to end encryption between the FrontEnd and the Worker (Inherited from Site) |
| ExtendedLocation |
Gets or sets extended Location. (Inherited from Site) |
| FunctionAppConfig |
Gets or sets configuration specific of the Azure Function app. (Inherited from Site) |
| GitRemoteName | |
| GitRemotePassword | |
| GitRemoteUri | |
| GitRemoteUsername | |
| HostingEnvironmentProfile |
Gets or sets app Service Environment to use for the app. (Inherited from Site) |
| HostNames |
Gets hostnames associated with the app. (Inherited from Site) |
| HostNamesDisabled |
Gets or sets <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. (Inherited from Site) |
| HostNameSslStates |
Gets or sets hostname SSL states are used to manage the SSL bindings for app's hostnames. (Inherited from Site) |
| HttpsOnly |
Gets or sets httpsOnly: configures a web site to accept only https requests. Issues redirect for http requests (Inherited from Site) |
| HyperV |
Gets or sets hyper-V sandbox. (Inherited from Site) |
| Id |
Gets fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}" (Inherited from Resource) |
| Identity |
Gets or sets managed service identity. (Inherited from Site) |
| InProgressOperationId |
Gets specifies an operation id if this site has a pending operation. (Inherited from Site) |
| IPMode |
Gets or sets specifies the IP mode of the app. Possible values include: 'IPv4', 'IPv6', 'IPv4AndIPv6' (Inherited from Site) |
| IsDefaultContainer |
Gets <code>true</code> if the app is a default container; otherwise, <code>false</code>. (Inherited from Site) |
| IsXenon |
Gets or sets obsolete: Hyper-V sandbox. (Inherited from Site) |
| KeyVaultReferenceIdentity |
Gets or sets identity to use for Key Vault Reference authentication. (Inherited from Site) |
| Kind |
Gets or sets kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind. (Inherited from Site) |
| LastModifiedTimeUtc |
Gets last time the app was modified, in UTC. Read-only. (Inherited from Site) |
| Location |
Gets or sets the geo-location where the resource lives (Inherited from TrackedResource) |
| ManagedEnvironmentId |
Gets or sets 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} (Inherited from Site) |
| MaxNumberOfWorkers |
Gets maximum number of workers. This only applies to Functions container. (Inherited from Site) |
| Name |
Gets the name of the resource (Inherited from Resource) |
| OutboundIpAddresses |
Gets 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. (Inherited from Site) |
| OutboundVnetRouting |
Gets or sets property to configure various outbound traffic routing options over virtual network for a site (Inherited from Site) |
| PossibleOutboundIpAddresses |
Gets list of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only. (Inherited from Site) |
| PublicNetworkAccess |
Gets or sets property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string. (Inherited from Site) |
| RedundancyMode |
Gets or sets site redundancy mode Possible values include: 'None', 'Manual', 'Failover', 'ActiveActive', 'GeoRedundant' (Inherited from Site) |
| RepositorySiteName |
Gets name of the repository site. (Inherited from Site) |
| Reserved |
Gets or sets <code>true</code> if reserved; otherwise, <code>false</code>. (Inherited from Site) |
| ResourceConfig |
Gets or sets function app resource requirements. (Inherited from Site) |
| ResourceGroup |
Gets name of the resource group the app belongs to. Read-only. (Inherited from Site) |
| ScmSiteAlsoStopped |
Gets or sets <code>true</code> to stop SCM (KUDU) site when the app is stopped; otherwise, <code>false</code>. The default is <code>false</code>. (Inherited from Site) |
| ServerFarmId |
Gets or sets resource ID of the associated App Service plan, formatted as: "/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}". (Inherited from Site) |
| SiteConfig |
Gets or sets configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information. (Inherited from Site) |
| Sku |
Gets current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2 (Inherited from Site) |
| SlotSwapStatus |
Gets status of the last deployment slot swap operation. (Inherited from Site) |
| SshEnabled |
Gets or sets whether to enable ssh access. (Inherited from Site) |
| State |
Gets current state of the app. (Inherited from Site) |
| StorageAccountRequired |
Gets or sets checks if Customer provided storage account is required (Inherited from Site) |
| SuspendedTill |
Gets app suspended till in case memory-time quota is exceeded. (Inherited from Site) |
| SystemData |
Gets azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from Resource) |
| Tags |
Gets or sets resource tags. (Inherited from TrackedResource) |
| TargetSwapSlot |
Gets specifies which deployment slot this app will swap into. Read-only. (Inherited from Site) |
| TrafficManagerHostNames |
Gets azure Traffic Manager hostnames associated with the app. Read-only. (Inherited from Site) |
| Type |
Gets the type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" (Inherited from Resource) |
| UsageState |
Gets state indicating whether the app has exceeded its quota usage. Read-only. Possible values include: 'Normal', 'Exceeded' (Inherited from Site) |
| VirtualNetworkSubnetId |
Gets or sets 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} (Inherited from Site) |
| VnetInfo | |
| WorkloadProfileName |
Gets or sets workload profile name for function app to execute on. (Inherited from Site) |
Methods
| Name | Description |
|---|---|
| Validate() |
Validate the object. (Inherited from Site) |