UNPKG

@azure/arm-appservice

Version:
360 lines 23.4 kB
import type { PagedAsyncIterableIterator } from "@azure/core-paging"; import type { AppServicePlans } from "../operationsInterfaces/index.js"; import type { WebSiteManagementClient } from "../webSiteManagementClient.js"; import type { SimplePollerLike, OperationState } from "@azure/core-lro"; import type { AppServicePlan, AppServicePlansListOptionalParams, AppServicePlansListByResourceGroupOptionalParams, AppServicePlansListWebAppsByHybridConnectionOptionalParams, HybridConnection, AppServicePlansListHybridConnectionsOptionalParams, Site, AppServicePlansListWebAppsOptionalParams, CsmUsageQuota, AppServicePlansListUsagesOptionalParams, AppServicePlansGetOptionalParams, AppServicePlansGetResponse, AppServicePlansCreateOrUpdateOptionalParams, AppServicePlansCreateOrUpdateResponse, AppServicePlansDeleteOptionalParams, AppServicePlanPatchResource, AppServicePlansUpdateOptionalParams, AppServicePlansUpdateResponse, AppServicePlansListCapabilitiesOptionalParams, AppServicePlansListCapabilitiesResponse, AppServicePlansGetServerFarmRdpPasswordOptionalParams, AppServicePlansGetServerFarmRdpPasswordResponse, AppServicePlansGetHybridConnectionOptionalParams, AppServicePlansGetHybridConnectionResponse, AppServicePlansDeleteHybridConnectionOptionalParams, AppServicePlansListHybridConnectionKeysOptionalParams, AppServicePlansListHybridConnectionKeysResponse, AppServicePlansGetHybridConnectionPlanLimitOptionalParams, AppServicePlansGetHybridConnectionPlanLimitResponse, AppServicePlansGetServerFarmInstanceDetailsOptionalParams, AppServicePlansGetServerFarmInstanceDetailsResponse, AppServicePlansRestartWebAppsOptionalParams, AppServicePlansGetServerFarmSkusOptionalParams, AppServicePlansGetServerFarmSkusResponse, AppServicePlansListVnetsOptionalParams, AppServicePlansListVnetsResponse, AppServicePlansGetVnetFromServerFarmOptionalParams, AppServicePlansGetVnetFromServerFarmResponse, AppServicePlansGetVnetGatewayOptionalParams, AppServicePlansGetVnetGatewayResponse, VnetGateway, AppServicePlansUpdateVnetGatewayOptionalParams, AppServicePlansUpdateVnetGatewayResponse, AppServicePlansListRoutesForVnetOptionalParams, AppServicePlansListRoutesForVnetResponse, AppServicePlansGetRouteForVnetOptionalParams, AppServicePlansGetRouteForVnetResponse, VnetRoute, AppServicePlansCreateOrUpdateVnetRouteOptionalParams, AppServicePlansCreateOrUpdateVnetRouteResponse, AppServicePlansDeleteVnetRouteOptionalParams, AppServicePlansUpdateVnetRouteOptionalParams, AppServicePlansUpdateVnetRouteResponse, AppServicePlansRebootWorkerOptionalParams, AppServicePlansRecycleManagedInstanceWorkerOptionalParams, AppServicePlansRecycleManagedInstanceWorkerResponse } from "../models/index.js"; /** Class containing AppServicePlans operations. */ export declare class AppServicePlansImpl implements AppServicePlans { private readonly client; /** * Initialize a new instance of the class AppServicePlans class. * @param client Reference to the service client */ constructor(client: WebSiteManagementClient); /** * Description for Get all App Service plans for a subscription. * @param options The options parameters. */ list(options?: AppServicePlansListOptionalParams): PagedAsyncIterableIterator<AppServicePlan>; private listPagingPage; private listPagingAll; /** * Description for Get all App Service plans in a resource group. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param options The options parameters. */ listByResourceGroup(resourceGroupName: string, options?: AppServicePlansListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AppServicePlan>; private listByResourceGroupPagingPage; private listByResourceGroupPagingAll; /** * Description for Get all apps that use a Hybrid Connection in an App Service Plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param namespaceName Name of the Hybrid Connection namespace. * @param relayName Name of the Hybrid Connection relay. * @param options The options parameters. */ listWebAppsByHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansListWebAppsByHybridConnectionOptionalParams): PagedAsyncIterableIterator<string>; private listWebAppsByHybridConnectionPagingPage; private listWebAppsByHybridConnectionPagingAll; /** * Description for Retrieve all Hybrid Connections in use in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ listHybridConnections(resourceGroupName: string, name: string, options?: AppServicePlansListHybridConnectionsOptionalParams): PagedAsyncIterableIterator<HybridConnection>; private listHybridConnectionsPagingPage; private listHybridConnectionsPagingAll; /** * Description for Get all apps associated with an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ listWebApps(resourceGroupName: string, name: string, options?: AppServicePlansListWebAppsOptionalParams): PagedAsyncIterableIterator<Site>; private listWebAppsPagingPage; private listWebAppsPagingAll; /** * Description for Gets server farm usage information * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of App Service Plan * @param options The options parameters. */ listUsages(resourceGroupName: string, name: string, options?: AppServicePlansListUsagesOptionalParams): PagedAsyncIterableIterator<CsmUsageQuota>; private listUsagesPagingPage; private listUsagesPagingAll; /** * Description for Get all App Service plans for a subscription. * @param options The options parameters. */ private _list; /** * Description for Get all App Service plans in a resource group. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param options The options parameters. */ private _listByResourceGroup; /** * Description for Get an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ get(resourceGroupName: string, name: string, options?: AppServicePlansGetOptionalParams): Promise<AppServicePlansGetResponse>; /** * Description for Creates or updates an App Service Plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param appServicePlan Details of the App Service plan. * @param options The options parameters. */ beginCreateOrUpdate(resourceGroupName: string, name: string, appServicePlan: AppServicePlan, options?: AppServicePlansCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AppServicePlansCreateOrUpdateResponse>, AppServicePlansCreateOrUpdateResponse>>; /** * Description for Creates or updates an App Service Plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param appServicePlan Details of the App Service plan. * @param options The options parameters. */ beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, appServicePlan: AppServicePlan, options?: AppServicePlansCreateOrUpdateOptionalParams): Promise<AppServicePlansCreateOrUpdateResponse>; /** * Description for Delete an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ delete(resourceGroupName: string, name: string, options?: AppServicePlansDeleteOptionalParams): Promise<void>; /** * Description for Creates or updates an App Service Plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param appServicePlan Details of the App Service plan. * @param options The options parameters. */ update(resourceGroupName: string, name: string, appServicePlan: AppServicePlanPatchResource, options?: AppServicePlansUpdateOptionalParams): Promise<AppServicePlansUpdateResponse>; /** * Description for List all capabilities of an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ listCapabilities(resourceGroupName: string, name: string, options?: AppServicePlansListCapabilitiesOptionalParams): Promise<AppServicePlansListCapabilitiesResponse>; /** * Description for Get the RDP password for an IsCustomMode ServerFarm. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ getServerFarmRdpPassword(resourceGroupName: string, name: string, options?: AppServicePlansGetServerFarmRdpPasswordOptionalParams): Promise<AppServicePlansGetServerFarmRdpPasswordResponse>; /** * Description for Retrieve a Hybrid Connection in use in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param namespaceName Name of the Service Bus namespace. * @param relayName Name of the Service Bus relay. * @param options The options parameters. */ getHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansGetHybridConnectionOptionalParams): Promise<AppServicePlansGetHybridConnectionResponse>; /** * Description for Delete a Hybrid Connection in use in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param namespaceName Name of the Service Bus namespace. * @param relayName Name of the Service Bus relay. * @param options The options parameters. */ deleteHybridConnection(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansDeleteHybridConnectionOptionalParams): Promise<void>; /** * Description for Get the send key name and value of a Hybrid Connection. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param namespaceName The name of the Service Bus namespace. * @param relayName The name of the Service Bus relay. * @param options The options parameters. */ listHybridConnectionKeys(resourceGroupName: string, name: string, namespaceName: string, relayName: string, options?: AppServicePlansListHybridConnectionKeysOptionalParams): Promise<AppServicePlansListHybridConnectionKeysResponse>; /** * Description for Get all apps that use a Hybrid Connection in an App Service Plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param namespaceName Name of the Hybrid Connection namespace. * @param relayName Name of the Hybrid Connection relay. * @param options The options parameters. */ private _listWebAppsByHybridConnection; /** * Description for Get the maximum number of Hybrid Connections allowed in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ getHybridConnectionPlanLimit(resourceGroupName: string, name: string, options?: AppServicePlansGetHybridConnectionPlanLimitOptionalParams): Promise<AppServicePlansGetHybridConnectionPlanLimitResponse>; /** * Description for Retrieve all Hybrid Connections in use in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ private _listHybridConnections; /** * Description for Get the instance details for an app service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ getServerFarmInstanceDetails(resourceGroupName: string, name: string, options?: AppServicePlansGetServerFarmInstanceDetailsOptionalParams): Promise<AppServicePlansGetServerFarmInstanceDetailsResponse>; /** * Description for Restart all apps in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ restartWebApps(resourceGroupName: string, name: string, options?: AppServicePlansRestartWebAppsOptionalParams): Promise<void>; /** * Description for Get all apps associated with an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ private _listWebApps; /** * Description for Gets all selectable SKUs for a given App Service Plan * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of App Service Plan * @param options The options parameters. */ getServerFarmSkus(resourceGroupName: string, name: string, options?: AppServicePlansGetServerFarmSkusOptionalParams): Promise<AppServicePlansGetServerFarmSkusResponse>; /** * Description for Gets server farm usage information * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of App Service Plan * @param options The options parameters. */ private _listUsages; /** * Description for Get all Virtual Networks associated with an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param options The options parameters. */ listVnets(resourceGroupName: string, name: string, options?: AppServicePlansListVnetsOptionalParams): Promise<AppServicePlansListVnetsResponse>; /** * Description for Get a Virtual Network associated with an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param options The options parameters. */ getVnetFromServerFarm(resourceGroupName: string, name: string, vnetName: string, options?: AppServicePlansGetVnetFromServerFarmOptionalParams): Promise<AppServicePlansGetVnetFromServerFarmResponse>; /** * Description for Get a Virtual Network gateway. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param gatewayName Name of the gateway. Only the 'primary' gateway is supported. * @param options The options parameters. */ getVnetGateway(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, options?: AppServicePlansGetVnetGatewayOptionalParams): Promise<AppServicePlansGetVnetGatewayResponse>; /** * Description for Update a Virtual Network gateway. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param gatewayName Name of the gateway. Only the 'primary' gateway is supported. * @param connectionEnvelope Definition of the gateway. * @param options The options parameters. */ updateVnetGateway(resourceGroupName: string, name: string, vnetName: string, gatewayName: string, connectionEnvelope: VnetGateway, options?: AppServicePlansUpdateVnetGatewayOptionalParams): Promise<AppServicePlansUpdateVnetGatewayResponse>; /** * Description for Get all routes that are associated with a Virtual Network in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param options The options parameters. */ listRoutesForVnet(resourceGroupName: string, name: string, vnetName: string, options?: AppServicePlansListRoutesForVnetOptionalParams): Promise<AppServicePlansListRoutesForVnetResponse>; /** * Description for Get a Virtual Network route in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param routeName Name of the Virtual Network route. * @param options The options parameters. */ getRouteForVnet(resourceGroupName: string, name: string, vnetName: string, routeName: string, options?: AppServicePlansGetRouteForVnetOptionalParams): Promise<AppServicePlansGetRouteForVnetResponse>; /** * Description for Create or update a Virtual Network route in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param routeName Name of the Virtual Network route. * @param route Definition of the Virtual Network route. * @param options The options parameters. */ createOrUpdateVnetRoute(resourceGroupName: string, name: string, vnetName: string, routeName: string, route: VnetRoute, options?: AppServicePlansCreateOrUpdateVnetRouteOptionalParams): Promise<AppServicePlansCreateOrUpdateVnetRouteResponse>; /** * Description for Delete a Virtual Network route in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param routeName Name of the Virtual Network route. * @param options The options parameters. */ deleteVnetRoute(resourceGroupName: string, name: string, vnetName: string, routeName: string, options?: AppServicePlansDeleteVnetRouteOptionalParams): Promise<void>; /** * Description for Create or update a Virtual Network route in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param vnetName Name of the Virtual Network. * @param routeName Name of the Virtual Network route. * @param route Definition of the Virtual Network route. * @param options The options parameters. */ updateVnetRoute(resourceGroupName: string, name: string, vnetName: string, routeName: string, route: VnetRoute, options?: AppServicePlansUpdateVnetRouteOptionalParams): Promise<AppServicePlansUpdateVnetRouteResponse>; /** * Description for Reboot a worker machine in an App Service plan. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param workerName Name of worker machine, which typically starts with RD. * @param options The options parameters. */ rebootWorker(resourceGroupName: string, name: string, workerName: string, options?: AppServicePlansRebootWorkerOptionalParams): Promise<void>; /** * Description for Recycles a managed instance worker machine. * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param workerName Name of worker machine. * @param options The options parameters. */ recycleManagedInstanceWorker(resourceGroupName: string, name: string, workerName: string, options?: AppServicePlansRecycleManagedInstanceWorkerOptionalParams): Promise<AppServicePlansRecycleManagedInstanceWorkerResponse>; /** * ListNext * @param nextLink The nextLink from the previous successful call to the List method. * @param options The options parameters. */ private _listNext; /** * ListByResourceGroupNext * @param resourceGroupName Name of the resource group to which the resource belongs. * @param nextLink The nextLink from the previous successful call to the ListByResourceGroup method. * @param options The options parameters. */ private _listByResourceGroupNext; /** * ListWebAppsByHybridConnectionNext * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param namespaceName Name of the Hybrid Connection namespace. * @param relayName Name of the Hybrid Connection relay. * @param nextLink The nextLink from the previous successful call to the ListWebAppsByHybridConnection * method. * @param options The options parameters. */ private _listWebAppsByHybridConnectionNext; /** * ListHybridConnectionsNext * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param nextLink The nextLink from the previous successful call to the ListHybridConnections method. * @param options The options parameters. */ private _listHybridConnectionsNext; /** * ListWebAppsNext * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of the App Service plan. * @param nextLink The nextLink from the previous successful call to the ListWebApps method. * @param options The options parameters. */ private _listWebAppsNext; /** * ListUsagesNext * @param resourceGroupName Name of the resource group to which the resource belongs. * @param name Name of App Service Plan * @param nextLink The nextLink from the previous successful call to the ListUsages method. * @param options The options parameters. */ private _listUsagesNext; } //# sourceMappingURL=appServicePlans.d.ts.map