AppServicePlans interface
Interface representing a AppServicePlans.
Methods
Method Details
beginCreateOrUpdate(string, string, AppServicePlan, AppServicePlansCreateOrUpdateOptionalParams)
Creates or updates an App Service Plan.
function beginCreateOrUpdate(resourceGroupName: string, name: string, appServicePlan: AppServicePlan, options?: AppServicePlansCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<AppServicePlan>, AppServicePlan>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- appServicePlan
- AppServicePlan
Details of the App Service plan.
The options parameters.
Returns
Promise<PollerLike<@azure/core-lro.PollOperationState<AppServicePlan>, AppServicePlan>>
beginCreateOrUpdateAndWait(string, string, AppServicePlan, AppServicePlansCreateOrUpdateOptionalParams)
Creates or updates an App Service Plan.
function beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, appServicePlan: AppServicePlan, options?: AppServicePlansCreateOrUpdateOptionalParams): Promise<AppServicePlan>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- appServicePlan
- AppServicePlan
Details of the App Service plan.
The options parameters.
Returns
Promise<AppServicePlan>
createOrUpdateVnetRoute(string, string, string, string, VnetRoute, AppServicePlansCreateOrUpdateVnetRouteOptionalParams)
Create or update a Virtual Network route in an App Service plan.
function createOrUpdateVnetRoute(resourceGroupName: string, name: string, vnetName: string, routeName: string, route: VnetRoute, options?: AppServicePlansCreateOrUpdateVnetRouteOptionalParams): Promise<VnetRoute>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
- routeName
-
string
Name of the Virtual Network route.
- route
- VnetRoute
Definition of the Virtual Network route.
The options parameters.
Returns
Promise<VnetRoute>
delete(string, string, AppServicePlansDeleteOptionalParams)
Delete an App Service plan.
function delete(resourceGroupName: string, name: string, options?: AppServicePlansDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
Promise<void>
deleteHybridConnection(string, string, string, string, AppServicePlansDeleteHybridConnectionOptionalParams)
Delete a Hybrid Connection in use in an App Service plan.
function deleteHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansDeleteHybridConnectionOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- namespaceName
-
string
Name of the Service Bus namespace.
- relayName
-
string
Name of the Service Bus relay.
The options parameters.
Returns
Promise<void>
deleteVnetRoute(string, string, string, string, AppServicePlansDeleteVnetRouteOptionalParams)
Delete a Virtual Network route in an App Service plan.
function deleteVnetRoute(resourceGroupName: string, name: string, vnetName: string, routeName: string, options?: AppServicePlansDeleteVnetRouteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
- routeName
-
string
Name of the Virtual Network route.
The options parameters.
Returns
Promise<void>
get(string, string, AppServicePlansGetOptionalParams)
Get an App Service plan.
function get(resourceGroupName: string, name: string, options?: AppServicePlansGetOptionalParams): Promise<AppServicePlan>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- options
- AppServicePlansGetOptionalParams
The options parameters.
Returns
Promise<AppServicePlan>
getHybridConnection(string, string, string, string, AppServicePlansGetHybridConnectionOptionalParams)
Retrieve a Hybrid Connection in use in an App Service plan.
function getHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansGetHybridConnectionOptionalParams): Promise<HybridConnection>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- namespaceName
-
string
Name of the Service Bus namespace.
- relayName
-
string
Name of the Service Bus relay.
The options parameters.
Returns
Promise<HybridConnection>
getHybridConnectionPlanLimit(string, string, AppServicePlansGetHybridConnectionPlanLimitOptionalParams)
Get the maximum number of Hybrid Connections allowed in an App Service plan.
function getHybridConnectionPlanLimit(resourceGroupName: string, name: string, options?: AppServicePlansGetHybridConnectionPlanLimitOptionalParams): Promise<HybridConnectionLimits>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
Promise<HybridConnectionLimits>
getRouteForVnet(string, string, string, string, AppServicePlansGetRouteForVnetOptionalParams)
Get a Virtual Network route in an App Service plan.
function getRouteForVnet(resourceGroupName: string, name: string, vnetName: string, routeName: string, options?: AppServicePlansGetRouteForVnetOptionalParams): Promise<AppServicePlansGetRouteForVnetResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
- routeName
-
string
Name of the Virtual Network route.
The options parameters.
Returns
getServerFarmSkus(string, string, AppServicePlansGetServerFarmSkusOptionalParams)
Gets all selectable SKUs for a given App Service Plan
function getServerFarmSkus(resourceGroupName: string, name: string, options?: AppServicePlansGetServerFarmSkusOptionalParams): Promise<AppServicePlansGetServerFarmSkusResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of App Service Plan
The options parameters.
Returns
getVnetFromServerFarm(string, string, string, AppServicePlansGetVnetFromServerFarmOptionalParams)
Get a Virtual Network associated with an App Service plan.
function getVnetFromServerFarm(resourceGroupName: string, name: string, vnetName: string, options?: AppServicePlansGetVnetFromServerFarmOptionalParams): Promise<VnetInfo>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
The options parameters.
Returns
Promise<VnetInfo>
getVnetGateway(string, string, string, string, AppServicePlansGetVnetGatewayOptionalParams)
Get a Virtual Network gateway.
function getVnetGateway(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, options?: AppServicePlansGetVnetGatewayOptionalParams): Promise<VnetGateway>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
- gatewayName
-
string
Name of the gateway. Only the 'primary' gateway is supported.
The options parameters.
Returns
Promise<VnetGateway>
list(AppServicePlansListOptionalParams)
Get all App Service plans for a subscription.
function list(options?: AppServicePlansListOptionalParams): PagedAsyncIterableIterator<AppServicePlan, AppServicePlan[], PageSettings>Parameters
The options parameters.
Returns
listByResourceGroup(string, AppServicePlansListByResourceGroupOptionalParams)
Get all App Service plans in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: AppServicePlansListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AppServicePlan, AppServicePlan[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The options parameters.
Returns
listCapabilities(string, string, AppServicePlansListCapabilitiesOptionalParams)
List all capabilities of an App Service plan.
function listCapabilities(resourceGroupName: string, name: string, options?: AppServicePlansListCapabilitiesOptionalParams): Promise<AppServicePlansListCapabilitiesResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
listHybridConnectionKeys(string, string, string, string, AppServicePlansListHybridConnectionKeysOptionalParams)
Get the send key name and value of a Hybrid Connection.
function listHybridConnectionKeys(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansListHybridConnectionKeysOptionalParams): Promise<HybridConnectionKey>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- namespaceName
-
string
The name of the Service Bus namespace.
- relayName
-
string
The name of the Service Bus relay.
The options parameters.
Returns
Promise<HybridConnectionKey>
listHybridConnections(string, string, AppServicePlansListHybridConnectionsOptionalParams)
Retrieve all Hybrid Connections in use in an App Service plan.
function listHybridConnections(resourceGroupName: string, name: string, options?: AppServicePlansListHybridConnectionsOptionalParams): PagedAsyncIterableIterator<HybridConnection, HybridConnection[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
listMetricDefintions(string, string, AppServicePlansListMetricDefintionsOptionalParams)
Get metrics that can be queried for an App Service plan, and their definitions.
function listMetricDefintions(resourceGroupName: string, name: string, options?: AppServicePlansListMetricDefintionsOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
listMetrics(string, string, AppServicePlansListMetricsOptionalParams)
Get metrics for an App Service plan.
function listMetrics(resourceGroupName: string, name: string, options?: AppServicePlansListMetricsOptionalParams): PagedAsyncIterableIterator<ResourceMetric, ResourceMetric[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
listRoutesForVnet(string, string, string, AppServicePlansListRoutesForVnetOptionalParams)
Get all routes that are associated with a Virtual Network in an App Service plan.
function listRoutesForVnet(resourceGroupName: string, name: string, vnetName: string, options?: AppServicePlansListRoutesForVnetOptionalParams): Promise<AppServicePlansListRoutesForVnetResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
The options parameters.
Returns
listUsages(string, string, AppServicePlansListUsagesOptionalParams)
Gets server farm usage information
function listUsages(resourceGroupName: string, name: string, options?: AppServicePlansListUsagesOptionalParams): PagedAsyncIterableIterator<CsmUsageQuota, CsmUsageQuota[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of App Service Plan
The options parameters.
Returns
listVnets(string, string, AppServicePlansListVnetsOptionalParams)
Get all Virtual Networks associated with an App Service plan.
function listVnets(resourceGroupName: string, name: string, options?: AppServicePlansListVnetsOptionalParams): Promise<AppServicePlansListVnetsResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
Promise<AppServicePlansListVnetsResponse>
listWebApps(string, string, AppServicePlansListWebAppsOptionalParams)
Get all apps associated with an App Service plan.
function listWebApps(resourceGroupName: string, name: string, options?: AppServicePlansListWebAppsOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
listWebAppsByHybridConnection(string, string, string, string, AppServicePlansListWebAppsByHybridConnectionOptionalParams)
Get all apps that use a Hybrid Connection in an App Service Plan.
function listWebAppsByHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansListWebAppsByHybridConnectionOptionalParams): PagedAsyncIterableIterator<string, string[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- namespaceName
-
string
Name of the Hybrid Connection namespace.
- relayName
-
string
Name of the Hybrid Connection relay.
The options parameters.
Returns
PagedAsyncIterableIterator<string, string[], PageSettings>
rebootWorker(string, string, string, AppServicePlansRebootWorkerOptionalParams)
Reboot a worker machine in an App Service plan.
function rebootWorker(resourceGroupName: string, name: string, workerName: string, options?: AppServicePlansRebootWorkerOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- workerName
-
string
Name of worker machine, which typically starts with RD.
The options parameters.
Returns
Promise<void>
restartWebApps(string, string, AppServicePlansRestartWebAppsOptionalParams)
Restart all apps in an App Service plan.
function restartWebApps(resourceGroupName: string, name: string, options?: AppServicePlansRestartWebAppsOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
The options parameters.
Returns
Promise<void>
update(string, string, AppServicePlanPatchResource, AppServicePlansUpdateOptionalParams)
Creates or updates an App Service Plan.
function update(resourceGroupName: string, name: string, appServicePlan: AppServicePlanPatchResource, options?: AppServicePlansUpdateOptionalParams): Promise<AppServicePlan>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- appServicePlan
- AppServicePlanPatchResource
Details of the App Service plan.
The options parameters.
Returns
Promise<AppServicePlan>
updateVnetGateway(string, string, string, string, VnetGateway, AppServicePlansUpdateVnetGatewayOptionalParams)
Update a Virtual Network gateway.
function updateVnetGateway(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, connectionEnvelope: VnetGateway, options?: AppServicePlansUpdateVnetGatewayOptionalParams): Promise<VnetGateway>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
- gatewayName
-
string
Name of the gateway. Only the 'primary' gateway is supported.
- connectionEnvelope
- VnetGateway
Definition of the gateway.
The options parameters.
Returns
Promise<VnetGateway>
updateVnetRoute(string, string, string, string, VnetRoute, AppServicePlansUpdateVnetRouteOptionalParams)
Create or update a Virtual Network route in an App Service plan.
function updateVnetRoute(resourceGroupName: string, name: string, vnetName: string, routeName: string, route: VnetRoute, options?: AppServicePlansUpdateVnetRouteOptionalParams): Promise<VnetRoute>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service plan.
- vnetName
-
string
Name of the Virtual Network.
- routeName
-
string
Name of the Virtual Network route.
- route
- VnetRoute
Definition of the Virtual Network route.
The options parameters.
Returns
Promise<VnetRoute>