{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-web-appserviceenvironments","description":"AppServiceEnvironments API Client","version":"2018-02-01","base_url":"https://management.azure.com","endpoints":42,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AppServiceEnvironments API Client\n@base https://management.azure.com\n@version 2018-02-01\n@auth OAuth2\n@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.}\n@endpoints 42\n@hint download_for_search\n@toc subscriptions(42)\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments\n@desc Get all App Service Environments for a subscription.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments\n@desc Get all App Service Environments in a resource group.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}\n@desc Get the properties of an App Service Environment.\n@returns(200) OK\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}\n@desc Create or update an App Service Environment.\n@required {hostingEnvironmentEnvelope: map # Configuration details of the App Service Environment.}\n@returns(200) OK\n@returns(202) Operation is in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}\n@desc Delete an App Service Environment.\n@optional {forceDelete: any # Specify true to force the deletion even if the App Service Environment contains resources. The default is false.}\n@returns(202) Operation is in progress.\n@returns(204) App Service Environment does not exist\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}\n@desc Create or update an App Service Environment.\n@required {hostingEnvironmentEnvelope: map # Configuration details of the App Service Environment.}\n@returns(200) OK\n@returns(202) Operation is in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute\n@desc Get the used, available, and total worker capacity an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip\n@desc Get IP addresses assigned to an App Service Environment.\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork\n@desc Move an App Service Environment to a different VNET.\n@required {vnetInfo: any # Details for the new virtual network.}\n@returns(200) OK.\n@returns(202) Operation is in progress.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics\n@desc Get diagnostic information for an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}\n@desc Get a diagnostics item for an App Service Environment.\n@required {diagnosticsName: any # Name of the diagnostics item.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints\n@desc Get the network endpoints of all inbound dependencies of an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions\n@desc Get global metric definitions of an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics\n@desc Get global metrics of an App Service Environment.\n@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]'.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools\n@desc Get all multi-role pools.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default\n@desc Get properties of a multi-role pool.\n@returns(200) OK\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default\n@desc Create or update a multi-role pool.\n@required {multiRolePoolEnvelope: map # Properties of the multi-role pool.}\n@returns(200) OK.\n@returns(202) Operation is in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default\n@desc Create or update a multi-role pool.\n@required {multiRolePoolEnvelope: map # Properties of the multi-role pool.}\n@returns(200) OK.\n@returns(202) Operation is in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions\n@desc Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.\n@required {instance: any # Name of the instance in the multi-role pool.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics\n@desc Get metrics for a specific instance of a multi-role pool of an App Service Environment.\n@required {instance: any # Name of the instance in the multi-role pool.}\n@optional {details: any # Specify true to include instance details. The default is false.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions\n@desc Get metric definitions for a multi-role pool of an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics\n@desc Get metrics for a multi-role pool of an App Service Environment.\n@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]'.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus\n@desc Get available SKUs for scaling a multi-role pool.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages\n@desc Get usage metrics for a multi-role pool of an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations\n@desc List all currently running operations on the App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints\n@desc Get the network endpoints of all outbound dependencies of an App Service Environment.\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot\n@desc Reboot all machines in an App Service Environment.\n@returns(202) Asynchronous operation in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume\n@desc Resume an App Service Environment.\n@returns(200) OK.\n@returns(202) Operation is in progress.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms\n@desc Get all App Service plans in an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites\n@desc Get all apps in an App Service Environment.\n@optional {propertiesToInclude: any # Comma separated list of app properties to include.}\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend\n@desc Suspend an App Service Environment.\n@returns(200) OK.\n@returns(202) Operation is in progress.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages\n@desc Get global usage metrics of an App Service Environment.\n@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]'.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools\n@desc Get all worker pools of an App Service Environment.\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}\n@desc Get properties of a worker pool.\n@required {workerPoolName: any # Name of the worker pool.}\n@returns(200) OK\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}\n@desc Create or update a worker pool.\n@required {workerPoolName: any # Name of the worker pool., workerPoolEnvelope: map # Properties of the worker pool.}\n@returns(200) OK.\n@returns(202) Operation is in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}\n@desc Create or update a worker pool.\n@required {workerPoolName: any # Name of the worker pool., workerPoolEnvelope: map # Properties of the worker pool.}\n@returns(200) OK.\n@returns(202) Operation is in progress.\n@errors {400: Bad request., 404: Not found., 409: Conflict.}\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions\n@desc Get metric definitions for a specific instance of a worker pool of an App Service Environment.\n@required {workerPoolName: any # Name of the worker pool., instance: any # Name of the instance in the worker pool.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics\n@desc Get metrics for a specific instance of a worker pool of an App Service Environment.\n@required {workerPoolName: any # Name of the worker pool., instance: any # Name of the instance in the worker pool.}\n@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]'.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions\n@desc Get metric definitions for a worker pool of an App Service Environment.\n@required {workerPoolName: any # Name of the worker pool.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics\n@desc Get metrics for a worker pool of a AppServiceEnvironment (App Service Environment).\n@required {workerPoolName: any # Name of worker pool}\n@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]'.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus\n@desc Get available SKUs for scaling a worker pool.\n@required {workerPoolName: any # Name of the worker pool.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages\n@desc Get usage metrics for a worker pool of an App Service Environment.\n@required {workerPoolName: any # Name of the worker pool.}\n@returns(200) OK\n\n@end\n"}