AppServicePlanData Class

Definition

Namespace:

Azure.ResourceManager.AppService

Assembly:

Azure.ResourceManager.AppService.dll

Package:

Azure.ResourceManager.AppService v1.5.0

Source:

AppServicePlanData.cs

A class representing the AppServicePlan data model. App Service plan. Serialized Name: AppServicePlan

public class AppServicePlanData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.AppService.AppServicePlanData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.AppService.AppServicePlanData>

type AppServicePlanData = class
    inherit TrackedResourceData
    interface IJsonModel<AppServicePlanData>
    interface IPersistableModel<AppServicePlanData>

Public Class AppServicePlanData
Inherits TrackedResourceData
Implements IJsonModel(Of AppServicePlanData), IPersistableModel(Of AppServicePlanData)

Inheritance

Object

ResourceData

TrackedResourceData

AppServicePlanData

Implements

IJsonModel<AppServicePlanData> IPersistableModel<AppServicePlanData> IPersistableModel<T>

Constructors

Name	Description
AppServicePlanData(AzureLocation)	Initializes a new instance of AppServicePlanData.

Properties

Name	Description
ExtendedLocation	Extended Location. Serialized Name: AppServicePlan.extendedLocation
FreeOfferExpireOn	The time when the server farm free offer expires. Serialized Name: AppServicePlan.properties.freeOfferExpirationTime
GeoRegion	Geographical location for the App Service plan. Serialized Name: AppServicePlan.properties.geoRegion
HostingEnvironmentProfile	Specification for the App Service Environment to use for the App Service plan. Serialized Name: AppServicePlan.properties.hostingEnvironmentProfile
Id	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData)
Identity	Managed service identity. Serialized Name: AppServicePlan.identity
InstallScripts	Install scripts associated with this App Service plan. Serialized Name: AppServicePlan.properties.installScripts
IsAsyncScalingEnabled	If <code>true</code>, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously. If <code>false</code>, this App Service Plan will only attempt sync scaling. Serialized Name: AppServicePlan.properties.asyncScalingEnabled
IsCustomMode	Whether this server farm is in custom mode. Serialized Name: AppServicePlan.properties.isCustomMode
IsElasticScaleEnabled	ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku Serialized Name: AppServicePlan.properties.elasticScaleEnabled
IsHyperV	If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. Serialized Name: AppServicePlan.properties.hyperV
IsPerSiteScaling	If <code>true</code>, apps assigned to this App Service plan can be scaled independently. If <code>false</code>, apps assigned to this App Service plan will scale to all instances of the plan. Serialized Name: AppServicePlan.properties.perSiteScaling
IsReserved	If Linux app service plan <code>true</code>, <code>false</code> otherwise. Serialized Name: AppServicePlan.properties.reserved
IsSpot	If <code>true</code>, this App Service Plan owns spot instances. Serialized Name: AppServicePlan.properties.isSpot
IsXenon	Obsolete: If Hyper-V container app service plan <code>true</code>, <code>false</code> otherwise. Serialized Name: AppServicePlan.properties.isXenon
IsZoneRedundant	If <code>true</code>, this App Service Plan will perform availability zone balancing. If <code>false</code>, this App Service Plan will not perform availability zone balancing. Serialized Name: AppServicePlan.properties.zoneRedundant
Kind	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. Serialized Name: AppServicePlan.kind
KubeEnvironmentProfile	Specification for the Kubernetes Environment to use for the App Service plan. Serialized Name: AppServicePlan.properties.kubeEnvironmentProfile
Location	The geo-location where the resource lives. (Inherited from TrackedResourceData)
MaximumElasticWorkerCount	Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan Serialized Name: AppServicePlan.properties.maximumElasticWorkerCount
MaximumNumberOfWorkers	Maximum number of instances that can be assigned to this App Service plan. Serialized Name: AppServicePlan.properties.maximumNumberOfWorkers
Name	The name of the resource. (Inherited from ResourceData)
NumberOfSites	Number of apps assigned to this App Service plan. Serialized Name: AppServicePlan.properties.numberOfSites
NumberOfWorkers	The number of instances that are assigned to this App Service plan. Serialized Name: AppServicePlan.properties.numberOfWorkers
PlanDefaultIdentity	Identity to use by platform for various features and integrations using managed identity. Serialized Name: AppServicePlan.properties.planDefaultIdentity
ProvisioningState	Provisioning state of the App Service Plan. Serialized Name: AppServicePlan.properties.provisioningState
RdpEnabled	If <code>true</code>, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs. If <code>false</code>, RDP access is disabled. Serialized Name: AppServicePlan.properties.rdpEnabled
RegistryAdapters	Registry adapters associated with this App Service plan. Serialized Name: AppServicePlan.properties.registryAdapters
ResourceGroup	Resource group of the App Service plan. Serialized Name: AppServicePlan.properties.resourceGroup
ResourceType	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData)
Sku	Description of a SKU for a scalable resource. Serialized Name: AppServicePlan.sku
SpotExpireOn	The time when the server farm expires. Valid only if it is a spot server farm. Serialized Name: AppServicePlan.properties.spotExpirationTime
Status	App Service plan status. Serialized Name: AppServicePlan.properties.status
StorageMounts	Storage mounts associated with this App Service plan. Serialized Name: AppServicePlan.properties.storageMounts
Subscription	App Service plan subscription. Serialized Name: AppServicePlan.properties.subscription
SystemData	Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData)
Tags	Resource tags. (Inherited from TrackedResourceData)
TargetWorkerCount	Scaling worker count. Serialized Name: AppServicePlan.properties.targetWorkerCount
TargetWorkerSizeId	Scaling worker size ID. Serialized Name: AppServicePlan.properties.targetWorkerSizeId
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} Serialized Name: ServerFarmNetworkSettings.virtualNetworkSubnetId
WorkerTierName	Target worker tier assigned to the App Service plan. Serialized Name: AppServicePlan.properties.workerTierName

Methods

Name	Description
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<AppServicePlanData>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AppServicePlanData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AppServicePlanData>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AppServicePlanData>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AppServicePlanData>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.