swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector HostingEnvironments API schemes: - https tags: - name: HostingEnvironments paths: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}: get: tags: - HostingEnvironments summary: Microsoft Azure Get Properties Of Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironment' deprecated: false description: Needs a more full description created. put: tags: - HostingEnvironments summary: Microsoft Azure Create Or Update A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsCreateorupdatehostingenvironment consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: hostingEnvironmentEnvelope in: body description: Properties of hostingEnvironment (App Service Environment) required: true schema: $ref: '#/definitions/HostingEnvironment' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironment' '202': description: Operation is in progress schema: $ref: '#/definitions/HostingEnvironment' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. delete: tags: - HostingEnvironments summary: Microsoft Azure Delete A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsDeletehostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: forceDelete in: query description: Delete even if the hostingEnvironment (App Service Environment) contains resources type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' '202': description: Operation is in progress schema: $ref: '#/definitions/Object' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics : get: tags: - HostingEnvironments summary: Microsoft Azure Get Diagnostic Information For Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentdiagnostics consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: type: array items: $ref: '#/definitions/HostingEnvironmentDiagnostics' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName} : get: tags: - HostingEnvironments summary: Microsoft Azure Get Diagnostic Information For Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentdiagnosticsitem consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: diagnosticsName in: path description: Name of the diagnostics required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironmentDiagnostics' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute : get: tags: - HostingEnvironments summary: Microsoft Azure Get Used, Available, And Total Worker Capacity For Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentcapacities consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/StampCapacityCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip : get: tags: - HostingEnvironments summary: Microsoft Azure Get Ip Addresses Assigned To The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentvips consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/AddressResponse' deprecated: false description: Needs a more full description created. /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments: get: tags: - HostingEnvironments summary: Microsoft Azure Get All Hostingenvironments App Service Environments In A Resource Group operationId: microsoftAzureHostingenvironmentsGethostingenvironments consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/HostingEnvironmentCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot : post: tags: - HostingEnvironments summary: Microsoft Azure Reboots All Machines In A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsReboothostingenvironment consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Object' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations : get: tags: - HostingEnvironments summary: Microsoft Azure List All Currently Running Operations On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentoperations consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations/{operationId} : get: tags: - HostingEnvironments summary: Microsoft Azure Get Status Of An Operation On A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentoperation consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: operationId in: path description: operation identifier GUID required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: Operation completed successfully schema: $ref: '#/definitions/Object' '202': description: Asynchronous operation in progress schema: $ref: '#/definitions/Object' '404': description: Not found '500': description: Operation failed deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metrics : get: tags: - HostingEnvironments summary: Microsoft Azure Get Global Metrics Of Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: '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]''.' type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/metricdefinitions : get: tags: - HostingEnvironments summary: Microsoft Azure Get Global Metric Definitions Of Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmetricdefinitions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinition' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages : get: tags: - HostingEnvironments summary: Microsoft Azure Get Global Usages Of Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: $filter in: query description: '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]''.' type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/CsmUsageQuotaCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metrics : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metrics For A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmultirolemetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: startTime in: query description: Beginning time of metrics query type: string - name: endTime in: query description: End time of metrics query type: string - name: timeGrain in: query description: Time granularity of metrics query type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: '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]''.' type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metrics : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metrics For A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebworkermetrics consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: '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]''.' type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ResourceMetricCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metric Definitions For A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmultirolemetricdefinitions consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metric Definitions For A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebworkermetricdefinitions consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/MetricDefinitionCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages : get: tags: - HostingEnvironments summary: Microsoft Azure Get Usages For A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentmultiroleusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/UsageCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages : get: tags: - HostingEnvironments summary: Microsoft Azure Get Usages For A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebworkerusages consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/UsageCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Sites On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentsites consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: propertiesToInclude in: query description: Comma separated list of site properties to include type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/webhostingplans : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Serverfarms App Service Plans On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentwebhostingplans consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Serverfarms App Service Plans On The Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGethostingenvironmentserverfarms consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/ServerFarmCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Multi Role Pools operationId: microsoftAzureHostingenvironmentsGetmultirolepools consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPoolCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default : get: tags: - HostingEnvironments summary: Microsoft Azure Get Properties Of A Multirole Pool operationId: microsoftAzureHostingenvironmentsGetmultirolepool consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' deprecated: false description: Needs a more full description created. put: tags: - HostingEnvironments summary: Microsoft Azure Create Or Update A Multirole Pool operationId: microsoftAzureHostingenvironmentsCreateorupdatemultirolepool consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: multiRolePoolEnvelope in: body description: Properties of multiRole pool required: true schema: $ref: '#/definitions/WorkerPool' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' '202': description: Operation is in progress schema: $ref: '#/definitions/WorkerPool' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus : get: tags: - HostingEnvironments summary: Microsoft Azure Get Available Skus For Scaling A Multirole Pool operationId: microsoftAzureHostingenvironmentsGetmultirolepoolskus consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SkuInfoCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools : get: tags: - HostingEnvironments summary: Microsoft Azure Get All Worker Pools operationId: microsoftAzureHostingenvironmentsGetworkerpools consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPoolCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName} : get: tags: - HostingEnvironments summary: Microsoft Azure Get Properties Of A Worker Pool operationId: microsoftAzureHostingenvironmentsGetworkerpool consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' deprecated: false description: Needs a more full description created. put: tags: - HostingEnvironments summary: Microsoft Azure Create Or Update A Worker Pool operationId: microsoftAzureHostingenvironmentsCreateorupdateworkerpool consumes: - application/json - text/json - application/x-www-form-urlencoded produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: workerPoolEnvelope in: body description: Properties of worker pool required: true schema: $ref: '#/definitions/WorkerPool' - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/WorkerPool' '202': description: Operation is in progress schema: $ref: '#/definitions/WorkerPool' '400': description: Bad request '404': description: Not found '409': description: Conflict deprecated: false x-ms-long-running-operation: true description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus : get: tags: - HostingEnvironments summary: Microsoft Azure Get Available Skus For Scaling A Worker Pool operationId: microsoftAzureHostingenvironmentsGetworkerpoolskus consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SkuInfoCollection' deprecated: false x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metrics : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metrics For A Specific Instance Of A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetworkerpoolinstancemetrics consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: instance in: path description: Name of instance in the worker pool required: true type: string - name: details in: query description: Include instance details type: boolean - name: $filter in: query description: '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]''.' type: string x-ms-skip-url-encoding: true - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metric Definitions For A Specific Instance Of A Worker Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetworkerpoolinstancemetricdefinitions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: workerPoolName in: path description: Name of worker pool required: true type: string - name: instance in: path description: Name of instance in the worker pool required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metrics : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metrics For A Specific Instance Of A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetmultirolepoolinstancemetrics consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: instance in: path description: Name of instance in the multiRole pool required: true type: string - name: details in: query description: Include instance details type: boolean - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions : get: tags: - HostingEnvironments summary: Microsoft Azure Get Metric Definitions For A Specific Instance Of A Multirole Pool Of A Hostingenvironment App Service Environment operationId: microsoftAzureHostingenvironmentsGetmultirolepoolinstancemetricdefinitions consumes: [] produces: - application/json - text/json - application/xml - text/xml parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - name: instance in: path description: Name of instance in the multiRole pool> required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/Object' deprecated: false description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend : post: tags: - HostingEnvironments summary: Microsoft Azure Suspends The Hostingenvironment operationId: microsoftAzureHostingenvironmentsSuspendhostingenvironment consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' '202': description: Operation is in progress schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume : post: tags: - HostingEnvironments summary: Microsoft Azure Resumes The Hostingenvironment operationId: microsoftAzureHostingenvironmentsResumehostingenvironment consumes: [] produces: - application/json - text/json parameters: - name: resourceGroupName in: path description: Name of resource group required: true type: string - name: name in: path description: Name of hostingEnvironment (App Service Environment) required: true type: string - $ref: '#/parameters/subscriptionIdParameter' - $ref: '#/parameters/apiVersionParameter' responses: '200': description: OK schema: $ref: '#/definitions/SiteCollection' '202': description: Operation is in progress schema: $ref: '#/definitions/SiteCollection' deprecated: false x-ms-long-running-operation: true x-ms-pageable: nextLinkName: nextLink description: Needs a more full description created. definitions: MetricDefinition: description: Class representing metadata for the metrics type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: name: description: Name of the metric type: string unit: description: Unit of the metric type: string primaryAggregationType: description: Primary aggregation type type: string metricAvailabilities: description: List of time grains supported for the metric together with retention period type: array items: $ref: '#/definitions/MetricAvailabilily' displayName: description: Friendly name shown in the UI type: string x-ms-client-flatten: true Experiments: description: Class containing Routing in production experiments type: object properties: rampUpRules: description: List of {Microsoft.Web.Hosting.Administration.RampUpRule} objects. type: array items: $ref: '#/definitions/RampUpRule' ServerFarmCollection: description: Collection of serverfarms type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/ServerFarmWithRichSku' nextLink: description: Link to next page of resources type: string CloningInfo: description: Represents information needed for cloning operation type: object properties: correlationId: description: "Correlation Id of cloning operation. This id ties multiple cloning operations\r\n together to use the same snapshot" type: string overwrite: description: Overwrite destination web app type: boolean cloneCustomHostNames: description: If true, clone custom hostnames from source web app type: boolean cloneSourceControl: description: Clone source control from source web app type: boolean sourceWebAppId: description: "ARM resource id of the source web app. Web app resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots" type: string hostingEnvironment: description: Hosting environment type: string appSettingsOverrides: description: "Application settings overrides for cloned web app. If specified these settings will override the settings cloned \r\n from source web app. If not specified, application settings from source web app are retained." type: object additionalProperties: type: string configureLoadBalancing: description: If specified configure load balancing for source and clone site type: boolean trafficManagerProfileId: description: "ARM resource id of the traffic manager profile to use if it exists. Traffic manager resource id is of the form \r\n /subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}" type: string trafficManagerProfileName: description: Name of traffic manager profile to create. This is only needed if traffic manager profile does not already exist type: string HostNameSslState: description: Object that represents a SSL-enabled host name. required: - sslState type: object properties: name: description: Host name type: string sslState: description: SSL type enum: - Disabled - SniEnabled - IpBasedEnabled type: string x-ms-enum: name: SslState modelAsString: false virtualIP: description: Virtual IP address assigned to the host name if IP based SSL is enabled type: string thumbprint: description: SSL cert thumbprint type: string toUpdate: description: Set this flag to update existing host name type: boolean RampUpRule: description: Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance type: object properties: actionHostName: description: Hostname of a slot to which the traffic will be redirected if decided to. E.g. mysite-stage.azurewebsites.net type: string reroutePercentage: format: double description: Percentage of the traffic which will be redirected to {Microsoft.Web.Hosting.Administration.RampUpRule.ActionHostName} type: number changeStep: format: double description: "[Optional] In auto ramp up scenario this is the step to add/remove from {Microsoft.Web.Hosting.Administration.RampUpRule.ReroutePercentage} until it reaches \r\n {Microsoft.Web.Hosting.Administration.RampUpRule.MinReroutePercentage} or {Microsoft.Web.Hosting.Administration.RampUpRule.MaxReroutePercentage}. Site metrics are checked every N minutes specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeIntervalInMinutes}.\r\n Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified in {Microsoft.Web.Hosting.Administration.RampUpRule.ChangeDecisionCallbackUrl}" type: number changeIntervalInMinutes: format: int32 description: '[Optional] Specifies interval in minutes to reevaluate ReroutePercentage' type: integer minReroutePercentage: format: double description: '[Optional] Specifies lower boundary above which ReroutePercentage will stay.' type: number maxReroutePercentage: format: double description: '[Optional] Specifies upper boundary below which ReroutePercentage will stay.' type: number changeDecisionCallbackUrl: description: "Custom decision algorithm can be provided in TiPCallback site extension which Url can be specified. See TiPCallback site extension for the scaffold and contracts.\r\n https://www.siteextensions.net/packages/TiPCallback/" type: string name: description: Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment. type: string SkuInfo: description: Sku discovery information type: object properties: resourceType: description: Resource type that this sku applies to type: string sku: $ref: '#/definitions/SkuDescription' description: Name and tier of the sku capacity: $ref: '#/definitions/SkuCapacity' description: Min, max, and default scale values of the sku ResourceMetricCollection: description: Collection of metric responses type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/ResourceMetric' nextLink: description: Link to next page of resources type: string SiteConfig: description: Configuration of Azure web site type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: numberOfWorkers: format: int32 description: Number of workers type: integer defaultDocuments: description: Default documents type: array items: type: string netFrameworkVersion: description: Net Framework Version type: string phpVersion: description: Version of PHP type: string pythonVersion: description: Version of Python type: string nodeVersion: description: Version of Node type: string requestTracingEnabled: description: Enable request tracing type: boolean requestTracingExpirationTime: format: date-time description: Request tracing expiration time type: string remoteDebuggingEnabled: description: Remote Debugging Enabled type: boolean remoteDebuggingVersion: description: Remote Debugging Version type: string httpLoggingEnabled: description: HTTP logging Enabled type: boolean logsDirectorySizeLimit: format: int32 description: HTTP Logs Directory size limit type: integer detailedErrorLoggingEnabled: description: Detailed error logging enabled type: boolean publishingUsername: description: Publishing user name type: string publishingPassword: description: Publishing password type: string appSettings: description: Application Settings type: array items: $ref: '#/definitions/NameValuePair' metadata: description: Site Metadata type: array items: $ref: '#/definitions/NameValuePair' connectionStrings: description: Connection strings type: array items: $ref: '#/definitions/ConnStringInfo' handlerMappings: description: Handler mappings type: array items: $ref: '#/definitions/HandlerMapping' documentRoot: description: Document root type: string scmType: description: SCM type type: string use32BitWorkerProcess: description: Use 32 bit worker process type: boolean webSocketsEnabled: description: Web socket enabled. type: boolean alwaysOn: description: Always On type: boolean javaVersion: description: Java version type: string javaContainer: description: Java container type: string javaContainerVersion: description: Java container version type: string appCommandLine: description: App Command Line to launch type: string managedPipelineMode: description: Managed pipeline mode enum: - Integrated - Classic type: string x-ms-enum: name: ManagedPipelineMode modelAsString: false virtualApplications: description: Virtual applications type: array items: $ref: '#/definitions/VirtualApplication' loadBalancing: description: Site load balancing enum: - WeightedRoundRobin - LeastRequests - LeastResponseTime - WeightedTotalTraffic - RequestHash type: string x-ms-enum: name: SiteLoadBalancing modelAsString: false experiments: $ref: '#/definitions/Experiments' description: This is work around for polymorphic types limits: $ref: '#/definitions/SiteLimits' description: Site limits autoHealEnabled: description: Auto heal enabled type: boolean autoHealRules: $ref: '#/definitions/AutoHealRules' description: Auto heal rules tracingOptions: description: Tracing options type: string vnetName: description: Vnet name type: string cors: $ref: '#/definitions/CorsSettings' description: Cross-Origin Resource Sharing (CORS) settings. apiDefinition: $ref: '#/definitions/ApiDefinitionInfo' description: Information about the formal API definition for the web app. autoSwapSlotName: description: Auto swap slot name type: string localMySqlEnabled: description: Local mysql enabled type: boolean ipSecurityRestrictions: description: Ip Security restrictions type: array items: $ref: '#/definitions/IpSecurityRestriction' x-ms-client-flatten: true StatusCodesBasedTrigger: description: StatusCodeBasedTrigger type: object properties: status: format: int32 description: HTTP status code type: integer subStatus: format: int32 description: SubStatus type: integer win32Status: format: int32 description: Win32 error code type: integer count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string MetricDefinitionCollection: description: Collection of metric definitions type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/MetricDefinition' nextLink: description: Link to next page of resources type: string AddressResponse: description: Describes main public ip address and any extra vips type: object properties: serviceIpAddress: description: Main public vip type: string internalIpAddress: description: VNET internal ip address of the hostingEnvironment (App Service Environment) if it is in internal load-balancing mode type: string outboundIpAddresses: description: IP addresses appearing on outbound connections type: array items: type: string vipMappings: description: Additional vips type: array items: $ref: '#/definitions/VirtualIPMapping' Resource: required: - location properties: id: description: Resource Id type: string name: description: Resource Name type: string kind: description: Kind of resource type: string location: description: Resource Location type: string type: description: Resource type type: string tags: description: Resource tags type: object additionalProperties: type: string x-ms-azure-resource: true VirtualIPMapping: description: Class that represents a VIP mapping type: object properties: virtualIP: description: Virtual IP address type: string internalHttpPort: format: int32 description: Internal HTTP port type: integer internalHttpsPort: format: int32 description: Internal HTTPS port type: integer inUse: description: Is VIP mapping in use type: boolean WorkerPool: description: Worker pool of a hostingEnvironment (App Service Environment) type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: workerSizeId: format: int32 description: Worker size id for referencing this worker pool type: integer computeMode: description: Shared or dedicated web app hosting enum: - Shared - Dedicated - Dynamic type: string x-ms-enum: name: ComputeModeOptions modelAsString: false workerSize: description: VM size of the worker pool instances type: string workerCount: format: int32 description: Number of instances in the worker pool type: integer instanceNames: description: Names of all instances in the worker pool (read only) type: array items: type: string x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' CsmUsageQuota: description: Usage of the quota resource type: object properties: unit: description: Units of measurement for the quota resource type: string nextResetTime: format: date-time description: Next reset time for the resource counter type: string currentValue: format: int64 description: The current value of the resource counter type: integer limit: format: int64 description: The resource limit type: integer name: $ref: '#/definitions/LocalizableString' description: Quota name CsmUsageQuotaCollection: description: Collection of csm usage quotas type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/CsmUsageQuota' nextLink: description: Link to next page of resources type: string HostingEnvironment: description: Description of an hostingEnvironment (App Service Environment) type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: name: description: Name of the hostingEnvironment (App Service Environment) type: string location: description: Location of the hostingEnvironment (App Service Environment), e.g. "West US" type: string provisioningState: description: Provisioning state of the hostingEnvironment (App Service Environment) enum: - Succeeded - Failed - Canceled - InProgress - Deleting type: string x-ms-enum: name: ProvisioningState modelAsString: false status: description: Current status of the hostingEnvironment (App Service Environment) enum: - Preparing - Ready - Scaling - Deleting type: string x-ms-enum: name: HostingEnvironmentStatus modelAsString: false vnetName: description: Name of the hostingEnvironment's (App Service Environment) virtual network type: string vnetResourceGroupName: description: Resource group of the hostingEnvironment's (App Service Environment) virtual network type: string vnetSubnetName: description: Subnet of the hostingEnvironment's (App Service Environment) virtual network type: string virtualNetwork: $ref: '#/definitions/VirtualNetworkProfile' description: Description of the hostingEnvironment's (App Service Environment) virtual network internalLoadBalancingMode: description: Specifies which endpoints to serve internally in the hostingEnvironment's (App Service Environment) VNET enum: - None - Web - Publishing type: string x-ms-enum: name: InternalLoadBalancingMode modelAsString: false multiSize: description: Front-end VM size, e.g. "Medium", "Large" type: string multiRoleCount: format: int32 description: Number of front-end instances type: integer workerPools: description: Description of worker pools with worker size ids, VM sizes, and number of workers in each pool type: array items: $ref: '#/definitions/WorkerPool' ipsslAddressCount: format: int32 description: Number of IP SSL addresses reserved for this hostingEnvironment (App Service Environment) type: integer databaseEdition: description: Edition of the metadata database for the hostingEnvironment (App Service Environment) e.g. "Standard" type: string databaseServiceObjective: description: Service objective of the metadata database for the hostingEnvironment (App Service Environment) e.g. "S0" type: string upgradeDomains: format: int32 description: Number of upgrade domains of this hostingEnvironment (App Service Environment) type: integer subscriptionId: description: Subscription of the hostingEnvironment (App Service Environment) type: string dnsSuffix: description: DNS suffix of the hostingEnvironment (App Service Environment) type: string lastAction: description: Last deployment action on this hostingEnvironment (App Service Environment) type: string lastActionResult: description: Result of the last deployment action on this hostingEnvironment (App Service Environment) type: string allowedMultiSizes: description: List of comma separated strings describing which VM sizes are allowed for front-ends type: string allowedWorkerSizes: description: List of comma separated strings describing which VM sizes are allowed for workers type: string maximumNumberOfMachines: format: int32 description: Maximum number of VMs in this hostingEnvironment (App Service Environment) type: integer vipMappings: description: Description of IP SSL mapping for this hostingEnvironment (App Service Environment) type: array items: $ref: '#/definitions/VirtualIPMapping' environmentCapacities: description: Current total, used, and available worker capacities type: array items: $ref: '#/definitions/StampCapacity' networkAccessControlList: description: Access control list for controlling traffic to the hostingEnvironment (App Service Environment) type: array items: $ref: '#/definitions/NetworkAccessControlEntry' environmentIsHealthy: description: True/false indicating whether the hostingEnvironment (App Service Environment) is healthy type: boolean environmentStatus: description: Detailed message about with results of the last check of the hostingEnvironment (App Service Environment) type: string resourceGroup: description: Resource group of the hostingEnvironment (App Service Environment) type: string apiManagementAccountId: description: Api Management Account associated with this Hosting Environment type: string suspended: description: "True/false indicating whether the hostingEnvironment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\r\n (most likely because NSG blocked the incoming traffic)" type: boolean clusterSettings: description: Custom settings for changing the behavior of the hosting environment type: array items: $ref: '#/definitions/NameValuePair' x-ms-client-flatten: true HostingEnvironmentDiagnostics: description: Diagnostics for a hosting environment (App Service Environment) type: object properties: name: description: Name/identifier of the diagnostics type: string diagnosicsOutput: description: Diagnostics output type: string WorkerPoolCollection: description: Collection of worker pools type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/WorkerPool' nextLink: description: Link to next page of resources type: string HostingEnvironmentProfile: description: Specification for a hostingEnvironment (App Service Environment) to use for this resource type: object properties: id: description: Resource id of the hostingEnvironment (App Service Environment) type: string name: description: Name of the hostingEnvironment (App Service Environment) (read only) type: string type: description: Resource type of the hostingEnvironment (App Service Environment) (read only) type: string NetworkAccessControlEntry: type: object properties: action: enum: - Permit - Deny type: string x-ms-enum: name: AccessControlEntryAction modelAsString: false description: type: string order: format: int32 type: integer remoteSubnet: type: string ResourceMetricValue: description: Value of resource metric type: object properties: timeStamp: description: Value timestamp type: string average: format: float description: Value average type: number minimum: format: float description: Value minimum type: number maximum: format: float description: Value maximum type: number total: format: float description: Value total type: number count: format: float description: Value count type: number SkuDescription: description: Describes a sku for a scalable resource type: object properties: name: description: Name of the resource sku type: string tier: description: Service Tier of the resource sku type: string size: description: Size specifier of the resource sku type: string family: description: Family code of the resource sku type: string capacity: format: int32 description: Current number of instances assigned to the resource type: integer ServerFarmWithRichSku: description: App Service Plan Model type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - status properties: name: description: Name for the App Service Plan type: string workerTierName: description: Target worker tier assigned to the App Service Plan type: string status: description: App Service Plan Status enum: - Ready - Pending type: string readOnly: true x-ms-enum: name: StatusOptions modelAsString: false subscription: description: App Service Plan Subscription type: string readOnly: true adminSiteName: description: App Service Plan administration site type: string hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: Specification for the hosting environment (App Service Environment) to use for the App Service Plan maximumNumberOfWorkers: format: int32 description: Maximum number of instances that can be assigned to this App Service Plan type: integer geoRegion: description: Geographical location for the App Service Plan type: string readOnly: true perSiteScaling: description: "If True apps assigned to this App Service Plan can be scaled independently\r\n If False apps assigned to this App Service Plan will scale to all instances of the plan" type: boolean numberOfSites: format: int32 description: Number of web apps assigned to this App Service Plan type: integer readOnly: true resourceGroup: description: Resource group of the server farm type: string readOnly: true reserved: description: Enables creation of a Linux App Service Plan type: boolean x-ms-client-flatten: true sku: $ref: '#/definitions/SkuDescription' SiteLimits: description: Represents metric limits set on a web app. type: object properties: maxPercentageCpu: format: double description: Maximum allowed CPU usage percentage type: number maxMemoryInMb: format: int64 description: Maximum allowed memory usage in MB type: integer maxDiskSizeInMb: format: int64 description: Maximum allowed disk size usage in MB type: integer VirtualNetworkProfile: description: Specification for using a virtual network type: object properties: id: description: Resource id of the virtual network type: string name: description: Name of the virtual network (read-only) type: string type: description: Resource type of the virtual network (read-only) type: string subnet: description: Subnet within the virtual network type: string ResourceMetricName: description: Name of a metric for any resource type: object properties: value: description: metric name value type: string localizedValue: description: Localized metric name value type: string SkuInfoCollection: description: Collection of SkuInfos type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/SkuInfo' nextLink: description: Link to next page of resources type: string AutoHealCustomAction: description: "AutoHealCustomAction - Describes the custom action to be executed\r\n when an auto heal rule is triggered." type: object properties: exe: description: Executable to be run type: string parameters: description: Parameters for the executable type: string CorsSettings: description: Cross-Origin Resource Sharing (CORS) settings for the web app. type: object properties: allowedOrigins: description: "Gets or sets the list of origins that should be allowed to make cross-origin\r\n calls (for example: http://example.com:12345). Use \"*\" to allow all." type: array items: type: string MetricAvailabilily: description: Class representing metrics availability and retention type: object properties: timeGrain: description: Time grain type: string retention: description: Retention period for the current {Microsoft.Web.Hosting.Administration.MetricAvailabilily.TimeGrain} type: string SiteCollection: description: Collection of sites type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Site' nextLink: description: Link to next page of resources type: string SlowRequestsBasedTrigger: description: SlowRequestsBasedTrigger type: object properties: timeTaken: description: TimeTaken type: string count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string VirtualApplication: type: object properties: virtualPath: type: string physicalPath: type: string preloadEnabled: type: boolean virtualDirectories: type: array items: $ref: '#/definitions/VirtualDirectory' UsageCollection: description: Collection of usages type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/Usage' nextLink: description: Link to next page of resources type: string AutoHealActions: description: "AutoHealActions - Describes the actions which can be\r\n taken by the auto-heal module when a rule is triggered." required: - actionType type: object properties: actionType: description: ActionType - predefined action to be taken enum: - Recycle - LogEvent - CustomAction type: string x-ms-enum: name: AutoHealActionType modelAsString: false customAction: $ref: '#/definitions/AutoHealCustomAction' description: CustomAction - custom action to be taken minProcessExecutionTime: description: "MinProcessExecutionTime - minimum time the process must execute\r\n before taking the action" type: string ConnStringInfo: description: Represents database connection string information required: - type type: object properties: name: description: Name of connection string type: string connectionString: description: Connection string value type: string type: description: Type of database enum: - MySql - SQLServer - SQLAzure - Custom type: string x-ms-enum: name: DatabaseServerType modelAsString: false KeyValuePair[String,String]: type: object properties: key: type: string readOnly: true value: type: string readOnly: true Site: description: Represents a web app type: object allOf: - $ref: '#/definitions/Resource' properties: properties: required: - usageState - availabilityState properties: name: description: Name of web app type: string state: description: State of the web app type: string readOnly: true hostNames: description: Hostnames associated with web app type: array items: type: string readOnly: true repositorySiteName: description: Name of repository site type: string readOnly: true usageState: description: State indicating whether web app has exceeded its quota usage enum: - Normal - Exceeded type: string readOnly: true x-ms-enum: name: UsageState modelAsString: false enabled: description: True if the site is enabled; otherwise, false. Setting this value to false disables the site (takes the site off line). type: boolean enabledHostNames: description: "Hostnames for the web app that are enabled. Hostnames need to be assigned and enabled. If some hostnames are assigned but not enabled\r\n the app is not served on those hostnames" type: array items: type: string readOnly: true availabilityState: description: "Management information availability state for the web app. Possible values are Normal or Limited. \r\n Normal means that the site is running correctly and that management information for the site is available. \r\n Limited means that only partial management information for the site is available and that detailed site information is unavailable." enum: - Normal - Limited - DisasterRecoveryMode type: string readOnly: true x-ms-enum: name: SiteAvailabilityState modelAsString: false hostNameSslStates: description: Hostname SSL states are used to manage the SSL bindings for site's hostnames. type: array items: $ref: '#/definitions/HostNameSslState' serverFarmId: type: string lastModifiedTimeUtc: format: date-time description: Last time web app was modified in UTC type: string readOnly: true siteConfig: $ref: '#/definitions/SiteConfig' description: Configuration of web app trafficManagerHostNames: description: Read-only list of Azure Traffic manager hostnames associated with web app type: array items: type: string readOnly: true premiumAppDeployed: description: If set indicates whether web app is deployed as a premium app type: boolean readOnly: true scmSiteAlsoStopped: description: If set indicates whether to stop SCM (KUDU) site when the web app is stopped. Default is false. type: boolean targetSwapSlot: description: Read-only property that specifies which slot this app will swap into type: string readOnly: true hostingEnvironmentProfile: $ref: '#/definitions/HostingEnvironmentProfile' description: Specification for the hosting environment (App Service Environment) to use for the web app microService: description: '' type: string gatewaySiteName: description: Name of gateway app associated with web app type: string clientAffinityEnabled: description: Specifies if the client affinity is enabled when load balancing http request for multiple instances of the web app type: boolean clientCertEnabled: description: Specifies if the client certificate is enabled for the web app type: boolean hostNamesDisabled: description: "Specifies if the public hostnames are disabled the web app.\r\n If set to true the app is only accessible via API Management process" type: boolean outboundIpAddresses: description: List of comma separated IP addresses that this web app uses for outbound connections. Those can be used when configuring firewall rules for databases accessed by this web app. type: string readOnly: true containerSize: format: int32 description: Size of a function container type: integer maxNumberOfWorkers: format: int32 description: "Maximum number of workers\r\n This only applies to function container" type: integer cloningInfo: $ref: '#/definitions/CloningInfo' description: "This is only valid for web app creation. If specified, web app is cloned from \r\n a source web app" resourceGroup: description: Resource group web app belongs to type: string readOnly: true isDefaultContainer: description: Site is a default container type: boolean readOnly: true defaultHostName: description: Default hostname of the web app type: string readOnly: true x-ms-client-flatten: true LocalizableString: description: LocalizableString object containing the name and a localized value. type: object properties: value: description: Non localized name type: string localizedValue: description: Localized name type: string AutoHealRules: description: AutoHealRules - describes the rules which can be defined for auto-heal type: object properties: triggers: $ref: '#/definitions/AutoHealTriggers' description: Triggers - Conditions that describe when to execute the auto-heal actions actions: $ref: '#/definitions/AutoHealActions' description: Actions - Actions to be executed when a rule is triggered RequestsBasedTrigger: description: RequestsBasedTrigger type: object properties: count: format: int32 description: Count type: integer timeInterval: description: TimeInterval type: string AutoHealTriggers: description: AutoHealTriggers - describes the triggers for auto-heal. type: object properties: requests: $ref: '#/definitions/RequestsBasedTrigger' description: Requests - Defines a rule based on total requests privateBytesInKB: format: int32 description: PrivateBytesInKB - Defines a rule based on private bytes type: integer statusCodes: description: StatusCodes - Defines a rule based on status codes type: array items: $ref: '#/definitions/StatusCodesBasedTrigger' slowRequests: $ref: '#/definitions/SlowRequestsBasedTrigger' description: SlowRequests - Defines a rule based on request execution time IpSecurityRestriction: description: Represents an ip security restriction on a web app. type: object properties: ipAddress: description: IP address the security restriction is valid for type: string subnetMask: description: Subnet mask for the range of IP addresses the restriction is valid for type: string HandlerMapping: description: "The IIS handler mappings used to define which handler processes HTTP requests with certain extension. \r\n For example it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension." type: object properties: extension: description: Requests with this extension will be handled using the specified FastCGI application. type: string scriptProcessor: description: The absolute path to the FastCGI application. type: string arguments: description: Command-line arguments to be passed to the script processor. type: string SkuCapacity: description: Description of the App Service Plan scale options type: object properties: minimum: format: int32 description: Minimum number of Workers for this App Service Plan SKU type: integer maximum: format: int32 description: Maximum number of Workers for this App Service Plan SKU type: integer default: format: int32 description: Default number of Workers for this App Service Plan SKU type: integer scaleType: description: Available scale configurations for an App Service Plan type: string NameValuePair: description: Name value pair type: object properties: name: description: Pair name type: string value: description: Pair value type: string HostingEnvironmentCollection: description: Collection of hosting environments (App Service Environments) type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/HostingEnvironment' nextLink: description: Link to next page of resources type: string Usage: description: Class that represents usage of the quota resource. type: object allOf: - $ref: '#/definitions/Resource' properties: properties: properties: displayName: description: Friendly name shown in the UI type: string name: description: Name of the quota type: string resourceName: description: Name of the quota resource type: string unit: description: Units of measurement for the quota resource type: string currentValue: format: int64 description: The current value of the resource counter type: integer limit: format: int64 description: The resource limit type: integer nextResetTime: format: date-time description: Next reset time for the resource counter type: string computeMode: description: ComputeMode used for this usage enum: - Shared - Dedicated - Dynamic type: string x-ms-enum: name: ComputeModeOptions modelAsString: false siteMode: description: SiteMode used for this usage type: string x-ms-client-flatten: true StampCapacityCollection: description: Collection of stamp capacities type: object properties: value: description: Collection of resources type: array items: $ref: '#/definitions/StampCapacity' nextLink: description: Link to next page of resources type: string Object: type: object properties: {} ApiDefinitionInfo: description: Information about the formal API definition for the web app. type: object properties: url: description: The URL of the API definition. type: string StampCapacity: description: Class containing stamp capacity information type: object properties: name: description: Name of the stamp type: string availableCapacity: format: int64 description: Available capacity (# of machines, bytes of storage etc...) type: integer totalCapacity: format: int64 description: Total capacity (# of machines, bytes of storage etc...) type: integer unit: description: Name of the unit type: string computeMode: description: Shared/Dedicated workers enum: - Shared - Dedicated - Dynamic type: string x-ms-enum: name: ComputeModeOptions modelAsString: false workerSize: description: Size of the machines enum: - Default - Small - Medium - Large type: string x-ms-enum: name: WorkerSizeOptions modelAsString: false workerSizeId: format: int32 description: "Size Id of machines: \r\n 0 - Small\r\n 1 - Medium\r\n 2 - Large" type: integer excludeFromCapacityAllocation: description: "If true it includes basic sites\r\n Basic sites are not used for capacity allocation." type: boolean isApplicableForAllComputeModes: description: Is capacity applicable for all sites? type: boolean siteMode: description: Shared or Dedicated type: string ResourceMetric: description: Object representing a metric for any resource type: object properties: name: $ref: '#/definitions/ResourceMetricName' description: Name of metric unit: description: Metric unit type: string timeGrain: description: Metric granularity. E.g PT1H, PT5M, P1D type: string startTime: format: date-time description: Metric start time type: string endTime: format: date-time description: Metric end time type: string resourceId: description: Metric resource Id type: string metricValues: description: Metric values type: array items: $ref: '#/definitions/ResourceMetricValue' properties: description: Properties type: array items: $ref: '#/definitions/KeyValuePair[String,String]' VirtualDirectory: type: object properties: virtualPath: type: string physicalPath: type: string parameters: apiVersionParameter: name: api-version in: query description: API Version required: true type: string subscriptionIdParameter: name: subscriptionId in: path description: Subscription Id required: true type: string x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'