@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api AppServiceEnvironments API Client
@base https://management.azure.com
@version 2018-02-01
@auth OAuth2
@common_fields {subscriptionId: any # Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)., api-version: any # API Version, resourceGroupName: any # Name of the resource group to which the resource belongs., name: any # Name of the App Service Environment.}
@endpoints 42
@hint download_for_search
@toc subscriptions(42)

@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments
@desc Get all App Service Environments for a subscription.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments
@desc Get all App Service Environments in a resource group.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
@desc Get the properties of an App Service Environment.
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
@desc Create or update an App Service Environment.
@required {hostingEnvironmentEnvelope: map # Configuration details of the App Service Environment.}
@returns(200) OK
@returns(202) Operation is in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
@desc Delete an App Service Environment.
@optional {forceDelete: any # Specify true to force the deletion even if the App Service Environment contains resources. The default is false.}
@returns(202) Operation is in progress.
@returns(204) App Service Environment does not exist
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}
@desc Create or update an App Service Environment.
@required {hostingEnvironmentEnvelope: map # Configuration details of the App Service Environment.}
@returns(200) OK
@returns(202) Operation is in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute
@desc Get the used, available, and total worker capacity an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip
@desc Get IP addresses assigned to an App Service Environment.
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork
@desc Move an App Service Environment to a different VNET.
@required {vnetInfo: any # Details for the new virtual network.}
@returns(200) OK.
@returns(202) Operation is in progress.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics
@desc Get diagnostic information for an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}
@desc Get a diagnostics item for an App Service Environment.
@required {diagnosticsName: any # Name of the diagnostics item.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints
@desc Get the network endpoints of all inbound dependencies of an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions
@desc Get global metric definitions of an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics
@desc Get global metrics of an App Service Environment.
@optional {details: any # Specify true to include instance details. The default is false., $filter: any # Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools
@desc Get all multi-role pools.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
@desc Get properties of a multi-role pool.
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
@desc Create or update a multi-role pool.
@required {multiRolePoolEnvelope: map # Properties of the multi-role pool.}
@returns(200) OK.
@returns(202) Operation is in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default
@desc Create or update a multi-role pool.
@required {multiRolePoolEnvelope: map # Properties of the multi-role pool.}
@returns(200) OK.
@returns(202) Operation is in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions
@desc Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.
@required {instance: any # Name of the instance in the multi-role pool.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics
@desc Get metrics for a specific instance of a multi-role pool of an App Service Environment.
@required {instance: any # Name of the instance in the multi-role pool.}
@optional {details: any # Specify true to include instance details. The default is false.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions
@desc Get metric definitions for a multi-role pool of an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics
@desc Get metrics for a multi-role pool of an App Service Environment.
@optional {startTime: any # Beginning time of the metrics query., endTime: any # End time of the metrics query., timeGrain: any # Time granularity of the metrics query., details: any # Specify true to include instance details. The default is false., $filter: any # Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus
@desc Get available SKUs for scaling a multi-role pool.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages
@desc Get usage metrics for a multi-role pool of an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations
@desc List all currently running operations on the App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints
@desc Get the network endpoints of all outbound dependencies of an App Service Environment.
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot
@desc Reboot all machines in an App Service Environment.
@returns(202) Asynchronous operation in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume
@desc Resume an App Service Environment.
@returns(200) OK.
@returns(202) Operation is in progress.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms
@desc Get all App Service plans in an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites
@desc Get all apps in an App Service Environment.
@optional {propertiesToInclude: any # Comma separated list of app properties to include.}
@returns(200) OK

@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend
@desc Suspend an App Service Environment.
@returns(200) OK.
@returns(202) Operation is in progress.

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages
@desc Get global usage metrics of an App Service Environment.
@optional {$filter: any # Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools
@desc Get all worker pools of an App Service Environment.
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
@desc Get properties of a worker pool.
@required {workerPoolName: any # Name of the worker pool.}
@returns(200) OK

@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
@desc Create or update a worker pool.
@required {workerPoolName: any # Name of the worker pool., workerPoolEnvelope: map # Properties of the worker pool.}
@returns(200) OK.
@returns(202) Operation is in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}
@desc Create or update a worker pool.
@required {workerPoolName: any # Name of the worker pool., workerPoolEnvelope: map # Properties of the worker pool.}
@returns(200) OK.
@returns(202) Operation is in progress.
@errors {400: Bad request., 404: Not found., 409: Conflict.}

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions
@desc Get metric definitions for a specific instance of a worker pool of an App Service Environment.
@required {workerPoolName: any # Name of the worker pool., instance: any # Name of the instance in the worker pool.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics
@desc Get metrics for a specific instance of a worker pool of an App Service Environment.
@required {workerPoolName: any # Name of the worker pool., instance: any # Name of the instance in the worker pool.}
@optional {details: any # Specify true to include instance details. The default is false., $filter: any # Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions
@desc Get metric definitions for a worker pool of an App Service Environment.
@required {workerPoolName: any # Name of the worker pool.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics
@desc Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).
@required {workerPoolName: any # Name of worker pool}
@optional {details: any # Specify true to include instance details. The default is false., $filter: any # Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus
@desc Get available SKUs for scaling a worker pool.
@required {workerPoolName: any # Name of the worker pool.}
@returns(200) OK

@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages
@desc Get usage metrics for a worker pool of an App Service Environment.
@required {workerPoolName: any # Name of the worker pool.}
@returns(200) OK

@end