AppServiceEnvironments interface
Interface representing a AppServiceEnvironments.
Methods
Method Details
beginApproveOrRejectPrivateEndpointConnection(string, string, string, RemotePrivateEndpointConnectionARMResource, AppServiceEnvironmentsApproveOrRejectPrivateEndpointConnectionOptionalParams)
Description for Approves or rejects a private endpoint connection
function beginApproveOrRejectPrivateEndpointConnection(resourceGroupName: string, name: string, privateEndpointConnectionName: string, privateEndpointWrapper: RemotePrivateEndpointConnectionARMResource, options?: AppServiceEnvironmentsApproveOrRejectPrivateEndpointConnectionOptionalParams): Promise<SimplePollerLike<OperationState<RemotePrivateEndpointConnectionARMResource>, RemotePrivateEndpointConnectionARMResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- privateEndpointConnectionName
-
string
- privateEndpointWrapper
- RemotePrivateEndpointConnectionARMResource
Remote Private Endpoint Connection ARM resource.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<RemotePrivateEndpointConnectionARMResource>, RemotePrivateEndpointConnectionARMResource>>
beginApproveOrRejectPrivateEndpointConnectionAndWait(string, string, string, RemotePrivateEndpointConnectionARMResource, AppServiceEnvironmentsApproveOrRejectPrivateEndpointConnectionOptionalParams)
Description for Approves or rejects a private endpoint connection
function beginApproveOrRejectPrivateEndpointConnectionAndWait(resourceGroupName: string, name: string, privateEndpointConnectionName: string, privateEndpointWrapper: RemotePrivateEndpointConnectionARMResource, options?: AppServiceEnvironmentsApproveOrRejectPrivateEndpointConnectionOptionalParams): Promise<RemotePrivateEndpointConnectionARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- privateEndpointConnectionName
-
string
- privateEndpointWrapper
- RemotePrivateEndpointConnectionARMResource
Remote Private Endpoint Connection ARM resource.
The options parameters.
Returns
beginCreateOrUpdate(string, string, AppServiceEnvironmentResource, AppServiceEnvironmentsCreateOrUpdateOptionalParams)
Description for Create or update an App Service Environment.
function beginCreateOrUpdate(resourceGroupName: string, name: string, hostingEnvironmentEnvelope: AppServiceEnvironmentResource, options?: AppServiceEnvironmentsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<AppServiceEnvironmentResource>, AppServiceEnvironmentResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- hostingEnvironmentEnvelope
- AppServiceEnvironmentResource
Configuration details of the App Service Environment.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppServiceEnvironmentResource>, AppServiceEnvironmentResource>>
beginCreateOrUpdateAndWait(string, string, AppServiceEnvironmentResource, AppServiceEnvironmentsCreateOrUpdateOptionalParams)
Description for Create or update an App Service Environment.
function beginCreateOrUpdateAndWait(resourceGroupName: string, name: string, hostingEnvironmentEnvelope: AppServiceEnvironmentResource, options?: AppServiceEnvironmentsCreateOrUpdateOptionalParams): Promise<AppServiceEnvironmentResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- hostingEnvironmentEnvelope
- AppServiceEnvironmentResource
Configuration details of the App Service Environment.
The options parameters.
Returns
Promise<AppServiceEnvironmentResource>
beginCreateOrUpdateMultiRolePool(string, string, WorkerPoolResource, AppServiceEnvironmentsCreateOrUpdateMultiRolePoolOptionalParams)
Description for Create or update a multi-role pool.
function beginCreateOrUpdateMultiRolePool(resourceGroupName: string, name: string, multiRolePoolEnvelope: WorkerPoolResource, options?: AppServiceEnvironmentsCreateOrUpdateMultiRolePoolOptionalParams): Promise<SimplePollerLike<OperationState<WorkerPoolResource>, WorkerPoolResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- multiRolePoolEnvelope
- WorkerPoolResource
Properties of the multi-role pool.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkerPoolResource>, WorkerPoolResource>>
beginCreateOrUpdateMultiRolePoolAndWait(string, string, WorkerPoolResource, AppServiceEnvironmentsCreateOrUpdateMultiRolePoolOptionalParams)
Description for Create or update a multi-role pool.
function beginCreateOrUpdateMultiRolePoolAndWait(resourceGroupName: string, name: string, multiRolePoolEnvelope: WorkerPoolResource, options?: AppServiceEnvironmentsCreateOrUpdateMultiRolePoolOptionalParams): Promise<WorkerPoolResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- multiRolePoolEnvelope
- WorkerPoolResource
Properties of the multi-role pool.
The options parameters.
Returns
Promise<WorkerPoolResource>
beginCreateOrUpdateWorkerPool(string, string, string, WorkerPoolResource, AppServiceEnvironmentsCreateOrUpdateWorkerPoolOptionalParams)
Description for Create or update a worker pool.
function beginCreateOrUpdateWorkerPool(resourceGroupName: string, name: string, workerPoolName: string, workerPoolEnvelope: WorkerPoolResource, options?: AppServiceEnvironmentsCreateOrUpdateWorkerPoolOptionalParams): Promise<SimplePollerLike<OperationState<WorkerPoolResource>, WorkerPoolResource>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
- workerPoolEnvelope
- WorkerPoolResource
Properties of the worker pool.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkerPoolResource>, WorkerPoolResource>>
beginCreateOrUpdateWorkerPoolAndWait(string, string, string, WorkerPoolResource, AppServiceEnvironmentsCreateOrUpdateWorkerPoolOptionalParams)
Description for Create or update a worker pool.
function beginCreateOrUpdateWorkerPoolAndWait(resourceGroupName: string, name: string, workerPoolName: string, workerPoolEnvelope: WorkerPoolResource, options?: AppServiceEnvironmentsCreateOrUpdateWorkerPoolOptionalParams): Promise<WorkerPoolResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
- workerPoolEnvelope
- WorkerPoolResource
Properties of the worker pool.
The options parameters.
Returns
Promise<WorkerPoolResource>
beginDelete(string, string, AppServiceEnvironmentsDeleteOptionalParams)
Description for Delete an App Service Environment.
function beginDelete(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, AppServiceEnvironmentsDeleteOptionalParams)
Description for Delete an App Service Environment.
function beginDeleteAndWait(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<void>
beginDeletePrivateEndpointConnection(string, string, string, AppServiceEnvironmentsDeletePrivateEndpointConnectionOptionalParams)
Description for Deletes a private endpoint connection
function beginDeletePrivateEndpointConnection(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: AppServiceEnvironmentsDeletePrivateEndpointConnectionOptionalParams): Promise<SimplePollerLike<OperationState<AppServiceEnvironmentsDeletePrivateEndpointConnectionResponse>, AppServiceEnvironmentsDeletePrivateEndpointConnectionResponse>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- privateEndpointConnectionName
-
string
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<AppServiceEnvironmentsDeletePrivateEndpointConnectionResponse>, AppServiceEnvironmentsDeletePrivateEndpointConnectionResponse>>
beginDeletePrivateEndpointConnectionAndWait(string, string, string, AppServiceEnvironmentsDeletePrivateEndpointConnectionOptionalParams)
Description for Deletes a private endpoint connection
function beginDeletePrivateEndpointConnectionAndWait(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: AppServiceEnvironmentsDeletePrivateEndpointConnectionOptionalParams): Promise<AppServiceEnvironmentsDeletePrivateEndpointConnectionResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- privateEndpointConnectionName
-
string
The options parameters.
Returns
beginListChangeVnetAndWait(string, string, VirtualNetworkProfile, AppServiceEnvironmentsChangeVnetOptionalParams)
Description for Move an App Service Environment to a different VNET.
function beginListChangeVnetAndWait(resourceGroupName: string, name: string, vnetInfo: VirtualNetworkProfile, options?: AppServiceEnvironmentsChangeVnetOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- vnetInfo
- VirtualNetworkProfile
Details for the new virtual network.
The options parameters.
Returns
beginListResumeAndWait(string, string, AppServiceEnvironmentsResumeOptionalParams)
Description for Resume an App Service Environment.
function beginListResumeAndWait(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsResumeOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
beginListSuspendAndWait(string, string, AppServiceEnvironmentsSuspendOptionalParams)
Description for Suspend an App Service Environment.
function beginListSuspendAndWait(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsSuspendOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
beginUpgrade(string, string, AppServiceEnvironmentsUpgradeOptionalParams)
Description for Initiate an upgrade of an App Service Environment if one is available.
function beginUpgrade(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsUpgradeOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginUpgradeAndWait(string, string, AppServiceEnvironmentsUpgradeOptionalParams)
Description for Initiate an upgrade of an App Service Environment if one is available.
function beginUpgradeAndWait(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsUpgradeOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<void>
deleteAseCustomDnsSuffixConfiguration(string, string, AppServiceEnvironmentsDeleteAseCustomDnsSuffixConfigurationOptionalParams)
Delete Custom Dns Suffix configuration of an App Service Environment
function deleteAseCustomDnsSuffixConfiguration(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsDeleteAseCustomDnsSuffixConfigurationOptionalParams): Promise<AppServiceEnvironmentsDeleteAseCustomDnsSuffixConfigurationResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
get(string, string, AppServiceEnvironmentsGetOptionalParams)
Description for Get the properties of an App Service Environment.
function get(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetOptionalParams): Promise<AppServiceEnvironmentResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<AppServiceEnvironmentResource>
getAseCustomDnsSuffixConfiguration(string, string, AppServiceEnvironmentsGetAseCustomDnsSuffixConfigurationOptionalParams)
Get Custom Dns Suffix configuration of an App Service Environment
function getAseCustomDnsSuffixConfiguration(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetAseCustomDnsSuffixConfigurationOptionalParams): Promise<CustomDnsSuffixConfiguration>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<CustomDnsSuffixConfiguration>
getAseV3NetworkingConfiguration(string, string, AppServiceEnvironmentsGetAseV3NetworkingConfigurationOptionalParams)
Description for Get networking configuration of an App Service Environment
function getAseV3NetworkingConfiguration(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetAseV3NetworkingConfigurationOptionalParams): Promise<AseV3NetworkingConfiguration>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<AseV3NetworkingConfiguration>
getDiagnosticsItem(string, string, string, AppServiceEnvironmentsGetDiagnosticsItemOptionalParams)
Description for Get a diagnostics item for an App Service Environment.
function getDiagnosticsItem(resourceGroupName: string, name: string, diagnosticsName: string, options?: AppServiceEnvironmentsGetDiagnosticsItemOptionalParams): Promise<HostingEnvironmentDiagnostics>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- diagnosticsName
-
string
Name of the diagnostics item.
The options parameters.
Returns
Promise<HostingEnvironmentDiagnostics>
getMultiRolePool(string, string, AppServiceEnvironmentsGetMultiRolePoolOptionalParams)
Description for Get properties of a multi-role pool.
function getMultiRolePool(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetMultiRolePoolOptionalParams): Promise<WorkerPoolResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<WorkerPoolResource>
getPrivateEndpointConnection(string, string, string, AppServiceEnvironmentsGetPrivateEndpointConnectionOptionalParams)
Description for Gets a private endpoint connection
function getPrivateEndpointConnection(resourceGroupName: string, name: string, privateEndpointConnectionName: string, options?: AppServiceEnvironmentsGetPrivateEndpointConnectionOptionalParams): Promise<RemotePrivateEndpointConnectionARMResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- privateEndpointConnectionName
-
string
Name of the private endpoint connection.
The options parameters.
Returns
getPrivateLinkResources(string, string, AppServiceEnvironmentsGetPrivateLinkResourcesOptionalParams)
Description for Gets the private link resources
function getPrivateLinkResources(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetPrivateLinkResourcesOptionalParams): Promise<PrivateLinkResourcesWrapper>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<PrivateLinkResourcesWrapper>
getVipInfo(string, string, AppServiceEnvironmentsGetVipInfoOptionalParams)
Description for Get IP addresses assigned to an App Service Environment.
function getVipInfo(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetVipInfoOptionalParams): Promise<AddressResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<AddressResponse>
getWorkerPool(string, string, string, AppServiceEnvironmentsGetWorkerPoolOptionalParams)
Description for Get properties of a worker pool.
function getWorkerPool(resourceGroupName: string, name: string, workerPoolName: string, options?: AppServiceEnvironmentsGetWorkerPoolOptionalParams): Promise<WorkerPoolResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
The options parameters.
Returns
Promise<WorkerPoolResource>
list(AppServiceEnvironmentsListOptionalParams)
Description for Get all App Service Environments for a subscription.
function list(options?: AppServiceEnvironmentsListOptionalParams): PagedAsyncIterableIterator<AppServiceEnvironmentResource, AppServiceEnvironmentResource[], PageSettings>Parameters
The options parameters.
Returns
listAppServicePlans(string, string, AppServiceEnvironmentsListAppServicePlansOptionalParams)
Description for Get all App Service plans in an App Service Environment.
function listAppServicePlans(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListAppServicePlansOptionalParams): PagedAsyncIterableIterator<AppServicePlan, AppServicePlan[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listByResourceGroup(string, AppServiceEnvironmentsListByResourceGroupOptionalParams)
Description for Get all App Service Environments in a resource group.
function listByResourceGroup(resourceGroupName: string, options?: AppServiceEnvironmentsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<AppServiceEnvironmentResource, AppServiceEnvironmentResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
The options parameters.
Returns
listCapacities(string, string, AppServiceEnvironmentsListCapacitiesOptionalParams)
Description for Get the used, available, and total worker capacity an App Service Environment.
function listCapacities(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListCapacitiesOptionalParams): PagedAsyncIterableIterator<StampCapacity, StampCapacity[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listDiagnostics(string, string, AppServiceEnvironmentsListDiagnosticsOptionalParams)
Description for Get diagnostic information for an App Service Environment.
function listDiagnostics(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListDiagnosticsOptionalParams): Promise<AppServiceEnvironmentsListDiagnosticsResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listInboundNetworkDependenciesEndpoints(string, string, AppServiceEnvironmentsGetInboundNetworkDependenciesEndpointsOptionalParams)
Description for Get the network endpoints of all inbound dependencies of an App Service Environment.
function listInboundNetworkDependenciesEndpoints(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetInboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<InboundEnvironmentEndpoint, InboundEnvironmentEndpoint[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listMultiRoleMetricDefinitions(string, string, AppServiceEnvironmentsListMultiRoleMetricDefinitionsOptionalParams)
Description for Get metric definitions for a multi-role pool of an App Service Environment.
function listMultiRoleMetricDefinitions(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListMultiRoleMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listMultiRolePoolInstanceMetricDefinitions(string, string, string, AppServiceEnvironmentsListMultiRolePoolInstanceMetricDefinitionsOptionalParams)
Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
function listMultiRolePoolInstanceMetricDefinitions(resourceGroupName: string, name: string, instance: string, options?: AppServiceEnvironmentsListMultiRolePoolInstanceMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- instance
-
string
Name of the instance in the multi-role pool.
The options parameters.
Returns
listMultiRolePools(string, string, AppServiceEnvironmentsListMultiRolePoolsOptionalParams)
Description for Get all multi-role pools.
function listMultiRolePools(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListMultiRolePoolsOptionalParams): PagedAsyncIterableIterator<WorkerPoolResource, WorkerPoolResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listMultiRolePoolSkus(string, string, AppServiceEnvironmentsListMultiRolePoolSkusOptionalParams)
Description for Get available SKUs for scaling a multi-role pool.
function listMultiRolePoolSkus(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListMultiRolePoolSkusOptionalParams): PagedAsyncIterableIterator<SkuInfo, SkuInfo[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listMultiRoleUsages(string, string, AppServiceEnvironmentsListMultiRoleUsagesOptionalParams)
Description for Get usage metrics for a multi-role pool of an App Service Environment.
function listMultiRoleUsages(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListMultiRoleUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listOperations(string, string, AppServiceEnvironmentsListOperationsOptionalParams)
Description for List all currently running operations on the App Service Environment.
function listOperations(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListOperationsOptionalParams): Promise<AppServiceEnvironmentsListOperationsResponse>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listOutboundNetworkDependenciesEndpoints(string, string, AppServiceEnvironmentsGetOutboundNetworkDependenciesEndpointsOptionalParams)
Description for Get the network endpoints of all outbound dependencies of an App Service Environment.
function listOutboundNetworkDependenciesEndpoints(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetOutboundNetworkDependenciesEndpointsOptionalParams): PagedAsyncIterableIterator<OutboundEnvironmentEndpoint, OutboundEnvironmentEndpoint[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listPrivateEndpointConnectionList(string, string, AppServiceEnvironmentsGetPrivateEndpointConnectionListOptionalParams)
Description for Gets the list of private endpoints associated with a hosting environment
function listPrivateEndpointConnectionList(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsGetPrivateEndpointConnectionListOptionalParams): PagedAsyncIterableIterator<RemotePrivateEndpointConnectionARMResource, RemotePrivateEndpointConnectionARMResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listUsages(string, string, AppServiceEnvironmentsListUsagesOptionalParams)
Description for Get global usage metrics of an App Service Environment.
function listUsages(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListUsagesOptionalParams): PagedAsyncIterableIterator<CsmUsageQuota, CsmUsageQuota[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listWebApps(string, string, AppServiceEnvironmentsListWebAppsOptionalParams)
Description for Get all apps in an App Service Environment.
function listWebApps(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListWebAppsOptionalParams): PagedAsyncIterableIterator<Site, Site[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listWebWorkerMetricDefinitions(string, string, string, AppServiceEnvironmentsListWebWorkerMetricDefinitionsOptionalParams)
Description for Get metric definitions for a worker pool of an App Service Environment.
function listWebWorkerMetricDefinitions(resourceGroupName: string, name: string, workerPoolName: string, options?: AppServiceEnvironmentsListWebWorkerMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
The options parameters.
Returns
listWebWorkerUsages(string, string, string, AppServiceEnvironmentsListWebWorkerUsagesOptionalParams)
Description for Get usage metrics for a worker pool of an App Service Environment.
function listWebWorkerUsages(resourceGroupName: string, name: string, workerPoolName: string, options?: AppServiceEnvironmentsListWebWorkerUsagesOptionalParams): PagedAsyncIterableIterator<Usage, Usage[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
The options parameters.
Returns
listWorkerPoolInstanceMetricDefinitions(string, string, string, string, AppServiceEnvironmentsListWorkerPoolInstanceMetricDefinitionsOptionalParams)
Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.
function listWorkerPoolInstanceMetricDefinitions(resourceGroupName: string, name: string, workerPoolName: string, instance: string, options?: AppServiceEnvironmentsListWorkerPoolInstanceMetricDefinitionsOptionalParams): PagedAsyncIterableIterator<ResourceMetricDefinition, ResourceMetricDefinition[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
- instance
-
string
Name of the instance in the worker pool.
The options parameters.
Returns
listWorkerPools(string, string, AppServiceEnvironmentsListWorkerPoolsOptionalParams)
Description for Get all worker pools of an App Service Environment.
function listWorkerPools(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsListWorkerPoolsOptionalParams): PagedAsyncIterableIterator<WorkerPoolResource, WorkerPoolResource[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
listWorkerPoolSkus(string, string, string, AppServiceEnvironmentsListWorkerPoolSkusOptionalParams)
Description for Get available SKUs for scaling a worker pool.
function listWorkerPoolSkus(resourceGroupName: string, name: string, workerPoolName: string, options?: AppServiceEnvironmentsListWorkerPoolSkusOptionalParams): PagedAsyncIterableIterator<SkuInfo, SkuInfo[], PageSettings>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
The options parameters.
Returns
reboot(string, string, AppServiceEnvironmentsRebootOptionalParams)
Description for Reboot all machines in an App Service Environment.
function reboot(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsRebootOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<void>
testUpgradeAvailableNotification(string, string, AppServiceEnvironmentsTestUpgradeAvailableNotificationOptionalParams)
Send a test notification that an upgrade is available for this App Service Environment.
function testUpgradeAvailableNotification(resourceGroupName: string, name: string, options?: AppServiceEnvironmentsTestUpgradeAvailableNotificationOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
The options parameters.
Returns
Promise<void>
update(string, string, AppServiceEnvironmentPatchResource, AppServiceEnvironmentsUpdateOptionalParams)
Description for Create or update an App Service Environment.
function update(resourceGroupName: string, name: string, hostingEnvironmentEnvelope: AppServiceEnvironmentPatchResource, options?: AppServiceEnvironmentsUpdateOptionalParams): Promise<AppServiceEnvironmentResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- hostingEnvironmentEnvelope
- AppServiceEnvironmentPatchResource
Configuration details of the App Service Environment.
The options parameters.
Returns
Promise<AppServiceEnvironmentResource>
updateAseCustomDnsSuffixConfiguration(string, string, CustomDnsSuffixConfiguration, AppServiceEnvironmentsUpdateAseCustomDnsSuffixConfigurationOptionalParams)
Update Custom Dns Suffix configuration of an App Service Environment
function updateAseCustomDnsSuffixConfiguration(resourceGroupName: string, name: string, customDnsSuffixConfiguration: CustomDnsSuffixConfiguration, options?: AppServiceEnvironmentsUpdateAseCustomDnsSuffixConfigurationOptionalParams): Promise<CustomDnsSuffixConfiguration>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- customDnsSuffixConfiguration
- CustomDnsSuffixConfiguration
Full view of the custom domain suffix configuration for ASEv3.
The options parameters.
Returns
Promise<CustomDnsSuffixConfiguration>
updateAseNetworkingConfiguration(string, string, AseV3NetworkingConfiguration, AppServiceEnvironmentsUpdateAseNetworkingConfigurationOptionalParams)
Description for Update networking configuration of an App Service Environment
function updateAseNetworkingConfiguration(resourceGroupName: string, name: string, aseNetworkingConfiguration: AseV3NetworkingConfiguration, options?: AppServiceEnvironmentsUpdateAseNetworkingConfigurationOptionalParams): Promise<AseV3NetworkingConfiguration>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- aseNetworkingConfiguration
- AseV3NetworkingConfiguration
Full view of networking configuration for an ASE.
The options parameters.
Returns
Promise<AseV3NetworkingConfiguration>
updateMultiRolePool(string, string, WorkerPoolResource, AppServiceEnvironmentsUpdateMultiRolePoolOptionalParams)
Description for Create or update a multi-role pool.
function updateMultiRolePool(resourceGroupName: string, name: string, multiRolePoolEnvelope: WorkerPoolResource, options?: AppServiceEnvironmentsUpdateMultiRolePoolOptionalParams): Promise<WorkerPoolResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- multiRolePoolEnvelope
- WorkerPoolResource
Properties of the multi-role pool.
The options parameters.
Returns
Promise<WorkerPoolResource>
updateWorkerPool(string, string, string, WorkerPoolResource, AppServiceEnvironmentsUpdateWorkerPoolOptionalParams)
Description for Create or update a worker pool.
function updateWorkerPool(resourceGroupName: string, name: string, workerPoolName: string, workerPoolEnvelope: WorkerPoolResource, options?: AppServiceEnvironmentsUpdateWorkerPoolOptionalParams): Promise<WorkerPoolResource>Parameters
- resourceGroupName
-
string
Name of the resource group to which the resource belongs.
- name
-
string
Name of the App Service Environment.
- workerPoolName
-
string
Name of the worker pool.
- workerPoolEnvelope
- WorkerPoolResource
Properties of the worker pool.
The options parameters.
Returns
Promise<WorkerPoolResource>