AppServicePlanResource Class

Definition

Namespace:: Azure.ResourceManager.AppService

Assembly:: Azure.ResourceManager.AppService.dll

Package:: Azure.ResourceManager.AppService v1.5.0

Package:: Azure.ResourceManager.AppService v1.3.0-beta.2

Source:: AppServicePlanResource.cs

Source:: AppServicePlanResource.cs

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 Class representing an AppServicePlan along with the instance operations that can be performed on it. If you have a ResourceIdentifier you can construct an AppServicePlanResource from an instance of ArmClient using the GetAppServicePlanResource method. Otherwise you can get one from its parent resource ResourceGroupResource using the GetAppServicePlan method.

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

type AppServicePlanResource = class
    inherit ArmResource
    interface IJsonModel<AppServicePlanData>
    interface IPersistableModel<AppServicePlanData>

Public Class AppServicePlanResource
Inherits ArmResource
Implements IJsonModel(Of AppServicePlanData), IPersistableModel(Of AppServicePlanData)

Inheritance: Object

ArmResource
AppServicePlanResource

Implements: IJsonModel<AppServicePlanData> IPersistableModel<AppServicePlanData> IPersistableModel<T>

Constructors

Name	Description
AppServicePlanResource()	Initializes a new instance of the AppServicePlanResource class for mocking.

Fields

Name	Description
ResourceType	Gets the resource type for the operations.

Properties

Name	Description
Client	Gets the ArmClient this resource client was created from. (Inherited from ArmResource)
Data	Gets the data representing this Feature.
Diagnostics	Gets the diagnostic options for this resource client. (Inherited from ArmResource)
Endpoint	Gets the base uri for this resource client. (Inherited from ArmResource)
HasData	Gets whether or not the current instance has data.
Id	Gets the resource identifier. (Inherited from ArmResource)
Pipeline	Gets the pipeline for this resource client. (Inherited from ArmResource)

Methods

Name	Description
CanUseTagResource(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CanUseTagResourceAsync(CancellationToken)	Checks to see if the TagResource API is deployed in the current environment. (Inherited from ArmResource)
CreateResourceIdentifier(String, String, String)	Generate the resource identifier of a AppServicePlanResource instance.
Delete(WaitUntil, CancellationToken)	Description for Delete an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} Operation Id: AppServicePlans_Delete Default Api Version: 2025-05-01 Resource: AppServicePlanResource
DeleteAsync(WaitUntil, CancellationToken)	Description for Delete an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} Operation Id: AppServicePlans_Delete Default Api Version: 2025-05-01 Resource: AppServicePlanResource
Get(CancellationToken)	Description for Get an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} Operation Id: AppServicePlans_Get Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetAppServicePlanHybridConnectionNamespaceRelay(String, String, CancellationToken)	Description for Retrieve a Hybrid Connection in use in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} Operation Id: AppServicePlans_GetHybridConnection Default Api Version: 2025-05-01 Resource: AppServicePlanHybridConnectionNamespaceRelayResource
GetAppServicePlanHybridConnectionNamespaceRelayAsync(String, String, CancellationToken)	Description for Retrieve a Hybrid Connection in use in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName} Operation Id: AppServicePlans_GetHybridConnection Default Api Version: 2025-05-01 Resource: AppServicePlanHybridConnectionNamespaceRelayResource
GetAppServicePlanHybridConnectionNamespaceRelays()	Gets a collection of AppServicePlanHybridConnectionNamespaceRelayResources in the AppServicePlan.
GetAppServicePlanVirtualNetworkConnection(String, CancellationToken)	Description for Get a Virtual Network associated with an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName} Operation Id: AppServicePlans_GetVnetFromServerFarm Default Api Version: 2025-05-01 Resource: AppServicePlanVirtualNetworkConnectionResource
GetAppServicePlanVirtualNetworkConnectionAsync(String, CancellationToken)	Description for Get a Virtual Network associated with an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName} Operation Id: AppServicePlans_GetVnetFromServerFarm Default Api Version: 2025-05-01 Resource: AppServicePlanVirtualNetworkConnectionResource
GetAppServicePlanVirtualNetworkConnections()	Gets a collection of AppServicePlanVirtualNetworkConnectionResources in the AppServicePlan.
GetAsync(CancellationToken)	Description for Get an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} Operation Id: AppServicePlans_Get Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetAvailableLocations(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetAvailableLocationsAsync(CancellationToken)	Lists all available geo-locations. (Inherited from ArmResource)
GetCapabilities(CancellationToken)	Description for List all capabilities of an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities Operation Id: AppServicePlans_ListCapabilities Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetCapabilitiesAsync(CancellationToken)	Description for List all capabilities of an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities Operation Id: AppServicePlans_ListCapabilities Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetHybridConnectionLimit()	Gets an object representing a HybridConnectionLimitResource along with the instance operations that can be performed on it in the AppServicePlan.
GetHybridConnectionRelays(CancellationToken)	Description for Retrieve all Hybrid Connections in use in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays Operation Id: AppServicePlans_ListHybridConnections Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetHybridConnectionRelaysAsync(CancellationToken)	Description for Retrieve all Hybrid Connections in use in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays Operation Id: AppServicePlans_ListHybridConnections Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetManagementLock(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLockAsync(String, CancellationToken)	Get a management lock by scope. Request Path: /{scope}/providers/Microsoft.Authorization/locks/{lockName} Operation Id: ManagementLocks_GetByScope Default Api Version: 2020-05-01 Resource: ManagementLockResource (Inherited from ArmResource)
GetManagementLocks()	Gets a collection of ManagementLockResources in the ArmResource. (Inherited from ArmResource)
GetPolicyAssignment(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignmentAsync(String, CancellationToken)	This operation retrieves a single policy assignment, given its name and the scope it was created at. Request Path: /{scope}/providers/Microsoft.Authorization/policyAssignments/{policyAssignmentName} Operation Id: PolicyAssignments_Get Default Api Version: 2022-06-01 Resource: PolicyAssignmentResource (Inherited from ArmResource)
GetPolicyAssignments()	Gets a collection of PolicyAssignmentResources in the ArmResource. (Inherited from ArmResource)
GetServerFarmInstanceDetails(CancellationToken)	Description for Get the instance details for an app service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances Operation Id: AppServicePlans_GetServerFarmInstanceDetails Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetServerFarmInstanceDetailsAsync(CancellationToken)	Description for Get the instance details for an app service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances Operation Id: AppServicePlans_GetServerFarmInstanceDetails Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetServerFarmRdpPassword(CancellationToken)	Description for Get the RDP password for an IsCustomMode ServerFarm. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword Operation Id: AppServicePlans_GetServerFarmRdpPassword Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetServerFarmRdpPasswordAsync(CancellationToken)	Description for Get the RDP password for an IsCustomMode ServerFarm. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword Operation Id: AppServicePlans_GetServerFarmRdpPassword Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetServerFarmSkus(CancellationToken)	Description for Gets all selectable SKUs for a given App Service Plan Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus Operation Id: AppServicePlans_GetServerFarmSkus Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetServerFarmSkusAsync(CancellationToken)	Description for Gets all selectable SKUs for a given App Service Plan Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus Operation Id: AppServicePlans_GetServerFarmSkus Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetTagResource()	Gets an object representing a TagResource along with the instance operations that can be performed on it in the ArmResource. (Inherited from ArmResource)
GetUsages(String, CancellationToken)	Description for Gets server farm usage information Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages Operation Id: AppServicePlans_ListUsages Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetUsagesAsync(String, CancellationToken)	Description for Gets server farm usage information Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages Operation Id: AppServicePlans_ListUsages Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetWebApps(String, String, String, CancellationToken)	Description for Get all apps associated with an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites Operation Id: AppServicePlans_ListWebApps Default Api Version: 2025-05-01 Resource: AppServicePlanResource
GetWebAppsAsync(String, String, String, CancellationToken)	Description for Get all apps associated with an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites Operation Id: AppServicePlans_ListWebApps Default Api Version: 2025-05-01 Resource: AppServicePlanResource
RebootWorker(String, CancellationToken)	Description for Reboot a worker machine in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot Operation Id: AppServicePlans_RebootWorker Default Api Version: 2025-05-01
RebootWorkerAsync(String, CancellationToken)	Description for Reboot a worker machine in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot Operation Id: AppServicePlans_RebootWorker Default Api Version: 2025-05-01
RecycleManagedInstanceWorker(String, CancellationToken)	Description for Recycles a managed instance worker machine. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance Operation Id: AppServicePlans_RecycleManagedInstanceWorker Default Api Version: 2025-05-01
RecycleManagedInstanceWorkerAsync(String, CancellationToken)	Description for Recycles a managed instance worker machine. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance Operation Id: AppServicePlans_RecycleManagedInstanceWorker Default Api Version: 2025-05-01
RestartWebApps(Nullable<Boolean>, CancellationToken)	Description for Restart all apps in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites Operation Id: AppServicePlans_RestartWebApps Default Api Version: 2025-05-01 Resource: AppServicePlanResource
RestartWebAppsAsync(Nullable<Boolean>, CancellationToken)	Description for Restart all apps in an App Service plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites Operation Id: AppServicePlans_RestartWebApps Default Api Version: 2025-05-01 Resource: AppServicePlanResource
TryGetApiVersion(ResourceType, String)	Gets the api version override if it has been set for the current client options. (Inherited from ArmResource)
Update(AppServicePlanPatch, CancellationToken)	Description for Creates or updates an App Service Plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} Operation Id: AppServicePlans_Update Default Api Version: 2025-05-01 Resource: AppServicePlanResource
UpdateAsync(AppServicePlanPatch, CancellationToken)	Description for Creates or updates an App Service Plan. Request Path: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name} Operation Id: AppServicePlans_Update Default Api Version: 2025-05-01 Resource: AppServicePlanResource

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.

Extension Methods

Name	Description
GetAuthorizationRoleDefinition(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitionAsync(ArmResource, ResourceIdentifier, CancellationToken)	Gets the role definition identified by `roleDefinitionId` at this resource scope.
GetAuthorizationRoleDefinitions(ArmResource)	Gets a collection of AuthorizationRoleDefinitionCollection objects within the specified scope.
GetDenyAssignment(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified deny assignment.
GetDenyAssignments(ArmResource)	Gets a collection of DenyAssignmentCollection objects within the specified scope.
GetLinkerResource(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResource(String, CancellationToken) instead.</item>
GetLinkerResourceAsync(ArmResource, String, CancellationToken)	Returns Linker resource for a given name. Request Path: /{resourceUri}/providers/Microsoft.ServiceLinker/linkers/{linkerName} Operation Id: Linker_Get Default Api Version: 2022-05-01 Resource: LinkerResource <item>MockingTo mock this method, please mock GetLinkerResourceAsync(String, CancellationToken) instead.</item>
GetLinkerResources(ArmResource)	Gets a collection of LinkerResources in the ArmResource. <item>MockingTo mock this method, please mock GetLinkerResources() instead.</item>
GetRoleAssignment(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignmentAsync(ArmResource, String, String, CancellationToken)	Get a role assignment by scope and name.
GetRoleAssignments(ArmResource)	Gets a collection of RoleAssignmentCollection objects within the specified scope.
GetRoleAssignmentSchedule(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule for a resource scope.
GetRoleAssignmentScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role assignment schedule instance.
GetRoleAssignmentScheduleInstances(ArmResource)	Gets a collection of RoleAssignmentScheduleInstanceCollection objects within the specified scope.
GetRoleAssignmentScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role assignment schedule request.
GetRoleAssignmentScheduleRequests(ArmResource)	Gets a collection of RoleAssignmentScheduleRequestCollection objects within the specified scope.
GetRoleAssignmentSchedules(ArmResource)	Gets a collection of RoleAssignmentScheduleCollection objects within the specified scope.
GetRoleEligibilitySchedule(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule for a resource scope.
GetRoleEligibilityScheduleInstance(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstanceAsync(ArmResource, String, CancellationToken)	Gets the specified role eligibility schedule instance.
GetRoleEligibilityScheduleInstances(ArmResource)	Gets a collection of RoleEligibilityScheduleInstanceCollection objects within the specified scope.
GetRoleEligibilityScheduleRequest(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequestAsync(ArmResource, String, CancellationToken)	Get the specified role eligibility schedule request.
GetRoleEligibilityScheduleRequests(ArmResource)	Gets a collection of RoleEligibilityScheduleRequestCollection objects within the specified scope.
GetRoleEligibilitySchedules(ArmResource)	Gets a collection of RoleEligibilityScheduleCollection objects within the specified scope.
GetRoleManagementPolicies(ArmResource)	Gets a collection of RoleManagementPolicyCollection objects within the specified scope.
GetRoleManagementPolicy(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetRoleManagementPolicyAssignment(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignmentAsync(ArmResource, String, CancellationToken)	Get the specified role management policy assignment for a resource scope.
GetRoleManagementPolicyAssignments(ArmResource)	Gets a collection of RoleManagementPolicyAssignmentCollection objects within the specified scope.
GetRoleManagementPolicyAsync(ArmResource, String, CancellationToken)	Get the specified role management policy for a resource scope.
GetSystemAssignedIdentity(ArmResource)	Gets an object representing a SystemAssignedIdentityResource along with the instance operations that can be performed on it in the ArmResource scope.

Applies to

Feedback

Was this page helpful?