{
"swagger": "2.0",
"info": {
"title": "WebApps API Client",
"version": "2025-05-01",
"x-typespec-generated": [
{
"emitter": "@azure-tools/typespec-autorest"
}
]
},
"schemes": [
"https"
],
"host": "management.azure.com",
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"security": [
{
"azure_auth": [
"user_impersonation"
]
}
],
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"description": "Azure Active Directory OAuth2 Flow.",
"flow": "implicit",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
},
"tags": [
{
"name": "Provider"
},
{
"name": "Operations"
},
{
"name": "AppServiceEnvironments"
},
{
"name": "Recommendations"
},
{
"name": "StaticSites"
},
{
"name": "WebApps"
},
{
"name": "AppServicePlans"
},
{
"name": "Certificates"
},
{
"name": "SiteCertificates"
},
{
"name": "DeletedWebApps"
},
{
"name": "Global"
},
{
"name": "Diagnostics"
},
{
"name": "KubeEnvironments"
},
{
"name": "ResourceHealthMetadata"
},
{
"name": "Workflows"
},
{
"name": "WorkflowRuns"
},
{
"name": "WorkflowRunActions"
},
{
"name": "WorkflowTriggers"
},
{
"name": "WorkflowTriggerHistories"
},
{
"name": "WorkflowVersions"
}
],
"paths": {
"/providers/Microsoft.Web/availableStacks": {
"get": {
"operationId": "Provider_GetAvailableStacks",
"tags": [
"Provider"
],
"summary": "Get available application frameworks and their versions",
"description": "Description for Get available application frameworks and their versions",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "osTypeSelected",
"in": "query",
"required": false,
"type": "string",
"enum": [
"Windows",
"Linux",
"WindowsFunctions",
"LinuxFunctions",
"All"
],
"x-ms-enum": {
"name": "ProviderOsTypeSelected",
"modelAsString": true,
"values": [
{
"name": "Windows",
"value": "Windows"
},
{
"name": "Linux",
"value": "Linux"
},
{
"name": "WindowsFunctions",
"value": "WindowsFunctions"
},
{
"name": "LinuxFunctions",
"value": "LinuxFunctions"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ApplicationStackCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Web/functionAppStacks": {
"get": {
"operationId": "Provider_GetFunctionAppStacks",
"tags": [
"Provider"
],
"summary": "Get available Function app frameworks and their versions",
"description": "Description for Get available Function app frameworks and their versions",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "stackOsType",
"in": "query",
"description": "Stack OS Type",
"required": false,
"type": "string",
"enum": [
"Windows",
"Linux",
"All"
],
"x-ms-enum": {
"name": "ProviderStackOsType",
"modelAsString": true,
"values": [
{
"name": "Windows",
"value": "Windows"
},
{
"name": "Linux",
"value": "Linux"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/FunctionAppStackCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Function App Stacks": {
"$ref": "./examples/GetFunctionAppStacks.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Web/locations/{location}/functionAppStacks": {
"get": {
"operationId": "Provider_GetFunctionAppStacksForLocation",
"tags": [
"Provider"
],
"summary": "Get available Function app frameworks and their versions for location",
"description": "Description for Get available Function app frameworks and their versions for location",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
},
{
"name": "stackOsType",
"in": "query",
"description": "Stack OS Type",
"required": false,
"type": "string",
"enum": [
"Windows",
"Linux",
"All"
],
"x-ms-enum": {
"name": "ProviderStackOsType",
"modelAsString": true,
"values": [
{
"name": "Windows",
"value": "Windows"
},
{
"name": "Linux",
"value": "Linux"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/FunctionAppStackCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Locations Function App Stacks": {
"$ref": "./examples/GetFunctionAppStacksForLocation.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Web/locations/{location}/webAppStacks": {
"get": {
"operationId": "Provider_GetWebAppStacksForLocation",
"tags": [
"Provider"
],
"summary": "Get available Web app frameworks and their versions for location",
"description": "Description for Get available Web app frameworks and their versions for location",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
},
{
"name": "stackOsType",
"in": "query",
"description": "Stack OS Type",
"required": false,
"type": "string",
"enum": [
"Windows",
"Linux",
"All"
],
"x-ms-enum": {
"name": "ProviderStackOsType",
"modelAsString": true,
"values": [
{
"name": "Windows",
"value": "Windows"
},
{
"name": "Linux",
"value": "Linux"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/WebAppStackCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Locations Web App Stacks": {
"$ref": "./examples/GetWebAppStacksForLocation.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Web/operations": {
"get": {
"operationId": "Provider_ListOperations",
"tags": [
"Provider",
"Operations"
],
"summary": "Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions",
"description": "Description for Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmOperationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List operations": {
"$ref": "./examples/ListOperations.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Web/publishingUsers/web": {
"get": {
"operationId": "GetPublishingUser",
"summary": "Gets publishing user",
"description": "Description for Gets publishing user",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/User"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "UpdatePublishingUser",
"summary": "Updates publishing user",
"description": "Description for Updates publishing user",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "userDetails",
"in": "body",
"description": "Details of publishing user",
"required": true,
"schema": {
"$ref": "#/definitions/User"
}
}
],
"responses": {
"200": {
"description": "Resource 'User' update operation succeeded",
"schema": {
"$ref": "#/definitions/User"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/providers/Microsoft.Web/sourcecontrols": {
"get": {
"operationId": "ListSourceControls",
"summary": "Gets the source controls available for Azure websites.",
"description": "Description for Gets the source controls available for Azure websites.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SourceControlCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/providers/Microsoft.Web/sourcecontrols/{sourceControlType}": {
"get": {
"operationId": "GetSourceControl",
"summary": "Gets source control token",
"description": "Description for Gets source control token",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "sourceControlType",
"in": "path",
"description": "Type of source control",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "UpdateSourceControl",
"summary": "Updates source control token",
"description": "Description for Updates source control token",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "sourceControlType",
"in": "path",
"description": "Type of source control",
"required": true,
"type": "string"
},
{
"name": "requestMessage",
"in": "body",
"description": "Source control token information",
"required": true,
"schema": {
"$ref": "#/definitions/SourceControl"
}
}
],
"responses": {
"200": {
"description": "Resource 'SourceControl' update operation succeeded",
"schema": {
"$ref": "#/definitions/SourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/providers/Microsoft.Web/webAppStacks": {
"get": {
"operationId": "Provider_GetWebAppStacks",
"tags": [
"Provider"
],
"summary": "Get available Web app frameworks and their versions",
"description": "Description for Get available Web app frameworks and their versions",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"name": "stackOsType",
"in": "query",
"description": "Stack OS Type",
"required": false,
"type": "string",
"enum": [
"Windows",
"Linux",
"All"
],
"x-ms-enum": {
"name": "ProviderStackOsType",
"modelAsString": true,
"values": [
{
"name": "Windows",
"value": "Windows"
},
{
"name": "Linux",
"value": "Linux"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/WebAppStackCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Web App Stacks": {
"$ref": "./examples/GetWebAppStacks.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/aseRegions": {
"get": {
"operationId": "ListAseRegions",
"summary": "Get a list of available ASE regions and its supported Skus.",
"description": "Description for get a list of available ASE regions and its supported Skus.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/AseRegionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List aseregions": {
"$ref": "./examples/ListAseRegions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks": {
"get": {
"operationId": "Provider_GetAvailableStacksOnPrem",
"tags": [
"Provider"
],
"summary": "Get available application frameworks and their versions",
"description": "Description for Get available application frameworks and their versions",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "osTypeSelected",
"in": "query",
"required": false,
"type": "string",
"enum": [
"Windows",
"Linux",
"WindowsFunctions",
"LinuxFunctions",
"All"
],
"x-ms-enum": {
"name": "ProviderOsTypeSelected",
"modelAsString": true,
"values": [
{
"name": "Windows",
"value": "Windows"
},
{
"name": "Linux",
"value": "Linux"
},
{
"name": "WindowsFunctions",
"value": "WindowsFunctions"
},
{
"name": "LinuxFunctions",
"value": "LinuxFunctions"
},
{
"name": "All",
"value": "All"
}
]
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ApplicationStackCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters": {
"get": {
"operationId": "ListBillingMeters",
"summary": "Gets a list of meters for a given location.",
"description": "Description for Gets a list of meters for a given location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "billingLocation",
"in": "query",
"description": "Azure Location of billable resource",
"required": false,
"type": "string"
},
{
"name": "osType",
"in": "query",
"description": "App Service OS type meters used for",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/BillingMeterCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": {
"get": {
"operationId": "Certificates_List",
"tags": [
"Certificates"
],
"summary": "Get all certificates for a subscription.",
"description": "Description for Get all certificates for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "$filter",
"in": "query",
"description": "Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Certificates for subscription": {
"$ref": "./examples/ListCertificates.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": {
"post": {
"operationId": "CheckNameAvailability",
"summary": "Check if a resource name is available.",
"description": "Description for Check if a resource name is available.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "request",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/ResourceNameAvailabilityRequest"
},
"x-ms-client-flatten": true
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ResourceNameAvailability"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/customhostnameSites": {
"get": {
"operationId": "ListCustomHostNameSites",
"summary": "Get custom hostnames under this subscription",
"description": "Get custom hostnames under this subscription",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "hostname",
"in": "query",
"description": "Specific hostname",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/CustomHostnameSitesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get custom hostnames under subscription": {
"$ref": "./examples/ListCustomHostNameSites.json"
},
"Get specific custom hostname under subscription": {
"$ref": "./examples/ListCustomSpecificHostNameSites.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites": {
"get": {
"operationId": "DeletedWebApps_List",
"tags": [
"DeletedWebApps"
],
"summary": "Get all deleted apps for a subscription.",
"description": "Description for Get all deleted apps for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeletedWebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}": {
"get": {
"operationId": "Global_GetDeletedWebApp",
"tags": [
"Global"
],
"summary": "Get deleted app for a subscription.",
"description": "Description for Get deleted app for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "deletedSiteId",
"in": "path",
"description": "The numeric ID of the deleted app, e.g. 12345",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeletedSite"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Deleted Web App": {
"$ref": "./examples/GetDeletedWebApp.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}/snapshots": {
"get": {
"operationId": "Global_GetDeletedWebAppSnapshots",
"tags": [
"Global"
],
"summary": "Get all deleted apps for a subscription.",
"description": "Description for Get all deleted apps for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "deletedSiteId",
"in": "path",
"description": "The numeric ID of the deleted app, e.g. 12345",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Snapshot"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Deleted Web App Snapshots": {
"$ref": "./examples/GetDeletedWebAppSnapshots.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations": {
"get": {
"operationId": "GetSubscriptionDeploymentLocations",
"summary": "Gets list of available geo regions plus ministamps",
"description": "Description for Gets list of available geo regions plus ministamps",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/DeploymentLocations"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": {
"get": {
"operationId": "ListGeoRegions",
"summary": "Get a list of available geographical regions.",
"description": "Description for Get a list of available geographical regions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "sku",
"in": "query",
"description": "Name of SKU used to filter the regions.",
"required": false,
"type": "string",
"enum": [
"Free",
"Shared",
"Basic",
"Standard",
"Premium",
"Dynamic",
"Isolated",
"IsolatedV2",
"PremiumV2",
"PremiumV3",
"PremiumContainer",
"ElasticPremium",
"ElasticIsolated",
"FlexConsumption"
],
"x-ms-enum": {
"name": "SkuName",
"modelAsString": true,
"values": [
{
"name": "Free",
"value": "Free"
},
{
"name": "Shared",
"value": "Shared"
},
{
"name": "Basic",
"value": "Basic"
},
{
"name": "Standard",
"value": "Standard"
},
{
"name": "Premium",
"value": "Premium"
},
{
"name": "Dynamic",
"value": "Dynamic"
},
{
"name": "Isolated",
"value": "Isolated"
},
{
"name": "IsolatedV2",
"value": "IsolatedV2"
},
{
"name": "PremiumV2",
"value": "PremiumV2"
},
{
"name": "PremiumV3",
"value": "PremiumV3"
},
{
"name": "PremiumContainer",
"value": "PremiumContainer"
},
{
"name": "ElasticPremium",
"value": "ElasticPremium"
},
{
"name": "ElasticIsolated",
"value": "ElasticIsolated"
},
{
"name": "FlexConsumption",
"value": "FlexConsumption"
}
]
}
},
{
"name": "linuxWorkersEnabled",
"in": "query",
"description": "Specify true if you want to filter to only regions that support Linux workers.",
"required": false,
"type": "boolean"
},
{
"name": "xenonWorkersEnabled",
"in": "query",
"description": "Specify true if you want to filter to only regions that support Xenon workers.",
"required": false,
"type": "boolean"
},
{
"name": "linuxDynamicWorkersEnabled",
"in": "query",
"description": "Specify true if you want to filter to only regions that support Linux Consumption Workers.",
"required": false,
"type": "boolean"
},
{
"name": "customModeWorkersEnabled",
"in": "query",
"description": "Specify true if you want to filter to only regions that support App Service Plans with IsCustomMode set to true.",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/GeoRegionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/hostingEnvironments": {
"get": {
"operationId": "AppServiceEnvironments_List",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get all App Service Environments for a subscription.",
"description": "Description for Get all App Service Environments for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all App Service Environments for a subscription.": {
"$ref": "./examples/AppServiceEnvironments_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/kubeEnvironments": {
"get": {
"operationId": "KubeEnvironments_ListBySubscription",
"tags": [
"KubeEnvironments"
],
"summary": "Get all Kubernetes Environments for a subscription.",
"description": "Description for Get all Kubernetes Environments for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KubeEnvironmentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List kube environments by subscription": {
"$ref": "./examples/KubeEnvironments_ListBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName": {
"post": {
"operationId": "ListSiteIdentifiersAssignedToHostName",
"summary": "List all apps that are assigned to a hostname.",
"description": "Description for List all apps that are assigned to a hostname.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "nameIdentifier",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/NameIdentifier"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/IdentifierCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/checknameavailability": {
"post": {
"operationId": "RegionalCheckNameAvailability",
"summary": "Check if a resource name is available for DNL sites.",
"description": "Check if a resource name is available for DNL sites.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
},
{
"name": "request",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/DnlResourceNameAvailabilityRequest"
},
"x-ms-client-flatten": true
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/DnlResourceNameAvailability"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites": {
"get": {
"operationId": "DeletedWebApps_ListByLocation",
"tags": [
"DeletedWebApps"
],
"summary": "Get all deleted apps for a subscription at location",
"description": "Description for Get all deleted apps for a subscription at location",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeletedWebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Deleted Web App by Location": {
"$ref": "./examples/ListDeletedWebAppsByLocation.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites/{deletedSiteId}": {
"get": {
"operationId": "DeletedWebApps_GetDeletedWebAppByLocation",
"tags": [
"DeletedWebApps"
],
"summary": "Get deleted app for a subscription at location.",
"description": "Description for Get deleted app for a subscription at location.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
},
{
"name": "deletedSiteId",
"in": "path",
"description": "The numeric ID of the deleted app, e.g. 12345",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeletedSite"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Deleted Web App by Location": {
"$ref": "./examples/GetDeletedWebAppByLocation.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/operations/{operationId}": {
"get": {
"operationId": "Global_GetSubscriptionOperationWithAsyncResponse",
"tags": [
"Global"
],
"summary": "Gets an operation in a subscription and given region",
"description": "Description for Gets an operation in a subscription and given region",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
},
{
"name": "operationId",
"in": "path",
"description": "Operation Id",
"required": true,
"type": "string"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets an operation in a subscription and given region": {
"$ref": "./examples/GetSubscriptionOperationWithAsyncResponse.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile": {
"post": {
"operationId": "StaticSites_PreviewWorkflow",
"tags": [
"StaticSites"
],
"summary": "Generates a preview workflow file for the static site",
"description": "Description for Generates a preview workflow file for the static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
},
{
"name": "staticSitesWorkflowPreviewRequest",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSitesWorkflowPreviewRequest"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/StaticSitesWorkflowPreview"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Generates a preview workflow file for the static site": {
"$ref": "./examples/GenerateStaticSiteWorkflowPreview.json"
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/usages": {
"get": {
"operationId": "GetUsagesInLocation_list",
"summary": "Lists subscription core usages for all skus used in a location, for a given type of quota.",
"description": "List usages in cores for all skus used by a subscription in a given location, for a specific quota type.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/LocationParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/CsmUsageQuotaCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get usages in location for subscription": {
"$ref": "./examples/GetUsagesInLocation.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": {
"get": {
"operationId": "ListPremierAddOnOffers",
"summary": "List all premier add-on offers.",
"description": "Description for List all premier add-on offers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/PremierAddOnOfferCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations": {
"get": {
"operationId": "Recommendations_List",
"tags": [
"Recommendations"
],
"summary": "List all recommendations for a subscription.",
"description": "Description for List all recommendations for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "featured",
"in": "query",
"description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.",
"required": false,
"type": "boolean"
},
{
"name": "$filter",
"in": "query",
"description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/RecommendationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/{name}/disable": {
"post": {
"operationId": "Recommendations_DisableRecommendationForSubscription",
"tags": [
"Recommendations"
],
"summary": "Disables the specified rule so it will not apply to a subscription in the future.",
"description": "Description for Disables the specified rule so it will not apply to a subscription in the future.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "name",
"in": "path",
"description": "Rule name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/reset": {
"post": {
"operationId": "Recommendations_ResetAllFilters",
"tags": [
"Recommendations"
],
"summary": "Reset all recommendation opt-out settings for a subscription.",
"description": "Description for Reset all recommendation opt-out settings for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful. "
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata": {
"get": {
"operationId": "ResourceHealthMetadata_List",
"tags": [
"ResourceHealthMetadata"
],
"summary": "List all ResourceHealthMetadata for all sites in the subscription.",
"description": "Description for List all ResourceHealthMetadata for all sites in the subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/ResourceHealthMetadataCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List ResourceHealthMetadata for a subscription": {
"$ref": "./examples/ListResourceHealthMetadataBySubscription.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": {
"get": {
"operationId": "AppServicePlans_List",
"tags": [
"AppServicePlans"
],
"summary": "Get all App Service plans for a subscription.",
"description": "Description for Get all App Service plans for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "detailed",
"in": "query",
"description": "Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties.\nRetrieval of all properties may increase the API latency.",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServicePlanCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Service plans": {
"$ref": "./examples/ListAppServicePlans.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": {
"get": {
"operationId": "WebApps_List",
"tags": [
"WebApps"
],
"summary": "Get all apps for a subscription.",
"description": "Description for Get all apps for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Web apps for subscription": {
"$ref": "./examples/ListWebApps.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/skus": {
"get": {
"operationId": "ListSkus",
"summary": "List all SKUs.",
"description": "Description for List all SKUs.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/SkuInfos"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites": {
"get": {
"operationId": "StaticSites_List",
"tags": [
"StaticSites"
],
"summary": "Get all Static Sites for a subscription.",
"description": "Description for Get all Static Sites for a subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all static sites in a subscription": {
"$ref": "./examples/GetAllStaticSites.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet": {
"post": {
"operationId": "VerifyHostingEnvironmentVnet",
"summary": "Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.",
"description": "Description for Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "parameters",
"in": "body",
"description": "The request body",
"required": true,
"schema": {
"$ref": "#/definitions/VnetParameters"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/VnetValidationFailureDetails"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"VerifyHostingEnvironmentVnet": {
"$ref": "./examples/VerifyHostingEnvironmentVnet.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": {
"post": {
"operationId": "Move",
"summary": "Move resources between resource groups.",
"description": "Description for Move resources between resource groups.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "moveResourceEnvelope",
"in": "body",
"description": "Object that represents the resource to move.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmMoveResourceEnvelope"
}
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": {
"get": {
"operationId": "Certificates_ListByResourceGroup",
"tags": [
"Certificates"
],
"summary": "Get all certificates in a resource group.",
"description": "Description for Get all certificates in a resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Certificates by resource group": {
"$ref": "./examples/ListCertificatesByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": {
"get": {
"operationId": "Certificates_Get",
"tags": [
"Certificates"
],
"summary": "Get a certificate.",
"description": "Description for Get a certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Certificate": {
"$ref": "./examples/GetCertificate.json"
}
}
},
"put": {
"operationId": "Certificates_CreateOrUpdate",
"tags": [
"Certificates"
],
"summary": "Create or update a certificate.",
"description": "Description for Create or update a certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Details of certificate, if it exists already.",
"required": true,
"schema": {
"$ref": "#/definitions/Certificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'Certificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create Or Update Certificate": {
"$ref": "./examples/CreateOrUpdateCertificate.json"
}
}
},
"patch": {
"operationId": "Certificates_Update",
"tags": [
"Certificates"
],
"summary": "Create or update a certificate.",
"description": "Description for Create or update a certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Details of certificate, if it exists already.",
"required": true,
"schema": {
"$ref": "#/definitions/CertificatePatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Certificate": {
"$ref": "./examples/PatchCertificate.json"
}
}
},
"delete": {
"operationId": "Certificates_Delete",
"tags": [
"Certificates"
],
"summary": "Delete a certificate.",
"description": "Description for Delete a certificate.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate": {
"$ref": "./examples/DeleteCertificate.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments": {
"get": {
"operationId": "AppServiceEnvironments_ListByResourceGroup",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get all App Service Environments in a resource group.",
"description": "Description for Get all App Service Environments in a resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all App Service Environments in a resource group.": {
"$ref": "./examples/AppServiceEnvironments_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}": {
"get": {
"operationId": "AppServiceEnvironments_Get",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get the properties of an App Service Environment.",
"description": "Description for Get the properties of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the properties of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_Get.json"
}
}
},
"put": {
"operationId": "AppServiceEnvironments_CreateOrUpdate",
"tags": [
"AppServiceEnvironments"
],
"summary": "Create or update an App Service Environment.",
"description": "Description for Create or update an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "hostingEnvironmentEnvelope",
"in": "body",
"description": "Configuration details of the App Service Environment.",
"required": true,
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'AppServiceEnvironmentResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"201": {
"description": "Resource 'AppServiceEnvironmentResource' create operation succeeded",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/AppServiceEnvironmentResource"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "AppServiceEnvironments_Update",
"tags": [
"AppServiceEnvironments"
],
"summary": "Create or update an App Service Environment.",
"description": "Description for Create or update an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "hostingEnvironmentEnvelope",
"in": "body",
"description": "Configuration details of the App Service Environment.",
"required": true,
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentPatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"201": {
"description": "Resource 'AppServiceEnvironmentResource' create operation succeeded",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_Update.json"
}
}
},
"delete": {
"operationId": "AppServiceEnvironments_Delete",
"tags": [
"AppServiceEnvironments"
],
"summary": "Delete an App Service Environment.",
"description": "Description for Delete an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "forceDelete",
"in": "query",
"description": "Specify true to force the deletion even if the App Service Environment contains resources. The default is false.",
"required": false,
"type": "boolean"
}
],
"responses": {
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": {
"get": {
"operationId": "AppServiceEnvironments_ListCapacities",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get the used, available, and total worker capacity an App Service Environment.",
"description": "Description for Get the used, available, and total worker capacity an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StampCapacityCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the used, available, and total worker capacity an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListCapacities.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": {
"get": {
"operationId": "AppServiceEnvironments_GetVipInfo",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get IP addresses assigned to an App Service Environment.",
"description": "Description for Get IP addresses assigned to an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AddressResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get IP addresses assigned to an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_GetVipInfo.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork": {
"post": {
"operationId": "AppServiceEnvironments_ChangeVnet",
"tags": [
"AppServiceEnvironments"
],
"summary": "Move an App Service Environment to a different VNET.",
"description": "Description for Move an App Service Environment to a different VNET.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "vnetInfo",
"in": "body",
"description": "Details for the new virtual network.",
"required": true,
"schema": {
"$ref": "#/definitions/VirtualNetworkProfile"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Move an App Service Environment to a different VNET.": {
"$ref": "./examples/AppServiceEnvironments_ChangeVnet.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/WebAppCollection"
},
"x-ms-long-running-operation": true,
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/customdnssuffix": {
"get": {
"operationId": "AppServiceEnvironments_GetAseCustomDnsSuffixConfiguration",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get Custom Dns Suffix configuration of an App Service Environment",
"description": "Get Custom Dns Suffix configuration of an App Service Environment",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CustomDnsSuffixConfiguration"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get ASE custom DNS suffix configuration": {
"$ref": "./examples/GetAseCustomDnsSuffixConfiguration.json"
}
}
},
"put": {
"operationId": "AppServiceEnvironments_UpdateAseCustomDnsSuffixConfiguration",
"tags": [
"AppServiceEnvironments"
],
"summary": "Update Custom Dns Suffix configuration of an App Service Environment",
"description": "Update Custom Dns Suffix configuration of an App Service Environment",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "customDnsSuffixConfiguration",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/CustomDnsSuffixConfiguration"
}
}
],
"responses": {
"200": {
"description": "Resource 'CustomDnsSuffixConfiguration' update operation succeeded",
"schema": {
"$ref": "#/definitions/CustomDnsSuffixConfiguration"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update ASE custom DNS suffix configuration": {
"$ref": "./examples/UpdateAseCustomDnsSuffixConfiguration.json"
}
}
},
"delete": {
"operationId": "AppServiceEnvironments_DeleteAseCustomDnsSuffixConfiguration",
"tags": [
"AppServiceEnvironments"
],
"summary": "Delete Custom Dns Suffix configuration of an App Service Environment",
"description": "Delete Custom Dns Suffix configuration of an App Service Environment",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete ASE custom DNS suffix configuration": {
"$ref": "./examples/DeleteAseCustomDnsSuffixConfiguration.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/configurations/networking": {
"get": {
"operationId": "AppServiceEnvironments_GetAseV3NetworkingConfiguration",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get networking configuration of an App Service Environment",
"description": "Description for Get networking configuration of an App Service Environment",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AseV3NetworkingConfiguration"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get networking configuration of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_GetAseV3NetworkingConfiguration.json"
}
}
},
"put": {
"operationId": "AppServiceEnvironments_UpdateAseNetworkingConfiguration",
"tags": [
"AppServiceEnvironments"
],
"summary": "Update networking configuration of an App Service Environment",
"description": "Description for Update networking configuration of an App Service Environment",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "aseNetworkingConfiguration",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/AseV3NetworkingConfiguration"
}
}
],
"responses": {
"200": {
"description": "Resource 'AseV3NetworkingConfiguration' update operation succeeded",
"schema": {
"$ref": "#/definitions/AseV3NetworkingConfiguration"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update networking configuration of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_UpdateAseNetworkingConfiguration.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors": {
"get": {
"operationId": "Diagnostics_ListHostingEnvironmentDetectorResponses",
"tags": [
"Diagnostics"
],
"summary": "List Hosting Environment Detector Responses",
"description": "Description for List Hosting Environment Detector Responses",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "App Service Environment Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorResponseCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Service Environment Detector Responses": {
"$ref": "./examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}": {
"get": {
"operationId": "Diagnostics_GetHostingEnvironmentDetectorResponse",
"tags": [
"Diagnostics"
],
"summary": "Get Hosting Environment Detector Response",
"description": "Description for Get Hosting Environment Detector Response",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "App Service Environment Name",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Resource Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Service Environment Detector Responses": {
"$ref": "./examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": {
"get": {
"operationId": "AppServiceEnvironments_ListDiagnostics",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get diagnostic information for an App Service Environment.",
"description": "Description for Get diagnostic information for an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/HostingEnvironmentDiagnostics"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get diagnostic information for an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListDiagnostics.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints": {
"get": {
"operationId": "AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get the network endpoints of all inbound dependencies of an App Service Environment.",
"description": "Description for Get the network endpoints of all inbound dependencies of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/InboundEnvironmentEndpointCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the network endpoints of all inbound dependencies of an App Service Environment.": {
"$ref": "./examples/GetInboundNetworkDependenciesEndpoints.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": {
"get": {
"operationId": "AppServiceEnvironments_ListMultiRolePools",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get all multi-role pools.",
"description": "Description for Get all multi-role pools.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkerPoolCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all multi-role pools.": {
"$ref": "./examples/AppServiceEnvironments_ListMultiRolePools.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": {
"get": {
"operationId": "AppServiceEnvironments_GetMultiRolePool",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get properties of a multi-role pool.",
"description": "Description for Get properties of a multi-role pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get properties of a multi-role pool.": {
"$ref": "./examples/AppServiceEnvironments_GetMultiRolePool.json"
}
}
},
"put": {
"operationId": "AppServiceEnvironments_CreateOrUpdateMultiRolePool",
"tags": [
"AppServiceEnvironments"
],
"summary": "Create or update a multi-role pool.",
"description": "Description for Create or update a multi-role pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "multiRolePoolEnvelope",
"in": "body",
"description": "Properties of the multi-role pool.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'WorkerPoolResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a multi-role pool.": {
"$ref": "./examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/WorkerPoolResource"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "AppServiceEnvironments_UpdateMultiRolePool",
"tags": [
"AppServiceEnvironments"
],
"summary": "Create or update a multi-role pool.",
"description": "Description for Create or update a multi-role pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "multiRolePoolEnvelope",
"in": "body",
"description": "Properties of the multi-role pool.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a multi-role pool.": {
"$ref": "./examples/AppServiceEnvironments_CreateOrUpdateMultiRolePool_UpdateMultiRolePool.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": {
"get": {
"operationId": "AppServiceEnvironments_ListMultiRoleMetricDefinitions",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get metric definitions for a multi-role pool of an App Service Environment.",
"description": "Description for Get metric definitions for a multi-role pool of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceMetricDefinitionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get metric definitions for a multi-role pool of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListMultiRoleMetricDefinitions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": {
"get": {
"operationId": "AppServiceEnvironments_ListMultiRolePoolSkus",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get available SKUs for scaling a multi-role pool.",
"description": "Description for Get available SKUs for scaling a multi-role pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SkuInfoCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get available SKUs for scaling a multi-role pool.": {
"$ref": "./examples/AppServiceEnvironments_ListMultiRolePoolSkus.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": {
"get": {
"operationId": "AppServiceEnvironments_ListMultiRoleUsages",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get usage metrics for a multi-role pool of an App Service Environment.",
"description": "Description for Get usage metrics for a multi-role pool of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/UsageCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get usage metrics for a multi-role pool of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListMultiRoleUsages.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": {
"get": {
"operationId": "AppServiceEnvironments_ListOperations",
"tags": [
"AppServiceEnvironments"
],
"summary": "List all currently running operations on the App Service Environment.",
"description": "Description for List all currently running operations on the App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Operation"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List all currently running operations on the App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListOperations.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints": {
"get": {
"operationId": "AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get the network endpoints of all outbound dependencies of an App Service Environment.",
"description": "Description for Get the network endpoints of all outbound dependencies of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/OutboundEnvironmentEndpointCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the network endpoints of all outbound dependencies of an App Service Environment.": {
"$ref": "./examples/GetOutboundNetworkDependenciesEndpoints.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections": {
"get": {
"operationId": "AppServiceEnvironments_GetPrivateEndpointConnectionList",
"tags": [
"AppServiceEnvironments"
],
"summary": "Gets the list of private endpoints associated with a hosting environment",
"description": "Description for Gets the list of private endpoints associated with a hosting environment",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets the list of private endpoints associated with a hosting environment.": {
"$ref": "./examples/AppServiceEnvironments_GetPrivateEndpointConnectionList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"operationId": "AppServiceEnvironments_GetPrivateEndpointConnection",
"tags": [
"AppServiceEnvironments"
],
"summary": "Gets a private endpoint connection",
"description": "Description for Gets a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets a private endpoint connection.": {
"$ref": "./examples/AppServiceEnvironments_GetPrivateEndpointConnection.json"
}
}
},
"put": {
"operationId": "AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection",
"tags": [
"AppServiceEnvironments"
],
"summary": "Approves or rejects a private endpoint connection",
"description": "Description for Approves or rejects a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointWrapper",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Approves or rejects a private endpoint connection.": {
"$ref": "./examples/AppServiceEnvironments_ApproveOrRejectPrivateEndpointConnection.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "AppServiceEnvironments_DeletePrivateEndpointConnection",
"tags": [
"AppServiceEnvironments"
],
"summary": "Deletes a private endpoint connection",
"description": "Description for Deletes a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Deletes a private endpoint connection.": {
"$ref": "./examples/AppServiceEnvironments_DeletePrivateEndpointConnection.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/privateLinkResources": {
"get": {
"operationId": "AppServiceEnvironments_GetPrivateLinkResources",
"tags": [
"AppServiceEnvironments"
],
"summary": "Gets the private link resources",
"description": "Description for Gets the private link resources",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateLinkResourcesWrapper"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets the private link resources.": {
"$ref": "./examples/AppServiceEnvironments_GetPrivateLinkResources.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": {
"post": {
"operationId": "AppServiceEnvironments_Reboot",
"tags": [
"AppServiceEnvironments"
],
"summary": "Reboot all machines in an App Service Environment.",
"description": "Description for Reboot all machines in an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Reboot all machines in an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_Reboot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory": {
"get": {
"operationId": "Recommendations_ListHistoryForHostingEnvironment",
"tags": [
"Recommendations"
],
"summary": "Get past recommendations for an app, optionally specified by the time range.",
"description": "Description for Get past recommendations for an app, optionally specified by the time range.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "hostingEnvironmentName",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "expiredOnly",
"in": "query",
"description": "Specify false to return all recommendations. The default is true, which returns only expired recommendations.",
"required": false,
"type": "boolean"
},
{
"name": "$filter",
"in": "query",
"description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RecommendationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations": {
"get": {
"operationId": "Recommendations_ListRecommendedRulesForHostingEnvironment",
"tags": [
"Recommendations"
],
"summary": "Get all recommendations for a hosting environment.",
"description": "Description for Get all recommendations for a hosting environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "hostingEnvironmentName",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "featured",
"in": "query",
"description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.",
"required": false,
"type": "boolean"
},
{
"name": "$filter",
"in": "query",
"description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RecommendationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}": {
"get": {
"operationId": "Recommendations_GetRuleDetailsByHostingEnvironment",
"tags": [
"Recommendations"
],
"summary": "Get a recommendation rule for an app.",
"description": "Description for Get a recommendation rule for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "hostingEnvironmentName",
"in": "path",
"description": "Name of the hosting environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"description": "Name of the recommendation.",
"required": true,
"type": "string"
},
{
"name": "updateSeen",
"in": "query",
"description": "Specify true to update the last-seen timestamp of the recommendation object.",
"required": false,
"type": "boolean"
},
{
"name": "recommendationId",
"in": "query",
"description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RecommendationRule"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}/disable": {
"post": {
"operationId": "Recommendations_DisableRecommendationForHostingEnvironment",
"tags": [
"Recommendations"
],
"summary": "Disables the specific rule for a web site permanently.",
"description": "Description for Disables the specific rule for a web site permanently.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "hostingEnvironmentName",
"in": "path",
"description": "Name of the hosting environment.",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"description": "Name of the recommendation.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "query",
"description": "Site name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/disable": {
"post": {
"operationId": "Recommendations_DisableAllForHostingEnvironment",
"tags": [
"Recommendations"
],
"summary": "Disable all recommendations for an app.",
"description": "Description for Disable all recommendations for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "hostingEnvironmentName",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "query",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/reset": {
"post": {
"operationId": "Recommendations_ResetAllFiltersForHostingEnvironment",
"tags": [
"Recommendations"
],
"summary": "Reset all recommendation opt-out settings for an app.",
"description": "Description for Reset all recommendation opt-out settings for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "hostingEnvironmentName",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "query",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": {
"post": {
"operationId": "AppServiceEnvironments_Resume",
"tags": [
"AppServiceEnvironments"
],
"summary": "Resume an App Service Environment.",
"description": "Description for Resume an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Resume an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_Resume.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/WebAppCollection"
},
"x-ms-long-running-operation": true,
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": {
"get": {
"operationId": "AppServiceEnvironments_ListAppServicePlans",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get all App Service plans in an App Service Environment.",
"description": "Description for Get all App Service plans in an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServicePlanCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all App Service plans in an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListAppServicePlans.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": {
"get": {
"operationId": "AppServiceEnvironments_ListWebApps",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get all apps in an App Service Environment.",
"description": "Description for Get all apps in an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "propertiesToInclude",
"in": "query",
"description": "Comma separated list of app properties to include.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all apps in an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListWebApps.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": {
"post": {
"operationId": "AppServiceEnvironments_Suspend",
"tags": [
"AppServiceEnvironments"
],
"summary": "Suspend an App Service Environment.",
"description": "Description for Suspend an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Suspend an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_Suspend.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/WebAppCollection"
},
"x-ms-long-running-operation": true,
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/testUpgradeAvailableNotification": {
"post": {
"operationId": "AppServiceEnvironments_TestUpgradeAvailableNotification",
"tags": [
"AppServiceEnvironments"
],
"summary": "Send a test notification that an upgrade is available for this App Service Environment.",
"description": "Send a test notification that an upgrade is available for this App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Send a test notification that an upgrade is available for this App Service Environment": {
"$ref": "./examples/AppServiceEnvironments_TestUpgradeAvailableNotification.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/upgrade": {
"post": {
"operationId": "AppServiceEnvironments_Upgrade",
"tags": [
"AppServiceEnvironments"
],
"summary": "Initiate an upgrade of an App Service Environment if one is available.",
"description": "Description for Initiate an upgrade of an App Service Environment if one is available.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Initiate an upgrade on an App Service Environment": {
"$ref": "./examples/AppServiceEnvironments_Upgrade.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": {
"get": {
"operationId": "AppServiceEnvironments_ListUsages",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get global usage metrics of an App Service Environment.",
"description": "Description for Get global usage metrics of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the 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]'.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmUsageQuotaCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get global usage metrics of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListUsages.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": {
"get": {
"operationId": "AppServiceEnvironments_ListWorkerPools",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get all worker pools of an App Service Environment.",
"description": "Description for Get all worker pools of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkerPoolCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all worker pools of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListWorkerPools.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": {
"get": {
"operationId": "AppServiceEnvironments_GetWorkerPool",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get properties of a worker pool.",
"description": "Description for Get properties of a worker pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get properties of a worker pool.": {
"$ref": "./examples/AppServiceEnvironments_GetWorkerPool.json"
}
}
},
"put": {
"operationId": "AppServiceEnvironments_CreateOrUpdateWorkerPool",
"tags": [
"AppServiceEnvironments"
],
"summary": "Create or update a worker pool.",
"description": "Description for Create or update a worker pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
},
{
"name": "workerPoolEnvelope",
"in": "body",
"description": "Properties of the worker pool.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'WorkerPoolResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get properties of a worker pool.": {
"$ref": "./examples/AppServiceEnvironments_CreateOrUpdateWorkerPool_CreateOrUpdateWorkerPool.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/WorkerPoolResource"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "AppServiceEnvironments_UpdateWorkerPool",
"tags": [
"AppServiceEnvironments"
],
"summary": "Create or update a worker pool.",
"description": "Description for Create or update a worker pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
},
{
"name": "workerPoolEnvelope",
"in": "body",
"description": "Properties of the worker pool.",
"required": true,
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get properties of a worker pool.": {
"$ref": "./examples/AppServiceEnvironments_CreateOrUpdateWorkerPool.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": {
"get": {
"operationId": "AppServiceEnvironments_ListWebWorkerMetricDefinitions",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get metric definitions for a worker pool of an App Service Environment.",
"description": "Description for Get metric definitions for a worker pool of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceMetricDefinitionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get metric definitions for a worker pool of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListWebWorkerMetricDefinitions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": {
"get": {
"operationId": "AppServiceEnvironments_ListWorkerPoolSkus",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get available SKUs for scaling a worker pool.",
"description": "Description for Get available SKUs for scaling a worker pool.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SkuInfoCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get available SKUs for scaling a worker pool.": {
"$ref": "./examples/AppServiceEnvironments_ListWorkerPoolSkus.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": {
"get": {
"operationId": "AppServiceEnvironments_ListWebWorkerUsages",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get usage metrics for a worker pool of an App Service Environment.",
"description": "Description for Get usage metrics for a worker pool of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/UsageCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get usage metrics for a worker pool of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListWebWorkerUsages.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments": {
"get": {
"operationId": "KubeEnvironments_ListByResourceGroup",
"tags": [
"KubeEnvironments"
],
"summary": "Get all the Kubernetes Environments in a resource group.",
"description": "Description for Get all the Kubernetes Environments in a resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KubeEnvironmentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List kube environments by resource group": {
"$ref": "./examples/KubeEnvironments_ListByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/kubeEnvironments/{name}": {
"get": {
"operationId": "KubeEnvironments_Get",
"tags": [
"KubeEnvironments"
],
"summary": "Get the properties of a Kubernetes Environment.",
"description": "Description for Get the properties of a Kubernetes Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the Kubernetes Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KubeEnvironment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get kube environments by name": {
"$ref": "./examples/KubeEnvironments_Get.json"
}
}
},
"put": {
"operationId": "KubeEnvironments_CreateOrUpdate",
"tags": [
"KubeEnvironments"
],
"summary": "Creates or updates a Kubernetes Environment.",
"description": "Description for Creates or updates a Kubernetes Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the Kubernetes Environment.",
"required": true,
"type": "string"
},
{
"name": "kubeEnvironmentEnvelope",
"in": "body",
"description": "Configuration details of the Kubernetes Environment.",
"required": true,
"schema": {
"$ref": "#/definitions/KubeEnvironment"
}
}
],
"responses": {
"200": {
"description": "Resource 'KubeEnvironment' update operation succeeded",
"schema": {
"$ref": "#/definitions/KubeEnvironment"
}
},
"201": {
"description": "Resource 'KubeEnvironment' create operation succeeded",
"schema": {
"$ref": "#/definitions/KubeEnvironment"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create kube environments": {
"$ref": "./examples/KubeEnvironments_CreateOrUpdate.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/KubeEnvironment"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "KubeEnvironments_Update",
"tags": [
"KubeEnvironments"
],
"summary": "Creates or updates a Kubernetes Environment.",
"description": "Description for Creates or updates a Kubernetes Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the Kubernetes Environment.",
"required": true,
"type": "string"
},
{
"name": "kubeEnvironmentEnvelope",
"in": "body",
"description": "Configuration details of the Kubernetes Environment.",
"required": true,
"schema": {
"$ref": "#/definitions/KubeEnvironmentPatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KubeEnvironment"
}
},
"201": {
"description": "Resource 'KubeEnvironment' create operation succeeded",
"schema": {
"$ref": "#/definitions/KubeEnvironment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update kube environments": {
"$ref": "./examples/KubeEnvironments_Update.json"
}
}
},
"delete": {
"operationId": "KubeEnvironments_Delete",
"tags": [
"KubeEnvironments"
],
"summary": "Delete a Kubernetes Environment.",
"description": "Description for Delete a Kubernetes Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the Kubernetes Environment.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete kube environment by name": {
"$ref": "./examples/KubeEnvironments_Delete.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata": {
"get": {
"operationId": "ResourceHealthMetadata_ListByResourceGroup",
"tags": [
"ResourceHealthMetadata"
],
"summary": "List all ResourceHealthMetadata for all sites in the resource group in the subscription.",
"description": "Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceHealthMetadataCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List ResourceHealthMetadata for a resource group": {
"$ref": "./examples/ListResourceHealthMetadataByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms": {
"get": {
"operationId": "AppServicePlans_ListByResourceGroup",
"tags": [
"AppServicePlans"
],
"summary": "Get all App Service plans in a resource group.",
"description": "Description for Get all App Service plans in a resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServicePlanCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Service plans by resource group": {
"$ref": "./examples/ListAppServicePlansByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}": {
"get": {
"operationId": "AppServicePlans_Get",
"tags": [
"AppServicePlans"
],
"summary": "Get an App Service plan.",
"description": "Description for Get an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServicePlan"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Service plan": {
"$ref": "./examples/GetAppServicePlan.json"
}
}
},
"put": {
"operationId": "AppServicePlans_CreateOrUpdate",
"tags": [
"AppServicePlans"
],
"summary": "Creates or updates an App Service Plan.",
"description": "Description for Creates or updates an App Service Plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "appServicePlan",
"in": "body",
"description": "Details of the App Service plan.",
"required": true,
"schema": {
"$ref": "#/definitions/AppServicePlan"
}
}
],
"responses": {
"200": {
"description": "Resource 'AppServicePlan' update operation succeeded",
"schema": {
"$ref": "#/definitions/AppServicePlan"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/AppServicePlan"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create Or Update App Service plan": {
"$ref": "./examples/CreateOrUpdateAppServicePlan.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/AppServicePlan"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "AppServicePlans_Update",
"tags": [
"AppServicePlans"
],
"summary": "Creates or updates an App Service Plan.",
"description": "Description for Creates or updates an App Service Plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "appServicePlan",
"in": "body",
"description": "Details of the App Service plan.",
"required": true,
"schema": {
"$ref": "#/definitions/AppServicePlanPatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AppServicePlan"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/AppServicePlan"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Service plan": {
"$ref": "./examples/PatchAppServicePlan.json"
}
}
},
"delete": {
"operationId": "AppServicePlans_Delete",
"tags": [
"AppServicePlans"
],
"summary": "Delete an App Service plan.",
"description": "Description for Delete an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete App Service plan": {
"$ref": "./examples/DeleteAppServicePlan.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities": {
"get": {
"operationId": "AppServicePlans_ListCapabilities",
"tags": [
"AppServicePlans"
],
"summary": "List all capabilities of an App Service plan.",
"description": "Description for List all capabilities of an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/Capability"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/getrdppassword": {
"post": {
"operationId": "AppServicePlans_GetServerFarmRdpPassword",
"tags": [
"AppServicePlans"
],
"summary": "Get the RDP password for an IsCustomMode ServerFarm.",
"description": "Description for Get the RDP password for an IsCustomMode ServerFarm.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ServerFarmRdpDetails"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
"get": {
"operationId": "AppServicePlans_GetHybridConnection",
"tags": [
"AppServicePlans"
],
"summary": "Retrieve a Hybrid Connection in use in an App Service plan.",
"description": "Description for Retrieve a Hybrid Connection in use in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "Name of the Service Bus namespace.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "Name of the Service Bus relay.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "AppServicePlans_DeleteHybridConnection",
"tags": [
"AppServicePlans"
],
"summary": "Delete a Hybrid Connection in use in an App Service plan.",
"description": "Description for Delete a Hybrid Connection in use in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "Name of the Service Bus namespace.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "Name of the Service Bus relay.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": {
"post": {
"operationId": "AppServicePlans_ListHybridConnectionKeys",
"tags": [
"AppServicePlans"
],
"summary": "Get the send key name and value of a Hybrid Connection.",
"description": "Description for Get the send key name and value of a Hybrid Connection.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "Name of the Service Bus namespace.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "Name of the Service Bus relay.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnectionKey"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites": {
"get": {
"operationId": "AppServicePlans_ListWebAppsByHybridConnection",
"tags": [
"AppServicePlans"
],
"summary": "Get all apps that use a Hybrid Connection in an App Service Plan.",
"description": "Description for Get all apps that use a Hybrid Connection in an App Service Plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "Name of the Service Bus namespace.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "Name of the Service Bus relay.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit": {
"get": {
"operationId": "AppServicePlans_GetHybridConnectionPlanLimit",
"tags": [
"AppServicePlans"
],
"summary": "Get the maximum number of Hybrid Connections allowed in an App Service plan.",
"description": "Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnectionLimits"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays": {
"get": {
"operationId": "AppServicePlans_ListHybridConnections",
"tags": [
"AppServicePlans"
],
"summary": "Retrieve all Hybrid Connections in use in an App Service plan.",
"description": "Description for Retrieve all Hybrid Connections in use in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/listinstances": {
"post": {
"operationId": "AppServicePlans_GetServerFarmInstanceDetails",
"tags": [
"AppServicePlans"
],
"summary": "Get the instance details for an app service plan.",
"description": "Description for Get the instance details for an app service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ServerFarmInstanceDetails"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": {
"post": {
"operationId": "AppServicePlans_RestartWebApps",
"tags": [
"AppServicePlans"
],
"summary": "Restart all apps in an App Service plan.",
"description": "Description for Restart all apps in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "softRestart",
"in": "query",
"description": "Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps",
"required": false,
"type": "boolean"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": {
"get": {
"operationId": "AppServicePlans_ListWebApps",
"tags": [
"AppServicePlans"
],
"summary": "Get all apps associated with an App Service plan.",
"description": "Description for Get all apps associated with an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "$skipToken",
"in": "query",
"description": "Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list",
"required": false,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "Supported filter: $filter=state eq running. Returns only web apps that are currently running",
"required": false,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "List page size. If specified, results are paged.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus": {
"get": {
"operationId": "AppServicePlans_GetServerFarmSkus",
"tags": [
"AppServicePlans"
],
"summary": "Gets all selectable SKUs for a given App Service Plan",
"description": "Description for Gets all selectable SKUs for a given App Service Plan",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages": {
"get": {
"operationId": "AppServicePlans_ListUsages",
"tags": [
"AppServicePlans"
],
"summary": "Gets server farm usage information",
"description": "Description for Gets server farm usage information",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"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').",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmUsageQuotaCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": {
"get": {
"operationId": "AppServicePlans_ListVnets",
"tags": [
"AppServicePlans"
],
"summary": "Get all Virtual Networks associated with an App Service plan.",
"description": "Description for Get all Virtual Networks associated with an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VnetInfoResource"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": {
"get": {
"operationId": "AppServicePlans_GetVnetFromServerFarm",
"tags": [
"AppServicePlans"
],
"summary": "Get a Virtual Network associated with an App Service plan.",
"description": "Description for Get a Virtual Network associated with an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
"get": {
"operationId": "AppServicePlans_GetVnetGateway",
"tags": [
"AppServicePlans"
],
"summary": "Get a Virtual Network gateway.",
"description": "Description for Get a Virtual Network gateway.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Only the 'primary' gateway is supported.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "AppServicePlans_UpdateVnetGateway",
"tags": [
"AppServicePlans"
],
"summary": "Update a Virtual Network gateway.",
"description": "Description for Update a Virtual Network gateway.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Only the 'primary' gateway is supported.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Definition of the gateway.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetGateway"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetGateway' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes": {
"get": {
"operationId": "AppServicePlans_ListRoutesForVnet",
"tags": [
"AppServicePlans"
],
"summary": "Get all routes that are associated with a Virtual Network in an App Service plan.",
"description": "Description for Get all routes that are associated with a Virtual Network in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VnetRoute"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": {
"get": {
"operationId": "AppServicePlans_GetRouteForVnet",
"tags": [
"AppServicePlans"
],
"summary": "Get a Virtual Network route in an App Service plan.",
"description": "Description for Get a Virtual Network route in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "routeName",
"in": "path",
"description": "Name of the Virtual Network route.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VnetRoute"
}
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "AppServicePlans_CreateOrUpdateVnetRoute",
"tags": [
"AppServicePlans"
],
"summary": "Create or update a Virtual Network route in an App Service plan.",
"description": "Description for Create or update a Virtual Network route in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "routeName",
"in": "path",
"description": "Name of the Virtual Network route.",
"required": true,
"type": "string"
},
{
"name": "route",
"in": "body",
"description": "Definition of the Virtual Network route.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetRoute"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetRoute' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetRoute"
}
},
"400": {
"description": "The server could not understand the request due to invalid syntax.",
"x-ms-error-response": true
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "AppServicePlans_UpdateVnetRoute",
"tags": [
"AppServicePlans"
],
"summary": "Create or update a Virtual Network route in an App Service plan.",
"description": "Description for Create or update a Virtual Network route in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "routeName",
"in": "path",
"description": "Name of the Virtual Network route.",
"required": true,
"type": "string"
},
{
"name": "route",
"in": "body",
"description": "Definition of the Virtual Network route.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetRoute"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetRoute' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetRoute"
}
},
"400": {
"description": "The server could not understand the request due to invalid syntax.",
"x-ms-error-response": true
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "AppServicePlans_DeleteVnetRoute",
"tags": [
"AppServicePlans"
],
"summary": "Delete a Virtual Network route in an App Service plan.",
"description": "Description for Delete a Virtual Network route in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service plan.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "routeName",
"in": "path",
"description": "Name of the Virtual Network route.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": {
"get": {
"operationId": "WebApps_ListByResourceGroup",
"tags": [
"WebApps"
],
"summary": "Gets all web, mobile, and API apps in the specified resource group.",
"description": "Description for Gets all web, mobile, and API apps in the specified resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "includeSlots",
"in": "query",
"description": "Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Web Apps by Resource group": {
"$ref": "./examples/ListWebAppsByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": {
"get": {
"operationId": "WebApps_Get",
"tags": [
"WebApps"
],
"summary": "Gets the details of a web, mobile, or API app.",
"description": "Description for Gets the details of a web, mobile, or API app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Site"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Web App": {
"$ref": "./examples/GetWebApp.json"
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdate",
"tags": [
"WebApps"
],
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteEnvelope",
"in": "body",
"description": "A JSON representation of the app properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/Site"
}
}
],
"responses": {
"200": {
"description": "Resource 'Site' update operation succeeded",
"schema": {
"$ref": "#/definitions/Site"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/Site"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Clone web app": {
"$ref": "./examples/CloneWebApp.json"
},
"Create or Update Flex Consumption function app": {
"$ref": "./examples/CreateOrUpdateFunctionAppFlexConsumption.json"
},
"Create or Update Flex Consumption function app with details": {
"$ref": "./examples/CreateOrUpdateFunctionAppFlexConsumptionWithDetails.json"
},
"Create or Update web app": {
"$ref": "./examples/CreateOrUpdateWebApp.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Site"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "WebApps_Update",
"tags": [
"WebApps"
],
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteEnvelope",
"in": "body",
"description": "A JSON representation of the app properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SitePatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Site"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/Site"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update web app": {
"$ref": "./examples/UpdateWebApp.json"
}
}
},
"delete": {
"operationId": "WebApps_Delete",
"tags": [
"WebApps"
],
"summary": "Deletes a web, mobile, or API app, or one of the deployment slots.",
"description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "deleteMetrics",
"in": "query",
"description": "If true, web app metrics are also deleted.",
"required": false,
"type": "boolean"
},
{
"name": "deleteEmptyServerFarm",
"in": "query",
"description": "Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Web app": {
"$ref": "./examples/DeleteWebApp.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname": {
"get": {
"operationId": "WebApps_AnalyzeCustomHostname",
"tags": [
"WebApps"
],
"summary": "Analyze a custom hostname.",
"description": "Description for Analyze a custom hostname.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "query",
"description": "Custom hostname.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CustomHostnameAnalysisResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Analyze custom hostname for webapp.": {
"$ref": "./examples/AnalyzeCustomHostName.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": {
"post": {
"operationId": "WebApps_ApplySlotConfigToProduction",
"tags": [
"WebApps"
],
"summary": "Applies the configuration settings from the target slot onto the current slot.",
"description": "Description for Applies the configuration settings from the target slot onto the current slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slotSwapEntity",
"in": "body",
"description": "JSON object that contains the target slot name. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Apply web app slot config": {
"$ref": "./examples/ApplySlotConfig.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": {
"post": {
"operationId": "WebApps_Backup",
"tags": [
"WebApps"
],
"summary": "Creates a backup of an app.",
"description": "Description for Creates a backup of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Backup configuration. You can use the JSON response from the POST action as input here.",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Backup web app": {
"$ref": "./examples/BackupWebApp.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": {
"get": {
"operationId": "WebApps_ListBackups",
"tags": [
"WebApps"
],
"summary": "Gets existing backups of an app.",
"description": "Description for Gets existing backups of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List web app backups": {
"$ref": "./examples/ListWebAppBackups.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": {
"get": {
"operationId": "WebApps_GetBackupStatus",
"tags": [
"WebApps"
],
"summary": "Gets a backup of an app by its ID.",
"description": "Description for Gets a backup of an app by its ID.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get web app backup": {
"$ref": "./examples/GetWebAppBackup.json"
}
}
},
"delete": {
"operationId": "WebApps_DeleteBackup",
"tags": [
"WebApps"
],
"summary": "Deletes a backup of an app by its ID.",
"description": "Description for Deletes a backup of an app by its ID.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete web app backup": {
"$ref": "./examples/DeleteWebAppBackup.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": {
"post": {
"operationId": "WebApps_ListBackupStatusSecrets",
"tags": [
"WebApps"
],
"summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Information on backup request.",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get web app backup with secrets": {
"$ref": "./examples/GetWebAppBackupWithSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": {
"post": {
"operationId": "WebApps_Restore",
"tags": [
"WebApps"
],
"summary": "Restores a specific backup to another app (or deployment slot, if specified).",
"description": "Description for Restores a specific backup to another app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Information on restore request .",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Restore web app from backup": {
"$ref": "./examples/RestoreWebAppBackup.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies": {
"get": {
"operationId": "WebApps_ListBasicPublishingCredentialsPolicies",
"tags": [
"WebApps"
],
"summary": "Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
"description": "Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PublishingCredentialsPoliciesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Publishing Credentials Policies": {
"$ref": "./examples/ListPublishingCredentialsPolicies.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp": {
"get": {
"operationId": "WebApps_GetFtpAllowed",
"tags": [
"WebApps"
],
"summary": "Returns whether FTP is allowed on the site or not.",
"description": "Description for Returns whether FTP is allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get FTP Allowed": {
"$ref": "./examples/GetPublishingCredentialsPolicy_GetFtpAllowed.json"
}
}
},
"put": {
"operationId": "WebApps_UpdateFtpAllowed",
"tags": [
"WebApps"
],
"summary": "Updates whether FTP is allowed on the site or not.",
"description": "Description for Updates whether FTP is allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "csmPublishingAccessPoliciesEntity",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
}
],
"responses": {
"200": {
"description": "Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update FTP Allowed": {
"$ref": "./examples/UpdatePublishingCredentialsPolicy_UpdateFtpAllowed.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm": {
"get": {
"operationId": "WebApps_GetScmAllowed",
"tags": [
"WebApps"
],
"summary": "Returns whether Scm basic auth is allowed on the site or not.",
"description": "Description for Returns whether Scm basic auth is allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get SCM Allowed": {
"$ref": "./examples/GetPublishingCredentialsPolicy.json"
}
}
},
"put": {
"operationId": "WebApps_UpdateScmAllowed",
"tags": [
"WebApps"
],
"summary": "Updates whether user publishing credentials are allowed on the site or not.",
"description": "Description for Updates whether user publishing credentials are allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "csmPublishingAccessPoliciesEntity",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
}
],
"responses": {
"200": {
"description": "Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update SCM Allowed": {
"$ref": "./examples/UpdatePublishingCredentialsPolicy.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates": {
"get": {
"operationId": "SiteCertificates_List",
"tags": [
"SiteCertificates"
],
"summary": "Get all certificates in a resource group under a site.",
"description": "Get all certificates in a resource group under a site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Certificates by resource group": {
"$ref": "./examples/ListSiteCertificatesByResourceGroup.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/certificates/{certificateName}": {
"get": {
"operationId": "SiteCertificates_Get",
"tags": [
"SiteCertificates"
],
"summary": "Get a certificate belonging to a given site.",
"description": "Get a certificate belonging to a given site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Certificate": {
"$ref": "./examples/GetSiteCertificate.json"
}
}
},
"put": {
"operationId": "SiteCertificates_CreateOrUpdate",
"tags": [
"SiteCertificates"
],
"summary": "Create or update a certificate under a given site.",
"description": "Create or update a certificate under a given site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Details of certificate, if it exists already.",
"required": true,
"schema": {
"$ref": "#/definitions/Certificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'Certificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"201": {
"description": "Resource 'Certificate' create operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create Or Update Certificate": {
"$ref": "./examples/CreateOrUpdateSiteCertificate.json"
}
}
},
"patch": {
"operationId": "SiteCertificates_Update",
"tags": [
"SiteCertificates"
],
"summary": "Create or update a certificate under a given site.",
"description": "Create or update a certificate under a given site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Details of certificate, if it exists already.",
"required": true,
"schema": {
"$ref": "#/definitions/CertificatePatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Certificate": {
"$ref": "./examples/PatchSiteCertificate.json"
}
}
},
"delete": {
"operationId": "SiteCertificates_Delete",
"tags": [
"SiteCertificates"
],
"summary": "Delete a certificate from the site.",
"description": "Delete a certificate from the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate": {
"$ref": "./examples/DeleteSiteCertificate.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config": {
"get": {
"operationId": "WebApps_ListConfigurations",
"tags": [
"WebApps"
],
"summary": "List the configurations of an app",
"description": "Description for List the configurations of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResourceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List web app configurations": {
"$ref": "./examples/ListWebAppConfigurations.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": {
"put": {
"operationId": "WebApps_UpdateApplicationSettings",
"tags": [
"WebApps"
],
"summary": "Replaces the application settings of an app.",
"description": "Description for Replaces the application settings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "appSettings",
"in": "body",
"description": "Application settings of the app.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update App Settings": {
"$ref": "./examples/UpdateAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": {
"post": {
"operationId": "WebApps_ListApplicationSettings",
"tags": [
"WebApps"
],
"summary": "Gets the application settings of an app.",
"description": "Description for Gets the application settings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Settings": {
"$ref": "./examples/ListAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": {
"put": {
"operationId": "WebApps_UpdateAuthSettings",
"tags": [
"WebApps"
],
"summary": "Updates the Authentication / Authorization settings associated with web app.",
"description": "Description for Updates the Authentication / Authorization settings associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteAuthSettings",
"in": "body",
"description": "Auth settings associated with web app.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update Auth Settings": {
"$ref": "./examples/UpdateAuthSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": {
"post": {
"operationId": "WebApps_GetAuthSettings",
"tags": [
"WebApps"
],
"summary": "Gets the Authentication/Authorization settings of an app.",
"description": "Description for Gets the Authentication/Authorization settings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Auth Settings": {
"$ref": "./examples/ListAuthSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2": {
"get": {
"operationId": "WebApps_GetAuthSettingsV2WithoutSecrets",
"tags": [
"WebApps"
],
"summary": "Gets site's Authentication / Authorization settings for apps via the V2 format",
"description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Auth Settings without Secrets": {
"$ref": "./examples/GetAuthSettingsV2WithoutSecrets.json"
}
}
},
"put": {
"operationId": "WebApps_UpdateAuthSettingsV2",
"tags": [
"WebApps"
],
"summary": "Updates site's Authentication / Authorization settings for apps via the V2 format",
"description": "Description for Updates site's Authentication / Authorization settings for apps via the V2 format",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteAuthSettingsV2",
"in": "body",
"description": "Auth settings associated with web app.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteAuthSettingsV2' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update Auth Settings V2": {
"$ref": "./examples/UpdateAuthSettingsV2.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list": {
"get": {
"operationId": "WebApps_GetAuthSettingsV2",
"tags": [
"WebApps"
],
"summary": "Gets site's Authentication / Authorization settings for apps via the V2 format",
"description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Auth Settings V2": {
"$ref": "./examples/ListAuthSettingsV2.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts": {
"put": {
"operationId": "WebApps_UpdateAzureStorageAccounts",
"tags": [
"WebApps"
],
"summary": "Updates the Azure storage account configurations of an app.",
"description": "Description for Updates the Azure storage account configurations of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "azureStorageAccounts",
"in": "body",
"description": "Azure storage accounts of the app.",
"required": true,
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update Azure Storage Accounts": {
"$ref": "./examples/UpdateAzureStorageAccounts.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list": {
"post": {
"operationId": "WebApps_ListAzureStorageAccounts",
"tags": [
"WebApps"
],
"summary": "Gets the Azure storage account configurations of an app.",
"description": "Description for Gets the Azure storage account configurations of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": {
"put": {
"operationId": "WebApps_UpdateBackupConfiguration",
"tags": [
"WebApps"
],
"summary": "Updates the backup configuration of an app.",
"description": "Description for Updates the backup configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Edited backup configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteBackupConfiguration",
"tags": [
"WebApps"
],
"summary": "Deletes the backup configuration of an app.",
"description": "Description for Deletes the backup configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": {
"post": {
"operationId": "WebApps_GetBackupConfiguration",
"tags": [
"WebApps"
],
"summary": "Gets the backup configuration of an app.",
"description": "Description for Gets the backup configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings": {
"get": {
"operationId": "WebApps_GetAppSettingsKeyVaultReferences",
"tags": [
"WebApps"
],
"summary": "Gets the config reference app settings and status of an app",
"description": "Description for Gets the config reference app settings and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReferenceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Azure Key Vault references for app settings": {
"$ref": "./examples/GetKeyVaultReferencesForAppSettings.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/appsettings/{appSettingKey}": {
"get": {
"operationId": "WebApps_GetAppSettingKeyVaultReference",
"tags": [
"WebApps"
],
"summary": "Gets the config reference and status of an app",
"description": "Description for Gets the config reference and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "appSettingKey",
"in": "path",
"description": "App Setting key name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReference"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Azure Key Vault app setting reference": {
"$ref": "./examples/GetKeyVaultReferencesForAppSetting.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings": {
"get": {
"operationId": "WebApps_GetSiteConnectionStringKeyVaultReferences",
"tags": [
"WebApps"
],
"summary": "Gets the config reference app settings and status of an app",
"description": "Description for Gets the config reference app settings and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReferenceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/configreferences/connectionstrings/{connectionStringKey}": {
"get": {
"operationId": "WebApps_GetSiteConnectionStringKeyVaultReference",
"tags": [
"WebApps"
],
"summary": "Gets the config reference and status of an app",
"description": "Description for Gets the config reference and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "connectionStringKey",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReference"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": {
"put": {
"operationId": "WebApps_UpdateConnectionStrings",
"tags": [
"WebApps"
],
"summary": "Replaces the connection strings of an app.",
"description": "Description for Replaces the connection strings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "connectionStrings",
"in": "body",
"description": "Connection strings of the app or deployment slot. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": {
"post": {
"operationId": "WebApps_ListConnectionStrings",
"tags": [
"WebApps"
],
"summary": "Gets the connection strings of an app.",
"description": "Description for Gets the connection strings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": {
"get": {
"operationId": "WebApps_GetDiagnosticLogsConfiguration",
"tags": [
"WebApps"
],
"summary": "Gets the logging configuration of an app.",
"description": "Description for Gets the logging configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_UpdateDiagnosticLogsConfig",
"tags": [
"WebApps"
],
"summary": "Updates the logging configuration of an app.",
"description": "Description for Updates the logging configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteLogsConfig",
"in": "body",
"description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\"property",
"required": true,
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteLogsConfig' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": {
"put": {
"operationId": "WebApps_UpdateMetadata",
"tags": [
"WebApps"
],
"summary": "Replaces the metadata of an app.",
"description": "Description for Replaces the metadata of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "metadata",
"in": "body",
"description": "Edited metadata of the app or deployment slot. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": {
"post": {
"operationId": "WebApps_ListMetadata",
"tags": [
"WebApps"
],
"summary": "Gets the metadata of an app.",
"description": "Description for Gets the metadata of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": {
"post": {
"operationId": "WebApps_ListPublishingCredentials",
"tags": [
"WebApps"
],
"summary": "Gets the Git/FTP publishing credentials of an app.",
"description": "Description for Gets the Git/FTP publishing credentials of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/User"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/User"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings": {
"put": {
"operationId": "WebApps_UpdateSitePushSettings",
"tags": [
"WebApps"
],
"summary": "Updates the Push settings associated with web app.",
"description": "Description for Updates the Push settings associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "pushSettings",
"in": "body",
"description": "Push settings associated with web app.",
"required": true,
"schema": {
"$ref": "#/definitions/PushSettings"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PushSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list": {
"post": {
"operationId": "WebApps_ListSitePushSettings",
"tags": [
"WebApps"
],
"summary": "Gets the Push settings associated with web app.",
"description": "Description for Gets the Push settings associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PushSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": {
"get": {
"operationId": "WebApps_ListSlotConfigurationNames",
"tags": [
"WebApps"
],
"summary": "Gets the names of app settings and connection strings that stick to the slot (not swapped).",
"description": "Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SlotConfigNamesResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_UpdateSlotConfigurationNames",
"tags": [
"WebApps"
],
"summary": "Updates the names of application settings and connection string that remain with the slot during swap operation.",
"description": "Description for Updates the names of application settings and connection string that remain with the slot during swap operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slotConfigNames",
"in": "body",
"description": "Names of application settings and connection strings. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SlotConfigNamesResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'SlotConfigNamesResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/SlotConfigNamesResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": {
"get": {
"operationId": "WebApps_GetConfiguration",
"tags": [
"WebApps"
],
"summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Site Config": {
"$ref": "./examples/GetSiteConfig.json"
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateConfiguration",
"tags": [
"WebApps"
],
"summary": "Updates the configuration of an app.",
"description": "Description for Updates the configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteConfig",
"in": "body",
"description": "JSON representation of a SiteConfig object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteConfigResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update Site Config": {
"$ref": "./examples/UpdateSiteConfig.json"
}
}
},
"patch": {
"operationId": "WebApps_UpdateConfiguration",
"tags": [
"WebApps"
],
"summary": "Updates the configuration of an app.",
"description": "Description for Updates the configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteConfig",
"in": "body",
"description": "JSON representation of a SiteConfig object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots": {
"get": {
"operationId": "WebApps_ListConfigurationSnapshotInfo",
"tags": [
"WebApps"
],
"summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}": {
"get": {
"operationId": "WebApps_GetConfigurationSnapshot",
"tags": [
"WebApps"
],
"summary": "Gets a snapshot of the configuration of an app at a previous point in time.",
"description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "snapshotId",
"in": "path",
"description": "The ID of the snapshot to read.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover": {
"post": {
"operationId": "WebApps_RecoverSiteConfigurationSnapshot",
"tags": [
"WebApps"
],
"summary": "Reverts the configuration of an app to a previous snapshot.",
"description": "Description for Reverts the configuration of an app to a previous snapshot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "snapshotId",
"in": "path",
"description": "The ID of the snapshot to read.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs": {
"post": {
"operationId": "WebApps_GetWebSiteContainerLogs",
"tags": [
"WebApps"
],
"summary": "Gets the last lines of docker logs for the given site",
"description": "Description for Gets the last lines of docker logs for the given site",
"produces": [
"application/octet-stream",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download": {
"post": {
"operationId": "WebApps_GetContainerLogsZip",
"tags": [
"WebApps"
],
"summary": "Gets the ZIP archived docker log files for the given site",
"description": "Description for Gets the ZIP archived docker log files for the given site",
"produces": [
"application/zip",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs": {
"get": {
"operationId": "WebApps_ListContinuousWebJobs",
"tags": [
"WebApps"
],
"summary": "List continuous web jobs for an app, or a deployment slot.",
"description": "Description for List continuous web jobs for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContinuousWebJobCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}": {
"get": {
"operationId": "WebApps_GetContinuousWebJob",
"tags": [
"WebApps"
],
"summary": "Gets a continuous web job by its ID for an app, or a deployment slot.",
"description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContinuousWebJob"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteContinuousWebJob",
"tags": [
"WebApps"
],
"summary": "Delete a continuous web job by its ID for an app, or a deployment slot.",
"description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start": {
"post": {
"operationId": "WebApps_StartContinuousWebJob",
"tags": [
"WebApps"
],
"summary": "Start a continuous web job for an app, or a deployment slot.",
"description": "Description for Start a continuous web job for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop": {
"post": {
"operationId": "WebApps_StopContinuousWebJob",
"tags": [
"WebApps"
],
"summary": "Stop a continuous web job for an app, or a deployment slot.",
"description": "Description for Stop a continuous web job for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployWorkflowArtifacts": {
"post": {
"operationId": "WebApps_DeployWorkflowArtifacts",
"tags": [
"WebApps"
],
"summary": "Creates the artifacts for web site, or a deployment slot.",
"description": "Description for Creates the artifacts for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "workflowArtifacts",
"in": "body",
"description": "Application settings and files of the workflow.",
"required": false,
"schema": {
"$ref": "#/definitions/WorkflowArtifacts"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete workflow artifacts": {
"$ref": "./examples/DeleteDeployWorkflowArtifacts.json"
},
"Deploys workflow artifacts": {
"$ref": "./examples/PostDeployWorkflowArtifacts.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus": {
"get": {
"operationId": "WebApps_ListProductionSiteDeploymentStatuses",
"tags": [
"WebApps"
],
"summary": "List deployment statuses for an app (or deployment slot, if specified).",
"description": "List deployment statuses for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmDeploymentStatusCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Deployment Status": {
"$ref": "./examples/ListSiteDeploymentStatus.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deploymentStatus/{deploymentStatusId}": {
"get": {
"operationId": "WebApps_GetProductionSiteDeploymentStatus",
"tags": [
"WebApps"
],
"summary": "Gets the deployment status for an app (or deployment slot, if specified).",
"description": "Gets the deployment status for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "deploymentStatusId",
"in": "path",
"description": "GUID of the deployment operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmDeploymentStatus"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/CsmDeploymentStatus"
},
"headers": {
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Deployment Status": {
"$ref": "./examples/GetSiteDeploymentStatus.json"
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": {
"get": {
"operationId": "WebApps_ListDeployments",
"tags": [
"WebApps"
],
"summary": "List deployments for an app, or a deployment slot.",
"description": "Description for List deployments for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeploymentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": {
"get": {
"operationId": "WebApps_GetDeployment",
"tags": [
"WebApps"
],
"summary": "Get a deployment by its ID for an app, or a deployment slot.",
"description": "Description for Get a deployment by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateDeployment",
"tags": [
"WebApps"
],
"summary": "Create a deployment for an app, or a deployment slot.",
"description": "Description for Create a deployment for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
},
{
"name": "deployment",
"in": "body",
"description": "Deployment details.",
"required": true,
"schema": {
"$ref": "#/definitions/Deployment"
}
}
],
"responses": {
"200": {
"description": "Resource 'Deployment' update operation succeeded",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteDeployment",
"tags": [
"WebApps"
],
"summary": "Delete a deployment by its ID for an app, or a deployment slot.",
"description": "Description for Delete a deployment by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log": {
"get": {
"operationId": "WebApps_ListDeploymentLog",
"tags": [
"WebApps"
],
"summary": "List deployment log for specific deployment for an app, or a deployment slot.",
"description": "Description for List deployment log for specific deployment for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors": {
"get": {
"operationId": "Diagnostics_ListSiteDetectorResponses",
"tags": [
"Diagnostics"
],
"summary": "List Site Detector Responses",
"description": "Description for List Site Detector Responses",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorResponseCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Detector Responses": {
"$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json"
},
"Get App Slot Detector Responses": {
"$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}": {
"get": {
"operationId": "Diagnostics_GetSiteDetectorResponse",
"tags": [
"Diagnostics"
],
"summary": "Get site detector response",
"description": "Description for Get site detector response",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Resource Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Detector Response": {
"$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json"
},
"Get App Slot Detector Response": {
"$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics": {
"get": {
"operationId": "Diagnostics_ListSiteDiagnosticCategories",
"tags": [
"Diagnostics"
],
"summary": "Get Diagnostics Categories",
"description": "Description for Get Diagnostics Categories",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticCategoryCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Diagnostic Categories": {
"$ref": "./examples/Diagnostics_ListSiteDiagnosticCategories.json"
},
"List App Slot Diagnostic Categories": {
"$ref": "./examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}": {
"get": {
"operationId": "Diagnostics_GetSiteDiagnosticCategory",
"tags": [
"Diagnostics"
],
"summary": "Get Diagnostics Category",
"description": "Description for Get Diagnostics Category",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticCategory"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Diagnostic Category": {
"$ref": "./examples/Diagnostics_GetSiteDiagnosticCategory.json"
},
"Get App Slot Diagnostic Category": {
"$ref": "./examples/Diagnostics_GetSiteDiagnosticCategorySlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses": {
"get": {
"operationId": "Diagnostics_ListSiteAnalyses",
"tags": [
"Diagnostics"
],
"summary": "Get Site Analyses",
"description": "Description for Get Site Analyses",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticAnalysisCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Analyses": {
"$ref": "./examples/Diagnostics_ListSiteAnalyses.json"
},
"List App Slot Analyses": {
"$ref": "./examples/Diagnostics_ListSiteAnalysesSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}": {
"get": {
"operationId": "Diagnostics_GetSiteAnalysis",
"tags": [
"Diagnostics"
],
"summary": "Get Site Analysis",
"description": "Description for Get Site Analysis",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "analysisName",
"in": "path",
"description": "Analysis Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AnalysisDefinition"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Analysis": {
"$ref": "./examples/Diagnostics_GetSiteAnalysis.json"
},
"Get App Slot Analysis": {
"$ref": "./examples/Diagnostics_GetSiteAnalysisSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute": {
"post": {
"operationId": "Diagnostics_ExecuteSiteAnalysis",
"tags": [
"Diagnostics"
],
"summary": "Execute Analysis",
"description": "Description for Execute Analysis",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "analysisName",
"in": "path",
"description": "Analysis Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticAnalysis"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Execute site analysis": {
"$ref": "./examples/Diagnostics_ExecuteSiteAnalysis.json"
},
"Execute site slot analysis": {
"$ref": "./examples/Diagnostics_ExecuteSiteAnalysisSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors": {
"get": {
"operationId": "Diagnostics_ListSiteDetectors",
"tags": [
"Diagnostics"
],
"summary": "Get Detectors",
"description": "Description for Get Detectors",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticDetectorCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Detectors": {
"$ref": "./examples/Diagnostics_ListSiteDetectors.json"
},
"List App Slot Detectors": {
"$ref": "./examples/Diagnostics_ListSiteDetectorsSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}": {
"get": {
"operationId": "Diagnostics_GetSiteDetector",
"tags": [
"Diagnostics"
],
"summary": "Get Detector",
"description": "Description for Get Detector",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorDefinitionResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Detector": {
"$ref": "./examples/Diagnostics_GetSiteDetector.json"
},
"Get App Slot Detector": {
"$ref": "./examples/Diagnostics_GetSiteDetectorSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute": {
"post": {
"operationId": "Diagnostics_ExecuteSiteDetector",
"tags": [
"Diagnostics"
],
"summary": "Execute Detector",
"description": "Description for Execute Detector",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticDetectorResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Execute site detector": {
"$ref": "./examples/Diagnostics_ExecuteSiteDetector.json"
},
"Execute site slot detector": {
"$ref": "./examples/Diagnostics_ExecuteSiteDetectorSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup": {
"post": {
"operationId": "WebApps_DiscoverBackup",
"tags": [
"WebApps"
],
"summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers": {
"get": {
"operationId": "WebApps_ListDomainOwnershipIdentifiers",
"tags": [
"WebApps"
],
"summary": "Lists ownership identifiers for domain associated with web app.",
"description": "Description for Lists ownership identifiers for domain associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/IdentifierCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": {
"get": {
"operationId": "WebApps_GetDomainOwnershipIdentifier",
"tags": [
"WebApps"
],
"summary": "Get domain ownership identifier for web app.",
"description": "Description for Get domain ownership identifier for web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Identifier"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifier",
"tags": [
"WebApps"
],
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifier",
"in": "body",
"description": "A JSON representation of the domain ownership properties.",
"required": true,
"schema": {
"$ref": "#/definitions/Identifier"
}
}
],
"responses": {
"200": {
"description": "Resource 'Identifier' update operation succeeded",
"schema": {
"$ref": "#/definitions/Identifier"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateDomainOwnershipIdentifier",
"tags": [
"WebApps"
],
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifier",
"in": "body",
"description": "A JSON representation of the domain ownership properties.",
"required": true,
"schema": {
"$ref": "#/definitions/Identifier"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Identifier"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteDomainOwnershipIdentifier",
"tags": [
"WebApps"
],
"summary": "Deletes a domain ownership identifier for a web app.",
"description": "Description for Deletes a domain ownership identifier for a web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy": {
"get": {
"operationId": "WebApps_GetMSDeployStatus",
"tags": [
"WebApps"
],
"summary": "Get the status of the last MSDeploy operation.",
"description": "Description for Get the status of the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateMSDeployOperation",
"tags": [
"WebApps"
],
"summary": "Invoke the MSDeploy web app extension.",
"description": "Description for Invoke the MSDeploy web app extension.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "MSDeploy",
"in": "body",
"description": "Details of MSDeploy operation",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
}
],
"responses": {
"201": {
"description": "Resource 'MSDeployStatus' create operation succeeded",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"409": {
"description": "The request conflicts with the current state of the server.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/MSDeployStatus"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log": {
"get": {
"operationId": "WebApps_GetMSDeployLog",
"tags": [
"WebApps"
],
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/onedeploy": {
"get": {
"operationId": "WebApps_GetOneDeployStatus",
"tags": [
"WebApps"
],
"summary": "Invoke onedeploy status API /api/deployments and gets the deployment status for the site",
"description": "Description for Invoke onedeploy status API /api/deployments and gets the deployment status for the site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOneDeployOperation",
"tags": [
"WebApps"
],
"summary": "Invoke the OneDeploy publish web app extension.",
"description": "Description for Invoke the OneDeploy publish web app extension.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions": {
"get": {
"operationId": "WebApps_ListFunctions",
"tags": [
"WebApps"
],
"summary": "List the functions for a web site, or a deployment slot.",
"description": "Description for List the functions for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionEnvelopeCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}": {
"get": {
"operationId": "WebApps_GetFunction",
"tags": [
"WebApps"
],
"summary": "Get function information by its ID for web site, or a deployment slot.",
"description": "Description for Get function information by its ID for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateFunction",
"tags": [
"WebApps"
],
"summary": "Create function for web site, or a deployment slot.",
"description": "Description for Create function for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
},
{
"name": "function_envelope",
"in": "body",
"description": "Function details.",
"required": true,
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
}
],
"responses": {
"201": {
"description": "Resource 'FunctionEnvelope' create operation succeeded",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/FunctionEnvelope"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "WebApps_DeleteFunction",
"tags": [
"WebApps"
],
"summary": "Delete a function for web site, or a deployment slot.",
"description": "Description for Delete a function for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys": {
"post": {
"operationId": "WebApps_ListFunctionKeys",
"tags": [
"WebApps"
],
"summary": "Get function keys for a function in a web site, or a deployment slot.",
"description": "Description for Get function keys for a function in a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets": {
"post": {
"operationId": "WebApps_ListFunctionSecrets",
"tags": [
"WebApps"
],
"summary": "Get function secrets for a function in a web site, or a deployment slot.",
"description": "Description for Get function secrets for a function in a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token": {
"get": {
"operationId": "WebApps_GetFunctionsAdminToken",
"tags": [
"WebApps"
],
"summary": "Fetch a short lived token that can be exchanged for a master key.",
"description": "Description for Fetch a short lived token that can be exchanged for a master key.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/stringApplicationJson"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": {
"post": {
"operationId": "WebApps_ListHostKeys",
"tags": [
"WebApps"
],
"summary": "Get host secrets for a function app.",
"description": "Description for Get host secrets for a function app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostKeys"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": {
"post": {
"operationId": "WebApps_ListSyncStatus",
"tags": [
"WebApps"
],
"summary": "This is to allow calling via powershell and ARM template.",
"description": "Description for This is to allow calling via powershell and ARM template.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": {
"post": {
"operationId": "WebApps_SyncFunctions",
"tags": [
"WebApps"
],
"summary": "Syncs function trigger metadata to the management database",
"description": "Description for Syncs function trigger metadata to the management database",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": {
"get": {
"operationId": "WebApps_ListHostNameBindings",
"tags": [
"WebApps"
],
"summary": "Get hostname bindings for an app or a deployment slot.",
"description": "Description for Get hostname bindings for an app or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostNameBindingCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": {
"get": {
"operationId": "WebApps_GetHostNameBinding",
"tags": [
"WebApps"
],
"summary": "Get the named hostname binding for an app (or deployment slot, if specified).",
"description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "path",
"description": "Hostname in the hostname binding.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateHostNameBinding",
"tags": [
"WebApps"
],
"summary": "Creates a hostname binding for an app.",
"description": "Description for Creates a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "path",
"description": "Hostname in the hostname binding.",
"required": true,
"type": "string"
},
{
"name": "hostNameBinding",
"in": "body",
"description": "Binding details. This is the JSON representation of a HostNameBinding object.",
"required": true,
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
}
],
"responses": {
"200": {
"description": "Resource 'HostNameBinding' update operation succeeded",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteHostNameBinding",
"tags": [
"WebApps"
],
"summary": "Deletes a hostname binding for an app.",
"description": "Description for Deletes a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "path",
"description": "Hostname in the hostname binding.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/regenerateAccessKey": {
"post": {
"operationId": "Workflows_RegenerateAccessKey",
"tags": [
"Workflows"
],
"description": "Regenerates the callback URL access key for request triggers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "keyType",
"in": "body",
"description": "The access key type.",
"required": true,
"schema": {
"$ref": "#/definitions/RegenerateActionParameter"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Regenerate the callback URL access key for request triggers": {
"$ref": "./examples/Workflows_RegenerateAccessKey.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs": {
"get": {
"operationId": "WorkflowRuns_List",
"tags": [
"WorkflowRuns"
],
"description": "Gets a list of workflow runs.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "The number of items to be included in the result.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List workflow runs": {
"$ref": "./examples/WorkflowRuns_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}": {
"get": {
"operationId": "WorkflowRuns_Get",
"tags": [
"WorkflowRuns"
],
"description": "Gets a workflow run.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRun"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a run for a workflow": {
"$ref": "./examples/WorkflowRuns_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions": {
"get": {
"operationId": "WorkflowRunActions_List",
"tags": [
"WorkflowRunActions"
],
"description": "Gets a list of workflow run actions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "The number of items to be included in the result.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation. Options for filters include: Status.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunActionListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List a workflow run actions": {
"$ref": "./examples/WorkflowRunActions_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}": {
"get": {
"operationId": "WorkflowRunActions_Get",
"tags": [
"WorkflowRunActions"
],
"description": "Gets a workflow run action.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunAction"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a workflow run action": {
"$ref": "./examples/WorkflowRunActions_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/listExpressionTraces": {
"post": {
"operationId": "WorkflowRunActions_ListExpressionTraces",
"tags": [
"WorkflowRunActions"
],
"description": "Lists a workflow run expression trace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ExpressionTraces"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List expression traces": {
"$ref": "./examples/WorkflowRunActions_ListExpressionTraces.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink",
"itemName": "inputs"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions": {
"get": {
"operationId": "WorkflowRunActionRepetitions_List",
"tags": [
"WorkflowRunActions"
],
"description": "Get all of a workflow run action repetitions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List repetitions": {
"$ref": "./examples/WorkflowRunActionRepetitions_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}": {
"get": {
"operationId": "WorkflowRunActionRepetitions_Get",
"tags": [
"WorkflowRunActions"
],
"description": "Get a workflow run action repetition.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
},
{
"name": "repetitionName",
"in": "path",
"description": "The workflow repetition.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunActionRepetitionDefinition"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a repetition": {
"$ref": "./examples/WorkflowRunActionRepetitions_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/listExpressionTraces": {
"post": {
"operationId": "WorkflowRunActionRepetitions_ListExpressionTraces",
"tags": [
"WorkflowRunActions"
],
"description": "Lists a workflow run expression trace.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
},
{
"name": "repetitionName",
"in": "path",
"description": "The workflow repetition.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ExpressionTraces"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List expression traces for a repetition": {
"$ref": "./examples/WorkflowRunActionRepetitions_ListExpressionTraces.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink",
"itemName": "inputs"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories": {
"get": {
"operationId": "WorkflowRunActionRepetitionsRequestHistories_List",
"tags": [
"WorkflowRunActions"
],
"description": "List a workflow run repetition request history.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
},
{
"name": "repetitionName",
"in": "path",
"description": "The workflow repetition.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RequestHistoryListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List repetition request history": {
"$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/repetitions/{repetitionName}/requestHistories/{requestHistoryName}": {
"get": {
"operationId": "WorkflowRunActionRepetitionsRequestHistories_Get",
"tags": [
"WorkflowRunActions"
],
"description": "Gets a workflow run repetition request history.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
},
{
"name": "repetitionName",
"in": "path",
"description": "The workflow repetition.",
"required": true,
"type": "string"
},
{
"name": "requestHistoryName",
"in": "path",
"description": "The workflow repetition.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RequestHistory"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a repetition request history": {
"$ref": "./examples/WorkflowRunActionRepetitionsRequestHistories_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions": {
"get": {
"operationId": "WorkflowRunActionScopeRepetitions_List",
"tags": [
"WorkflowRunActions"
],
"description": "List the workflow run action scoped repetitions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunActionRepetitionDefinitionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List the scoped repetitions": {
"$ref": "./examples/WorkflowRunActionScopeRepetitions_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/actions/{actionName}/scopeRepetitions/{repetitionName}": {
"get": {
"operationId": "WorkflowRunActionScopeRepetitions_Get",
"tags": [
"WorkflowRunActions"
],
"description": "Get a workflow run action scoped repetition.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
},
{
"name": "actionName",
"in": "path",
"description": "The workflow action name.",
"required": true,
"type": "string"
},
{
"name": "repetitionName",
"in": "path",
"description": "The workflow repetition.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowRunActionRepetitionDefinition"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a scoped repetition": {
"$ref": "./examples/WorkflowRunActionScopeRepetitions_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/runs/{runName}/cancel": {
"post": {
"operationId": "WorkflowRuns_Cancel",
"tags": [
"WorkflowRuns"
],
"description": "Cancels a workflow run.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "runName",
"in": "path",
"description": "The workflow run name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Cancel a workflow run": {
"$ref": "./examples/WorkflowRuns_Cancel.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers": {
"get": {
"operationId": "WorkflowTriggers_List",
"tags": [
"WorkflowTriggers"
],
"description": "Gets a list of workflow triggers.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "The number of items to be included in the result.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowTriggerListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List workflow triggers": {
"$ref": "./examples/WorkflowTriggers_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}": {
"get": {
"operationId": "WorkflowTriggers_Get",
"tags": [
"WorkflowTriggers"
],
"description": "Gets a workflow trigger.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowTrigger"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a workflow trigger": {
"$ref": "./examples/WorkflowTriggers_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories": {
"get": {
"operationId": "WorkflowTriggerHistories_List",
"tags": [
"WorkflowTriggerHistories"
],
"description": "Gets a list of workflow trigger histories.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "The number of items to be included in the result.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "$filter",
"in": "query",
"description": "The filter to apply on the operation. Options for filters include: Status, StartTime, and ClientTrackingId.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowTriggerHistoryListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List a workflow trigger history": {
"$ref": "./examples/WorkflowTriggerHistories_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}": {
"get": {
"operationId": "WorkflowTriggerHistories_Get",
"tags": [
"WorkflowTriggerHistories"
],
"description": "Gets a workflow trigger history.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
},
{
"name": "historyName",
"in": "path",
"description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowTriggerHistory"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a workflow trigger history": {
"$ref": "./examples/WorkflowTriggerHistories_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/histories/{historyName}/resubmit": {
"post": {
"operationId": "WorkflowTriggerHistories_Resubmit",
"tags": [
"WorkflowTriggerHistories"
],
"description": "Resubmits a workflow run based on the trigger history.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
},
{
"name": "historyName",
"in": "path",
"description": "The workflow trigger history name. Corresponds to the run name for triggers that resulted in a run.",
"required": true,
"type": "string"
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Resubmit a workflow run based on the trigger history": {
"$ref": "./examples/WorkflowTriggerHistories_Resubmit.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/listCallbackUrl": {
"post": {
"operationId": "WorkflowTriggers_ListCallbackUrl",
"tags": [
"WorkflowTriggers"
],
"description": "Get the callback URL for a workflow trigger.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowTriggerCallbackUrl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get the callback URL for a trigger": {
"$ref": "./examples/WorkflowTriggers_ListCallbackUrl.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/run": {
"post": {
"operationId": "WorkflowTriggers_Run",
"tags": [
"WorkflowTriggers"
],
"description": "Runs a workflow trigger.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Run a workflow trigger": {
"$ref": "./examples/WorkflowTriggers_Run.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/triggers/{triggerName}/schemas/json": {
"get": {
"operationId": "WorkflowTriggers_GetSchemaJson",
"tags": [
"WorkflowTriggers"
],
"description": "Get the trigger schema as JSON.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "triggerName",
"in": "path",
"description": "The workflow trigger name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/JsonSchema"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get trigger schema": {
"$ref": "./examples/WorkflowTriggers_GetSchemaJson.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/validate": {
"post": {
"operationId": "Workflows_Validate",
"tags": [
"Workflows"
],
"description": "Validates the workflow definition.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "validate",
"in": "body",
"description": "The workflow.",
"required": true,
"schema": {
"$ref": "#/definitions/Workflow"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Validate a workflow": {
"$ref": "./examples/Workflows_Validate.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions": {
"get": {
"operationId": "WorkflowVersions_List",
"tags": [
"WorkflowVersions"
],
"description": "Gets a list of workflow versions.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "$top",
"in": "query",
"description": "The number of items to be included in the result.",
"required": false,
"type": "integer",
"format": "int32"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowVersionListResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"List a workflows versions": {
"$ref": "./examples/WorkflowVersions_List.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostruntime/runtime/webhooks/workflow/api/management/workflows/{workflowName}/versions/{versionId}": {
"get": {
"operationId": "WorkflowVersions_Get",
"tags": [
"WorkflowVersions"
],
"description": "Gets a workflow version.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "The workflow name.",
"required": true,
"type": "string"
},
{
"name": "versionId",
"in": "path",
"description": "The workflow versionId.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowVersion"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/ErrorResponse"
}
}
},
"x-ms-examples": {
"Get a workflow version": {
"$ref": "./examples/WorkflowVersions_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
"get": {
"operationId": "WebApps_GetHybridConnection",
"tags": [
"WebApps"
],
"summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateHybridConnection",
"tags": [
"WebApps"
],
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
"$ref": "#/definitions/HybridConnection"
}
}
],
"responses": {
"200": {
"description": "Resource 'HybridConnection' update operation succeeded",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateHybridConnection",
"tags": [
"WebApps"
],
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
"$ref": "#/definitions/HybridConnection"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteHybridConnection",
"tags": [
"WebApps"
],
"summary": "Removes a Hybrid Connection from this site.",
"description": "Description for Removes a Hybrid Connection from this site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": {
"get": {
"operationId": "WebApps_ListHybridConnections",
"tags": [
"WebApps"
],
"summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.",
"description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": {
"get": {
"operationId": "WebApps_ListRelayServiceConnections",
"tags": [
"WebApps"
],
"summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).",
"description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": {
"get": {
"operationId": "WebApps_GetRelayServiceConnection",
"tags": [
"WebApps"
],
"summary": "Gets a hybrid connection configuration by its name.",
"description": "Description for Gets a hybrid connection configuration by its name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateRelayServiceConnection",
"tags": [
"WebApps"
],
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Details of the hybrid connection configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
}
],
"responses": {
"200": {
"description": "Resource 'RelayServiceConnectionEntity' update operation succeeded",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateRelayServiceConnection",
"tags": [
"WebApps"
],
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Details of the hybrid connection configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteRelayServiceConnection",
"tags": [
"WebApps"
],
"summary": "Deletes a relay service connection by its name.",
"description": "Description for Deletes a relay service connection by its name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": {
"get": {
"operationId": "WebApps_ListInstanceIdentifiers",
"tags": [
"WebApps"
],
"summary": "Gets all scale-out instances of an app.",
"description": "Description for Gets all scale-out instances of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppInstanceStatusCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}": {
"get": {
"operationId": "WebApps_GetInstanceInfo",
"tags": [
"WebApps"
],
"summary": "Gets all scale-out instances of an app.",
"description": "Description for Gets all scale-out instances of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebSiteInstanceStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get site instance info": {
"$ref": "./examples/GetSiteInstanceInfo.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": {
"get": {
"operationId": "WebApps_GetInstanceMsDeployStatus",
"tags": [
"WebApps"
],
"summary": "Get the status of the last MSDeploy operation.",
"description": "Description for Get the status of the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of web app instance.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateInstanceMSDeployOperation",
"tags": [
"WebApps"
],
"summary": "Invoke the MSDeploy web app extension.",
"description": "Description for Invoke the MSDeploy web app extension.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of web app instance.",
"required": true,
"type": "string"
},
{
"name": "MSDeploy",
"in": "body",
"description": "Details of MSDeploy operation",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
}
],
"responses": {
"201": {
"description": "Resource 'MSDeployStatus' create operation succeeded",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"409": {
"description": "The request conflicts with the current state of the server.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/MSDeployStatus"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": {
"get": {
"operationId": "WebApps_GetInstanceMSDeployLog",
"tags": [
"WebApps"
],
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of web app instance.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": {
"get": {
"operationId": "WebApps_ListInstanceProcesses",
"tags": [
"WebApps"
],
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": {
"get": {
"operationId": "WebApps_GetInstanceProcess",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteInstanceProcess",
"tags": [
"WebApps"
],
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": {
"get": {
"operationId": "WebApps_GetInstanceProcessDump",
"tags": [
"WebApps"
],
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"produces": [
"*/*",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": {
"get": {
"operationId": "WebApps_ListInstanceProcessModules",
"tags": [
"WebApps"
],
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": {
"get": {
"operationId": "WebApps_GetInstanceProcessModule",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
},
{
"name": "baseAddress",
"in": "path",
"description": "Module base address.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": {
"get": {
"operationId": "WebApps_ListInstanceProcessThreads",
"tags": [
"WebApps"
],
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": {
"post": {
"operationId": "WebApps_IsCloneable",
"tags": [
"WebApps"
],
"summary": "Shows whether an app can be cloned to another resource group or subscription.",
"description": "Description for Shows whether an app can be cloned to another resource group or subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteCloneability"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listWorkflowsConnections": {
"post": {
"operationId": "WebApps_ListWorkflowsConnections",
"tags": [
"WebApps"
],
"summary": "Lists logic app's connections for web site, or a deployment slot.",
"description": "Lists logic app's connections for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List the Instance Workflows Configuration Connections": {
"$ref": "./examples/ListWorkflowsConfigurationConnections.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups": {
"post": {
"operationId": "WebApps_ListSiteBackups",
"tags": [
"WebApps"
],
"summary": "Gets existing backups of an app.",
"description": "Description for Gets existing backups of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List backups": {
"$ref": "./examples/ListSlotBackups.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": {
"post": {
"operationId": "WebApps_ListSyncFunctionTriggers",
"tags": [
"WebApps"
],
"summary": "This is to allow calling via powershell and ARM template.",
"description": "Description for This is to allow calling via powershell and ARM template.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": {
"put": {
"operationId": "WebApps_MigrateStorage",
"tags": [
"WebApps"
],
"summary": "Restores a web app.",
"description": "Description for Restores a web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "subscriptionName",
"in": "query",
"description": "Azure subscription",
"required": true,
"type": "string"
},
{
"name": "migrationOptions",
"in": "body",
"description": "Migration migrationOptions.",
"required": true,
"schema": {
"$ref": "#/definitions/StorageMigrationOptions"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/StorageMigrationResponse"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StorageMigrationResponse"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": {
"post": {
"operationId": "WebApps_MigrateMySql",
"tags": [
"WebApps"
],
"summary": "Migrates a local (in-app) MySql database to a remote MySql database.",
"description": "Description for Migrates a local (in-app) MySql database to a remote MySql database.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "migrationRequestEnvelope",
"in": "body",
"description": "MySql migration options.",
"required": true,
"schema": {
"$ref": "#/definitions/MigrateMySqlRequest"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/Operation"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Operation"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": {
"get": {
"operationId": "WebApps_GetMigrateMySqlStatus",
"tags": [
"WebApps"
],
"summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MigrateMySqlStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": {
"get": {
"operationId": "WebApps_GetSwiftVirtualNetworkConnection",
"tags": [
"WebApps"
],
"summary": "Gets a Swift Virtual Network connection.",
"description": "Description for Gets a Swift Virtual Network connection.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheck",
"tags": [
"WebApps"
],
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
}
],
"responses": {
"200": {
"description": "Resource 'SwiftVirtualNetwork' update operation succeeded",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionWithCheck",
"tags": [
"WebApps"
],
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteSwiftVirtualNetwork",
"tags": [
"WebApps"
],
"summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": {
"get": {
"operationId": "WebApps_ListNetworkFeatures",
"tags": [
"WebApps"
],
"summary": "Gets all network features used by the app (or deployment slot, if specified).",
"description": "Description for Gets all network features used by the app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "view",
"in": "path",
"description": "The type of view. Only \"summary\" is supported at this time.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/NetworkFeatures"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": {
"post": {
"operationId": "WebApps_StartWebSiteNetworkTrace",
"tags": [
"WebApps"
],
"summary": "Start capturing network packets for the site (To be deprecated).",
"description": "Description for Start capturing network packets for the site (To be deprecated).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "durationInSeconds",
"in": "query",
"description": "The duration to keep capturing in seconds.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxFrameLength",
"in": "query",
"description": "The maximum frame length in bytes (Optional).",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sasUrl",
"in": "query",
"description": "The Blob URL to store capture file.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/stringApplicationJson"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": {
"post": {
"operationId": "WebApps_StartWebSiteNetworkTraceOperation",
"tags": [
"WebApps"
],
"summary": "Start capturing network packets for the site.",
"description": "Description for Start capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "durationInSeconds",
"in": "query",
"description": "The duration to keep capturing in seconds.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxFrameLength",
"in": "query",
"description": "The maximum frame length in bytes (Optional).",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sasUrl",
"in": "query",
"description": "The Blob URL to store capture file.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Start a new network trace operation for a site": {
"$ref": "./examples/StartWebSiteNetworkTraceOperation.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": {
"post": {
"operationId": "WebApps_StopWebSiteNetworkTrace",
"tags": [
"WebApps"
],
"summary": "Stop ongoing capturing network packets for the site.",
"description": "Description for Stop ongoing capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"$ref": "./examples/StopWebSiteNetworkTrace.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": {
"post": {
"operationId": "WebApps_GenerateNewSitePublishingPassword",
"tags": [
"WebApps"
],
"summary": "Generates a new publishing password for an app (or deployment slot, if specified).",
"description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": {
"get": {
"operationId": "WebApps_ListPerfMonCounters",
"tags": [
"WebApps"
],
"summary": "Gets perfmon counters for web app.",
"description": "Description for Gets perfmon counters for web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PerfMonCounterCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": {
"get": {
"operationId": "WebApps_GetSitePhpErrorLogFlag",
"tags": [
"WebApps"
],
"summary": "Gets web app's event logs.",
"description": "Description for Gets web app's event logs.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SitePhpErrorLogFlag"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": {
"get": {
"operationId": "WebApps_ListPremierAddOns",
"tags": [
"WebApps"
],
"summary": "Gets the premier add-ons of an app.",
"description": "Description for Gets the premier add-ons of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": {
"get": {
"operationId": "WebApps_GetPremierAddOn",
"tags": [
"WebApps"
],
"summary": "Gets a named add-on of an app.",
"description": "Description for Gets a named add-on of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_AddPremierAddOn",
"tags": [
"WebApps"
],
"summary": "Updates a named add-on of an app.",
"description": "Description for Updates a named add-on of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
},
{
"name": "premierAddOn",
"in": "body",
"description": "A JSON representation of the edited premier add-on.",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
}
],
"responses": {
"200": {
"description": "Resource 'PremierAddOn' update operation succeeded",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdatePremierAddOn",
"tags": [
"WebApps"
],
"summary": "Updates a named add-on of an app.",
"description": "Description for Updates a named add-on of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
},
{
"name": "premierAddOn",
"in": "body",
"description": "A JSON representation of the edited premier add-on.",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOnPatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeletePremierAddOn",
"tags": [
"WebApps"
],
"summary": "Delete a premier add-on from an app.",
"description": "Description for Delete a premier add-on from an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": {
"get": {
"operationId": "WebApps_GetPrivateAccess",
"tags": [
"WebApps"
],
"summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_PutPrivateAccessVnet",
"tags": [
"WebApps"
],
"summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "access",
"in": "body",
"description": "The information for the private access",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
}
],
"responses": {
"200": {
"description": "Resource 'PrivateAccess' update operation succeeded",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections": {
"get": {
"operationId": "WebApps_GetPrivateEndpointConnectionList",
"tags": [
"WebApps"
],
"summary": "Gets the list of private endpoint connections associated with a site",
"description": "Description for Gets the list of private endpoint connections associated with a site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"operationId": "WebApps_GetPrivateEndpointConnection",
"tags": [
"WebApps"
],
"summary": "Gets a private endpoint connection",
"description": "Description for Gets a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a private endpoint connection for a site.": {
"$ref": "./examples/GetSitePrivateEndpointConnection.json"
}
}
},
"put": {
"operationId": "WebApps_ApproveOrRejectPrivateEndpointConnection",
"tags": [
"WebApps"
],
"summary": "Approves or rejects a private endpoint connection",
"description": "Description for Approves or rejects a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointWrapper",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Approves or rejects a private endpoint connection for a site.": {
"$ref": "./examples/ApproveRejectSitePrivateEndpointConnection.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "WebApps_DeletePrivateEndpointConnection",
"tags": [
"WebApps"
],
"summary": "Deletes a private endpoint connection",
"description": "Description for Deletes a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a private endpoint connection for a site.": {
"$ref": "./examples/DeleteSitePrivateEndpointConnection.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources": {
"get": {
"operationId": "WebApps_GetPrivateLinkResources",
"tags": [
"WebApps"
],
"summary": "Gets the private link resources",
"description": "Description for Gets the private link resources",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateLinkResourcesWrapper"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get private link resources of a site": {
"$ref": "./examples/GetSitePrivateLinkResources_WebApps.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": {
"get": {
"operationId": "WebApps_ListProcesses",
"tags": [
"WebApps"
],
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": {
"get": {
"operationId": "WebApps_GetProcess",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteProcess",
"tags": [
"WebApps"
],
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": {
"get": {
"operationId": "WebApps_GetProcessDump",
"tags": [
"WebApps"
],
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"produces": [
"*/*",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": {
"get": {
"operationId": "WebApps_ListProcessModules",
"tags": [
"WebApps"
],
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": {
"get": {
"operationId": "WebApps_GetProcessModule",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
},
{
"name": "baseAddress",
"in": "path",
"description": "Module base address.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": {
"get": {
"operationId": "WebApps_ListProcessThreads",
"tags": [
"WebApps"
],
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": {
"get": {
"operationId": "WebApps_ListPublicCertificates",
"tags": [
"WebApps"
],
"summary": "Get public certificates for an app or a deployment slot.",
"description": "Description for Get public certificates for an app or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PublicCertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": {
"get": {
"operationId": "WebApps_GetPublicCertificate",
"tags": [
"WebApps"
],
"summary": "Get the named public certificate for an app (or deployment slot, if specified).",
"description": "Description for Get the named public certificate for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "publicCertificateName",
"in": "path",
"description": "Public certificate name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdatePublicCertificate",
"tags": [
"WebApps"
],
"summary": "Creates a hostname binding for an app.",
"description": "Description for Creates a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "publicCertificateName",
"in": "path",
"description": "Public certificate name.",
"required": true,
"type": "string"
},
{
"name": "publicCertificate",
"in": "body",
"description": "Public certificate details. This is the JSON representation of a PublicCertificate object.",
"required": true,
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'PublicCertificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeletePublicCertificate",
"tags": [
"WebApps"
],
"summary": "Deletes a hostname binding for an app.",
"description": "Description for Deletes a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "publicCertificateName",
"in": "path",
"description": "Public certificate name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": {
"post": {
"operationId": "WebApps_ListPublishingProfileXmlWithSecrets",
"tags": [
"WebApps"
],
"summary": "Gets the publishing profile for an app (or deployment slot, if specified).",
"description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "publishingProfileOptions",
"in": "body",
"description": "Specifies publishingProfileOptions for publishing profile. For example, use {\" format\": \"FileZilla3\"} to get a FileZilla publishing profile.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingProfileOptions"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory": {
"get": {
"operationId": "Recommendations_ListHistoryForWebApp",
"tags": [
"Recommendations"
],
"summary": "Get past recommendations for an app, optionally specified by the time range.",
"description": "Description for Get past recommendations for an app, optionally specified by the time range.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "expiredOnly",
"in": "query",
"description": "Specify false to return all recommendations. The default is true, which returns only expired recommendations.",
"required": false,
"type": "boolean"
},
{
"name": "$filter",
"in": "query",
"description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RecommendationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations": {
"get": {
"operationId": "Recommendations_ListRecommendedRulesForWebApp",
"tags": [
"Recommendations"
],
"summary": "Get all recommendations for an app.",
"description": "Description for Get all recommendations for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "featured",
"in": "query",
"description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.",
"required": false,
"type": "boolean"
},
{
"name": "$filter",
"in": "query",
"description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RecommendationCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}": {
"get": {
"operationId": "Recommendations_GetRuleDetailsByWebApp",
"tags": [
"Recommendations"
],
"summary": "Get a recommendation rule for an app.",
"description": "Description for Get a recommendation rule for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"description": "Name of the recommendation.",
"required": true,
"type": "string"
},
{
"name": "updateSeen",
"in": "query",
"description": "Specify true to update the last-seen timestamp of the recommendation object.",
"required": false,
"type": "boolean"
},
{
"name": "recommendationId",
"in": "query",
"description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RecommendationRule"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}/disable": {
"post": {
"operationId": "Recommendations_DisableRecommendationForSite",
"tags": [
"Recommendations"
],
"summary": "Disables the specific rule for a web site permanently.",
"description": "Description for Disables the specific rule for a web site permanently.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "name",
"in": "path",
"description": "Name of the recommendation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/disable": {
"post": {
"operationId": "Recommendations_DisableAllForWebApp",
"tags": [
"Recommendations"
],
"summary": "Disable all recommendations for an app.",
"description": "Description for Disable all recommendations for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/reset": {
"post": {
"operationId": "Recommendations_ResetAllFiltersForWebApp",
"tags": [
"Recommendations"
],
"summary": "Reset all recommendation opt-out settings for an app.",
"description": "Description for Reset all recommendation opt-out settings for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": {
"post": {
"operationId": "WebApps_ResetProductionSlotConfig",
"tags": [
"WebApps"
],
"summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata": {
"get": {
"operationId": "ResourceHealthMetadata_ListBySite",
"tags": [
"ResourceHealthMetadata"
],
"summary": "Gets the category of ResourceHealthMetadata to use for the given site as a collection",
"description": "Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceHealthMetadataCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List ResourceHealthMetadata for a site": {
"$ref": "./examples/ListResourceHealthMetadataBySite.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default": {
"get": {
"operationId": "ResourceHealthMetadata_GetBySite",
"tags": [
"ResourceHealthMetadata"
],
"summary": "Gets the category of ResourceHealthMetadata to use for the given site",
"description": "Description for Gets the category of ResourceHealthMetadata to use for the given site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceHealthMetadata"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get ResourceHealthMetadata": {
"$ref": "./examples/GetResourceHealthMetadataBySite.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": {
"post": {
"operationId": "WebApps_Restart",
"tags": [
"WebApps"
],
"summary": "Restarts an app (or deployment slot, if specified).",
"description": "Description for Restarts an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "softRestart",
"in": "query",
"description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.",
"required": false,
"type": "boolean"
},
{
"name": "synchronous",
"in": "query",
"description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": {
"post": {
"operationId": "WebApps_RestoreFromBackupBlob",
"tags": [
"WebApps"
],
"summary": "Restores an app from a backup blob in Azure Storage.",
"description": "Description for Restores an app from a backup blob in Azure Storage.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Information on restore request .",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": {
"post": {
"operationId": "WebApps_RestoreFromDeletedApp",
"tags": [
"WebApps"
],
"summary": "Restores a deleted web app to this web app.",
"description": "Description for Restores a deleted web app to this web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "restoreRequest",
"in": "body",
"description": "Deleted web app restore information.",
"required": true,
"schema": {
"$ref": "#/definitions/DeletedAppRestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": {
"post": {
"operationId": "WebApps_RestoreSnapshot",
"tags": [
"WebApps"
],
"summary": "Restores a web app from a snapshot.",
"description": "Description for Restores a web app from a snapshot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "restoreRequest",
"in": "body",
"description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
"required": true,
"schema": {
"$ref": "#/definitions/SnapshotRestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers": {
"get": {
"operationId": "WebApps_ListSiteContainers",
"tags": [
"WebApps"
],
"summary": "Lists all the site containers of a site, or a deployment slot.",
"description": "Lists all the site containers of a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteContainerCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sitecontainers/{containerName}": {
"get": {
"operationId": "WebApps_GetSiteContainer",
"tags": [
"WebApps"
],
"summary": "Gets a site container of a site, or a deployment slot.",
"description": "Gets a site container of a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"description": "Site Container Name",
"required": true,
"type": "string",
"pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSiteContainer",
"tags": [
"WebApps"
],
"summary": "Creates or Updates a site container for a site, or a deployment slot.",
"description": "Creates or Updates a site container for a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"description": "Site Container Name",
"required": true,
"type": "string",
"pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)"
},
{
"name": "request",
"in": "body",
"description": "Container Entity",
"required": true,
"schema": {
"$ref": "#/definitions/SiteContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteContainer"
}
},
"201": {
"description": "Resource 'SiteContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteSiteContainer",
"tags": [
"WebApps"
],
"summary": "Deletes a site container for a site, or a deployment slot.",
"description": "Deletes a site container for a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"description": "Site Container Name",
"required": true,
"type": "string",
"pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": {
"get": {
"operationId": "WebApps_ListSiteExtensions",
"tags": [
"WebApps"
],
"summary": "Get list of siteextensions for a web site, or a deployment slot.",
"description": "Description for Get list of siteextensions for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": {
"get": {
"operationId": "WebApps_GetSiteExtension",
"tags": [
"WebApps"
],
"summary": "Get site extension information by its ID for a web site, or a deployment slot.",
"description": "Description for Get site extension information by its ID for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "siteExtensionId",
"in": "path",
"description": "Site extension name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_InstallSiteExtension",
"tags": [
"WebApps"
],
"summary": "Install site extension on a web site, or a deployment slot.",
"description": "Description for Install site extension on a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "siteExtensionId",
"in": "path",
"description": "Site extension name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"201": {
"description": "Resource 'SiteExtensionInfo' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"429": {
"description": "Client error",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/SiteExtensionInfo"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "WebApps_DeleteSiteExtension",
"tags": [
"WebApps"
],
"summary": "Remove a site extension from a web site, or a deployment slot.",
"description": "Description for Remove a site extension from a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "siteExtensionId",
"in": "path",
"description": "Site extension name.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": {
"get": {
"operationId": "WebApps_ListSlots",
"tags": [
"WebApps"
],
"summary": "Gets an app's deployment slots.",
"description": "Description for Gets an app's deployment slots.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Web App Slots": {
"$ref": "./examples/ListWebAppSlots.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": {
"get": {
"operationId": "WebApps_GetSlot",
"tags": [
"WebApps"
],
"summary": "Gets the details of a web, mobile, or API app.",
"description": "Description for Gets the details of a web, mobile, or API app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Site"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Web App Slot": {
"$ref": "./examples/GetWebAppSlot.json"
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSlot",
"tags": [
"WebApps"
],
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteEnvelope",
"in": "body",
"description": "A JSON representation of the app properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/Site"
}
}
],
"responses": {
"200": {
"description": "Resource 'Site' update operation succeeded",
"schema": {
"$ref": "#/definitions/Site"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/Site"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Clone web app slot": {
"$ref": "./examples/CloneWebAppSlot.json"
},
"Create or Update Web App Slot": {
"$ref": "./examples/CreateOrUpdateWebAppSlot.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/Site"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "WebApps_UpdateSlot",
"tags": [
"WebApps"
],
"summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteEnvelope",
"in": "body",
"description": "A JSON representation of the app properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SitePatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Site"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/Site"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update Web App Slot": {
"$ref": "./examples/UpdateWebAppSlot.json"
}
}
},
"delete": {
"operationId": "WebApps_DeleteSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a web, mobile, or API app, or one of the deployment slots.",
"description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "deleteMetrics",
"in": "query",
"description": "If true, web app metrics are also deleted.",
"required": false,
"type": "boolean"
},
{
"name": "deleteEmptyServerFarm",
"in": "query",
"description": "Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "The request has succeeded."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Web App Slot": {
"$ref": "./examples/DeleteWebAppSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": {
"get": {
"operationId": "WebApps_AnalyzeCustomHostnameSlot",
"tags": [
"WebApps"
],
"summary": "Analyze a custom hostname.",
"description": "Description for Analyze a custom hostname.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "query",
"description": "Custom hostname.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CustomHostnameAnalysisResult"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Analyze custom hostname for slot": {
"$ref": "./examples/AnalyzeCustomHostNameSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": {
"post": {
"operationId": "WebApps_ApplySlotConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Applies the configuration settings from the target slot onto the current slot.",
"description": "Description for Applies the configuration settings from the target slot onto the current slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "slotSwapEntity",
"in": "body",
"description": "JSON object that contains the target slot name. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": {
"post": {
"operationId": "WebApps_BackupSlot",
"tags": [
"WebApps"
],
"summary": "Creates a backup of an app.",
"description": "Description for Creates a backup of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Backup configuration. You can use the JSON response from the POST action as input here.",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": {
"get": {
"operationId": "WebApps_ListBackupsSlot",
"tags": [
"WebApps"
],
"summary": "Gets existing backups of an app.",
"description": "Description for Gets existing backups of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": {
"get": {
"operationId": "WebApps_GetBackupStatusSlot",
"tags": [
"WebApps"
],
"summary": "Gets a backup of an app by its ID.",
"description": "Description for Gets a backup of an app by its ID.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteBackupSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a backup of an app by its ID.",
"description": "Description for Deletes a backup of an app by its ID.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": {
"post": {
"operationId": "WebApps_ListBackupStatusSecretsSlot",
"tags": [
"WebApps"
],
"summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Information on backup request.",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItem"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": {
"post": {
"operationId": "WebApps_RestoreSlot",
"tags": [
"WebApps"
],
"summary": "Restores a specific backup to another app (or deployment slot, if specified).",
"description": "Description for Restores a specific backup to another app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
"required": true,
"type": "string"
},
{
"name": "backupId",
"in": "path",
"description": "ID of the backup.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Information on restore request .",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies": {
"get": {
"operationId": "WebApps_ListBasicPublishingCredentialsPoliciesSlot",
"tags": [
"WebApps"
],
"summary": "Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
"description": "Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PublishingCredentialsPoliciesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Publishing Credentials Policies": {
"$ref": "./examples/ListPublishingCredentialsPoliciesSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/ftp": {
"get": {
"operationId": "WebApps_GetFtpAllowedSlot",
"tags": [
"WebApps"
],
"summary": "Returns whether FTP is allowed on the site or not.",
"description": "Description for Returns whether FTP is allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get FTP Allowed": {
"$ref": "./examples/GetPublishingCredentialsPolicySlot_FtpAllowedSlot.json"
}
}
},
"put": {
"operationId": "WebApps_UpdateFtpAllowedSlot",
"tags": [
"WebApps"
],
"summary": "Updates whether FTP is allowed on the site or not.",
"description": "Description for Updates whether FTP is allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "csmPublishingAccessPoliciesEntity",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
}
],
"responses": {
"200": {
"description": "Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update FTP Allowed": {
"$ref": "./examples/UpdatePublishingCredentialsPolicySlot_UpdateFtpAllowedSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/basicPublishingCredentialsPolicies/scm": {
"get": {
"operationId": "WebApps_GetScmAllowedSlot",
"tags": [
"WebApps"
],
"summary": "Returns whether Scm basic auth is allowed on the site or not.",
"description": "Description for Returns whether Scm basic auth is allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get SCM Allowed": {
"$ref": "./examples/GetPublishingCredentialsPolicySlot.json"
}
}
},
"put": {
"operationId": "WebApps_UpdateScmAllowedSlot",
"tags": [
"WebApps"
],
"summary": "Updates whether user publishing credentials are allowed on the site or not.",
"description": "Description for Updates whether user publishing credentials are allowed on the site or not.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "csmPublishingAccessPoliciesEntity",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
}
],
"responses": {
"200": {
"description": "Resource 'CsmPublishingCredentialsPoliciesEntity' update operation succeeded",
"schema": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Update SCM Allowed": {
"$ref": "./examples/UpdatePublishingCredentialsPolicySlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates": {
"get": {
"operationId": "SiteCertificates_ListSlot",
"tags": [
"SiteCertificates"
],
"summary": "Get all certificates in a resource group for a given site and a deployment slot.",
"description": "Get all certificates in a resource group for a given site and a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Certificates by resource group for a slot": {
"$ref": "./examples/ListSiteCertificatesByResourceGroupSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/certificates/{certificateName}": {
"get": {
"operationId": "SiteCertificates_GetSlot",
"tags": [
"SiteCertificates"
],
"summary": "Get a certificate for a given site and deployment slot.",
"description": "Get a certificate for a given site and deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Site Certificate for a slot": {
"$ref": "./examples/GetSiteCertificateSlot.json"
}
}
},
"put": {
"operationId": "SiteCertificates_CreateOrUpdateSlot",
"tags": [
"SiteCertificates"
],
"summary": "Create or update a certificate in a given site and deployment slot.",
"description": "Create or update a certificate in a given site and deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Details of certificate, if it exists already.",
"required": true,
"schema": {
"$ref": "#/definitions/Certificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'Certificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"201": {
"description": "Resource 'Certificate' create operation succeeded",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create Or Update Certificate for slot": {
"$ref": "./examples/CreateOrUpdateSiteCertificateSlot.json"
}
}
},
"patch": {
"operationId": "SiteCertificates_UpdateSlot",
"tags": [
"SiteCertificates"
],
"summary": "Create or update a certificate for a site and deployment slot.",
"description": "Create or update a certificate for a site and deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "certificateEnvelope",
"in": "body",
"description": "Details of certificate, if it exists already.",
"required": true,
"schema": {
"$ref": "#/definitions/CertificatePatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Certificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch Certificate for slot": {
"$ref": "./examples/PatchSiteCertificateSlot.json"
}
}
},
"delete": {
"operationId": "SiteCertificates_DeleteSlot",
"tags": [
"SiteCertificates"
],
"summary": "Delete a certificate for a given site and deployment slot.",
"description": "Delete a certificate for a given site and deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "certificateName",
"in": "path",
"description": "Name of the certificate.",
"required": true,
"type": "string",
"pattern": "^[A-z][A-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete Certificate for slot": {
"$ref": "./examples/DeleteSiteCertificateSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": {
"get": {
"operationId": "WebApps_ListConfigurationsSlot",
"tags": [
"WebApps"
],
"summary": "List the configurations of an app",
"description": "Description for List the configurations of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResourceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": {
"put": {
"operationId": "WebApps_UpdateApplicationSettingsSlot",
"tags": [
"WebApps"
],
"summary": "Replaces the application settings of an app.",
"description": "Description for Replaces the application settings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "appSettings",
"in": "body",
"description": "Application settings of the app.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": {
"post": {
"operationId": "WebApps_ListApplicationSettingsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the application settings of an app.",
"description": "Description for Gets the application settings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": {
"put": {
"operationId": "WebApps_UpdateAuthSettingsSlot",
"tags": [
"WebApps"
],
"summary": "Updates the Authentication / Authorization settings associated with web app.",
"description": "Description for Updates the Authentication / Authorization settings associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteAuthSettings",
"in": "body",
"description": "Auth settings associated with web app.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": {
"post": {
"operationId": "WebApps_GetAuthSettingsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the Authentication/Authorization settings of an app.",
"description": "Description for Gets the Authentication/Authorization settings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2": {
"get": {
"operationId": "WebApps_GetAuthSettingsV2WithoutSecretsSlot",
"tags": [
"WebApps"
],
"summary": "Gets site's Authentication / Authorization settings for apps via the V2 format",
"description": "Gets site's Authentication / Authorization settings for apps via the V2 format",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_UpdateAuthSettingsV2Slot",
"tags": [
"WebApps"
],
"summary": "Updates site's Authentication / Authorization settings for apps via the V2 format",
"description": "Description for Updates site's Authentication / Authorization settings for apps via the V2 format",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteAuthSettingsV2",
"in": "body",
"description": "Auth settings associated with web app.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteAuthSettingsV2' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list": {
"get": {
"operationId": "WebApps_GetAuthSettingsV2Slot",
"tags": [
"WebApps"
],
"summary": "Gets site's Authentication / Authorization settings for apps via the V2 format",
"description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteAuthSettingsV2"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": {
"put": {
"operationId": "WebApps_UpdateAzureStorageAccountsSlot",
"tags": [
"WebApps"
],
"summary": "Updates the Azure storage account configurations of an app.",
"description": "Description for Updates the Azure storage account configurations of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "azureStorageAccounts",
"in": "body",
"description": "Azure storage accounts of the app.",
"required": true,
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": {
"post": {
"operationId": "WebApps_ListAzureStorageAccountsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the Azure storage account configurations of an app.",
"description": "Description for Gets the Azure storage account configurations of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": {
"put": {
"operationId": "WebApps_UpdateBackupConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Updates the backup configuration of an app.",
"description": "Description for Updates the backup configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Edited backup configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/BackupRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteBackupConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Deletes the backup configuration of an app.",
"description": "Description for Deletes the backup configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": {
"post": {
"operationId": "WebApps_GetBackupConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Gets the backup configuration of an app.",
"description": "Description for Gets the backup configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupRequest"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings": {
"get": {
"operationId": "WebApps_GetAppSettingsKeyVaultReferencesSlot",
"tags": [
"WebApps"
],
"summary": "Gets the config reference app settings and status of an app",
"description": "Description for Gets the config reference app settings and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReferenceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Azure Key Vault references for app settings for slot": {
"$ref": "./examples/GetKeyVaultReferencesForAppSettingsSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/appsettings/{appSettingKey}": {
"get": {
"operationId": "WebApps_GetAppSettingKeyVaultReferenceSlot",
"tags": [
"WebApps"
],
"summary": "Gets the config reference and status of an app",
"description": "Description for Gets the config reference and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "appSettingKey",
"in": "path",
"description": "App Setting key name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReference"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Azure Key Vault slot app setting reference": {
"$ref": "./examples/GetKeyVaultReferencesForAppSettingSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings": {
"get": {
"operationId": "WebApps_GetSiteConnectionStringKeyVaultReferencesSlot",
"tags": [
"WebApps"
],
"summary": "Gets the config reference app settings and status of an app",
"description": "Description for Gets the config reference app settings and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReferenceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/configreferences/connectionstrings/{connectionStringKey}": {
"get": {
"operationId": "WebApps_GetSiteConnectionStringKeyVaultReferenceSlot",
"tags": [
"WebApps"
],
"summary": "Gets the config reference and status of an app",
"description": "Description for Gets the config reference and status of an app",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "connectionStringKey",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ApiKVReference"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": {
"put": {
"operationId": "WebApps_UpdateConnectionStringsSlot",
"tags": [
"WebApps"
],
"summary": "Replaces the connection strings of an app.",
"description": "Description for Replaces the connection strings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "connectionStrings",
"in": "body",
"description": "Connection strings of the app or deployment slot. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": {
"post": {
"operationId": "WebApps_ListConnectionStringsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the connection strings of an app.",
"description": "Description for Gets the connection strings of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ConnectionStringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": {
"get": {
"operationId": "WebApps_GetDiagnosticLogsConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Gets the logging configuration of an app.",
"description": "Description for Gets the logging configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_UpdateDiagnosticLogsConfigSlot",
"tags": [
"WebApps"
],
"summary": "Updates the logging configuration of an app.",
"description": "Description for Updates the logging configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteLogsConfig",
"in": "body",
"description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\"property",
"required": true,
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteLogsConfig' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteLogsConfig"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": {
"put": {
"operationId": "WebApps_UpdateMetadataSlot",
"tags": [
"WebApps"
],
"summary": "Replaces the metadata of an app.",
"description": "Description for Replaces the metadata of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "metadata",
"in": "body",
"description": "Edited metadata of the app or deployment slot. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": {
"post": {
"operationId": "WebApps_ListMetadataSlot",
"tags": [
"WebApps"
],
"summary": "Gets the metadata of an app.",
"description": "Description for Gets the metadata of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": {
"post": {
"operationId": "WebApps_ListPublishingCredentialsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the Git/FTP publishing credentials of an app.",
"description": "Description for Gets the Git/FTP publishing credentials of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "If true, the password is included in the response. The default is false.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/User"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/User"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": {
"put": {
"operationId": "WebApps_UpdateSitePushSettingsSlot",
"tags": [
"WebApps"
],
"summary": "Updates the Push settings associated with web app.",
"description": "Description for Updates the Push settings associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "pushSettings",
"in": "body",
"description": "Push settings associated with web app.",
"required": true,
"schema": {
"$ref": "#/definitions/PushSettings"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PushSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": {
"post": {
"operationId": "WebApps_ListSitePushSettingsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the Push settings associated with web app.",
"description": "Description for Gets the Push settings associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PushSettings"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": {
"get": {
"operationId": "WebApps_GetConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Updates the configuration of an app.",
"description": "Description for Updates the configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteConfig",
"in": "body",
"description": "JSON representation of a SiteConfig object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteConfigResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Updates the configuration of an app.",
"description": "Description for Updates the configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteConfig",
"in": "body",
"description": "JSON representation of a SiteConfig object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": {
"get": {
"operationId": "WebApps_ListConfigurationSnapshotInfoSlot",
"tags": [
"WebApps"
],
"summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": {
"get": {
"operationId": "WebApps_GetConfigurationSnapshotSlot",
"tags": [
"WebApps"
],
"summary": "Gets a snapshot of the configuration of an app at a previous point in time.",
"description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "snapshotId",
"in": "path",
"description": "The ID of the snapshot to read.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": {
"post": {
"operationId": "WebApps_RecoverSiteConfigurationSnapshotSlot",
"tags": [
"WebApps"
],
"summary": "Reverts the configuration of an app to a previous snapshot.",
"description": "Description for Reverts the configuration of an app to a previous snapshot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "snapshotId",
"in": "path",
"description": "The ID of the snapshot to read.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": {
"post": {
"operationId": "WebApps_GetWebSiteContainerLogsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the last lines of docker logs for the given site",
"description": "Description for Gets the last lines of docker logs for the given site",
"produces": [
"application/octet-stream",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": {
"post": {
"operationId": "WebApps_GetContainerLogsZipSlot",
"tags": [
"WebApps"
],
"summary": "Gets the ZIP archived docker log files for the given site",
"description": "Description for Gets the ZIP archived docker log files for the given site",
"produces": [
"application/zip",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": {
"get": {
"operationId": "WebApps_ListContinuousWebJobsSlot",
"tags": [
"WebApps"
],
"summary": "List continuous web jobs for an app, or a deployment slot.",
"description": "Description for List continuous web jobs for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContinuousWebJobCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": {
"get": {
"operationId": "WebApps_GetContinuousWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Gets a continuous web job by its ID for an app, or a deployment slot.",
"description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ContinuousWebJob"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteContinuousWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Delete a continuous web job by its ID for an app, or a deployment slot.",
"description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": {
"post": {
"operationId": "WebApps_StartContinuousWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Start a continuous web job for an app, or a deployment slot.",
"description": "Description for Start a continuous web job for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": {
"post": {
"operationId": "WebApps_StopContinuousWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Stop a continuous web job for an app, or a deployment slot.",
"description": "Description for Stop a continuous web job for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployWorkflowArtifacts": {
"post": {
"operationId": "WebApps_DeployWorkflowArtifactsSlot",
"tags": [
"WebApps"
],
"summary": "Creates the artifacts for web site, or a deployment slot.",
"description": "Description for Creates the artifacts for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "workflowArtifacts",
"in": "body",
"description": "Application settings and files of the workflow.",
"required": false,
"schema": {
"$ref": "#/definitions/WorkflowArtifacts"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Deploys workflow artifacts slot": {
"$ref": "./examples/PostDeployWorkflowArtifactsSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus": {
"get": {
"operationId": "WebApps_ListSlotSiteDeploymentStatusesSlot",
"tags": [
"WebApps"
],
"summary": "List deployment statuses for an app (or deployment slot, if specified).",
"description": "List deployment statuses for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmDeploymentStatusCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List Deployment Status Slot": {
"$ref": "./examples/ListSiteDeploymentStatusSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deploymentStatus/{deploymentStatusId}": {
"get": {
"operationId": "WebApps_GetSlotSiteDeploymentStatusSlot",
"tags": [
"WebApps"
],
"summary": "Gets the deployment status for an app (or deployment slot, if specified).",
"description": "Gets the deployment status for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the deployment status for the production slot.",
"required": true,
"type": "string"
},
{
"name": "deploymentStatusId",
"in": "path",
"description": "GUID of the deployment operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmDeploymentStatus"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/CsmDeploymentStatus"
},
"headers": {
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get Deployment Status Slot": {
"$ref": "./examples/GetSiteDeploymentStatusSlot.json"
}
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": {
"get": {
"operationId": "WebApps_ListDeploymentsSlot",
"tags": [
"WebApps"
],
"summary": "List deployments for an app, or a deployment slot.",
"description": "Description for List deployments for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DeploymentCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": {
"get": {
"operationId": "WebApps_GetDeploymentSlot",
"tags": [
"WebApps"
],
"summary": "Get a deployment by its ID for an app, or a deployment slot.",
"description": "Description for Get a deployment by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateDeploymentSlot",
"tags": [
"WebApps"
],
"summary": "Create a deployment for an app, or a deployment slot.",
"description": "Description for Create a deployment for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
},
{
"name": "deployment",
"in": "body",
"description": "Deployment details.",
"required": true,
"schema": {
"$ref": "#/definitions/Deployment"
}
}
],
"responses": {
"200": {
"description": "Resource 'Deployment' update operation succeeded",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteDeploymentSlot",
"tags": [
"WebApps"
],
"summary": "Delete a deployment by its ID for an app, or a deployment slot.",
"description": "Description for Delete a deployment by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": {
"get": {
"operationId": "WebApps_ListDeploymentLogSlot",
"tags": [
"WebApps"
],
"summary": "List deployment log for specific deployment for an app, or a deployment slot.",
"description": "Description for List deployment log for specific deployment for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "Deployment ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Deployment"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors": {
"get": {
"operationId": "Diagnostics_ListSiteDetectorResponsesSlot",
"tags": [
"Diagnostics"
],
"summary": "List Site Detector Responses",
"description": "Description for List Site Detector Responses",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorResponseCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Detector Responses": {
"$ref": "./examples/Diagnostics_ListSiteDetectorResponses_Slot.json"
},
"Get App Slot Detector Responses": {
"$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot_Slot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}": {
"get": {
"operationId": "Diagnostics_GetSiteDetectorResponseSlot",
"tags": [
"Diagnostics"
],
"summary": "Get site detector response",
"description": "Description for Get site detector response",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Resource Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Detector Response": {
"$ref": "./examples/Diagnostics_GetSiteDetectorResponse_Slot.json"
},
"Get App Slot Detector Response": {
"$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics": {
"get": {
"operationId": "Diagnostics_ListSiteDiagnosticCategoriesSlot",
"tags": [
"Diagnostics"
],
"summary": "Get Diagnostics Categories",
"description": "Description for Get Diagnostics Categories",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticCategoryCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Diagnostic Categories": {
"$ref": "./examples/Diagnostics_ListSiteDiagnosticCategories_Slot.json"
},
"List App Slot Diagnostic Categories": {
"$ref": "./examples/Diagnostics_ListSiteDiagnosticCategoriesSlot_Slot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}": {
"get": {
"operationId": "Diagnostics_GetSiteDiagnosticCategorySlot",
"tags": [
"Diagnostics"
],
"summary": "Get Diagnostics Category",
"description": "Description for Get Diagnostics Category",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticCategory"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Diagnostic Category": {
"$ref": "./examples/Diagnostics_GetSiteDiagnosticCategory_Slot.json"
},
"Get App Slot Diagnostic Category": {
"$ref": "./examples/Diagnostics_GetSiteDiagnosticCategorySlot_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses": {
"get": {
"operationId": "Diagnostics_ListSiteAnalysesSlot",
"tags": [
"Diagnostics"
],
"summary": "Get Site Analyses",
"description": "Description for Get Site Analyses",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot - optional",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticAnalysisCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Analyses": {
"$ref": "./examples/Diagnostics_ListSiteAnalyses_Slot.json"
},
"List App Slot Analyses": {
"$ref": "./examples/Diagnostics_ListSiteAnalysesSlot_Slot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}": {
"get": {
"operationId": "Diagnostics_GetSiteAnalysisSlot",
"tags": [
"Diagnostics"
],
"summary": "Get Site Analysis",
"description": "Description for Get Site Analysis",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot - optional",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "analysisName",
"in": "path",
"description": "Analysis Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/AnalysisDefinition"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Analysis": {
"$ref": "./examples/Diagnostics_GetSiteAnalysis_Slot.json"
},
"Get App Slot Analysis": {
"$ref": "./examples/Diagnostics_GetSiteAnalysisSlot_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute": {
"post": {
"operationId": "Diagnostics_ExecuteSiteAnalysisSlot",
"tags": [
"Diagnostics"
],
"summary": "Execute Analysis",
"description": "Description for Execute Analysis",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot - optional",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "analysisName",
"in": "path",
"description": "Analysis Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticAnalysis"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Execute site analysis": {
"$ref": "./examples/Diagnostics_ExecuteSiteAnalysis_Slot.json"
},
"Execute site slot analysis": {
"$ref": "./examples/Diagnostics_ExecuteSiteAnalysisSlot_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors": {
"get": {
"operationId": "Diagnostics_ListSiteDetectorsSlot",
"tags": [
"Diagnostics"
],
"summary": "Get Detectors",
"description": "Description for Get Detectors",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticDetectorCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List App Detectors": {
"$ref": "./examples/Diagnostics_ListSiteDetectors_Slot.json"
},
"List App Slot Detectors": {
"$ref": "./examples/Diagnostics_ListSiteDetectorsSlot_Slot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}": {
"get": {
"operationId": "Diagnostics_GetSiteDetectorSlot",
"tags": [
"Diagnostics"
],
"summary": "Get Detector",
"description": "Description for Get Detector",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Name",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DetectorDefinitionResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get App Detector": {
"$ref": "./examples/Diagnostics_GetSiteDetector_Slot.json"
},
"Get App Slot Detector": {
"$ref": "./examples/Diagnostics_GetSiteDetectorSlot_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute": {
"post": {
"operationId": "Diagnostics_ExecuteSiteDetectorSlot",
"tags": [
"Diagnostics"
],
"summary": "Execute Detector",
"description": "Description for Execute Detector",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "siteName",
"in": "path",
"description": "Site Name",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Slot Name",
"required": true,
"type": "string"
},
{
"name": "diagnosticCategory",
"in": "path",
"description": "Diagnostic Category",
"required": true,
"type": "string"
},
{
"name": "detectorName",
"in": "path",
"description": "Detector Name",
"required": true,
"type": "string"
},
{
"name": "startTime",
"in": "query",
"description": "Start Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "endTime",
"in": "query",
"description": "End Time",
"required": false,
"type": "string",
"format": "date-time"
},
{
"name": "timeGrain",
"in": "query",
"description": "Time Grain",
"required": false,
"type": "string",
"pattern": "PT[1-9][0-9]+[SMH]"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DiagnosticDetectorResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Execute site detector": {
"$ref": "./examples/Diagnostics_ExecuteSiteDetector_Slot.json"
},
"Execute site slot detector": {
"$ref": "./examples/Diagnostics_ExecuteSiteDetectorSlot_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": {
"post": {
"operationId": "WebApps_DiscoverBackupSlot",
"tags": [
"WebApps"
],
"summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": {
"get": {
"operationId": "WebApps_ListDomainOwnershipIdentifiersSlot",
"tags": [
"WebApps"
],
"summary": "Lists ownership identifiers for domain associated with web app.",
"description": "Description for Lists ownership identifiers for domain associated with web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/IdentifierCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": {
"get": {
"operationId": "WebApps_GetDomainOwnershipIdentifierSlot",
"tags": [
"WebApps"
],
"summary": "Get domain ownership identifier for web app.",
"description": "Description for Get domain ownership identifier for web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Identifier"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot",
"tags": [
"WebApps"
],
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifier",
"in": "body",
"description": "A JSON representation of the domain ownership properties.",
"required": true,
"schema": {
"$ref": "#/definitions/Identifier"
}
}
],
"responses": {
"200": {
"description": "Resource 'Identifier' update operation succeeded",
"schema": {
"$ref": "#/definitions/Identifier"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot",
"tags": [
"WebApps"
],
"summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifier",
"in": "body",
"description": "A JSON representation of the domain ownership properties.",
"required": true,
"schema": {
"$ref": "#/definitions/Identifier"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Identifier"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a domain ownership identifier for a web app.",
"description": "Description for Deletes a domain ownership identifier for a web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "domainOwnershipIdentifierName",
"in": "path",
"description": "Name of domain ownership identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": {
"get": {
"operationId": "WebApps_GetMSDeployStatusSlot",
"tags": [
"WebApps"
],
"summary": "Get the status of the last MSDeploy operation.",
"description": "Description for Get the status of the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateMSDeployOperationSlot",
"tags": [
"WebApps"
],
"summary": "Invoke the MSDeploy web app extension.",
"description": "Description for Invoke the MSDeploy web app extension.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
},
{
"name": "MSDeploy",
"in": "body",
"description": "Details of MSDeploy operation",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
}
],
"responses": {
"201": {
"description": "Resource 'MSDeployStatus' create operation succeeded",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"409": {
"description": "The request conflicts with the current state of the server.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/MSDeployStatus"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": {
"get": {
"operationId": "WebApps_GetMSDeployLogSlot",
"tags": [
"WebApps"
],
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": {
"get": {
"operationId": "WebApps_ListInstanceFunctionsSlot",
"tags": [
"WebApps"
],
"summary": "List the functions for a web site, or a deployment slot.",
"description": "Description for List the functions for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionEnvelopeCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": {
"get": {
"operationId": "WebApps_GetInstanceFunctionSlot",
"tags": [
"WebApps"
],
"summary": "Get function information by its ID for web site, or a deployment slot.",
"description": "Description for Get function information by its ID for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateInstanceFunctionSlot",
"tags": [
"WebApps"
],
"summary": "Create function for web site, or a deployment slot.",
"description": "Description for Create function for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
},
{
"name": "function_envelope",
"in": "body",
"description": "Function details.",
"required": true,
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
}
}
],
"responses": {
"201": {
"description": "Resource 'FunctionEnvelope' create operation succeeded",
"schema": {
"$ref": "#/definitions/FunctionEnvelope"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/FunctionEnvelope"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "WebApps_DeleteInstanceFunctionSlot",
"tags": [
"WebApps"
],
"summary": "Delete a function for web site, or a deployment slot.",
"description": "Description for Delete a function for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": {
"put": {
"operationId": "WebApps_CreateOrUpdateFunctionSecretSlot",
"tags": [
"WebApps"
],
"summary": "Add or update a function secret.",
"description": "Description for Add or update a function secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "body",
"description": "The key to create or update",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Resource 'KeyInfo' create operation succeeded",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteFunctionSecretSlot",
"tags": [
"WebApps"
],
"summary": "Delete a function secret.",
"description": "Description for Delete a function secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": {
"post": {
"operationId": "WebApps_ListFunctionKeysSlot",
"tags": [
"WebApps"
],
"summary": "Get function keys for a function in a web site, or a deployment slot.",
"description": "Description for Get function keys for a function in a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": {
"post": {
"operationId": "WebApps_ListFunctionSecretsSlot",
"tags": [
"WebApps"
],
"summary": "Get function secrets for a function in a web site, or a deployment slot.",
"description": "Description for Get function secrets for a function in a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"description": "Function name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": {
"get": {
"operationId": "WebApps_GetFunctionsAdminTokenSlot",
"tags": [
"WebApps"
],
"summary": "Fetch a short lived token that can be exchanged for a master key.",
"description": "Description for Fetch a short lived token that can be exchanged for a master key.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/stringApplicationJson"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": {
"post": {
"operationId": "WebApps_ListHostKeysSlot",
"tags": [
"WebApps"
],
"summary": "Get host secrets for a function app.",
"description": "Description for Get host secrets for a function app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostKeys"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": {
"post": {
"operationId": "WebApps_ListSyncStatusSlot",
"tags": [
"WebApps"
],
"summary": "This is to allow calling via powershell and ARM template.",
"description": "Description for This is to allow calling via powershell and ARM template.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync": {
"post": {
"operationId": "WebApps_SyncFunctionsSlot",
"tags": [
"WebApps"
],
"summary": "Syncs function trigger metadata to the management database",
"description": "Description for Syncs function trigger metadata to the management database",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": {
"get": {
"operationId": "WebApps_ListHostNameBindingsSlot",
"tags": [
"WebApps"
],
"summary": "Get hostname bindings for an app or a deployment slot.",
"description": "Description for Get hostname bindings for an app or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostNameBindingCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": {
"get": {
"operationId": "WebApps_GetHostNameBindingSlot",
"tags": [
"WebApps"
],
"summary": "Get the named hostname binding for an app (or deployment slot, if specified).",
"description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "path",
"description": "Hostname in the hostname binding.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateHostNameBindingSlot",
"tags": [
"WebApps"
],
"summary": "Creates a hostname binding for an app.",
"description": "Description for Creates a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "path",
"description": "Hostname in the hostname binding.",
"required": true,
"type": "string"
},
{
"name": "hostNameBinding",
"in": "body",
"description": "Binding details. This is the JSON representation of a HostNameBinding object.",
"required": true,
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
}
],
"responses": {
"200": {
"description": "Resource 'HostNameBinding' update operation succeeded",
"schema": {
"$ref": "#/definitions/HostNameBinding"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteHostNameBindingSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a hostname binding for an app.",
"description": "Description for Deletes a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "hostName",
"in": "path",
"description": "Hostname in the hostname binding.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
"get": {
"operationId": "WebApps_GetHybridConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "The name of the slot for the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateHybridConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "The name of the slot for the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
"$ref": "#/definitions/HybridConnection"
}
}
],
"responses": {
"200": {
"description": "Resource 'HybridConnection' update operation succeeded",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateHybridConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Creates a new Hybrid Connection using a Service Bus relay.",
"description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "The name of the slot for the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
"$ref": "#/definitions/HybridConnection"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteHybridConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Removes a Hybrid Connection from this site.",
"description": "Description for Removes a Hybrid Connection from this site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "The name of the slot for the web app.",
"required": true,
"type": "string"
},
{
"name": "namespaceName",
"in": "path",
"description": "The namespace for this hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "relayName",
"in": "path",
"description": "The relay name for this hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": {
"get": {
"operationId": "WebApps_ListHybridConnectionsSlot",
"tags": [
"WebApps"
],
"summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.",
"description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HybridConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": {
"get": {
"operationId": "WebApps_ListRelayServiceConnectionsSlot",
"tags": [
"WebApps"
],
"summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).",
"description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": {
"get": {
"operationId": "WebApps_GetRelayServiceConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Gets a hybrid connection configuration by its name.",
"description": "Description for Gets a hybrid connection configuration by its name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateRelayServiceConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Details of the hybrid connection configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
}
],
"responses": {
"200": {
"description": "Resource 'RelayServiceConnectionEntity' update operation succeeded",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateRelayServiceConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Details of the hybrid connection configuration.",
"required": true,
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteRelayServiceConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a relay service connection by its name.",
"description": "Description for Deletes a relay service connection by its name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.",
"required": true,
"type": "string"
},
{
"name": "entityName",
"in": "path",
"description": "Name of the hybrid connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": {
"get": {
"operationId": "WebApps_ListInstanceIdentifiersSlot",
"tags": [
"WebApps"
],
"summary": "Gets all scale-out instances of an app.",
"description": "Description for Gets all scale-out instances of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebAppInstanceStatusCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}": {
"get": {
"operationId": "WebApps_GetInstanceInfoSlot",
"tags": [
"WebApps"
],
"summary": "Gets all scale-out instances of an app.",
"description": "Description for Gets all scale-out instances of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebSiteInstanceStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get site instance info": {
"$ref": "./examples/GetSiteInstanceInfo_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": {
"get": {
"operationId": "WebApps_GetInstanceMsDeployStatusSlot",
"tags": [
"WebApps"
],
"summary": "Get the status of the last MSDeploy operation.",
"description": "Description for Get the status of the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of web app instance.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateInstanceMSDeployOperationSlot",
"tags": [
"WebApps"
],
"summary": "Invoke the MSDeploy web app extension.",
"description": "Description for Invoke the MSDeploy web app extension.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of web app instance.",
"required": true,
"type": "string"
},
{
"name": "MSDeploy",
"in": "body",
"description": "Details of MSDeploy operation",
"required": true,
"schema": {
"$ref": "#/definitions/MSDeploy"
}
}
],
"responses": {
"201": {
"description": "Resource 'MSDeployStatus' create operation succeeded",
"schema": {
"$ref": "#/definitions/MSDeployStatus"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"409": {
"description": "The request conflicts with the current state of the server.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/MSDeployStatus"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": {
"get": {
"operationId": "WebApps_GetInstanceMSDeployLogSlot",
"tags": [
"WebApps"
],
"summary": "Get the MSDeploy Log for the last MSDeploy operation.",
"description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of web app instance.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MSDeployLog"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes": {
"get": {
"operationId": "WebApps_ListInstanceProcessesSlot",
"tags": [
"WebApps"
],
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}": {
"get": {
"operationId": "WebApps_GetInstanceProcessSlot",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteInstanceProcessSlot",
"tags": [
"WebApps"
],
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump": {
"get": {
"operationId": "WebApps_GetInstanceProcessDumpSlot",
"tags": [
"WebApps"
],
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"produces": [
"*/*",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules": {
"get": {
"operationId": "WebApps_ListInstanceProcessModulesSlot",
"tags": [
"WebApps"
],
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": {
"get": {
"operationId": "WebApps_GetInstanceProcessModuleSlot",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
},
{
"name": "baseAddress",
"in": "path",
"description": "Module base address.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads": {
"get": {
"operationId": "WebApps_ListInstanceProcessThreadsSlot",
"tags": [
"WebApps"
],
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "instanceId",
"in": "path",
"description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": {
"post": {
"operationId": "WebApps_IsCloneableSlot",
"tags": [
"WebApps"
],
"summary": "Shows whether an app can be cloned to another resource group or subscription.",
"description": "Description for Shows whether an app can be cloned to another resource group or subscription.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteCloneability"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listWorkflowsConnections": {
"post": {
"operationId": "WebApps_ListWorkflowsConnectionsSlot",
"tags": [
"WebApps"
],
"summary": "Lists logic app's connections for web site, or a deployment slot.",
"description": "Lists logic app's connections for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List the Instance Workflows Configuration Connections Slot": {
"$ref": "./examples/ListWorkflowsConfigurationConnections_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups": {
"post": {
"operationId": "WebApps_ListSiteBackupsSlot",
"tags": [
"WebApps"
],
"summary": "Gets existing backups of an app.",
"description": "Description for Gets existing backups of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/BackupItemCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List backups": {
"$ref": "./examples/ListSiteBackupsSlot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": {
"post": {
"operationId": "WebApps_ListSyncFunctionTriggersSlot",
"tags": [
"WebApps"
],
"summary": "This is to allow calling via powershell and ARM template.",
"description": "Description for This is to allow calling via powershell and ARM template.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/FunctionSecrets"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": {
"get": {
"operationId": "WebApps_GetMigrateMySqlStatusSlot",
"tags": [
"WebApps"
],
"summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/MigrateMySqlStatus"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork": {
"get": {
"operationId": "WebApps_GetSwiftVirtualNetworkConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Gets a Swift Virtual Network connection.",
"description": "Description for Gets a Swift Virtual Network connection.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionWithCheckSlot",
"tags": [
"WebApps"
],
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
}
],
"responses": {
"200": {
"description": "Resource 'SwiftVirtualNetwork' update operation succeeded",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionWithCheckSlot",
"tags": [
"WebApps"
],
"summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
"description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SwiftVirtualNetwork"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteSwiftVirtualNetworkSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": {
"get": {
"operationId": "WebApps_ListNetworkFeaturesSlot",
"tags": [
"WebApps"
],
"summary": "Gets all network features used by the app (or deployment slot, if specified).",
"description": "Description for Gets all network features used by the app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.",
"required": true,
"type": "string"
},
{
"name": "view",
"in": "path",
"description": "The type of view. Only \"summary\" is supported at this time.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/NetworkFeatures"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": {
"post": {
"operationId": "WebApps_StartWebSiteNetworkTraceSlot",
"tags": [
"WebApps"
],
"summary": "Start capturing network packets for the site (To be deprecated).",
"description": "Description for Start capturing network packets for the site (To be deprecated).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "durationInSeconds",
"in": "query",
"description": "The duration to keep capturing in seconds.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxFrameLength",
"in": "query",
"description": "The maximum frame length in bytes (Optional).",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sasUrl",
"in": "query",
"description": "The Blob URL to store capture file.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/stringApplicationJson"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation": {
"post": {
"operationId": "WebApps_StartWebSiteNetworkTraceOperationSlot",
"tags": [
"WebApps"
],
"summary": "Start capturing network packets for the site.",
"description": "Description for Start capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "durationInSeconds",
"in": "query",
"description": "The duration to keep capturing in seconds.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxFrameLength",
"in": "query",
"description": "The maximum frame length in bytes (Optional).",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sasUrl",
"in": "query",
"description": "The Blob URL to store capture file.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Start a new network trace operation for a site": {
"$ref": "./examples/StartWebSiteNetworkTraceOperation_Slot.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": {
"post": {
"operationId": "WebApps_StopWebSiteNetworkTraceSlot",
"tags": [
"WebApps"
],
"summary": "Stop ongoing capturing network packets for the site.",
"description": "Description for Stop ongoing capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"$ref": "./examples/StopWebSiteNetworkTrace_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": {
"post": {
"operationId": "WebApps_GenerateNewSitePublishingPasswordSlot",
"tags": [
"WebApps"
],
"summary": "Generates a new publishing password for an app (or deployment slot, if specified).",
"description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": {
"get": {
"operationId": "WebApps_ListPerfMonCountersSlot",
"tags": [
"WebApps"
],
"summary": "Gets perfmon counters for web app.",
"description": "Description for Gets perfmon counters for web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PerfMonCounterCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": {
"get": {
"operationId": "WebApps_GetSitePhpErrorLogFlagSlot",
"tags": [
"WebApps"
],
"summary": "Gets web app's event logs.",
"description": "Description for Gets web app's event logs.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SitePhpErrorLogFlag"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": {
"get": {
"operationId": "WebApps_ListPremierAddOnsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the premier add-ons of an app.",
"description": "Description for Gets the premier add-ons of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": {
"get": {
"operationId": "WebApps_GetPremierAddOnSlot",
"tags": [
"WebApps"
],
"summary": "Gets a named add-on of an app.",
"description": "Description for Gets a named add-on of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_AddPremierAddOnSlot",
"tags": [
"WebApps"
],
"summary": "Updates a named add-on of an app.",
"description": "Description for Updates a named add-on of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
},
{
"name": "premierAddOn",
"in": "body",
"description": "A JSON representation of the edited premier add-on.",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
}
],
"responses": {
"200": {
"description": "Resource 'PremierAddOn' update operation succeeded",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdatePremierAddOnSlot",
"tags": [
"WebApps"
],
"summary": "Updates a named add-on of an app.",
"description": "Description for Updates a named add-on of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
},
{
"name": "premierAddOn",
"in": "body",
"description": "A JSON representation of the edited premier add-on.",
"required": true,
"schema": {
"$ref": "#/definitions/PremierAddOnPatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PremierAddOn"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeletePremierAddOnSlot",
"tags": [
"WebApps"
],
"summary": "Delete a premier add-on from an app.",
"description": "Description for Delete a premier add-on from an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.",
"required": true,
"type": "string"
},
{
"name": "premierAddOnName",
"in": "path",
"description": "Add-on name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks": {
"get": {
"operationId": "WebApps_GetPrivateAccessSlot",
"tags": [
"WebApps"
],
"summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "The name of the slot for the web app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_PutPrivateAccessVnetSlot",
"tags": [
"WebApps"
],
"summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "The name of the web app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "The name of the slot for the web app.",
"required": true,
"type": "string"
},
{
"name": "access",
"in": "body",
"description": "The information for the private access",
"required": true,
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
}
],
"responses": {
"200": {
"description": "Resource 'PrivateAccess' update operation succeeded",
"schema": {
"$ref": "#/definitions/PrivateAccess"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections": {
"get": {
"operationId": "WebApps_GetPrivateEndpointConnectionListSlot",
"tags": [
"WebApps"
],
"summary": "Gets the list of private endpoint connections associated with a site",
"description": "Description for Gets the list of private endpoint connections associated with a site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the site deployment slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"operationId": "WebApps_GetPrivateEndpointConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Gets a private endpoint connection",
"description": "Description for Gets a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the site deployment slot.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a private endpoint connection for a site.": {
"$ref": "./examples/GetSitePrivateEndpointConnectionSlot.json"
}
}
},
"put": {
"operationId": "WebApps_ApproveOrRejectPrivateEndpointConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Approves or rejects a private endpoint connection",
"description": "Description for Approves or rejects a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the site deployment slot.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointWrapper",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Approves or rejects a private endpoint connection for a site.": {
"$ref": "./examples/ApproveRejectSitePrivateEndpointConnectionSlot.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "WebApps_DeletePrivateEndpointConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a private endpoint connection",
"description": "Description for Deletes a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the site.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the site deployment slot.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a private endpoint connection for a site.": {
"$ref": "./examples/DeleteSitePrivateEndpointConnectionSlot.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateLinkResources": {
"get": {
"operationId": "WebApps_GetPrivateLinkResourcesSlot",
"tags": [
"WebApps"
],
"summary": "Gets the private link resources",
"description": "Description for Gets the private link resources",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateLinkResourcesWrapper"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get private link resources of a site": {
"$ref": "./examples/GetSitePrivateLinkResourcesSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes": {
"get": {
"operationId": "WebApps_ListProcessesSlot",
"tags": [
"WebApps"
],
"summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}": {
"get": {
"operationId": "WebApps_GetProcessSlot",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteProcessSlot",
"tags": [
"WebApps"
],
"summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump": {
"get": {
"operationId": "WebApps_GetProcessDumpSlot",
"tags": [
"WebApps"
],
"summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
"produces": [
"*/*",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules": {
"get": {
"operationId": "WebApps_ListProcessModulesSlot",
"tags": [
"WebApps"
],
"summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}": {
"get": {
"operationId": "WebApps_GetProcessModuleSlot",
"tags": [
"WebApps"
],
"summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
"description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
},
{
"name": "baseAddress",
"in": "path",
"description": "Module base address.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads": {
"get": {
"operationId": "WebApps_ListProcessThreadsSlot",
"tags": [
"WebApps"
],
"summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "processId",
"in": "path",
"description": "PID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ProcessThreadInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates": {
"get": {
"operationId": "WebApps_ListPublicCertificatesSlot",
"tags": [
"WebApps"
],
"summary": "Get public certificates for an app or a deployment slot.",
"description": "Description for Get public certificates for an app or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PublicCertificateCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": {
"get": {
"operationId": "WebApps_GetPublicCertificateSlot",
"tags": [
"WebApps"
],
"summary": "Get the named public certificate for an app (or deployment slot, if specified).",
"description": "Description for Get the named public certificate for an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "publicCertificateName",
"in": "path",
"description": "Public certificate name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdatePublicCertificateSlot",
"tags": [
"WebApps"
],
"summary": "Creates a hostname binding for an app.",
"description": "Description for Creates a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "publicCertificateName",
"in": "path",
"description": "Public certificate name.",
"required": true,
"type": "string"
},
{
"name": "publicCertificate",
"in": "body",
"description": "Public certificate details. This is the JSON representation of a PublicCertificate object.",
"required": true,
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
}
],
"responses": {
"200": {
"description": "Resource 'PublicCertificate' update operation succeeded",
"schema": {
"$ref": "#/definitions/PublicCertificate"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeletePublicCertificateSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a hostname binding for an app.",
"description": "Description for Deletes a hostname binding for an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
"required": true,
"type": "string"
},
{
"name": "publicCertificateName",
"in": "path",
"description": "Public certificate name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": {
"post": {
"operationId": "WebApps_ListPublishingProfileXmlWithSecretsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the publishing profile for an app (or deployment slot, if specified).",
"description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).",
"produces": [
"application/xml",
"application/json"
],
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "publishingProfileOptions",
"in": "body",
"description": "Specifies publishingProfileOptions for publishing profile. For example, use {\" format\": \"FileZilla3\"} to get a FileZilla publishing profile.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmPublishingProfileOptions"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "file"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": {
"post": {
"operationId": "WebApps_ResetSlotConfigurationSlot",
"tags": [
"WebApps"
],
"summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata": {
"get": {
"operationId": "ResourceHealthMetadata_ListBySiteSlot",
"tags": [
"ResourceHealthMetadata"
],
"summary": "Gets the category of ResourceHealthMetadata to use for the given site as a collection",
"description": "Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceHealthMetadataCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List ResourceHealthMetadata for a site": {
"$ref": "./examples/ListResourceHealthMetadataBySite_Slot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default": {
"get": {
"operationId": "ResourceHealthMetadata_GetBySiteSlot",
"tags": [
"ResourceHealthMetadata"
],
"summary": "Gets the category of ResourceHealthMetadata to use for the given site",
"description": "Description for Gets the category of ResourceHealthMetadata to use for the given site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of web app",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of web app slot. If not specified then will default to production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceHealthMetadata"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get ResourceHealthMetadata": {
"$ref": "./examples/GetResourceHealthMetadataBySite_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": {
"post": {
"operationId": "WebApps_RestartSlot",
"tags": [
"WebApps"
],
"summary": "Restarts an app (or deployment slot, if specified).",
"description": "Description for Restarts an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "softRestart",
"in": "query",
"description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.",
"required": false,
"type": "boolean"
},
{
"name": "synchronous",
"in": "query",
"description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob": {
"post": {
"operationId": "WebApps_RestoreFromBackupBlobSlot",
"tags": [
"WebApps"
],
"summary": "Restores an app from a backup blob in Azure Storage.",
"description": "Description for Restores an app from a backup blob in Azure Storage.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "request",
"in": "body",
"description": "Information on restore request .",
"required": true,
"schema": {
"$ref": "#/definitions/RestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp": {
"post": {
"operationId": "WebApps_RestoreFromDeletedAppSlot",
"tags": [
"WebApps"
],
"summary": "Restores a deleted web app to this web app.",
"description": "Description for Restores a deleted web app to this web app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "restoreRequest",
"in": "body",
"description": "Deleted web app restore information.",
"required": true,
"schema": {
"$ref": "#/definitions/DeletedAppRestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot": {
"post": {
"operationId": "WebApps_RestoreSnapshotSlot",
"tags": [
"WebApps"
],
"summary": "Restores a web app from a snapshot.",
"description": "Description for Restores a web app from a snapshot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "restoreRequest",
"in": "body",
"description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
"required": true,
"schema": {
"$ref": "#/definitions/SnapshotRestoreRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers": {
"get": {
"operationId": "WebApps_ListSiteContainersSlot",
"tags": [
"WebApps"
],
"summary": "Lists all the site containers of a site, or a deployment slot.",
"description": "Lists all the site containers of a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteContainerCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sitecontainers/{containerName}": {
"get": {
"operationId": "WebApps_GetSiteContainerSlot",
"tags": [
"WebApps"
],
"summary": "Gets a site container of a site, or a deployment slot.",
"description": "Gets a site container of a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"description": "Site Container Name",
"required": true,
"type": "string",
"pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSiteContainerSlot",
"tags": [
"WebApps"
],
"summary": "Creates or Updates a site container for a site, or a deployment slot.",
"description": "Creates or Updates a site container for a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"description": "Site Container Name",
"required": true,
"type": "string",
"pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)"
},
{
"name": "request",
"in": "body",
"description": "Container Entity",
"required": true,
"schema": {
"$ref": "#/definitions/SiteContainer"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteContainer' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteContainer"
}
},
"201": {
"description": "Resource 'SiteContainer' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteContainer"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteSiteContainerSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a site container for a site, or a deployment slot.",
"description": "Deletes a site container for a site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the Site Container for the production slot.",
"required": true,
"type": "string"
},
{
"name": "containerName",
"in": "path",
"description": "Site Container Name",
"required": true,
"type": "string",
"pattern": "(^[a-zA-Z0-9]$)|(^[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9]$)"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": {
"get": {
"operationId": "WebApps_ListSiteExtensionsSlot",
"tags": [
"WebApps"
],
"summary": "Get list of siteextensions for a web site, or a deployment slot.",
"description": "Description for Get list of siteextensions for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfoCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}": {
"get": {
"operationId": "WebApps_GetSiteExtensionSlot",
"tags": [
"WebApps"
],
"summary": "Get site extension information by its ID for a web site, or a deployment slot.",
"description": "Description for Get site extension information by its ID for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteExtensionId",
"in": "path",
"description": "Site extension name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_InstallSiteExtensionSlot",
"tags": [
"WebApps"
],
"summary": "Install site extension on a web site, or a deployment slot.",
"description": "Description for Install site extension on a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteExtensionId",
"in": "path",
"description": "Site extension name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"201": {
"description": "Resource 'SiteExtensionInfo' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteExtensionInfo"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"429": {
"description": "Client error",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/SiteExtensionInfo"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "WebApps_DeleteSiteExtensionSlot",
"tags": [
"WebApps"
],
"summary": "Remove a site extension from a web site, or a deployment slot.",
"description": "Description for Remove a site extension from a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteExtensionId",
"in": "path",
"description": "Site extension name.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Resource does not exist."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": {
"post": {
"operationId": "WebApps_ListSlotDifferencesSlot",
"tags": [
"WebApps"
],
"summary": "Get the difference in configuration settings between two web app slots.",
"description": "Description for Get the difference in configuration settings between two web app slots.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "slotSwapEntity",
"in": "body",
"description": "JSON object that contains the target slot name. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SlotDifferenceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": {
"post": {
"operationId": "WebApps_SwapSlotSlot",
"tags": [
"WebApps"
],
"summary": "Swaps two deployment slots of an app.",
"description": "Description for Swaps two deployment slots of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "slotSwapEntity",
"in": "body",
"description": "JSON object that contains the target slot name. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": {
"get": {
"operationId": "WebApps_ListSnapshotsSlot",
"tags": [
"WebApps"
],
"summary": "Returns all Snapshots to the user.",
"description": "Description for Returns all Snapshots to the user.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr": {
"get": {
"operationId": "WebApps_ListSnapshotsFromDRSecondarySlot",
"tags": [
"WebApps"
],
"summary": "Returns all Snapshots to the user from DRSecondary endpoint.",
"description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": {
"get": {
"operationId": "WebApps_GetSourceControlSlot",
"tags": [
"WebApps"
],
"summary": "Gets the source control configuration of an app.",
"description": "Description for Gets the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Resource 'SiteSourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSourceControlSlot",
"tags": [
"WebApps"
],
"summary": "Updates the source control configuration of an app.",
"description": "Description for Updates the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteSourceControl",
"in": "body",
"description": "JSON representation of a SiteSourceControl object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteSourceControl' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Resource 'SiteSourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/SiteSourceControl"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "WebApps_UpdateSourceControlSlot",
"tags": [
"WebApps"
],
"summary": "Updates the source control configuration of an app.",
"description": "Description for Updates the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "siteSourceControl",
"in": "body",
"description": "JSON representation of a SiteSourceControl object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Resource 'SiteSourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteSourceControlSlot",
"tags": [
"WebApps"
],
"summary": "Deletes the source control configuration of an app.",
"description": "Description for Deletes the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.",
"required": true,
"type": "string"
},
{
"name": "additionalFlags",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": {
"post": {
"operationId": "WebApps_StartSlot",
"tags": [
"WebApps"
],
"summary": "Starts an app (or deployment slot, if specified).",
"description": "Description for Starts an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace": {
"post": {
"operationId": "WebApps_StartNetworkTraceSlot",
"tags": [
"WebApps"
],
"summary": "Start capturing network packets for the site.",
"description": "Description for Start capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "durationInSeconds",
"in": "query",
"description": "The duration to keep capturing in seconds.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxFrameLength",
"in": "query",
"description": "The maximum frame length in bytes (Optional).",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sasUrl",
"in": "query",
"description": "The Blob URL to store capture file.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Start a new network trace operation for a site": {
"$ref": "./examples/StartWebSiteNetworkTraceOperation_StartNetworkTraceSlot.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": {
"post": {
"operationId": "WebApps_StopSlot",
"tags": [
"WebApps"
],
"summary": "Stops an app (or deployment slot, if specified).",
"description": "Description for Stops an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace": {
"post": {
"operationId": "WebApps_StopNetworkTraceSlot",
"tags": [
"WebApps"
],
"summary": "Stop ongoing capturing network packets for the site.",
"description": "Description for Stop ongoing capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"$ref": "./examples/StopWebSiteNetworkTrace_StopNetworkTraceSlot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": {
"post": {
"operationId": "WebApps_SyncRepositorySlot",
"tags": [
"WebApps"
],
"summary": "Sync web app repository.",
"description": "Description for Sync web app repository.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers": {
"post": {
"operationId": "WebApps_SyncFunctionTriggersSlot",
"tags": [
"WebApps"
],
"summary": "Syncs function trigger metadata to the management database",
"description": "Description for Syncs function trigger metadata to the management database",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs": {
"get": {
"operationId": "WebApps_ListTriggeredWebJobsSlot",
"tags": [
"WebApps"
],
"summary": "List triggered web jobs for an app, or a deployment slot.",
"description": "Description for List triggered web jobs for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredWebJobCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}": {
"get": {
"operationId": "WebApps_GetTriggeredWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Gets a triggered web job by its ID for an app, or a deployment slot.",
"description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredWebJob"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteTriggeredWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Delete a triggered web job by its ID for an app, or a deployment slot.",
"description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history": {
"get": {
"operationId": "WebApps_ListTriggeredWebJobHistorySlot",
"tags": [
"WebApps"
],
"summary": "List a triggered web job's history for an app, or a deployment slot.",
"description": "Description for List a triggered web job's history for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistoryCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}": {
"get": {
"operationId": "WebApps_GetTriggeredWebJobHistorySlot",
"tags": [
"WebApps"
],
"summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "History ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistory"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run": {
"post": {
"operationId": "WebApps_RunTriggeredWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Run a triggered web job for an app, or a deployment slot.",
"description": "Description for Run a triggered web job for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": {
"get": {
"operationId": "WebApps_ListUsagesSlot",
"tags": [
"WebApps"
],
"summary": "Gets the quota usage information of an app (or deployment slot, if specified).",
"description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "Return only information specified in the filter (using OData syntax). For 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]'.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmUsageQuotaCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": {
"get": {
"operationId": "WebApps_ListVnetConnectionsSlot",
"tags": [
"WebApps"
],
"summary": "Gets the virtual networks the app (or deployment slot) is connected to.",
"description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VnetInfoResource"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": {
"get": {
"operationId": "WebApps_GetVnetConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Gets a virtual network the app (or deployment slot) is connected to by name.",
"description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateVnetConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetInfoResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateVnetConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteVnetConnectionSlot",
"tags": [
"WebApps"
],
"summary": "Deletes a connection from an app (or deployment slot to a named virtual network.",
"description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
"get": {
"operationId": "WebApps_GetVnetConnectionGatewaySlot",
"tags": [
"WebApps"
],
"summary": "Gets an app's Virtual Network gateway.",
"description": "Description for Gets an app's Virtual Network gateway.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateVnetConnectionGatewaySlot",
"tags": [
"WebApps"
],
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetGateway"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetGateway' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateVnetConnectionGatewaySlot",
"tags": [
"WebApps"
],
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetGateway"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs": {
"get": {
"operationId": "WebApps_ListWebJobsSlot",
"tags": [
"WebApps"
],
"summary": "List webjobs for an app, or a deployment slot.",
"description": "Description for List webjobs for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebJobCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}": {
"get": {
"operationId": "WebApps_GetWebJobSlot",
"tags": [
"WebApps"
],
"summary": "Get webjob information for an app, or a deployment slot.",
"description": "Description for Get webjob information for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of the web job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebJob"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows": {
"get": {
"operationId": "WebApps_ListInstanceWorkflowsSlot",
"tags": [
"WebApps"
],
"summary": "List the workflows for a web site, or a deployment slot.",
"description": "List the workflows for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelopeCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List the workflows Slot": {
"$ref": "./examples/ListWorkflows_Slot.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/workflows/{workflowName}": {
"get": {
"operationId": "WebApps_GetInstanceWorkflowSlot",
"tags": [
"WebApps"
],
"summary": "Get workflow information by its ID for web site, or a deployment slot.",
"description": "Get workflow information by its ID for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "Workflow name.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"GET a workflow Slot": {
"$ref": "./examples/GetWorkflow_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": {
"post": {
"operationId": "WebApps_ListSlotDifferencesFromProduction",
"tags": [
"WebApps"
],
"summary": "Get the difference in configuration settings between two web app slots.",
"description": "Description for Get the difference in configuration settings between two web app slots.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slotSwapEntity",
"in": "body",
"description": "JSON object that contains the target slot name. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SlotDifferenceCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": {
"post": {
"operationId": "WebApps_SwapSlotWithProduction",
"tags": [
"WebApps"
],
"summary": "Swaps two deployment slots of an app.",
"description": "Description for Swaps two deployment slots of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slotSwapEntity",
"in": "body",
"description": "JSON object that contains the target slot name. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmSlotEntity"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": {
"get": {
"operationId": "WebApps_ListSnapshots",
"tags": [
"WebApps"
],
"summary": "Returns all Snapshots to the user.",
"description": "Description for Returns all Snapshots to the user.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr": {
"get": {
"operationId": "WebApps_ListSnapshotsFromDRSecondary",
"tags": [
"WebApps"
],
"summary": "Returns all Snapshots to the user from DRSecondary endpoint.",
"description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SnapshotCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": {
"get": {
"operationId": "WebApps_GetSourceControl",
"tags": [
"WebApps"
],
"summary": "Gets the source control configuration of an app.",
"description": "Description for Gets the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Resource 'SiteSourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateSourceControl",
"tags": [
"WebApps"
],
"summary": "Updates the source control configuration of an app.",
"description": "Description for Updates the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteSourceControl",
"in": "body",
"description": "JSON representation of a SiteSourceControl object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
}
],
"responses": {
"200": {
"description": "Resource 'SiteSourceControl' update operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Resource 'SiteSourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/SiteSourceControl"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "WebApps_UpdateSourceControl",
"tags": [
"WebApps"
],
"summary": "Updates the source control configuration of an app.",
"description": "Description for Updates the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "siteSourceControl",
"in": "body",
"description": "JSON representation of a SiteSourceControl object. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"201": {
"description": "Resource 'SiteSourceControl' create operation succeeded",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/SiteSourceControl"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteSourceControl",
"tags": [
"WebApps"
],
"summary": "Deletes the source control configuration of an app.",
"description": "Description for Deletes the source control configuration of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "additionalFlags",
"in": "query",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": {
"post": {
"operationId": "WebApps_Start",
"tags": [
"WebApps"
],
"summary": "Starts an app (or deployment slot, if specified).",
"description": "Description for Starts an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace": {
"post": {
"operationId": "WebApps_StartNetworkTrace",
"tags": [
"WebApps"
],
"summary": "Start capturing network packets for the site.",
"description": "Description for Start capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "durationInSeconds",
"in": "query",
"description": "The duration to keep capturing in seconds.",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "maxFrameLength",
"in": "query",
"description": "The maximum frame length in bytes (Optional).",
"required": false,
"type": "integer",
"format": "int32"
},
{
"name": "sasUrl",
"in": "query",
"description": "The Blob URL to store capture file.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Start a new network trace operation for a site": {
"$ref": "./examples/StartWebSiteNetworkTraceOperation_StartNetworkTrace.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": {
"post": {
"operationId": "WebApps_Stop",
"tags": [
"WebApps"
],
"summary": "Stops an app (or deployment slot, if specified).",
"description": "Description for Stops an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace": {
"post": {
"operationId": "WebApps_StopNetworkTrace",
"tags": [
"WebApps"
],
"summary": "Stop ongoing capturing network packets for the site.",
"description": "Description for Stop ongoing capturing network packets for the site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Stop a currently running network trace operation for a site": {
"$ref": "./examples/StopWebSiteNetworkTrace_StopNetworkTrace.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": {
"post": {
"operationId": "WebApps_SyncRepository",
"tags": [
"WebApps"
],
"summary": "Sync web app repository.",
"description": "Description for Sync web app repository.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers": {
"post": {
"operationId": "WebApps_SyncFunctionTriggers",
"tags": [
"WebApps"
],
"summary": "Syncs function trigger metadata to the management database",
"description": "Description for Syncs function trigger metadata to the management database",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs": {
"get": {
"operationId": "WebApps_ListTriggeredWebJobs",
"tags": [
"WebApps"
],
"summary": "List triggered web jobs for an app, or a deployment slot.",
"description": "Description for List triggered web jobs for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredWebJobCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}": {
"get": {
"operationId": "WebApps_GetTriggeredWebJob",
"tags": [
"WebApps"
],
"summary": "Gets a triggered web job by its ID for an app, or a deployment slot.",
"description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredWebJob"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteTriggeredWebJob",
"tags": [
"WebApps"
],
"summary": "Delete a triggered web job by its ID for an app, or a deployment slot.",
"description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history": {
"get": {
"operationId": "WebApps_ListTriggeredWebJobHistory",
"tags": [
"WebApps"
],
"summary": "List a triggered web job's history for an app, or a deployment slot.",
"description": "Description for List a triggered web job's history for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistoryCollection"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}": {
"get": {
"operationId": "WebApps_GetTriggeredWebJobHistory",
"tags": [
"WebApps"
],
"summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
},
{
"name": "id",
"in": "path",
"description": "History ID.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/TriggeredJobHistory"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run": {
"post": {
"operationId": "WebApps_RunTriggeredWebJob",
"tags": [
"WebApps"
],
"summary": "Run a triggered web job for an app, or a deployment slot.",
"description": "Description for Run a triggered web job for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of Web Job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/updatemachinekey": {
"post": {
"operationId": "WebApps_UpdateMachineKey",
"tags": [
"WebApps"
],
"summary": "Updates the machine key of an app.",
"description": "Updates the machine key of an app.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Updates the machine key for a site": {
"$ref": "./examples/UpdateMachineKey.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": {
"get": {
"operationId": "WebApps_ListUsages",
"tags": [
"WebApps"
],
"summary": "Gets the quota usage information of an app (or deployment slot, if specified).",
"description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "$filter",
"in": "query",
"description": "Return only information specified in the filter (using OData syntax). For 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]'.",
"required": false,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/CsmUsageQuotaCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": {
"get": {
"operationId": "WebApps_ListVnetConnections",
"tags": [
"WebApps"
],
"summary": "Gets the virtual networks the app (or deployment slot) is connected to.",
"description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/VnetInfoResource"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": {
"get": {
"operationId": "WebApps_GetVnetConnection",
"tags": [
"WebApps"
],
"summary": "Gets a virtual network the app (or deployment slot) is connected to by name.",
"description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateVnetConnection",
"tags": [
"WebApps"
],
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetInfoResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateVnetConnection",
"tags": [
"WebApps"
],
"summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetInfoResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteVnetConnection",
"tags": [
"WebApps"
],
"summary": "Deletes a connection from an app (or deployment slot to a named virtual network.",
"description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the virtual network.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
"get": {
"operationId": "WebApps_GetVnetConnectionGateway",
"tags": [
"WebApps"
],
"summary": "Gets an app's Virtual Network gateway.",
"description": "Description for Gets an app's Virtual Network gateway.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"put": {
"operationId": "WebApps_CreateOrUpdateVnetConnectionGateway",
"tags": [
"WebApps"
],
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetGateway"
}
}
],
"responses": {
"200": {
"description": "Resource 'VnetGateway' update operation succeeded",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"patch": {
"operationId": "WebApps_UpdateVnetConnectionGateway",
"tags": [
"WebApps"
],
"summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "vnetName",
"in": "path",
"description": "Name of the Virtual Network.",
"required": true,
"type": "string"
},
{
"name": "gatewayName",
"in": "path",
"description": "Name of the gateway. Currently, the only supported string is \"primary\".",
"required": true,
"type": "string"
},
{
"name": "connectionEnvelope",
"in": "body",
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
"$ref": "#/definitions/VnetGateway"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/VnetGateway"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs": {
"get": {
"operationId": "WebApps_ListWebJobs",
"tags": [
"WebApps"
],
"summary": "List webjobs for an app, or a deployment slot.",
"description": "Description for List webjobs for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebJobCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}": {
"get": {
"operationId": "WebApps_GetWebJob",
"tags": [
"WebApps"
],
"summary": "Get webjob information for an app, or a deployment slot.",
"description": "Description for Get webjob information for an app, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "webJobName",
"in": "path",
"description": "Name of the web job.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WebJob"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows": {
"get": {
"operationId": "WebApps_ListWorkflows",
"tags": [
"WebApps"
],
"summary": "List the workflows for a web site, or a deployment slot.",
"description": "List the workflows for a web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelopeCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List the workflows": {
"$ref": "./examples/ListWorkflows.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/workflows/{workflowName}": {
"get": {
"operationId": "WebApps_GetWorkflow",
"tags": [
"WebApps"
],
"summary": "Get workflow information by its ID for web site, or a deployment slot.",
"description": "Get workflow information by its ID for web site, or a deployment slot.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Site name.",
"required": true,
"type": "string"
},
{
"name": "workflowName",
"in": "path",
"description": "Workflow name.",
"required": true,
"type": "string",
"minLength": 3,
"maxLength": 63,
"pattern": "^[a-z][a-z0-9]*$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"GET a workflow": {
"$ref": "./examples/GetWorkflow.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites": {
"get": {
"operationId": "StaticSites_GetStaticSitesByResourceGroup",
"tags": [
"StaticSites"
],
"summary": "Gets all static sites in the specified resource group.",
"description": "Description for Gets all static sites in the specified resource group.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get static sites for a resource group": {
"$ref": "./examples/GetStaticSites.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}": {
"get": {
"operationId": "StaticSites_GetStaticSite",
"tags": [
"StaticSites"
],
"summary": "Gets the details of a static site.",
"description": "Description for Gets the details of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details for a static site": {
"$ref": "./examples/GetStaticSite.json"
}
}
},
"put": {
"operationId": "StaticSites_CreateOrUpdateStaticSite",
"tags": [
"StaticSites"
],
"summary": "Creates a new static site in an existing resource group, or updates an existing static site.",
"description": "Description for Creates a new static site in an existing resource group, or updates an existing static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "staticSiteEnvelope",
"in": "body",
"description": "A JSON representation of the staticsite properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'StaticSiteARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/StaticSiteARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/StaticSiteARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a static site": {
"$ref": "./examples/CreateOrUpdateStaticSite.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StaticSiteARMResource"
},
"x-ms-long-running-operation": true
},
"patch": {
"operationId": "StaticSites_UpdateStaticSite",
"tags": [
"StaticSites"
],
"summary": "Creates a new static site in an existing resource group, or updates an existing static site.",
"description": "Description for Creates a new static site in an existing resource group, or updates an existing static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "staticSiteEnvelope",
"in": "body",
"description": "A JSON representation of the staticsite properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSitePatchResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/StaticSiteARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch a static site": {
"$ref": "./examples/PatchStaticSite.json"
}
}
},
"delete": {
"operationId": "StaticSites_DeleteStaticSite",
"tags": [
"StaticSites"
],
"summary": "Deletes a static site.",
"description": "Description for Deletes a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a static site": {
"$ref": "./examples/DeleteStaticSite.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth": {
"get": {
"operationId": "StaticSites_ListBasicAuth",
"tags": [
"StaticSites"
],
"summary": "Gets the basic auth properties for a static site as a collection.",
"description": "Description for Gets the basic auth properties for a static site as a collection.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteBasicAuthPropertiesCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Lists the basic auth properties for a static site.": {
"$ref": "./examples/ListStaticSiteBasicAuth.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/basicAuth/{basicAuthName}": {
"get": {
"operationId": "StaticSites_GetBasicAuth",
"tags": [
"StaticSites"
],
"summary": "Gets the basic auth properties for a static site.",
"description": "Description for Gets the basic auth properties for a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "basicAuthName",
"in": "path",
"description": "name of the basic auth entry.",
"required": true,
"type": "string",
"enum": [
"default"
],
"x-ms-enum": {
"name": "BasicAuthName",
"modelAsString": true,
"values": [
{
"name": "default",
"value": "default"
}
]
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets the basic auth properties for a static site.": {
"$ref": "./examples/GetStaticSiteBasicAuth.json"
}
}
},
"put": {
"operationId": "StaticSites_CreateOrUpdateBasicAuth",
"tags": [
"StaticSites"
],
"summary": "Adds or updates basic auth for a static site.",
"description": "Description for Adds or updates basic auth for a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "basicAuthName",
"in": "path",
"description": "name of the basic auth entry.",
"required": true,
"type": "string",
"enum": [
"default"
],
"x-ms-enum": {
"name": "BasicAuthName",
"modelAsString": true,
"values": [
{
"name": "default",
"value": "default"
}
]
}
},
{
"name": "basicAuthEnvelope",
"in": "body",
"description": "A JSON representation of the basic auth properties.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'StaticSiteBasicAuthPropertiesARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Creates or updates basic auth properties for a static site.": {
"$ref": "./examples/CreateOrUpdateStaticSiteBasicAuth.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds": {
"get": {
"operationId": "StaticSites_GetStaticSiteBuilds",
"tags": [
"StaticSites"
],
"summary": "Gets all static site builds for a particular static site.",
"description": "Description for Gets all static site builds for a particular static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteBuildCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get all builds for a static site": {
"$ref": "./examples/GetStaticSiteBuilds.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}": {
"get": {
"operationId": "StaticSites_GetStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Gets the details of a static site build.",
"description": "Description for Gets the details of a static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteBuildARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a static site build": {
"$ref": "./examples/GetStaticSiteBuild.json"
}
}
},
"delete": {
"operationId": "StaticSites_DeleteStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Deletes a static site build.",
"description": "Description for Deletes a static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a static site build": {
"$ref": "./examples/DeleteStaticSiteBuild.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/appsettings": {
"put": {
"operationId": "StaticSites_CreateOrUpdateStaticSiteBuildAppSettings",
"tags": [
"StaticSites"
],
"summary": "Creates or updates the app settings of a static site build.",
"description": "Description for Creates or updates the app settings of a static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "appSettings",
"in": "body",
"description": "The dictionary containing the static site app settings to update.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Creates or updates the function app settings of a static site build.": {
"$ref": "./examples/CreateOrUpdateStaticSiteBuildAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/config/functionappsettings": {
"put": {
"operationId": "StaticSites_CreateOrUpdateStaticSiteBuildFunctionAppSettings",
"tags": [
"StaticSites"
],
"summary": "Creates or updates the function app settings of a static site build.",
"description": "Description for Creates or updates the function app settings of a static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "appSettings",
"in": "body",
"description": "The dictionary containing the static site function app settings to update.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Creates or updates the function app settings of a static site build.": {
"$ref": "./examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections": {
"get": {
"operationId": "StaticSites_GetBuildDatabaseConnections",
"tags": [
"StaticSites"
],
"summary": "Returns overviews of database connections for a static site build",
"description": "Returns overviews of database connections for a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List overviews of database connections for the static site build.": {
"$ref": "./examples/GetStaticSiteBuildDatabaseConnections.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}": {
"get": {
"operationId": "StaticSites_GetBuildDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Returns overview of a database connection for a static site build by name",
"description": "Returns overview of a database connection for a static site build by name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get overview of database connections for the static site build.": {
"$ref": "./examples/GetStaticSiteBuildDatabaseConnection.json"
}
}
},
"put": {
"operationId": "StaticSites_CreateOrUpdateBuildDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Create or update a database connection for a static site build",
"description": "Description for Create or update a database connection for a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionRequestEnvelope",
"in": "body",
"description": "A JSON representation of the database connection request properties",
"required": true,
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
}
],
"responses": {
"200": {
"description": "Resource 'DatabaseConnection' update operation succeeded",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a database connection for a static site build": {
"$ref": "./examples/CreateOrUpdateStaticSiteBuildDatabaseConnection.json"
}
}
},
"patch": {
"operationId": "StaticSites_UpdateBuildDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Create or update a database connection for a static site build",
"description": "Description for Create or update a database connection for a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionRequestEnvelope",
"in": "body",
"description": "A JSON representation of the database connection request properties",
"required": true,
"schema": {
"$ref": "#/definitions/DatabaseConnectionPatchRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch a database connection for a static site build": {
"$ref": "./examples/PatchStaticSiteBuildDatabaseConnection.json"
}
}
},
"delete": {
"operationId": "StaticSites_DeleteBuildDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Delete a database connection for a static site build",
"description": "Delete a database connection for a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a database connection from a static site build.": {
"$ref": "./examples/DeleteStaticSiteBuildDatabaseConnection.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/databaseConnections/{databaseConnectionName}/show": {
"post": {
"operationId": "StaticSites_GetBuildDatabaseConnectionWithDetails",
"tags": [
"StaticSites"
],
"summary": "Returns details of a database connection for a static site build by name",
"description": "Returns details of a database connection for a static site build by name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of database connections for the static site build.": {
"$ref": "./examples/GetStaticSiteBuildDatabaseConnectionWithDetails.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/functions": {
"get": {
"operationId": "StaticSites_ListStaticSiteBuildFunctions",
"tags": [
"StaticSites"
],
"summary": "Gets the functions of a particular static site build.",
"description": "Description for Gets the functions of a particular static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteFunctionOverviewCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets the functions of a particular static site build": {
"$ref": "./examples/ListStaticSiteBuildFunctions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends": {
"get": {
"operationId": "StaticSites_GetLinkedBackendsForBuild",
"tags": [
"StaticSites"
],
"summary": "Returns details of all backends linked to a static site build",
"description": "Returns details of all backends linked to a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the linked backends registered with a static site build.": {
"$ref": "./examples/GetLinkedBackendsForStaticSiteBuild.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}": {
"get": {
"operationId": "StaticSites_GetLinkedBackendForBuild",
"tags": [
"StaticSites"
],
"summary": "Returns the details of a linked backend linked to a static site build by name",
"description": "Returns the details of a linked backend linked to a static site build by name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the linked backend registered with a static site build by name.": {
"$ref": "./examples/GetLinkedBackendForStaticSiteBuild.json"
}
}
},
"put": {
"operationId": "StaticSites_LinkBackendToBuild",
"tags": [
"StaticSites"
],
"summary": "Link backend to a static site build",
"description": "Link backend to a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
},
{
"name": "staticSiteLinkedBackendEnvelope",
"in": "body",
"description": "A JSON representation of the linked backend request properties",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Link a backend to a static site build": {
"$ref": "./examples/LinkBackendToStaticSiteBuild.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StaticSiteLinkedBackendARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "StaticSites_UnlinkBackendFromBuild",
"tags": [
"StaticSites"
],
"summary": "Unlink a backend from a static site build",
"description": "Unlink a backend from a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
},
{
"name": "isCleaningAuthConfig",
"in": "query",
"description": "Decides if auth will be removed from backend configuration",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Unlink a backend from a static site build.": {
"$ref": "./examples/UnlinkBackendFromStaticSiteBuild.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/linkedBackends/{linkedBackendName}/validate": {
"post": {
"operationId": "StaticSites_ValidateBackendForBuild",
"tags": [
"StaticSites"
],
"summary": "Validates that a backend can be linked to a static site build",
"description": "Validates that a backend can be linked to a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
},
{
"name": "staticSiteLinkedBackendEnvelope",
"in": "body",
"description": "A JSON representation of the linked backend request properties",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Validate if backend can be linked to static site build.": {
"$ref": "./examples/ValidateLinkedBackendForStaticSiteBuild.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listAppSettings": {
"post": {
"operationId": "StaticSites_ListStaticSiteBuildAppSettings",
"tags": [
"StaticSites"
],
"summary": "Gets the application settings of a static site build.",
"description": "Description for Gets the application settings of a static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get app settings of a static site build": {
"$ref": "./examples/ListStaticSiteBuildAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/listFunctionAppSettings": {
"post": {
"operationId": "StaticSites_ListStaticSiteBuildFunctionAppSettings",
"tags": [
"StaticSites"
],
"summary": "Gets the application settings of a static site build.",
"description": "Description for Gets the application settings of a static site build.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get function app settings of a static site build": {
"$ref": "./examples/ListStaticSiteBuildFunctionAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/showDatabaseConnections": {
"post": {
"operationId": "StaticSites_GetBuildDatabaseConnectionsWithDetails",
"tags": [
"StaticSites"
],
"summary": "Returns details of database connections for a static site build",
"description": "Returns details of database connections for a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List full details of database connections for the static site build.": {
"$ref": "./examples/GetStaticSiteBuildDatabaseConnectionsWithDetails.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps": {
"get": {
"operationId": "StaticSites_GetUserProvidedFunctionAppsForStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Gets the details of the user provided function apps registered with a static site build",
"description": "Description for Gets the details of the user provided function apps registered with a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the user provided function apps registered with a static site build.": {
"$ref": "./examples/GetUserProvidedFunctionAppsForStaticSiteBuild.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/userProvidedFunctionApps/{functionAppName}": {
"get": {
"operationId": "StaticSites_GetUserProvidedFunctionAppForStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Gets the details of the user provided function app registered with a static site build",
"description": "Description for Gets the details of the user provided function app registered with a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string"
},
{
"name": "functionAppName",
"in": "path",
"description": "Name of the function app registered with the static site build.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the user provided function app registered with a static site build.": {
"$ref": "./examples/GetUserProvidedFunctionAppForStaticSiteBuild.json"
}
}
},
"put": {
"operationId": "StaticSites_RegisterUserProvidedFunctionAppWithStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Register a user provided function app with a static site build",
"description": "Description for Register a user provided function app with a static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string"
},
{
"name": "functionAppName",
"in": "path",
"description": "Name of the function app registered with the static site build.",
"required": true,
"type": "string"
},
{
"name": "isForced",
"in": "query",
"description": "Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.",
"required": false,
"type": "boolean"
},
{
"name": "staticSiteUserProvidedFunctionEnvelope",
"in": "body",
"description": "A JSON representation of the user provided function app properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'StaticSiteUserProvidedFunctionAppARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Register a user provided function app with a static site build": {
"$ref": "./examples/RegisterUserProvidedFunctionAppWithStaticSiteBuild.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "StaticSites_DetachUserProvidedFunctionAppFromStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Detach the user provided function app from the static site build",
"description": "Description for Detach the user provided function app from the static site build",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string"
},
{
"name": "functionAppName",
"in": "path",
"description": "Name of the function app registered with the static site build.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Detach the user provided function app from the static site build.": {
"$ref": "./examples/DetachUserProvidedFunctionAppFromStaticSiteBuild.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{environmentName}/zipdeploy": {
"post": {
"operationId": "StaticSites_CreateZipDeploymentForStaticSiteBuild",
"tags": [
"StaticSites"
],
"summary": "Deploys zipped content to a specific environment of a static site.",
"description": "Description for Deploys zipped content to a specific environment of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "environmentName",
"in": "path",
"description": "The stage site identifier.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "staticSiteZipDeploymentEnvelope",
"in": "body",
"description": "A JSON representation of the StaticSiteZipDeployment properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteZipDeploymentARMResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Deploy a site from a zipped package to a particular static site build": {
"$ref": "./examples/StaticSiteBuildZipDeploy.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/appsettings": {
"put": {
"operationId": "StaticSites_CreateOrUpdateStaticSiteAppSettings",
"tags": [
"StaticSites"
],
"summary": "Creates or updates the app settings of a static site.",
"description": "Description for Creates or updates the app settings of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "appSettings",
"in": "body",
"description": "The dictionary containing the static site app settings to update.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Creates or updates the app settings of a static site.": {
"$ref": "./examples/CreateOrUpdateStaticSiteAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings": {
"put": {
"operationId": "StaticSites_CreateOrUpdateStaticSiteFunctionAppSettings",
"tags": [
"StaticSites"
],
"summary": "Creates or updates the function app settings of a static site.",
"description": "Description for Creates or updates the function app settings of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "appSettings",
"in": "body",
"description": "The dictionary containing the static site function app settings to update.",
"required": true,
"schema": {
"$ref": "#/definitions/StringDictionary"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Creates or updates the function app settings of a static site.": {
"$ref": "./examples/CreateOrUpdateStaticSiteFunctionAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation": {
"post": {
"operationId": "StaticSites_CreateUserRolesInvitationLink",
"tags": [
"StaticSites"
],
"summary": "Creates an invitation link for a user with the role",
"description": "Description for Creates an invitation link for a user with the role",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "staticSiteUserRolesInvitationEnvelope",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteUserInvitationRequestResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserInvitationResponseResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create an invitation link for a user for a static site": {
"$ref": "./examples/CreateUserRolesInvitationLink.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains": {
"get": {
"operationId": "StaticSites_ListStaticSiteCustomDomains",
"tags": [
"StaticSites"
],
"summary": "Gets all static site custom domains for a particular static site.",
"description": "Description for Gets all static site custom domains for a particular static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteCustomDomainOverviewCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List custom domains for a static site": {
"$ref": "./examples/GetStaticSiteCustomDomains.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}": {
"get": {
"operationId": "StaticSites_GetStaticSiteCustomDomain",
"tags": [
"StaticSites"
],
"summary": "Gets an existing custom domain for a particular static site.",
"description": "Description for Gets an existing custom domain for a particular static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "domainName",
"in": "path",
"description": "The custom domain name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get custom domain for a static site": {
"$ref": "./examples/GetStaticSiteCustomDomain.json"
}
}
},
"put": {
"operationId": "StaticSites_CreateOrUpdateStaticSiteCustomDomain",
"tags": [
"StaticSites"
],
"summary": "Creates a new static site custom domain in an existing resource group and static site.",
"description": "Description for Creates a new static site custom domain in an existing resource group and static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "domainName",
"in": "path",
"description": "The custom domain name.",
"required": true,
"type": "string"
},
{
"name": "staticSiteCustomDomainRequestPropertiesEnvelope",
"in": "body",
"description": "A JSON representation of the static site custom domain request properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteCustomDomainRequestPropertiesARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'StaticSiteCustomDomainOverviewARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a custom domain for a static site": {
"$ref": "./examples/CreateOrUpdateStaticSiteCustomDomain.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "StaticSites_DeleteStaticSiteCustomDomain",
"tags": [
"StaticSites"
],
"summary": "Deletes a custom domain.",
"description": "Description for Deletes a custom domain.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "domainName",
"in": "path",
"description": "The custom domain name.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"202": {
"description": "Resource deletion accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a custom domain for a static site": {
"$ref": "./examples/DeleteStaticSiteCustomDomain.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}/validate": {
"post": {
"operationId": "StaticSites_ValidateCustomDomainCanBeAddedToStaticSite",
"tags": [
"StaticSites"
],
"summary": "Validates a particular custom domain can be added to a static site.",
"description": "Description for Validates a particular custom domain can be added to a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "domainName",
"in": "path",
"description": "The custom domain name.",
"required": true,
"type": "string"
},
{
"name": "staticSiteCustomDomainRequestPropertiesEnvelope",
"in": "body",
"description": "A JSON representation of the static site custom domain request properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteCustomDomainRequestPropertiesARMResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Validate a custom domain for a static site": {
"$ref": "./examples/ValidateStaticSiteCustomDomain.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections": {
"get": {
"operationId": "StaticSites_GetDatabaseConnections",
"tags": [
"StaticSites"
],
"summary": "Returns overviews of database connections for a static site",
"description": "Returns overviews of database connections for a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List overviews of database connections for the static site.": {
"$ref": "./examples/GetStaticSiteDatabaseConnections.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}": {
"get": {
"operationId": "StaticSites_GetDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Returns overview of a database connection for a static site by name",
"description": "Returns overview of a database connection for a static site by name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get overview of database connections for the static site.": {
"$ref": "./examples/GetStaticSiteDatabaseConnection.json"
}
}
},
"put": {
"operationId": "StaticSites_CreateOrUpdateDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Create or update a database connection for a static site",
"description": "Description for Create or update a database connection for a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionRequestEnvelope",
"in": "body",
"description": "A JSON representation of the database connection request properties",
"required": true,
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
}
],
"responses": {
"200": {
"description": "Resource 'DatabaseConnection' update operation succeeded",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a database connection for a static site": {
"$ref": "./examples/CreateOrUpdateStaticSiteDatabaseConnection.json"
}
}
},
"patch": {
"operationId": "StaticSites_UpdateDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Create or update a database connection for a static site",
"description": "Description for Create or update a database connection for a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
},
{
"name": "databaseConnectionRequestEnvelope",
"in": "body",
"description": "A JSON representation of the database connection request properties",
"required": true,
"schema": {
"$ref": "#/definitions/DatabaseConnectionPatchRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Patch a database connection for a static site": {
"$ref": "./examples/PatchStaticSiteDatabaseConnection.json"
}
}
},
"delete": {
"operationId": "StaticSites_DeleteDatabaseConnection",
"tags": [
"StaticSites"
],
"summary": "Delete a database connection for a static site",
"description": "Delete a database connection for a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a database connection from a static site.": {
"$ref": "./examples/DeleteStaticSiteDatabaseConnection.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/databaseConnections/{databaseConnectionName}/show": {
"post": {
"operationId": "StaticSites_GetDatabaseConnectionWithDetails",
"tags": [
"StaticSites"
],
"summary": "Returns details of a database connection for a static site by name",
"description": "Returns details of a database connection for a static site by name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "databaseConnectionName",
"in": "path",
"description": "Name of the database connection.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of database connections for the static site.": {
"$ref": "./examples/GetStaticSiteDatabaseConnectionWithDetails.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/detach": {
"post": {
"operationId": "StaticSites_DetachStaticSite",
"tags": [
"StaticSites"
],
"summary": "Detaches a static site.",
"description": "Description for Detaches a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Detach a static site": {
"$ref": "./examples/DetachStaticSite.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions": {
"get": {
"operationId": "StaticSites_ListStaticSiteFunctions",
"tags": [
"StaticSites"
],
"summary": "Gets the functions of a static site.",
"description": "Description for Gets the functions of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteFunctionOverviewCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Gets the functions of a static site": {
"$ref": "./examples/ListStaticSiteFunctions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends": {
"get": {
"operationId": "StaticSites_GetLinkedBackends",
"tags": [
"StaticSites"
],
"summary": "Returns details of all backends linked to a static site",
"description": "Returns details of all backends linked to a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the linked backends registered with a static site.": {
"$ref": "./examples/GetLinkedBackendsForStaticSite.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}": {
"get": {
"operationId": "StaticSites_GetLinkedBackend",
"tags": [
"StaticSites"
],
"summary": "Returns the details of a linked backend linked to a static site by name",
"description": "Returns the details of a linked backend linked to a static site by name",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the linked backend registered with a static site by name.": {
"$ref": "./examples/GetLinkedBackendForStaticSite.json"
}
}
},
"put": {
"operationId": "StaticSites_LinkBackend",
"tags": [
"StaticSites"
],
"summary": "Link backend to a static site",
"description": "Link backend to a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
},
{
"name": "staticSiteLinkedBackendEnvelope",
"in": "body",
"description": "A JSON representation of the linked backend request properties",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
}
],
"responses": {
"200": {
"description": "The request has succeeded.",
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Link a backend to a static site": {
"$ref": "./examples/LinkBackendToStaticSite.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StaticSiteLinkedBackendARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "StaticSites_UnlinkBackend",
"tags": [
"StaticSites"
],
"summary": "Unlink a backend from a static site",
"description": "Unlink a backend from a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
},
{
"name": "isCleaningAuthConfig",
"in": "query",
"description": "Decides if Easy Auth configuration will be removed from backend configuration",
"required": false,
"type": "boolean"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Unlink a backend from a static site.": {
"$ref": "./examples/UnlinkBackendFromStaticSite.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/linkedBackends/{linkedBackendName}/validate": {
"post": {
"operationId": "StaticSites_ValidateBackend",
"tags": [
"StaticSites"
],
"summary": "Validates that a backend can be linked to a static site",
"description": "Validates that a backend can be linked to a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site",
"required": true,
"type": "string"
},
{
"name": "linkedBackendName",
"in": "path",
"description": "Name of the linked backend that should be retrieved",
"required": true,
"type": "string"
},
{
"name": "staticSiteLinkedBackendEnvelope",
"in": "body",
"description": "A JSON representation of the linked backend request properties",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
}
],
"responses": {
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Validate if backend can be linked to static site.": {
"$ref": "./examples/ValidateLinkedBackendForStaticSite.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listAppSettings": {
"post": {
"operationId": "StaticSites_ListStaticSiteAppSettings",
"tags": [
"StaticSites"
],
"summary": "Gets the application settings of a static site.",
"description": "Description for Gets the application settings of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get app settings of a static site": {
"$ref": "./examples/ListStaticSiteAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listConfiguredRoles": {
"post": {
"operationId": "StaticSites_ListStaticSiteConfiguredRoles",
"tags": [
"StaticSites"
],
"summary": "Lists the roles configured for the static site.",
"description": "Description for Lists the roles configured for the static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringList"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Lists the configured roles for a static site": {
"$ref": "./examples/ListStaticSiteConfiguredRoles.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings": {
"post": {
"operationId": "StaticSites_ListStaticSiteFunctionAppSettings",
"tags": [
"StaticSites"
],
"summary": "Gets the application settings of a static site.",
"description": "Description for Gets the application settings of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get function app settings of a static site": {
"$ref": "./examples/ListStaticSiteFunctionAppSettings.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listSecrets": {
"post": {
"operationId": "StaticSites_ListStaticSiteSecrets",
"tags": [
"StaticSites"
],
"summary": "Lists the secrets for an existing static site.",
"description": "Description for Lists the secrets for an existing static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StringDictionary"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List secrets for a static site": {
"$ref": "./examples/ListStaticSiteSecrets.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections": {
"get": {
"operationId": "StaticSites_GetPrivateEndpointConnectionList",
"tags": [
"StaticSites"
],
"summary": "Gets the list of private endpoint connections associated with a static site",
"description": "Description for Gets the list of private endpoint connections associated with a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateEndpointConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a list of private endpoint connections associated with a site.": {
"$ref": "./examples/GetSitePrivateEndpointConnectionList.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateEndpointConnections/{privateEndpointConnectionName}": {
"get": {
"operationId": "StaticSites_GetPrivateEndpointConnection",
"tags": [
"StaticSites"
],
"summary": "Gets a private endpoint connection",
"description": "Description for Gets a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a private endpoint connection for a site.": {
"$ref": "./examples/GetSitePrivateEndpointConnection_StaticSites.json"
}
}
},
"put": {
"operationId": "StaticSites_ApproveOrRejectPrivateEndpointConnection",
"tags": [
"StaticSites"
],
"summary": "Approves or rejects a private endpoint connection",
"description": "Description for Approves or rejects a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointWrapper",
"in": "body",
"description": "Request body.",
"required": true,
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'RemotePrivateEndpointConnectionARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Approves or rejects a private endpoint connection for a site.": {
"$ref": "./examples/ApproveRejectSitePrivateEndpointConnection_StaticSites.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/RemotePrivateEndpointConnectionARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "StaticSites_DeletePrivateEndpointConnection",
"tags": [
"StaticSites"
],
"summary": "Deletes a private endpoint connection",
"description": "Description for Deletes a private endpoint connection",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "privateEndpointConnectionName",
"in": "path",
"description": "Name of the private endpoint connection.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"204": {
"description": "There is no content to send for this request, but the headers may be useful. ",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a private endpoint connection for a site.": {
"$ref": "./examples/DeleteSitePrivateEndpointConnection_StaticSites.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/privateLinkResources": {
"get": {
"operationId": "StaticSites_GetPrivateLinkResources",
"tags": [
"StaticSites"
],
"summary": "Gets the private link resources",
"description": "Description for Gets the private link resources",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/PrivateLinkResourcesWrapper"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get private link resources of a site": {
"$ref": "./examples/GetSitePrivateLinkResources.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/resetapikey": {
"post": {
"operationId": "StaticSites_ResetStaticSiteApiKey",
"tags": [
"StaticSites"
],
"summary": "Resets the api key for an existing static site.",
"description": "Description for Resets the api key for an existing static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "resetPropertiesEnvelope",
"in": "body",
"description": "",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteResetPropertiesARMResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Reset the api key for a static site": {
"$ref": "./examples/ResetStaticSiteApiKey.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/showDatabaseConnections": {
"post": {
"operationId": "StaticSites_GetDatabaseConnectionsWithDetails",
"tags": [
"StaticSites"
],
"summary": "Returns details of database connections for a static site",
"description": "Returns details of database connections for a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/DatabaseConnectionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List full details of database connections for the static site.": {
"$ref": "./examples/GetStaticSiteDatabaseConnectionsWithDetails.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps": {
"get": {
"operationId": "StaticSites_GetUserProvidedFunctionAppsForStaticSite",
"tags": [
"StaticSites"
],
"summary": "Gets the details of the user provided function apps registered with a static site",
"description": "Description for Gets the details of the user provided function apps registered with a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppsCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the user provided function apps registered with a static site.": {
"$ref": "./examples/GetUserProvidedFunctionAppsForStaticSite.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/userProvidedFunctionApps/{functionAppName}": {
"get": {
"operationId": "StaticSites_GetUserProvidedFunctionAppForStaticSite",
"tags": [
"StaticSites"
],
"summary": "Gets the details of the user provided function app registered with a static site",
"description": "Description for Gets the details of the user provided function app registered with a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "functionAppName",
"in": "path",
"description": "Name of the function app registered with the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get details of the user provided function app registered with a static site.": {
"$ref": "./examples/GetUserProvidedFunctionAppForStaticSite.json"
}
}
},
"put": {
"operationId": "StaticSites_RegisterUserProvidedFunctionAppWithStaticSite",
"tags": [
"StaticSites"
],
"summary": "Register a user provided function app with a static site",
"description": "Description for Register a user provided function app with a static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "functionAppName",
"in": "path",
"description": "Name of the function app registered with the static site.",
"required": true,
"type": "string"
},
{
"name": "isForced",
"in": "query",
"description": "Specify true to force the update of the auth configuration on the function app even if an AzureStaticWebApps provider is already configured on the function app. The default is false.",
"required": false,
"type": "boolean"
},
{
"name": "staticSiteUserProvidedFunctionEnvelope",
"in": "body",
"description": "A JSON representation of the user provided function app properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
}
],
"responses": {
"200": {
"description": "Resource 'StaticSiteUserProvidedFunctionAppARMResource' update operation succeeded",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
},
"202": {
"description": "The request has been accepted for processing, but processing has not yet completed.",
"schema": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
},
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Register a user provided function app with a static site": {
"$ref": "./examples/RegisterUserProvidedFunctionAppWithStaticSite.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location",
"final-state-schema": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
},
"x-ms-long-running-operation": true
},
"delete": {
"operationId": "StaticSites_DetachUserProvidedFunctionAppFromStaticSite",
"tags": [
"StaticSites"
],
"summary": "Detach the user provided function app from the static site",
"description": "Description for Detach the user provided function app from the static site",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "functionAppName",
"in": "path",
"description": "Name of the function app registered with the static site.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Resource deleted successfully."
},
"204": {
"description": "Resource does not exist."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Detach the user provided function app from the static site.": {
"$ref": "./examples/DetachUserProvidedFunctionAppFromStaticSite.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/zipdeploy": {
"post": {
"operationId": "StaticSites_CreateZipDeploymentForStaticSite",
"tags": [
"StaticSites"
],
"summary": "Deploys zipped content to a static site.",
"description": "Description for Deploys zipped content to a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the static site.",
"required": true,
"type": "string"
},
{
"name": "staticSiteZipDeploymentEnvelope",
"in": "body",
"description": "A JSON representation of the StaticSiteZipDeployment properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteZipDeploymentARMResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"202": {
"description": "Resource operation accepted.",
"headers": {
"Location": {
"type": "string",
"description": "The Location header contains the URL where the status of the long running operation can be checked."
},
"Retry-After": {
"type": "integer",
"format": "int32",
"description": "The Retry-After header can indicate how long the client should wait before polling the operation status."
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Deploy a site from a zipped package": {
"$ref": "./examples/StaticSiteZipDeploy.json"
}
},
"x-ms-long-running-operation-options": {
"final-state-via": "location"
},
"x-ms-long-running-operation": true
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate": {
"post": {
"operationId": "Validate",
"summary": "Validate if a resource can be created.",
"description": "Description for Validate if a resource can be created.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "validateRequest",
"in": "body",
"description": "Request with the resources to validate.",
"required": true,
"schema": {
"$ref": "#/definitions/ValidateRequest"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ValidateResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": {
"get": {
"operationId": "AppServiceEnvironments_GetDiagnosticsItem",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get a diagnostics item for an App Service Environment.",
"description": "Description for Get a diagnostics item for an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "diagnosticsName",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/HostingEnvironmentDiagnostics"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a diagnostics item for an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_GetDiagnosticsItem.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": {
"get": {
"operationId": "AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.",
"description": "Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "instance",
"in": "path",
"description": "Name of the instance in the multi-role pool.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceMetricDefinitionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": {
"get": {
"operationId": "AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions",
"tags": [
"AppServiceEnvironments"
],
"summary": "Get metric definitions for a specific instance of a worker pool of an App Service Environment.",
"description": "Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the App Service Environment.",
"required": true,
"type": "string"
},
{
"name": "workerPoolName",
"in": "path",
"description": "Name of the worker pool.",
"required": true,
"type": "string"
},
{
"name": "instance",
"in": "path",
"description": "Name of the instance in the worker pool.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/ResourceMetricDefinitionCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get metric definitions for a specific instance of a worker pool of an App Service Environment.": {
"$ref": "./examples/AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot": {
"post": {
"operationId": "AppServicePlans_RebootWorker",
"tags": [
"AppServicePlans"
],
"summary": "Reboot a worker machine in an App Service plan.",
"description": "Description for Reboot a worker machine in an App Service plan.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "App Service plan.",
"required": true,
"type": "string"
},
{
"name": "workerName",
"in": "path",
"description": "Name of worker machine, which typically starts with RD.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/serverfarms/{name}/workers/{workerName}/recycleinstance": {
"post": {
"operationId": "AppServicePlans_RecycleManagedInstanceWorker",
"tags": [
"AppServicePlans"
],
"summary": "Recycles a managed instance worker machine.",
"description": "Description for Recycles a managed instance worker machine.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "App Service plan.",
"required": true,
"type": "string"
},
{
"name": "workerName",
"in": "path",
"description": "Name of worker machine, which typically starts with RD.",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9]+$"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/Operation"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}": {
"put": {
"operationId": "WebApps_CreateOrUpdateFunctionSecret",
"tags": [
"WebApps"
],
"summary": "Add or update a function secret.",
"description": "Description for Add or update a function secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "body",
"description": "The key to create or update",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Resource 'KeyInfo' create operation succeeded",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteFunctionSecret",
"tags": [
"WebApps"
],
"summary": "Delete a function secret.",
"description": "Description for Delete a function secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "functionName",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": {
"put": {
"operationId": "WebApps_CreateOrUpdateHostSecret",
"tags": [
"WebApps"
],
"summary": "Add or update a host level secret.",
"description": "Description for Add or update a host level secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "keyType",
"in": "path",
"description": "The type of host key.",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"description": "The name of the key.",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "body",
"description": "The key to create or update",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Resource 'KeyInfo' create operation succeeded",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteHostSecret",
"tags": [
"WebApps"
],
"summary": "Delete a host level secret.",
"description": "Description for Delete a host level secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "keyType",
"in": "path",
"description": "The type of host key.",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"description": "The name of the key.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTrace/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTraces",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get NetworkTraces for a site": {
"$ref": "./examples/GetWebSiteNetworkTraces.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTraceOperation",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"$ref": "./examples/GetWebSiteNetworkTraceOperation.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTraces/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTracesV2",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get NetworkTraces for a site": {
"$ref": "./examples/GetWebSiteNetworkTraces_SlotV2.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTraceOperationV2",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"$ref": "./examples/GetWebSiteNetworkTraceOperation_V2.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}": {
"put": {
"operationId": "WebApps_CreateOrUpdateHostSecretSlot",
"tags": [
"WebApps"
],
"summary": "Add or update a host level secret.",
"description": "Description for Add or update a host level secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "keyType",
"in": "path",
"description": "The type of host key.",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"description": "The name of the key.",
"required": true,
"type": "string"
},
{
"name": "key",
"in": "body",
"description": "The key to create or update",
"required": true,
"schema": {
"$ref": "#/definitions/KeyInfo"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"201": {
"description": "Resource 'KeyInfo' create operation succeeded",
"schema": {
"$ref": "#/definitions/KeyInfo"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
},
"delete": {
"operationId": "WebApps_DeleteHostSecretSlot",
"tags": [
"WebApps"
],
"summary": "Delete a host level secret.",
"description": "Description for Delete a host level secret.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "keyType",
"in": "path",
"description": "The type of host key.",
"required": true,
"type": "string"
},
{
"name": "keyName",
"in": "path",
"description": "The name of the key.",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"404": {
"description": "The server cannot find the requested resource.",
"x-ms-error-response": true
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTracesSlot",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get NetworkTraces for a site": {
"$ref": "./examples/GetWebSiteNetworkTraces_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTraceOperationSlot",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"$ref": "./examples/GetWebSiteNetworkTraceOperation_Slot.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTracesSlotV2",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get NetworkTraces for a site": {
"$ref": "./examples/GetWebSiteNetworkTraces_GetNetworkTracesSlotV2.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}": {
"get": {
"operationId": "WebApps_GetNetworkTraceOperationSlotV2",
"tags": [
"WebApps"
],
"summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"description": "Name of the app.",
"required": true,
"type": "string"
},
{
"name": "slot",
"in": "path",
"description": "Name of the deployment slot. By default, this API returns the production slot.",
"required": true,
"type": "string"
},
{
"name": "operationId",
"in": "path",
"description": "GUID of the operation.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"202": {
"description": "Azure operation completed successfully.",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/NetworkTrace"
}
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get the current status of a network trace operation for a site": {
"$ref": "./examples/GetWebSiteNetworkTraceOperation_SlotV2.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers": {
"post": {
"operationId": "StaticSites_ListStaticSiteUsers",
"tags": [
"StaticSites"
],
"summary": "Gets the list of users of a static site.",
"description": "Description for Gets the list of users of a static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "authprovider",
"in": "path",
"description": "The auth provider for the users.",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserCollection"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"List users for a static site": {
"$ref": "./examples/ListStaticSiteUsers.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}": {
"patch": {
"operationId": "StaticSites_UpdateStaticSiteUser",
"tags": [
"StaticSites"
],
"summary": "Updates a user entry with the listed roles",
"description": "Description for Updates a user entry with the listed roles",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "authprovider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "userid",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "staticSiteUserEnvelope",
"in": "body",
"description": "A JSON representation of the StaticSiteUser properties. See example.",
"required": true,
"schema": {
"$ref": "#/definitions/StaticSiteUserARMResource"
}
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully.",
"schema": {
"$ref": "#/definitions/StaticSiteUserARMResource"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Create or update a user for a static site": {
"$ref": "./examples/UpdateStaticSiteUser.json"
}
}
},
"delete": {
"operationId": "StaticSites_DeleteStaticSiteUser",
"tags": [
"StaticSites"
],
"summary": "Deletes the user entry from the static site.",
"description": "Description for Deletes the user entry from the static site.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "name",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "authprovider",
"in": "path",
"required": true,
"type": "string"
},
{
"name": "userid",
"in": "path",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "Azure operation completed successfully."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Delete a user for a static site": {
"$ref": "./examples/DeleteStaticSiteUser.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources": {
"post": {
"operationId": "ValidateMove",
"summary": "Validate whether a resource can be moved.",
"description": "Description for Validate whether a resource can be moved.",
"parameters": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/parameters/SubscriptionIdParameter"
},
{
"name": "moveResourceEnvelope",
"in": "body",
"description": "Object that represents the resource to move.",
"required": true,
"schema": {
"$ref": "#/definitions/CsmMoveResourceEnvelope"
}
}
],
"responses": {
"204": {
"description": "There is no content to send for this request, but the headers may be useful."
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/DefaultErrorResponse"
}
}
}
}
}
},
"definitions": {
"AbnormalTimePeriod": {
"type": "object",
"description": "Class representing Abnormal Time Period identified in diagnosis",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the downtime"
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of the downtime"
},
"events": {
"type": "array",
"description": "List of Possible Cause of downtime",
"items": {
"$ref": "#/definitions/DetectorAbnormalTimePeriod"
},
"x-ms-identifiers": []
},
"solutions": {
"type": "array",
"description": "List of proposed solutions",
"items": {
"$ref": "#/definitions/Solution"
}
}
}
},
"AddressResponse": {
"type": "object",
"description": "Describes main public IP address and any extra virtual IPs.",
"properties": {
"properties": {
"$ref": "#/definitions/AddressResponseProperties",
"description": "AddressResponse resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"AddressResponseProperties": {
"type": "object",
"description": "AddressResponse resource specific properties",
"properties": {
"serviceIpAddress": {
"type": "string",
"description": "Main public virtual IP."
},
"internalIpAddress": {
"type": "string",
"description": "Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode."
},
"outboundIpAddresses": {
"type": "array",
"description": "IP addresses appearing on outbound connections.",
"items": {
"type": "string"
}
},
"vipMappings": {
"type": "array",
"description": "Additional virtual IPs.",
"items": {
"$ref": "#/definitions/VirtualIPMapping"
},
"x-ms-identifiers": [
"virtualIP"
]
}
}
},
"AllowedAudiencesValidation": {
"type": "object",
"description": "The configuration settings of the Allowed Audiences validation flow.",
"properties": {
"allowedAudiences": {
"type": "array",
"description": "The configuration settings of the allowed list of audiences from which to validate the JWT token.",
"items": {
"type": "string"
}
}
}
},
"AllowedPrincipals": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory allowed principals.",
"properties": {
"groups": {
"type": "array",
"description": "The list of the allowed groups.",
"items": {
"type": "string"
}
},
"identities": {
"type": "array",
"description": "The list of the allowed identities.",
"items": {
"type": "string"
}
}
}
},
"AnalysisData": {
"type": "object",
"description": "Class Representing Detector Evidence used for analysis",
"properties": {
"source": {
"type": "string",
"description": "Name of the Detector"
},
"detectorDefinition": {
"$ref": "#/definitions/DetectorDefinition",
"description": "Detector Definition"
},
"metrics": {
"type": "array",
"description": "Source Metrics",
"items": {
"$ref": "#/definitions/DiagnosticMetricSet"
},
"x-ms-identifiers": [
"name"
]
},
"data": {
"type": "array",
"description": "Additional Source Data",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"x-ms-identifiers": [
"name"
]
},
"detectorMetaData": {
"$ref": "#/definitions/ResponseMetaData",
"description": "Detector Meta Data"
}
}
},
"AnalysisDefinition": {
"type": "object",
"description": "Definition of Analysis",
"properties": {
"properties": {
"$ref": "#/definitions/AnalysisDefinitionProperties",
"description": "AnalysisDefinition resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"AnalysisDefinitionProperties": {
"type": "object",
"description": "AnalysisDefinition resource specific properties",
"properties": {
"description": {
"type": "string",
"description": "Description of the Analysis",
"readOnly": true
}
}
},
"ApiDefinitionInfo": {
"type": "object",
"description": "Information about the formal API definition for the app.",
"properties": {
"url": {
"type": "string",
"description": "The URL of the API definition."
}
}
},
"ApiKVReference": {
"type": "object",
"description": "Description of site key vault references.",
"properties": {
"properties": {
"$ref": "#/definitions/ApiKVReferenceProperties",
"description": "ApiKVReference resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ApiKVReferenceCollection": {
"type": "object",
"description": "Paged collection of ApiKVReference items",
"properties": {
"value": {
"type": "array",
"description": "The ApiKVReference items on this page",
"items": {
"$ref": "#/definitions/ApiKVReference"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ApiKVReferenceProperties": {
"type": "object",
"description": "ApiKVReference resource specific properties",
"properties": {
"reference": {
"type": "string"
},
"status": {
"$ref": "#/definitions/ResolveStatus"
},
"vaultName": {
"type": "string"
},
"secretName": {
"type": "string"
},
"secretVersion": {
"type": "string"
},
"identityType": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
},
"details": {
"type": "string"
},
"source": {
"type": "string",
"enum": [
"KeyVault"
],
"x-ms-enum": {
"modelAsString": false
}
},
"activeVersion": {
"type": "string"
}
}
},
"ApiManagementConfig": {
"type": "object",
"description": "Azure API management (APIM) configuration linked to the app.",
"properties": {
"id": {
"type": "string",
"description": "APIM-Api Identifier."
}
}
},
"AppInsightsWebAppStackSettings": {
"type": "object",
"description": "App Insights Web App stack settings.",
"properties": {
"isSupported": {
"type": "boolean",
"description": "true if remote Application Insights is supported for the stack; otherwise, false.",
"readOnly": true
},
"isDefaultOff": {
"type": "boolean",
"description": "true if Application Insights is disabled by default for the stack; otherwise, false.",
"readOnly": true
}
}
},
"AppLogsConfiguration": {
"type": "object",
"properties": {
"destination": {
"type": "string"
},
"logAnalyticsConfiguration": {
"$ref": "#/definitions/LogAnalyticsConfiguration"
}
}
},
"AppRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for providers that have app ids and app secrets",
"properties": {
"appId": {
"type": "string",
"description": "The App ID of the app used for login."
},
"appSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the app secret."
}
}
},
"AppServiceEnvironment": {
"type": "object",
"description": "Description of an App Service Environment.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "Provisioning state of the App Service Environment.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/HostingEnvironmentStatus",
"description": "Current status of the App Service Environment.",
"readOnly": true
},
"virtualNetwork": {
"$ref": "#/definitions/VirtualNetworkProfile",
"description": "Description of the Virtual Network."
},
"internalLoadBalancingMode": {
"$ref": "#/definitions/LoadBalancingMode",
"description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment."
},
"multiSize": {
"type": "string",
"description": "Front-end VM size, e.g. \"Medium\", \"Large\"."
},
"multiRoleCount": {
"type": "integer",
"format": "int32",
"description": "Number of front-end instances.",
"readOnly": true
},
"ipsslAddressCount": {
"type": "integer",
"format": "int32",
"description": "Number of IP SSL addresses reserved for the App Service Environment."
},
"dnsSuffix": {
"type": "string",
"description": "DNS suffix of the App Service Environment."
},
"maximumNumberOfMachines": {
"type": "integer",
"format": "int32",
"description": "Maximum number of VMs in the App Service Environment.",
"readOnly": true
},
"frontEndScaleFactor": {
"type": "integer",
"format": "int32",
"description": "Scale factor for front-ends."
},
"suspended": {
"type": "boolean",
"description": "true if the App Service Environment is suspended; otherwise, false. The environment can be suspended, e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
"readOnly": true
},
"clusterSettings": {
"type": "array",
"description": "Custom settings for changing the behavior of the App Service Environment.",
"items": {
"$ref": "#/definitions/NameValuePair"
},
"x-ms-identifiers": [
"name"
]
},
"userWhitelistedIpRanges": {
"type": "array",
"description": "User added ip ranges to whitelist on ASE db",
"items": {
"type": "string"
}
},
"hasLinuxWorkers": {
"type": "boolean",
"description": "Flag that displays whether an ASE has linux workers or not",
"readOnly": true
},
"upgradePreference": {
"type": "string",
"description": "Upgrade Preference",
"default": "None",
"enum": [
"None",
"Early",
"Late",
"Manual"
],
"x-ms-enum": {
"name": "UpgradePreference",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No preference on when this App Service Environment will be upgraded"
},
{
"name": "Early",
"value": "Early",
"description": "This App Service Environment will be upgraded before others in the same region that have Upgrade Preference 'Late'"
},
{
"name": "Late",
"value": "Late",
"description": "This App Service Environment will be upgraded after others in the same region that have Upgrade Preference 'Early'"
},
{
"name": "Manual",
"value": "Manual",
"description": "ASEv3 only. Once an upgrade is available, this App Service Environment will wait 10 days for the upgrade to be manually initiated. After 10 days the upgrade will begin automatically"
}
]
}
},
"dedicatedHostCount": {
"type": "integer",
"format": "int32",
"description": "Dedicated Host Count"
},
"zoneRedundant": {
"type": "boolean",
"description": "Whether or not this App Service Environment is zone-redundant."
},
"customDnsSuffixConfiguration": {
"$ref": "#/definitions/CustomDnsSuffixConfiguration",
"description": "Full view of the custom domain suffix configuration for ASEv3."
},
"networkingConfiguration": {
"$ref": "#/definitions/AseV3NetworkingConfiguration",
"description": "Full view of networking configuration for an ASE."
},
"upgradeAvailability": {
"$ref": "#/definitions/UpgradeAvailability",
"description": "Whether an upgrade is available for this App Service Environment.",
"readOnly": true
}
},
"required": [
"virtualNetwork"
]
},
"AppServiceEnvironmentCollection": {
"type": "object",
"description": "Collection of App Service Environments.",
"properties": {
"value": {
"type": "array",
"description": "The AppServiceEnvironmentResource items on this page",
"items": {
"$ref": "#/definitions/AppServiceEnvironmentResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"AppServiceEnvironmentPatchResource": {
"type": "object",
"description": "ARM resource for a app service environment.",
"properties": {
"properties": {
"$ref": "#/definitions/AppServiceEnvironment",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"AppServiceEnvironmentResource": {
"type": "object",
"description": "App Service Environment ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/AppServiceEnvironment",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"AppServicePlan": {
"type": "object",
"description": "App Service plan.",
"properties": {
"properties": {
"$ref": "#/definitions/AppServicePlanProperties",
"description": "AppServicePlan resource specific properties",
"x-ms-client-flatten": true
},
"sku": {
"$ref": "#/definitions/SkuDescription",
"description": "Description of a SKU for a scalable resource."
},
"extendedLocation": {
"$ref": "#/definitions/ExtendedLocation",
"description": "Extended Location."
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"AppServicePlanCollection": {
"type": "object",
"description": "Collection of App Service plans.",
"properties": {
"value": {
"type": "array",
"description": "The AppServicePlan items on this page",
"items": {
"$ref": "#/definitions/AppServicePlan"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"AppServicePlanPatchResource": {
"type": "object",
"description": "ARM resource for a app service plan.",
"properties": {
"properties": {
"$ref": "#/definitions/AppServicePlanPatchResourceProperties",
"description": "AppServicePlanPatchResource resource specific properties",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"AppServicePlanPatchResourceProperties": {
"type": "object",
"description": "AppServicePlanPatchResource resource specific properties",
"properties": {
"workerTierName": {
"type": "string",
"description": "Target worker tier assigned to the App Service plan."
},
"status": {
"$ref": "#/definitions/StatusOptions",
"description": "App Service plan status.",
"readOnly": true
},
"subscription": {
"type": "string",
"description": "App Service plan subscription.",
"readOnly": true
},
"hostingEnvironmentProfile": {
"$ref": "#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the App Service plan.",
"x-ms-mutability": [
"read",
"create"
]
},
"maximumNumberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "Maximum number of instances that can be assigned to this App Service plan.",
"readOnly": true
},
"numberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "The number of instances that are assigned to this App Service plan.",
"readOnly": true
},
"geoRegion": {
"type": "string",
"description": "Geographical location for the App Service plan.",
"readOnly": true
},
"perSiteScaling": {
"type": "boolean",
"description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.",
"default": false
},
"elasticScaleEnabled": {
"type": "boolean",
"description": "ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"
},
"maximumElasticWorkerCount": {
"type": "integer",
"format": "int32",
"description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"
},
"numberOfSites": {
"type": "integer",
"format": "int32",
"description": "Number of apps assigned to this App Service plan.",
"readOnly": true
},
"isSpot": {
"type": "boolean",
"description": "If true, this App Service Plan owns spot instances."
},
"spotExpirationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the server farm expires. Valid only if it is a spot server farm."
},
"freeOfferExpirationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the server farm free offer expires."
},
"resourceGroup": {
"type": "string",
"description": "Resource group of the App Service plan.",
"readOnly": true
},
"reserved": {
"type": "boolean",
"description": "If Linux app service plan true, false otherwise.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"isXenon": {
"type": "boolean",
"description": "Obsolete: If Hyper-V container app service plan true, false otherwise.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"hyperV": {
"type": "boolean",
"description": "If Hyper-V container app service plan true, false otherwise.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"targetWorkerCount": {
"type": "integer",
"format": "int32",
"description": "Scaling worker count."
},
"targetWorkerSizeId": {
"type": "integer",
"format": "int32",
"description": "Scaling worker size ID."
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "Provisioning state of the App Service Plan.",
"readOnly": true
},
"kubeEnvironmentProfile": {
"$ref": "#/definitions/KubeEnvironmentProfile",
"description": "Specification for the Kubernetes Environment to use for the App Service plan."
},
"zoneRedundant": {
"type": "boolean",
"description": "If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing.",
"default": false
}
}
},
"AppServicePlanProperties": {
"type": "object",
"description": "AppServicePlan resource specific properties",
"properties": {
"workerTierName": {
"type": "string",
"description": "Target worker tier assigned to the App Service plan."
},
"status": {
"$ref": "#/definitions/StatusOptions",
"description": "App Service plan status.",
"readOnly": true
},
"subscription": {
"type": "string",
"description": "App Service plan subscription.",
"readOnly": true
},
"hostingEnvironmentProfile": {
"$ref": "#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the App Service plan.",
"x-ms-mutability": [
"read",
"create"
]
},
"maximumNumberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "Maximum number of instances that can be assigned to this App Service plan.",
"readOnly": true
},
"numberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "The number of instances that are assigned to this App Service plan.",
"readOnly": true
},
"geoRegion": {
"type": "string",
"description": "Geographical location for the App Service plan.",
"readOnly": true
},
"perSiteScaling": {
"type": "boolean",
"description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan."
},
"elasticScaleEnabled": {
"type": "boolean",
"description": "ServerFarm supports ElasticScale. Apps in this plan will scale as if the ServerFarm was ElasticPremium sku"
},
"maximumElasticWorkerCount": {
"type": "integer",
"format": "int32",
"description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan"
},
"numberOfSites": {
"type": "integer",
"format": "int32",
"description": "Number of apps assigned to this App Service plan.",
"readOnly": true
},
"isSpot": {
"type": "boolean",
"description": "If true, this App Service Plan owns spot instances."
},
"spotExpirationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the server farm expires. Valid only if it is a spot server farm."
},
"freeOfferExpirationTime": {
"type": "string",
"format": "date-time",
"description": "The time when the server farm free offer expires."
},
"resourceGroup": {
"type": "string",
"description": "Resource group of the App Service plan.",
"readOnly": true
},
"reserved": {
"type": "boolean",
"description": "If Linux app service plan true, false otherwise.",
"x-ms-mutability": [
"read",
"create"
]
},
"isXenon": {
"type": "boolean",
"description": "Obsolete: If Hyper-V container app service plan true, false otherwise.",
"x-ms-mutability": [
"read",
"create"
]
},
"hyperV": {
"type": "boolean",
"description": "If Hyper-V container app service plan true, false otherwise.",
"x-ms-mutability": [
"read",
"create"
]
},
"targetWorkerCount": {
"type": "integer",
"format": "int32",
"description": "Scaling worker count."
},
"targetWorkerSizeId": {
"type": "integer",
"format": "int32",
"description": "Scaling worker size ID."
},
"provisioningState": {
"$ref": "#/definitions/ProvisioningState",
"description": "Provisioning state of the App Service Plan.",
"readOnly": true
},
"kubeEnvironmentProfile": {
"$ref": "#/definitions/KubeEnvironmentProfile",
"description": "Specification for the Kubernetes Environment to use for the App Service plan."
},
"zoneRedundant": {
"type": "boolean",
"description": "If true, this App Service Plan will perform availability zone balancing.\nIf false, this App Service Plan will not perform availability zone balancing."
},
"asyncScalingEnabled": {
"type": "boolean",
"description": "If true, this App Service Plan will attempt to scale asynchronously if there are insufficient workers to scale synchronously.\nIf false, this App Service Plan will only attempt sync scaling."
},
"planDefaultIdentity": {
"$ref": "#/definitions/DefaultIdentity",
"description": "Identity to use by platform for various features and integrations using managed identity."
},
"isCustomMode": {
"type": "boolean",
"description": "Whether this server farm is in custom mode."
},
"registryAdapters": {
"type": "array",
"description": "Registry adapters associated with this App Service plan.",
"items": {
"$ref": "#/definitions/RegistryAdapter"
},
"x-ms-identifiers": []
},
"installScripts": {
"type": "array",
"description": "Install scripts associated with this App Service plan.",
"items": {
"$ref": "#/definitions/InstallScript"
}
},
"network": {
"$ref": "#/definitions/ServerFarmNetworkSettings",
"description": "All network settings for the server farm."
},
"storageMounts": {
"type": "array",
"description": "Storage mounts associated with this App Service plan.",
"items": {
"$ref": "#/definitions/StorageMount"
}
},
"rdpEnabled": {
"type": "boolean",
"description": "If true, RDP access is enabled for this App Service plan. Only applicable for IsCustomMode ASPs.\nIf false, RDP access is disabled."
}
}
},
"AppServicePlanRestrictions": {
"type": "string",
"description": "App Service plans this offer is restricted to.",
"enum": [
"None",
"Free",
"Shared",
"Basic",
"Standard",
"Premium"
],
"x-ms-enum": {
"name": "AppServicePlanRestrictions",
"modelAsString": false
}
},
"Apple": {
"type": "object",
"description": "The configuration settings of the Apple provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Apple provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AppleRegistration",
"description": "The configuration settings of the Apple registration."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
}
}
},
"AppleRegistration": {
"type": "object",
"description": "The configuration settings of the registration for the Apple provider",
"properties": {
"clientId": {
"type": "string",
"description": "The Client ID of the app used for login."
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret."
}
}
},
"ApplicationLogsConfig": {
"type": "object",
"description": "Application logs configuration.",
"properties": {
"fileSystem": {
"$ref": "#/definitions/FileSystemApplicationLogsConfig",
"description": "Application logs to file system configuration."
},
"azureTableStorage": {
"$ref": "#/definitions/AzureTableStorageApplicationLogsConfig",
"description": "Application logs to azure table storage configuration."
},
"azureBlobStorage": {
"$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig",
"description": "Application logs to blob storage configuration."
}
}
},
"ApplicationStack": {
"type": "object",
"description": "Application stack.",
"properties": {
"name": {
"type": "string",
"description": "Application stack name."
},
"display": {
"type": "string",
"description": "Application stack display name."
},
"dependency": {
"type": "string",
"description": "Application stack dependency."
},
"majorVersions": {
"type": "array",
"description": "List of major versions available.",
"items": {
"$ref": "#/definitions/StackMajorVersion"
},
"x-ms-identifiers": [
"runtimeVersion"
]
},
"frameworks": {
"type": "array",
"description": "List of frameworks associated with application stack.",
"items": {
"$ref": "#/definitions/ApplicationStack"
},
"x-ms-identifiers": [
"name"
]
},
"isDeprecated": {
"type": "array",
"description": "true if this is the stack is deprecated; otherwise, false.",
"items": {
"$ref": "#/definitions/ApplicationStack"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"ApplicationStackCollection": {
"type": "object",
"description": "Collection of Application Stacks",
"properties": {
"value": {
"type": "array",
"description": "The ApplicationStackResource items on this page",
"items": {
"$ref": "#/definitions/ApplicationStackResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ApplicationStackResource": {
"type": "object",
"description": "ARM resource for a ApplicationStack.",
"properties": {
"properties": {
"$ref": "#/definitions/ApplicationStack",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"ArcConfiguration": {
"type": "object",
"properties": {
"artifactsStorageType": {
"$ref": "#/definitions/StorageType",
"x-ms-mutability": [
"read",
"create"
]
},
"artifactStorageClassName": {
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"artifactStorageMountPath": {
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"artifactStorageNodeName": {
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"artifactStorageAccessMode": {
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
},
"frontEndServiceConfiguration": {
"$ref": "#/definitions/FrontEndConfiguration"
},
"kubeConfig": {
"type": "string",
"format": "password",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
}
},
"ArmIdWrapper": {
"type": "object",
"description": "A wrapper for an ARM resource id",
"properties": {
"id": {
"type": "string",
"readOnly": true
}
}
},
"ArmPlan": {
"type": "object",
"description": "The plan object in Azure Resource Manager, represents a marketplace plan.",
"properties": {
"name": {
"type": "string",
"description": "The name."
},
"publisher": {
"type": "string",
"description": "The publisher."
},
"product": {
"type": "string",
"description": "The product."
},
"promotionCode": {
"type": "string",
"description": "The promotion code."
},
"version": {
"type": "string",
"description": "Version of product."
}
}
},
"AseRegion": {
"type": "object",
"description": "ASE region.",
"properties": {
"properties": {
"$ref": "#/definitions/AseRegionProperties",
"description": "ASE region resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"AseRegionCollection": {
"type": "object",
"description": "Collection of ASE regions.",
"properties": {
"value": {
"type": "array",
"description": "The AseRegion items on this page",
"items": {
"$ref": "#/definitions/AseRegion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"AseRegionProperties": {
"type": "object",
"description": "ASE region resource specific properties",
"properties": {
"displayName": {
"type": "string",
"description": "Display name for region.",
"readOnly": true
},
"standard": {
"type": "boolean",
"description": "Is region standard.",
"readOnly": true
},
"dedicatedHost": {
"type": "boolean",
"description": "Dedicated host enabled.",
"readOnly": true
},
"zoneRedundant": {
"type": "boolean",
"description": "Zone redundant deployment enabled.",
"readOnly": true
},
"availableSku": {
"type": "array",
"description": "Available Skus in region.",
"items": {
"type": "string"
}
},
"availableOS": {
"type": "array",
"description": "Available OSs in region.",
"items": {
"type": "string"
}
}
}
},
"AseV3NetworkingConfiguration": {
"type": "object",
"description": "Full view of networking configuration for an ASE.",
"properties": {
"properties": {
"$ref": "#/definitions/AseV3NetworkingConfigurationProperties",
"description": "AseV3NetworkingConfiguration resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"AseV3NetworkingConfigurationProperties": {
"type": "object",
"description": "AseV3NetworkingConfiguration resource specific properties",
"properties": {
"windowsOutboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"linuxOutboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"externalInboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"internalInboundIpAddresses": {
"type": "array",
"items": {
"type": "string"
},
"readOnly": true
},
"allowNewPrivateEndpointConnections": {
"type": "boolean",
"description": "Property to enable and disable new private endpoint connection creation on ASE"
},
"ftpEnabled": {
"type": "boolean",
"description": "Property to enable and disable FTP on ASEV3"
},
"remoteDebugEnabled": {
"type": "boolean",
"description": "Property to enable and disable Remote Debug on ASEV3"
},
"inboundIpAddressOverride": {
"type": "string",
"description": "Customer provided Inbound IP Address. Only able to be set on Ase create."
}
}
},
"AuthPlatform": {
"type": "object",
"description": "The configuration settings of the platform of App Service Authentication/Authorization.",
"properties": {
"enabled": {
"type": "boolean",
"description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."
},
"runtimeVersion": {
"type": "string",
"description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."
},
"configFilePath": {
"type": "string",
"description": "The path of the config file containing auth settings if they come from a file.\nIf the path is relative, base will the site's root directory."
}
}
},
"AuthType": {
"type": "string",
"description": "Auth Type",
"enum": [
"Anonymous",
"UserCredentials",
"SystemIdentity",
"UserAssigned"
],
"x-ms-enum": {
"name": "AuthType",
"modelAsString": false
}
},
"AuthenticationType": {
"type": "string",
"description": "Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString.",
"enum": [
"SystemAssignedIdentity",
"UserAssignedIdentity",
"StorageAccountConnectionString"
],
"x-ms-enum": {
"name": "AuthenticationType",
"modelAsString": true,
"values": [
{
"name": "SystemAssignedIdentity",
"value": "SystemAssignedIdentity"
},
{
"name": "UserAssignedIdentity",
"value": "UserAssignedIdentity"
},
{
"name": "StorageAccountConnectionString",
"value": "StorageAccountConnectionString"
}
]
}
},
"AutoGeneratedDomainNameLabelScope": {
"type": "string",
"description": "Specifies the scope of uniqueness for the default hostname during resource creation",
"enum": [
"TenantReuse",
"SubscriptionReuse",
"ResourceGroupReuse",
"NoReuse"
],
"x-ms-enum": {
"name": "AutoGeneratedDomainNameLabelScope",
"modelAsString": false
}
},
"AutoHealActionType": {
"type": "string",
"description": "Predefined action to be taken.",
"enum": [
"Recycle",
"LogEvent",
"CustomAction"
],
"x-ms-enum": {
"name": "AutoHealActionType",
"modelAsString": false
}
},
"AutoHealActions": {
"type": "object",
"description": "Actions which to take by the auto-heal module when a rule is triggered.",
"properties": {
"actionType": {
"$ref": "#/definitions/AutoHealActionType",
"description": "Predefined action to be taken."
},
"customAction": {
"$ref": "#/definitions/AutoHealCustomAction",
"description": "Custom action to be taken."
},
"minProcessExecutionTime": {
"type": "string",
"description": "Minimum time the process must execute\nbefore taking the action"
}
}
},
"AutoHealCustomAction": {
"type": "object",
"description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
"properties": {
"exe": {
"type": "string",
"description": "Executable to be run."
},
"parameters": {
"type": "string",
"description": "Parameters for the executable."
}
}
},
"AutoHealRules": {
"type": "object",
"description": "Rules that can be defined for auto-heal.",
"properties": {
"triggers": {
"$ref": "#/definitions/AutoHealTriggers",
"description": "Conditions that describe when to execute the auto-heal actions."
},
"actions": {
"$ref": "#/definitions/AutoHealActions",
"description": "Actions to be executed when a rule is triggered."
}
}
},
"AutoHealTriggers": {
"type": "object",
"description": "Triggers for auto-heal.",
"properties": {
"requests": {
"$ref": "#/definitions/RequestsBasedTrigger",
"description": "A rule based on total requests."
},
"privateBytesInKB": {
"type": "integer",
"format": "int32",
"description": "A rule based on private bytes."
},
"statusCodes": {
"type": "array",
"description": "A rule based on status codes.",
"items": {
"$ref": "#/definitions/StatusCodesBasedTrigger"
},
"x-ms-identifiers": [
"path"
]
},
"slowRequests": {
"$ref": "#/definitions/SlowRequestsBasedTrigger",
"description": "A rule based on request execution time."
},
"slowRequestsWithPath": {
"type": "array",
"description": "A rule based on multiple Slow Requests Rule with path",
"items": {
"$ref": "#/definitions/SlowRequestsBasedTrigger"
},
"x-ms-identifiers": [
"path"
]
},
"statusCodesRange": {
"type": "array",
"description": "A rule based on status codes ranges.",
"items": {
"$ref": "#/definitions/StatusCodesRangeBasedTrigger"
},
"x-ms-identifiers": [
"path"
]
}
}
},
"AzureActiveDirectory": {
"type": "object",
"description": "The configuration settings of the Azure Active directory provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Azure Active Directory provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AzureActiveDirectoryRegistration",
"description": "The configuration settings of the Azure Active Directory app registration."
},
"login": {
"$ref": "#/definitions/AzureActiveDirectoryLogin",
"description": "The configuration settings of the Azure Active Directory login flow."
},
"validation": {
"$ref": "#/definitions/AzureActiveDirectoryValidation",
"description": "The configuration settings of the Azure Active Directory token validation flow."
},
"isAutoProvisioned": {
"type": "boolean",
"description": "Gets a value indicating whether the Azure AD configuration was auto-provisioned using 1st party tooling.\nThis is an internal flag primarily intended to support the Azure Management Portal. Users should not\nread or write to this property."
}
}
},
"AzureActiveDirectoryLogin": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory login flow.",
"properties": {
"loginParameters": {
"type": "array",
"description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".",
"items": {
"type": "string"
}
},
"disableWWWAuthenticate": {
"type": "boolean",
"description": "true if the www-authenticate provider should be omitted from the request; otherwise, false."
}
}
},
"AzureActiveDirectoryRegistration": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory app registration.",
"properties": {
"openIdIssuer": {
"type": "string",
"description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://login.microsoftonline.com/v2.0/{tenant-guid}/`.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
},
"clientId": {
"type": "string",
"description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or\nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret of the relying party application."
},
"clientSecretCertificateThumbprint": {
"type": "string",
"description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."
},
"clientSecretCertificateSubjectAlternativeName": {
"type": "string",
"description": "An alternative to the client secret thumbprint, that is the subject alternative name of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."
},
"clientSecretCertificateIssuer": {
"type": "string",
"description": "An alternative to the client secret thumbprint, that is the issuer of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret Certificate Thumbprint. It is also optional."
}
}
},
"AzureActiveDirectoryValidation": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory token validation flow.",
"properties": {
"jwtClaimChecks": {
"$ref": "#/definitions/JwtClaimChecks",
"description": "The configuration settings of the checks that should be made while validating the JWT Claims."
},
"allowedAudiences": {
"type": "array",
"description": "The list of audiences that can make successful authentication/authorization requests.",
"items": {
"type": "string"
}
},
"defaultAuthorizationPolicy": {
"$ref": "#/definitions/DefaultAuthorizationPolicy",
"description": "The configuration settings of the default authorization policy."
}
}
},
"AzureBlobStorageApplicationLogsConfig": {
"type": "object",
"description": "Application logs azure blob storage configuration.",
"properties": {
"level": {
"$ref": "#/definitions/LogLevel",
"description": "Log level."
},
"sasUrl": {
"type": "string",
"description": "SAS url to a azure blob container with read/write/list/delete permissions."
},
"retentionInDays": {
"type": "integer",
"format": "int32",
"description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."
}
}
},
"AzureBlobStorageHttpLogsConfig": {
"type": "object",
"description": "Http logs to azure blob storage configuration.",
"properties": {
"sasUrl": {
"type": "string",
"description": "SAS url to a azure blob container with read/write/list/delete permissions."
},
"retentionInDays": {
"type": "integer",
"format": "int32",
"description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention."
},
"enabled": {
"type": "boolean",
"description": "True if configuration is enabled, false if it is disabled and null if configuration is not set."
}
}
},
"AzureResourceErrorInfo": {
"type": "object",
"description": "The azure resource error info.",
"properties": {
"message": {
"type": "string",
"description": "The error message."
},
"details": {
"type": "array",
"description": "The error details.",
"items": {
"$ref": "#/definitions/AzureResourceErrorInfo"
},
"x-ms-identifiers": [
"code"
]
}
},
"required": [
"message"
],
"allOf": [
{
"$ref": "#/definitions/ErrorInfo"
}
]
},
"AzureResourceType": {
"type": "string",
"description": "Azure resource type.",
"enum": [
"Website",
"TrafficManager"
],
"x-ms-enum": {
"name": "AzureResourceType",
"modelAsString": false
}
},
"AzureStaticWebApps": {
"type": "object",
"description": "The configuration settings of the Azure Static Web Apps provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Azure Static Web Apps provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AzureStaticWebAppsRegistration",
"description": "The configuration settings of the Azure Static Web Apps registration."
}
}
},
"AzureStaticWebAppsRegistration": {
"type": "object",
"description": "The configuration settings of the registration for the Azure Static Web Apps provider",
"properties": {
"clientId": {
"type": "string",
"description": "The Client ID of the app used for login."
}
}
},
"AzureStorageInfoValue": {
"type": "object",
"description": "Azure Files or Blob Storage access information value for dictionary storage.",
"properties": {
"type": {
"$ref": "#/definitions/AzureStorageType",
"description": "Type of storage."
},
"accountName": {
"type": "string",
"description": "Name of the storage account."
},
"shareName": {
"type": "string",
"description": "Name of the file share (container name, for Blob storage)."
},
"accessKey": {
"type": "string",
"format": "password",
"description": "Access key for the storage account.",
"x-ms-secret": true
},
"mountPath": {
"type": "string",
"description": "Path to mount the storage within the site's runtime environment."
},
"state": {
"$ref": "#/definitions/AzureStorageState",
"description": "State of the storage account.",
"readOnly": true
},
"protocol": {
"$ref": "#/definitions/AzureStorageProtocol",
"description": "Mounting protocol to use for the storage account."
}
}
},
"AzureStoragePropertyDictionaryResource": {
"type": "object",
"description": "AzureStorageInfo dictionary resource.",
"properties": {
"properties": {
"type": "object",
"description": "Azure storage accounts.",
"additionalProperties": {
"$ref": "#/definitions/AzureStorageInfoValue"
},
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"AzureStorageProtocol": {
"type": "string",
"description": "Mounting protocol to use for the storage account.",
"enum": [
"Smb",
"Http",
"Nfs"
],
"x-ms-enum": {
"name": "AzureStorageProtocol",
"modelAsString": true,
"values": [
{
"name": "Smb",
"value": "Smb"
},
{
"name": "Http",
"value": "Http"
},
{
"name": "Nfs",
"value": "Nfs"
}
]
}
},
"AzureStorageState": {
"type": "string",
"description": "State of the storage account.",
"enum": [
"Ok",
"InvalidCredentials",
"InvalidShare",
"NotValidated"
],
"x-ms-enum": {
"name": "AzureStorageState",
"modelAsString": false
}
},
"AzureStorageType": {
"type": "string",
"description": "Type of storage.",
"enum": [
"AzureFiles",
"AzureBlob"
],
"x-ms-enum": {
"name": "AzureStorageType",
"modelAsString": false
}
},
"AzureTableStorageApplicationLogsConfig": {
"type": "object",
"description": "Application logs to Azure table storage configuration.",
"properties": {
"level": {
"$ref": "#/definitions/LogLevel",
"description": "Log level."
},
"sasUrl": {
"type": "string",
"description": "SAS URL to an Azure table with add/query/delete permissions."
}
},
"required": [
"sasUrl"
]
},
"BackupItem": {
"type": "object",
"description": "Backup description.",
"properties": {
"properties": {
"$ref": "#/definitions/BackupItemProperties",
"description": "BackupItem resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"BackupItemCollection": {
"type": "object",
"description": "Collection of backup items.",
"properties": {
"value": {
"type": "array",
"description": "The BackupItem items on this page",
"items": {
"$ref": "#/definitions/BackupItem"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"BackupItemProperties": {
"type": "object",
"description": "BackupItem resource specific properties",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "Id of the backup.",
"readOnly": true,
"x-ms-client-name": "BackupId"
},
"storageAccountUrl": {
"type": "string",
"description": "SAS URL for the storage account container which contains this backup.",
"readOnly": true
},
"blobName": {
"type": "string",
"description": "Name of the blob which contains data for this backup.",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of this backup.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/BackupItemStatus",
"description": "Backup status.",
"readOnly": true
},
"sizeInBytes": {
"type": "integer",
"format": "int64",
"description": "Size of the backup in bytes.",
"readOnly": true
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of the backup creation.",
"readOnly": true
},
"log": {
"type": "string",
"description": "Details regarding this backup. Might contain an error message.",
"readOnly": true
},
"databases": {
"type": "array",
"description": "List of databases included in the backup.",
"items": {
"$ref": "#/definitions/DatabaseBackupSetting"
},
"readOnly": true,
"x-ms-identifiers": [
"name"
]
},
"scheduled": {
"type": "boolean",
"description": "True if this backup has been created due to a schedule being triggered.",
"readOnly": true
},
"lastRestoreTimeStamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp of a last restore operation which used this backup.",
"readOnly": true
},
"finishedTimeStamp": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this backup finished.",
"readOnly": true
},
"correlationId": {
"type": "string",
"description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.",
"readOnly": true
},
"websiteSizeInBytes": {
"type": "integer",
"format": "int64",
"description": "Size of the original web app which has been backed up.",
"readOnly": true
}
}
},
"BackupItemStatus": {
"type": "string",
"description": "Backup status.",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"TimedOut",
"Created",
"Skipped",
"PartiallySucceeded",
"DeleteInProgress",
"DeleteFailed",
"Deleted"
],
"x-ms-enum": {
"name": "BackupItemStatus",
"modelAsString": false
}
},
"BackupRequest": {
"type": "object",
"description": "Description of a backup which will be performed.",
"properties": {
"properties": {
"$ref": "#/definitions/BackupRequestProperties",
"description": "BackupRequest resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"BackupRequestProperties": {
"type": "object",
"description": "BackupRequest resource specific properties",
"properties": {
"backupName": {
"type": "string",
"description": "Name of the backup."
},
"enabled": {
"type": "boolean",
"description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled."
},
"storageAccountUrl": {
"type": "string",
"description": "SAS URL to the container."
},
"backupSchedule": {
"$ref": "#/definitions/BackupSchedule",
"description": "Schedule for the backup if it is executed periodically."
},
"databases": {
"type": "array",
"description": "Databases included in the backup.",
"items": {
"$ref": "#/definitions/DatabaseBackupSetting"
},
"x-ms-identifiers": [
"name"
]
}
},
"required": [
"storageAccountUrl"
]
},
"BackupSchedule": {
"type": "object",
"description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.",
"properties": {
"frequencyInterval": {
"type": "integer",
"format": "int32",
"description": "How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)",
"default": 7
},
"frequencyUnit": {
"type": "string",
"description": "The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)",
"default": "Day",
"enum": [
"Day",
"Hour"
],
"x-ms-enum": {
"name": "FrequencyUnit",
"modelAsString": false
}
},
"keepAtLeastOneBackup": {
"type": "boolean",
"description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.",
"default": true
},
"retentionPeriodInDays": {
"type": "integer",
"format": "int32",
"description": "After how many days backups should be deleted.",
"default": 30
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "When the schedule should start working."
},
"lastExecutionTime": {
"type": "string",
"format": "date-time",
"description": "Last time when this schedule was triggered.",
"readOnly": true
}
},
"required": [
"frequencyInterval",
"frequencyUnit",
"keepAtLeastOneBackup",
"retentionPeriodInDays"
]
},
"BillingMeter": {
"type": "object",
"description": "App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.",
"properties": {
"properties": {
"$ref": "#/definitions/BillingMeterProperties",
"description": "BillingMeter resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"BillingMeterCollection": {
"type": "object",
"description": "Collection of Billing Meters",
"properties": {
"value": {
"type": "array",
"description": "The BillingMeter items on this page",
"items": {
"$ref": "#/definitions/BillingMeter"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"BillingMeterProperties": {
"type": "object",
"description": "BillingMeter resource specific properties",
"properties": {
"meterId": {
"type": "string",
"description": "Meter GUID onboarded in Commerce"
},
"billingLocation": {
"type": "string",
"description": "Azure Location of billable resource"
},
"shortName": {
"type": "string",
"description": "Short Name from App Service Azure pricing Page"
},
"friendlyName": {
"type": "string",
"description": "Friendly name of the meter"
},
"resourceType": {
"type": "string",
"description": "App Service ResourceType meter used for"
},
"osType": {
"type": "string",
"description": "App Service OS type meter used for"
},
"multiplier": {
"type": "number",
"format": "double",
"description": "Meter Multiplier"
}
}
},
"BlobStorageTokenStore": {
"type": "object",
"description": "The configuration settings of the storage of the tokens if blob storage is used.",
"properties": {
"sasUrlSettingName": {
"type": "string",
"description": "The name of the app setting containing the SAS URL of the blob storage containing the tokens."
}
}
},
"BuildStatus": {
"type": "string",
"description": "The status of the static site build.",
"enum": [
"WaitingForDeployment",
"Uploading",
"Deploying",
"Ready",
"Failed",
"Deleting",
"Detached"
],
"x-ms-enum": {
"name": "BuildStatus",
"modelAsString": true,
"values": [
{
"name": "WaitingForDeployment",
"value": "WaitingForDeployment"
},
{
"name": "Uploading",
"value": "Uploading"
},
{
"name": "Deploying",
"value": "Deploying"
},
{
"name": "Ready",
"value": "Ready"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Detached",
"value": "Detached"
}
]
}
},
"BuiltInAuthenticationProvider": {
"type": "string",
"description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".",
"enum": [
"AzureActiveDirectory",
"Facebook",
"Google",
"MicrosoftAccount",
"Twitter",
"Github"
],
"x-ms-enum": {
"name": "BuiltInAuthenticationProvider",
"modelAsString": false
}
},
"Capability": {
"type": "object",
"description": "Describes the capabilities/features allowed for a specific SKU.",
"properties": {
"name": {
"type": "string",
"description": "Name of the SKU capability."
},
"value": {
"type": "string",
"description": "Value of the SKU capability."
},
"reason": {
"type": "string",
"description": "Reason of the SKU capability."
}
}
},
"Certificate": {
"type": "object",
"description": "SSL certificate for an app.",
"properties": {
"properties": {
"$ref": "#/definitions/CertificateProperties",
"description": "Certificate resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"CertificateCollection": {
"type": "object",
"description": "Collection of certificates.",
"properties": {
"value": {
"type": "array",
"description": "The Certificate items on this page",
"items": {
"$ref": "#/definitions/Certificate"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CertificatePatchResource": {
"type": "object",
"description": "ARM resource for a certificate.",
"properties": {
"properties": {
"$ref": "#/definitions/CertificatePatchResourceProperties",
"description": "CertificatePatchResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"CertificatePatchResourceProperties": {
"type": "object",
"description": "CertificatePatchResource resource specific properties",
"properties": {
"password": {
"type": "string",
"description": "Certificate password.",
"readOnly": true
},
"friendlyName": {
"type": "string",
"description": "Friendly name of the certificate.",
"readOnly": true
},
"subjectName": {
"type": "string",
"description": "Subject name of the certificate.",
"readOnly": true
},
"hostNames": {
"type": "array",
"description": "Host names the certificate applies to.",
"items": {
"type": "string"
}
},
"pfxBlob": {
"type": "string",
"format": "byte",
"description": "Pfx blob."
},
"siteName": {
"type": "string",
"description": "App name.",
"readOnly": true
},
"selfLink": {
"type": "string",
"description": "Self link.",
"readOnly": true
},
"issuer": {
"type": "string",
"description": "Certificate issuer.",
"readOnly": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"description": "Certificate issue Date.",
"readOnly": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "Certificate expiration date.",
"readOnly": true
},
"thumbprint": {
"type": "string",
"description": "Certificate thumbprint.",
"readOnly": true
},
"valid": {
"type": "boolean",
"description": "Is the certificate valid?.",
"readOnly": true
},
"cerBlob": {
"type": "string",
"format": "byte",
"description": "Raw bytes of .cer file",
"readOnly": true
},
"publicKeyHash": {
"type": "string",
"description": "Public key hash.",
"readOnly": true
},
"hostingEnvironmentProfile": {
"$ref": "#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the certificate.",
"readOnly": true
},
"keyVaultId": {
"type": "string",
"description": "Key Vault Csm resource Id."
},
"keyVaultSecretName": {
"type": "string",
"description": "Key Vault secret name."
},
"keyVaultSecretStatus": {
"$ref": "#/definitions/KeyVaultSecretStatus",
"description": "Status of the Key Vault secret.",
"readOnly": true
},
"serverFarmId": {
"type": "string",
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."
},
"canonicalName": {
"type": "string",
"description": "CNAME of the certificate to be issued via free certificate"
},
"domainValidationMethod": {
"type": "string",
"description": "Method of domain validation for free cert"
}
}
},
"CertificateProperties": {
"type": "object",
"description": "Certificate resource specific properties",
"properties": {
"password": {
"type": "string",
"description": "Certificate password."
},
"friendlyName": {
"type": "string",
"description": "Friendly name of the certificate.",
"readOnly": true
},
"subjectName": {
"type": "string",
"description": "Subject name of the certificate.",
"readOnly": true
},
"hostNames": {
"type": "array",
"description": "Host names the certificate applies to.",
"items": {
"type": "string"
}
},
"pfxBlob": {
"type": "string",
"format": "byte",
"description": "Pfx blob."
},
"siteName": {
"type": "string",
"description": "App name.",
"readOnly": true
},
"selfLink": {
"type": "string",
"description": "Self link.",
"readOnly": true
},
"issuer": {
"type": "string",
"description": "Certificate issuer.",
"readOnly": true
},
"issueDate": {
"type": "string",
"format": "date-time",
"description": "Certificate issue Date.",
"readOnly": true
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "Certificate expiration date.",
"readOnly": true
},
"thumbprint": {
"type": "string",
"description": "Certificate thumbprint.",
"readOnly": true
},
"valid": {
"type": "boolean",
"description": "Is the certificate valid?.",
"readOnly": true
},
"cerBlob": {
"type": "string",
"format": "byte",
"description": "Raw bytes of .cer file",
"readOnly": true
},
"publicKeyHash": {
"type": "string",
"description": "Public key hash.",
"readOnly": true
},
"hostingEnvironmentProfile": {
"$ref": "#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the certificate.",
"readOnly": true
},
"keyVaultId": {
"type": "string",
"format": "arm-id",
"description": "Azure Key Vault Csm resource Id.",
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.KeyVault/vaults"
}
]
}
},
"keyVaultSecretName": {
"type": "string",
"description": "Azure Key Vault secret name."
},
"keyVaultSecretStatus": {
"$ref": "#/definitions/KeyVaultSecretStatus",
"description": "Status of the Key Vault secret.",
"readOnly": true
},
"serverFarmId": {
"type": "string",
"format": "arm-id",
"description": "Resource ID of the associated App Service plan.",
"x-ms-arm-id-details": {
"allowedResources": [
{
"type": "Microsoft.Web/serverfarms"
}
]
}
},
"canonicalName": {
"type": "string",
"description": "CNAME of the certificate to be issued via free certificate"
},
"domainValidationMethod": {
"type": "string",
"description": "Method of domain validation for free cert"
}
}
},
"Channels": {
"type": "string",
"description": "List of channels that this recommendation can apply.",
"enum": [
"Notification",
"Api",
"Email",
"Webhook",
"All"
],
"x-ms-enum": {
"name": "Channels",
"modelAsString": false
}
},
"CheckNameResourceTypes": {
"type": "string",
"description": "Resource type used for verification.",
"enum": [
"Site",
"Slot",
"HostingEnvironment",
"PublishingUser",
"Microsoft.Web/sites",
"Microsoft.Web/sites/slots",
"Microsoft.Web/hostingEnvironments",
"Microsoft.Web/publishingUsers"
],
"x-ms-enum": {
"name": "CheckNameResourceTypes",
"modelAsString": true,
"values": [
{
"name": "Site",
"value": "Site"
},
{
"name": "Slot",
"value": "Slot"
},
{
"name": "HostingEnvironment",
"value": "HostingEnvironment"
},
{
"name": "PublishingUser",
"value": "PublishingUser"
},
{
"name": "Microsoft.Web/sites",
"value": "Microsoft.Web/sites"
},
{
"name": "Microsoft.Web/sites/slots",
"value": "Microsoft.Web/sites/slots"
},
{
"name": "Microsoft.Web/hostingEnvironments",
"value": "Microsoft.Web/hostingEnvironments"
},
{
"name": "Microsoft.Web/publishingUsers",
"value": "Microsoft.Web/publishingUsers"
}
]
}
},
"ClientCertMode": {
"type": "string",
"description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.",
"enum": [
"Required",
"Optional",
"OptionalInteractiveUser"
],
"x-ms-enum": {
"name": "ClientCertMode",
"modelAsString": false
}
},
"ClientRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for providers that have client ids and client secrets",
"properties": {
"clientId": {
"type": "string",
"description": "The Client ID of the app used for login."
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret."
}
}
},
"CloneAbilityResult": {
"type": "string",
"description": "Name of app.",
"enum": [
"Cloneable",
"PartiallyCloneable",
"NotCloneable"
],
"x-ms-enum": {
"name": "CloneAbilityResult",
"modelAsString": false
}
},
"CloningInfo": {
"type": "object",
"description": "Information needed for cloning operation.",
"properties": {
"correlationId": {
"type": "string",
"format": "uuid",
"description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot."
},
"overwrite": {
"type": "boolean",
"description": "true to overwrite destination app; otherwise, false."
},
"cloneCustomHostNames": {
"type": "boolean",
"description": "true to clone custom hostnames from source app; otherwise, false."
},
"cloneSourceControl": {
"type": "boolean",
"description": "true to clone source control from source app; otherwise, false."
},
"sourceWebAppId": {
"type": "string",
"description": "ARM resource ID of the source app. App resource ID is of the form\n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and\n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."
},
"sourceWebAppLocation": {
"type": "string",
"description": "Location of source app ex: West US or North Europe"
},
"hostingEnvironment": {
"type": "string",
"description": "App Service Environment."
},
"appSettingsOverrides": {
"type": "object",
"description": "Application setting overrides for cloned app. If specified, these settings override the settings cloned\nfrom source app. Otherwise, application settings from source app are retained.",
"additionalProperties": {
"type": "string"
}
},
"configureLoadBalancing": {
"type": "boolean",
"description": "true to configure load balancing for source and destination app."
},
"trafficManagerProfileId": {
"type": "string",
"description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form\n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}."
},
"trafficManagerProfileName": {
"type": "string",
"description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist."
}
},
"required": [
"sourceWebAppId"
]
},
"ComputeModeOptions": {
"type": "string",
"description": "Shared/dedicated workers.",
"enum": [
"Shared",
"Dedicated",
"Dynamic"
],
"x-ms-enum": {
"name": "ComputeModeOptions",
"modelAsString": false
}
},
"ConnStringInfo": {
"type": "object",
"description": "Database connection string information.",
"properties": {
"name": {
"type": "string",
"description": "Name of connection string."
},
"connectionString": {
"type": "string",
"description": "Connection string value."
},
"type": {
"$ref": "#/definitions/ConnectionStringType",
"description": "Type of database."
}
}
},
"ConnStringValueTypePair": {
"type": "object",
"description": "Database connection string value to type pair.",
"properties": {
"value": {
"type": "string",
"description": "Value of pair."
},
"type": {
"$ref": "#/definitions/ConnectionStringType",
"description": "Type of database."
}
},
"required": [
"value",
"type"
]
},
"ConnectionStringDictionary": {
"type": "object",
"description": "String dictionary resource.",
"properties": {
"properties": {
"type": "object",
"description": "Connection strings.",
"additionalProperties": {
"$ref": "#/definitions/ConnStringValueTypePair"
},
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"ConnectionStringType": {
"type": "string",
"description": "Type of database.",
"enum": [
"MySql",
"SQLServer",
"SQLAzure",
"Custom",
"NotificationHub",
"ServiceBus",
"EventHub",
"ApiHub",
"DocDb",
"RedisCache",
"PostgreSQL"
],
"x-ms-enum": {
"name": "ConnectionStringType",
"modelAsString": false
}
},
"ContainerAppsConfiguration": {
"type": "object",
"properties": {
"daprAIInstrumentationKey": {
"type": "string",
"description": "Azure Monitor instrumentation key used by Dapr to export Service to Service communication telemetry",
"x-ms-mutability": [
"read",
"create"
]
},
"platformReservedCidr": {
"type": "string",
"description": "IP range in CIDR notation that can be reserved for environment infrastructure IP addresses. It must not overlap with any other Subnet IP ranges.",
"x-ms-mutability": [
"read",
"create"
]
},
"platformReservedDnsIP": {
"type": "string",
"description": "An IP address from the IP range defined by platformReservedCidr that will be reserved for the internal DNS server",
"x-ms-mutability": [
"read",
"create"
]
},
"controlPlaneSubnetResourceId": {
"type": "string",
"description": "Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.",
"x-ms-mutability": [
"read",
"create"
]
},
"appSubnetResourceId": {
"type": "string",
"description": "Resource ID of a subnet for control plane infrastructure components. This subnet must be in the same VNET as the subnet defined in appSubnetResourceId. Must not overlap with the IP range defined in platformReservedCidr, if defined.",
"x-ms-mutability": [
"read",
"create"
]
},
"dockerBridgeCidr": {
"type": "string",
"description": "CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the IP range defined in platformReservedCidr, if defined.",
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"ContainerCpuStatistics": {
"type": "object",
"properties": {
"cpuUsage": {
"$ref": "#/definitions/ContainerCpuUsage"
},
"systemCpuUsage": {
"type": "integer",
"format": "int64"
},
"onlineCpuCount": {
"type": "integer",
"format": "int32"
},
"throttlingData": {
"$ref": "#/definitions/ContainerThrottlingData"
}
}
},
"ContainerCpuUsage": {
"type": "object",
"properties": {
"totalUsage": {
"type": "integer",
"format": "int64"
},
"perCpuUsage": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"kernelModeUsage": {
"type": "integer",
"format": "int64"
},
"userModeUsage": {
"type": "integer",
"format": "int64"
}
}
},
"ContainerInfo": {
"type": "object",
"properties": {
"currentTimeStamp": {
"type": "string",
"format": "date-time"
},
"previousTimeStamp": {
"type": "string",
"format": "date-time"
},
"currentCpuStats": {
"$ref": "#/definitions/ContainerCpuStatistics"
},
"previousCpuStats": {
"$ref": "#/definitions/ContainerCpuStatistics"
},
"memoryStats": {
"$ref": "#/definitions/ContainerMemoryStatistics"
},
"name": {
"type": "string"
},
"id": {
"type": "string"
},
"eth0": {
"$ref": "#/definitions/ContainerNetworkInterfaceStatistics"
}
}
},
"ContainerMemoryStatistics": {
"type": "object",
"properties": {
"usage": {
"type": "integer",
"format": "int64"
},
"maxUsage": {
"type": "integer",
"format": "int64"
},
"limit": {
"type": "integer",
"format": "int64"
}
}
},
"ContainerNetworkInterfaceStatistics": {
"type": "object",
"properties": {
"rxBytes": {
"type": "integer",
"format": "int64"
},
"rxPackets": {
"type": "integer",
"format": "int64"
},
"rxErrors": {
"type": "integer",
"format": "int64"
},
"rxDropped": {
"type": "integer",
"format": "int64"
},
"txBytes": {
"type": "integer",
"format": "int64"
},
"txPackets": {
"type": "integer",
"format": "int64"
},
"txErrors": {
"type": "integer",
"format": "int64"
},
"txDropped": {
"type": "integer",
"format": "int64"
}
}
},
"ContainerThrottlingData": {
"type": "object",
"properties": {
"periods": {
"type": "integer",
"format": "int32"
},
"throttledPeriods": {
"type": "integer",
"format": "int32"
},
"throttledTime": {
"type": "integer",
"format": "int32"
}
}
},
"ContentHash": {
"type": "object",
"description": "The content hash.",
"properties": {
"algorithm": {
"type": "string",
"description": "The algorithm of the content hash."
},
"value": {
"type": "string",
"description": "The value of the content hash."
}
}
},
"ContentLink": {
"type": "object",
"description": "The content link.",
"properties": {
"uri": {
"type": "string",
"description": "The content link URI."
},
"contentVersion": {
"type": "string",
"description": "The content version.",
"readOnly": true
},
"contentSize": {
"type": "integer",
"format": "int64",
"description": "The content size.",
"readOnly": true
},
"contentHash": {
"$ref": "#/definitions/ContentHash",
"description": "The content hash.",
"readOnly": true
},
"metadata": {
"description": "The metadata.",
"readOnly": true
}
}
},
"ContinuousWebJob": {
"type": "object",
"description": "Continuous Web Job Information.",
"properties": {
"properties": {
"$ref": "#/definitions/ContinuousWebJobProperties",
"description": "ContinuousWebJob resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ContinuousWebJobCollection": {
"type": "object",
"description": "Collection of Kudu continuous web job information elements.",
"properties": {
"value": {
"type": "array",
"description": "The ContinuousWebJob items on this page",
"items": {
"$ref": "#/definitions/ContinuousWebJob"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ContinuousWebJobProperties": {
"type": "object",
"description": "ContinuousWebJob resource specific properties",
"properties": {
"status": {
"$ref": "#/definitions/ContinuousWebJobStatus",
"description": "Job status."
},
"detailed_status": {
"type": "string",
"description": "Detailed status.",
"x-ms-client-name": "detailedStatus"
},
"log_url": {
"type": "string",
"description": "Log URL.",
"x-ms-client-name": "logUrl"
},
"run_command": {
"type": "string",
"description": "Run command.",
"x-ms-client-name": "runCommand"
},
"url": {
"type": "string",
"description": "Job URL."
},
"extra_info_url": {
"type": "string",
"description": "Extra Info URL.",
"x-ms-client-name": "extraInfoUrl"
},
"web_job_type": {
"$ref": "#/definitions/WebJobType",
"description": "Job type.",
"x-ms-client-name": "webJobType"
},
"error": {
"type": "string",
"description": "Error information."
},
"using_sdk": {
"type": "boolean",
"description": "Using SDK?",
"x-ms-client-name": "usingSdk"
},
"settings": {
"type": "object",
"description": "Job settings.",
"additionalProperties": {}
}
}
},
"ContinuousWebJobStatus": {
"type": "string",
"description": "Job status.",
"enum": [
"Initializing",
"Starting",
"Running",
"PendingRestart",
"Stopped"
],
"x-ms-enum": {
"name": "ContinuousWebJobStatus",
"modelAsString": false
}
},
"CookieExpiration": {
"type": "object",
"description": "The configuration settings of the session cookie's expiration.",
"properties": {
"convention": {
"$ref": "#/definitions/CookieExpirationConvention",
"description": "The convention used when determining the session cookie's expiration."
},
"timeToExpiration": {
"type": "string",
"description": "The time after the request is made when the session cookie should expire."
}
}
},
"CookieExpirationConvention": {
"type": "string",
"description": "The convention used when determining the session cookie's expiration.",
"enum": [
"FixedTime",
"IdentityProviderDerived"
],
"x-ms-enum": {
"name": "CookieExpirationConvention",
"modelAsString": false
}
},
"Correlation": {
"type": "object",
"description": "The correlation property.",
"properties": {
"clientTrackingId": {
"type": "string",
"description": "The client tracking id."
}
}
},
"CorsSettings": {
"type": "object",
"description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
"properties": {
"allowedOrigins": {
"type": "array",
"description": "Gets or sets the list of origins that should be allowed to make cross-origin\ncalls (for example: http://example.com:12345). Use \"*\" to allow all.",
"items": {
"type": "string"
}
},
"supportCredentials": {
"type": "boolean",
"description": "Gets or sets whether CORS requests with credentials are allowed. See\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details."
}
}
},
"CsmDeploymentStatus": {
"type": "object",
"description": "Deployment status response payload.",
"properties": {
"properties": {
"$ref": "#/definitions/CsmDeploymentStatusProperties",
"description": "CsmDeploymentStatus resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"CsmDeploymentStatusCollection": {
"type": "object",
"description": "Deployment status collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The CsmDeploymentStatus items on this page",
"items": {
"$ref": "#/definitions/CsmDeploymentStatus"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CsmDeploymentStatusProperties": {
"type": "object",
"description": "CsmDeploymentStatus resource specific properties",
"properties": {
"deploymentId": {
"type": "string",
"description": "Deployment operation id."
},
"status": {
"$ref": "#/definitions/DeploymentBuildStatus",
"description": "Deployment build status."
},
"numberOfInstancesInProgress": {
"type": "integer",
"format": "int32",
"description": "Number of site instances currently being provisioned."
},
"numberOfInstancesSuccessful": {
"type": "integer",
"format": "int32",
"description": "Number of site instances provisioned successfully."
},
"numberOfInstancesFailed": {
"type": "integer",
"format": "int32",
"description": "Number of site instances failed to provision."
},
"failedInstancesLogs": {
"type": "array",
"description": "List of URLs pointing to logs for instances which failed to provision.",
"items": {
"type": "string"
}
},
"errors": {
"type": "array",
"description": "List of errors.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"x-ms-identifiers": []
}
}
},
"CsmMoveResourceEnvelope": {
"type": "object",
"description": "Object with a list of the resources that need to be moved and the resource group they should be moved to.",
"properties": {
"targetResourceGroup": {
"type": "string",
"minLength": 1,
"maxLength": 90,
"pattern": " ^[-\\w\\._\\(\\)]+[^\\.]$"
},
"resources": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"CsmOperationCollection": {
"type": "object",
"description": "Collection of Azure resource manager operation metadata.",
"properties": {
"value": {
"type": "array",
"description": "Collection of resources.",
"items": {
"$ref": "#/definitions/CsmOperationDescription"
},
"x-ms-identifiers": [
"name"
]
},
"nextLink": {
"type": "string",
"description": "Link to next page of resources.",
"readOnly": true
}
},
"required": [
"value"
]
},
"CsmOperationDescription": {
"type": "object",
"description": "Description of an operation available for Microsoft.Web resource provider.",
"properties": {
"name": {
"type": "string"
},
"isDataAction": {
"type": "boolean"
},
"display": {
"$ref": "#/definitions/CsmOperationDisplay",
"description": "Meta data about operation used for display in portal."
},
"origin": {
"type": "string"
},
"properties": {
"$ref": "#/definitions/CsmOperationDescriptionProperties",
"description": "Properties available for a Microsoft.Web resource provider operation."
}
}
},
"CsmOperationDescriptionProperties": {
"type": "object",
"description": "Properties available for a Microsoft.Web resource provider operation.",
"properties": {
"serviceSpecification": {
"$ref": "#/definitions/ServiceSpecification",
"description": "Resource metrics service provided by Microsoft.Insights resource provider."
}
}
},
"CsmOperationDisplay": {
"type": "object",
"description": "Meta data about operation used for display in portal.",
"properties": {
"provider": {
"type": "string"
},
"resource": {
"type": "string"
},
"operation": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"CsmPublishingCredentialsPoliciesEntity": {
"type": "object",
"description": "Publishing Credentials Policies parameters.",
"properties": {
"properties": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntityProperties",
"description": "CsmPublishingCredentialsPoliciesEntity resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"CsmPublishingCredentialsPoliciesEntityProperties": {
"type": "object",
"description": "CsmPublishingCredentialsPoliciesEntity resource specific properties",
"properties": {
"allow": {
"type": "boolean",
"description": "true to allow access to a publishing method; otherwise, false."
}
},
"required": [
"allow"
]
},
"CsmPublishingProfileOptions": {
"type": "object",
"description": "Publishing options for requested profile.",
"properties": {
"format": {
"$ref": "#/definitions/PublishingProfileFormat",
"description": "Name of the format. Valid values are:\nFileZilla3\nWebDeploy -- default\nFtp"
},
"includeDisasterRecoveryEndpoints": {
"type": "boolean",
"description": "Include the DisasterRecover endpoint if true"
}
}
},
"CsmSlotEntity": {
"type": "object",
"description": "Deployment slot parameters.",
"properties": {
"targetSlot": {
"type": "string",
"description": "Destination deployment slot during swap operation."
},
"preserveVnet": {
"type": "boolean",
"description": "true to preserve Virtual Network to the slot during swap; otherwise, false."
}
},
"required": [
"targetSlot",
"preserveVnet"
]
},
"CsmUsageQuota": {
"type": "object",
"description": "Usage of the quota resource.",
"properties": {
"unit": {
"type": "string",
"description": "Units of measurement for the quota resource."
},
"nextResetTime": {
"type": "string",
"format": "date-time",
"description": "Next reset time for the resource counter."
},
"currentValue": {
"type": "integer",
"format": "int64",
"description": "The current value of the resource counter."
},
"limit": {
"type": "integer",
"format": "int64",
"description": "The resource limit."
},
"name": {
"$ref": "#/definitions/LocalizableString",
"description": "Quota name."
}
}
},
"CsmUsageQuotaCollection": {
"type": "object",
"description": "Paged collection of CsmUsageQuota items",
"properties": {
"value": {
"type": "array",
"description": "The CsmUsageQuota items on this page",
"items": {
"$ref": "#/definitions/CsmUsageQuota"
},
"x-ms-identifiers": [
"name"
]
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CustomDnsSuffixConfiguration": {
"type": "object",
"description": "Full view of the custom domain suffix configuration for ASEv3.",
"properties": {
"properties": {
"$ref": "#/definitions/CustomDnsSuffixConfigurationProperties",
"description": "CustomDnsSuffixConfiguration resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"CustomDnsSuffixConfigurationProperties": {
"type": "object",
"description": "CustomDnsSuffixConfiguration resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/CustomDnsSuffixProvisioningState",
"readOnly": true
},
"provisioningDetails": {
"type": "string",
"readOnly": true
},
"dnsSuffix": {
"type": "string",
"description": "The default custom domain suffix to use for all sites deployed on the ASE."
},
"certificateUrl": {
"type": "string",
"description": "The URL referencing the Azure Key Vault certificate secret that should be used as the default SSL/TLS certificate for sites with the custom domain suffix."
},
"keyVaultReferenceIdentity": {
"type": "string",
"description": "The user-assigned identity to use for resolving the key vault certificate reference. If not specified, the system-assigned ASE identity will be used if available."
}
}
},
"CustomDnsSuffixProvisioningState": {
"type": "string",
"enum": [
"Succeeded",
"Failed",
"Degraded",
"InProgress"
],
"x-ms-enum": {
"name": "CustomDnsSuffixProvisioningState",
"modelAsString": false
}
},
"CustomDomainStatus": {
"type": "string",
"description": "The status of the custom domain",
"enum": [
"RetrievingValidationToken",
"Validating",
"Adding",
"Ready",
"Failed",
"Deleting",
"Unhealthy"
],
"x-ms-enum": {
"name": "CustomDomainStatus",
"modelAsString": true,
"values": [
{
"name": "RetrievingValidationToken",
"value": "RetrievingValidationToken"
},
{
"name": "Validating",
"value": "Validating"
},
{
"name": "Adding",
"value": "Adding"
},
{
"name": "Ready",
"value": "Ready"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Unhealthy",
"value": "Unhealthy"
}
]
}
},
"CustomHostNameDnsRecordType": {
"type": "string",
"description": "Custom DNS record type.",
"enum": [
"CName",
"A"
],
"x-ms-enum": {
"name": "CustomHostNameDnsRecordType",
"modelAsString": false
}
},
"CustomHostnameAnalysisResult": {
"type": "object",
"description": "Custom domain analysis.",
"properties": {
"properties": {
"$ref": "#/definitions/CustomHostnameAnalysisResultProperties",
"description": "CustomHostnameAnalysisResult resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"CustomHostnameAnalysisResultProperties": {
"type": "object",
"description": "CustomHostnameAnalysisResult resource specific properties",
"properties": {
"isHostnameAlreadyVerified": {
"type": "boolean",
"description": "true if hostname is already verified; otherwise, false.",
"readOnly": true
},
"customDomainVerificationTest": {
"$ref": "#/definitions/DnsVerificationTestResult",
"description": "DNS verification test result.",
"readOnly": true
},
"customDomainVerificationFailureInfo": {
"$ref": "#/definitions/ErrorEntity",
"description": "Raw failure information if DNS verification fails.",
"readOnly": true
},
"hasConflictOnScaleUnit": {
"type": "boolean",
"description": "true if there is a conflict on a scale unit; otherwise, false.",
"readOnly": true
},
"hasConflictAcrossSubscription": {
"type": "boolean",
"description": "true if there is a conflict across subscriptions; otherwise, false.",
"readOnly": true
},
"conflictingAppResourceId": {
"type": "string",
"description": "Name of the conflicting app on scale unit if it's within the same subscription.",
"readOnly": true
},
"cNameRecords": {
"type": "array",
"description": "CName records controller can see for this hostname.",
"items": {
"type": "string"
}
},
"txtRecords": {
"type": "array",
"description": "TXT records controller can see for this hostname.",
"items": {
"type": "string"
}
},
"aRecords": {
"type": "array",
"description": "A records controller can see for this hostname.",
"items": {
"type": "string"
}
},
"alternateCNameRecords": {
"type": "array",
"description": "Alternate CName records controller can see for this hostname.",
"items": {
"type": "string"
}
},
"alternateTxtRecords": {
"type": "array",
"description": "Alternate TXT records controller can see for this hostname.",
"items": {
"type": "string"
}
}
}
},
"CustomHostnameSites": {
"type": "object",
"description": "A hostname and its assigned sites",
"properties": {
"properties": {
"$ref": "#/definitions/CustomHostnameSitesProperties",
"description": "CustomHostnameSites resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"CustomHostnameSitesCollection": {
"type": "object",
"description": "Collection of custom hostname sites",
"properties": {
"value": {
"type": "array",
"description": "The CustomHostnameSites items on this page",
"items": {
"$ref": "#/definitions/CustomHostnameSites"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"CustomHostnameSitesProperties": {
"type": "object",
"description": "CustomHostnameSites resource specific properties",
"properties": {
"customHostname": {
"type": "string"
},
"region": {
"type": "string"
},
"siteResourceIds": {
"type": "array",
"items": {
"$ref": "#/definitions/Identifier"
}
}
}
},
"CustomOpenIdConnectProvider": {
"type": "object",
"description": "The configuration settings of the custom Open ID Connect provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the custom Open ID provider provider should not be enabled; otherwise, true."
},
"registration": {
"$ref": "#/definitions/OpenIdConnectRegistration",
"description": "The configuration settings of the app registration for the custom Open ID Connect provider."
},
"login": {
"$ref": "#/definitions/OpenIdConnectLogin",
"description": "The configuration settings of the login flow of the custom Open ID Connect provider."
}
}
},
"DaprConfig": {
"type": "object",
"description": "App Dapr configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "Boolean indicating if the Dapr side car is enabled",
"default": false
},
"appId": {
"type": "string",
"description": "Dapr application identifier"
},
"appPort": {
"type": "integer",
"format": "int32",
"description": "Tells Dapr which port your application is listening on"
},
"httpReadBufferSize": {
"type": "integer",
"format": "int32",
"description": "Dapr max size of http header read buffer in KB to handle when sending multi-KB headers. Default is 65KB."
},
"httpMaxRequestSize": {
"type": "integer",
"format": "int32",
"description": "Increasing max size of request body http servers parameter in MB to handle uploading of big files. Default is 4 MB."
},
"logLevel": {
"$ref": "#/definitions/DaprLogLevel",
"description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info."
},
"enableApiLogging": {
"type": "boolean",
"description": "Enables API logging for the Dapr sidecar"
}
}
},
"DaprLogLevel": {
"type": "string",
"description": "Sets the log level for the Dapr sidecar. Allowed values are debug, info, warn, error. Default is info.",
"enum": [
"info",
"debug",
"warn",
"error"
],
"x-ms-enum": {
"name": "DaprLogLevel",
"modelAsString": true,
"values": [
{
"name": "info",
"value": "info"
},
{
"name": "debug",
"value": "debug"
},
{
"name": "warn",
"value": "warn"
},
{
"name": "error",
"value": "error"
}
]
}
},
"DataProviderMetadata": {
"type": "object",
"description": "Additional configuration for a data providers",
"properties": {
"providerName": {
"type": "string"
},
"propertyBag": {
"type": "array",
"description": "Settings for the data provider",
"items": {
"$ref": "#/definitions/KeyValuePairStringObject"
},
"readOnly": true,
"x-ms-identifiers": [
"key"
]
}
}
},
"DataSource": {
"type": "object",
"description": "Class representing data source used by the detectors",
"properties": {
"instructions": {
"type": "array",
"description": "Instructions if any for the data source",
"items": {
"type": "string"
}
},
"dataSourceUri": {
"type": "array",
"description": "Datasource Uri Links",
"items": {
"$ref": "#/definitions/NameValuePair"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"DataTableResponseColumn": {
"type": "object",
"description": "Column definition",
"properties": {
"columnName": {
"type": "string",
"description": "Name of the column"
},
"dataType": {
"type": "string",
"description": "Data type which looks like 'String' or 'Int32'."
},
"columnType": {
"type": "string",
"description": "Column Type"
}
}
},
"DataTableResponseObject": {
"type": "object",
"description": "Data Table which defines columns and raw row values",
"properties": {
"tableName": {
"type": "string",
"description": "Name of the table"
},
"columns": {
"type": "array",
"description": "List of columns with data types",
"items": {
"$ref": "#/definitions/DataTableResponseColumn"
},
"x-ms-identifiers": [
"columnName"
]
},
"rows": {
"type": "array",
"description": "Raw row values",
"items": {
"type": "array",
"items": {
"type": "string"
}
},
"x-ms-identifiers": []
}
}
},
"DatabaseBackupSetting": {
"type": "object",
"description": "Database backup settings.",
"properties": {
"databaseType": {
"$ref": "#/definitions/DatabaseType",
"description": "Database type (e.g. SqlAzure / MySql)."
},
"name": {
"type": "string"
},
"connectionStringName": {
"type": "string",
"description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options."
},
"connectionString": {
"type": "string",
"description": "Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one."
}
},
"required": [
"databaseType"
]
},
"DatabaseConnection": {
"type": "object",
"description": "Static Site Database Connection resource.",
"properties": {
"properties": {
"$ref": "#/definitions/DatabaseConnectionProperties",
"description": "DatabaseConnection resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DatabaseConnectionCollection": {
"type": "object",
"description": "Collection of static site database connections.",
"properties": {
"value": {
"type": "array",
"description": "The DatabaseConnection items on this page",
"items": {
"$ref": "#/definitions/DatabaseConnection"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DatabaseConnectionOverview": {
"type": "object",
"description": "Static Site Database Connection overview.",
"properties": {
"resourceId": {
"type": "string",
"description": "The resource id of the database.",
"readOnly": true
},
"connectionIdentity": {
"type": "string",
"description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource.",
"readOnly": true
},
"region": {
"type": "string",
"description": "The region of the database resource.",
"readOnly": true
},
"configurationFiles": {
"type": "array",
"description": "A list of configuration files associated with this database connection.",
"items": {
"$ref": "#/definitions/StaticSiteDatabaseConnectionConfigurationFileOverview"
},
"readOnly": true,
"x-ms-identifiers": [
"fileName"
]
},
"name": {
"type": "string",
"description": "If present, the name of this database connection resource.",
"readOnly": true
}
}
},
"DatabaseConnectionPatchRequest": {
"type": "object",
"description": "Static Site Database Connection Request Properties resource when patching",
"properties": {
"properties": {
"$ref": "#/definitions/DatabaseConnectionPatchRequestProperties",
"description": "DatabaseConnectionPatchRequest resource specific properties",
"x-ms-client-flatten": true
}
}
},
"DatabaseConnectionPatchRequestProperties": {
"type": "object",
"description": "DatabaseConnectionPatchRequest resource specific properties",
"properties": {
"resourceId": {
"type": "string",
"description": "The resource id of the database."
},
"connectionIdentity": {
"type": "string",
"description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource."
},
"connectionString": {
"type": "string",
"description": "The connection string to use to connect to the database."
},
"region": {
"type": "string",
"description": "The region of the database resource."
}
}
},
"DatabaseConnectionProperties": {
"type": "object",
"description": "DatabaseConnection resource specific properties",
"properties": {
"resourceId": {
"type": "string",
"description": "The resource id of the database."
},
"connectionIdentity": {
"type": "string",
"description": "If present, the identity is used in conjunction with connection string to connect to the database. Use of the system-assigned managed identity is indicated with the string 'SystemAssigned', while use of a user-assigned managed identity is indicated with the resource id of the managed identity resource."
},
"connectionString": {
"type": "string",
"description": "The connection string to use to connect to the database."
},
"region": {
"type": "string",
"description": "The region of the database resource."
},
"configurationFiles": {
"type": "array",
"description": "A list of configuration files associated with this database connection.",
"items": {
"$ref": "#/definitions/StaticSiteDatabaseConnectionConfigurationFileOverview"
},
"readOnly": true,
"x-ms-identifiers": [
"fileName"
]
}
},
"required": [
"resourceId",
"region"
]
},
"DatabaseType": {
"type": "string",
"description": "Database type (e.g. SqlAzure / MySql).",
"enum": [
"SqlAzure",
"MySql",
"LocalMySql",
"PostgreSql"
],
"x-ms-enum": {
"name": "DatabaseType",
"modelAsString": true,
"values": [
{
"name": "SqlAzure",
"value": "SqlAzure"
},
{
"name": "MySql",
"value": "MySql"
},
{
"name": "LocalMySql",
"value": "LocalMySql"
},
{
"name": "PostgreSql",
"value": "PostgreSql"
}
]
}
},
"DayOfWeek": {
"type": "string",
"description": "The day of the week.",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"x-ms-enum": {
"name": "DayOfWeek",
"modelAsString": false
}
},
"DaysOfWeek": {
"type": "string",
"enum": [
"Sunday",
"Monday",
"Tuesday",
"Wednesday",
"Thursday",
"Friday",
"Saturday"
],
"x-ms-enum": {
"name": "DaysOfWeek",
"modelAsString": false
}
},
"DefaultAction": {
"type": "string",
"description": "Default action for main access restriction if no rules are matched.",
"enum": [
"Allow",
"Deny"
],
"x-ms-enum": {
"name": "DefaultAction",
"modelAsString": true,
"values": [
{
"name": "Allow",
"value": "Allow"
},
{
"name": "Deny",
"value": "Deny"
}
]
}
},
"DefaultAuthorizationPolicy": {
"type": "object",
"description": "The configuration settings of the Azure Active Directory default authorization policy.",
"properties": {
"allowedPrincipals": {
"$ref": "#/definitions/AllowedPrincipals",
"description": "The configuration settings of the Azure Active Directory allowed principals."
},
"allowedApplications": {
"type": "array",
"description": "The configuration settings of the Azure Active Directory allowed applications.",
"items": {
"type": "string"
}
}
}
},
"DefaultErrorResponse": {
"type": "object",
"description": "App Service error response.",
"properties": {
"error": {
"$ref": "#/definitions/DefaultErrorResponseError",
"description": "Error model.",
"readOnly": true
}
}
},
"DefaultErrorResponseError": {
"type": "object",
"description": "Error model.",
"properties": {
"code": {
"type": "string",
"description": "Standardized string to programmatically identify the error.",
"readOnly": true
},
"message": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"target": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"details": {
"type": "array",
"items": {
"$ref": "#/definitions/DefaultErrorResponseErrorDetailsItem"
},
"x-ms-identifiers": []
},
"innererror": {
"type": "string",
"description": "More information to debug error.",
"readOnly": true
}
}
},
"DefaultErrorResponseErrorDetailsItem": {
"type": "object",
"description": "Detailed errors.",
"properties": {
"code": {
"type": "string",
"description": "Standardized string to programmatically identify the error.",
"readOnly": true
},
"message": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
},
"target": {
"type": "string",
"description": "Detailed error description and debugging information.",
"readOnly": true
}
}
},
"DefaultIdentity": {
"type": "object",
"properties": {
"identityType": {
"$ref": "#/definitions/ManagedServiceIdentityType"
},
"userAssignedIdentityResourceId": {
"type": "string"
}
}
},
"DeletedAppRestoreRequest": {
"type": "object",
"description": "Details about restoring a deleted app.",
"properties": {
"properties": {
"$ref": "#/definitions/DeletedAppRestoreRequestProperties",
"description": "DeletedAppRestoreRequest resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"DeletedAppRestoreRequestProperties": {
"type": "object",
"description": "DeletedAppRestoreRequest resource specific properties",
"properties": {
"deletedSiteId": {
"type": "string",
"description": "ARM resource ID of the deleted app. Example:\n/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}"
},
"recoverConfiguration": {
"type": "boolean",
"description": "If true, deleted site configuration, in addition to content, will be restored."
},
"snapshotTime": {
"type": "string",
"description": "Point in time to restore the deleted app from, formatted as a DateTime string.\nIf unspecified, default value is the time that the app was deleted."
},
"useDRSecondary": {
"type": "boolean",
"description": "If true, the snapshot is retrieved from DRSecondary endpoint."
}
}
},
"DeletedSite": {
"type": "object",
"description": "A deleted app.",
"properties": {
"properties": {
"$ref": "#/definitions/DeletedSiteProperties",
"description": "DeletedSite resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DeletedSiteProperties": {
"type": "object",
"description": "DeletedSite resource specific properties",
"properties": {
"deletedSiteId": {
"type": "integer",
"format": "int32",
"description": "Numeric id for the deleted site",
"readOnly": true
},
"deletedTimestamp": {
"type": "string",
"description": "Time in UTC when the app was deleted.",
"readOnly": true
},
"subscription": {
"type": "string",
"description": "Subscription containing the deleted site",
"readOnly": true
},
"resourceGroup": {
"type": "string",
"description": "ResourceGroup that contained the deleted site",
"readOnly": true
},
"deletedSiteName": {
"type": "string",
"description": "Name of the deleted site",
"readOnly": true
},
"slot": {
"type": "string",
"description": "Slot of the deleted site",
"readOnly": true
},
"kind": {
"type": "string",
"description": "Kind of site that was deleted",
"readOnly": true
},
"geoRegionName": {
"type": "string",
"description": "Geo Region of the deleted site",
"readOnly": true
}
}
},
"DeletedWebAppCollection": {
"type": "object",
"description": "Collection of deleted apps.",
"properties": {
"value": {
"type": "array",
"description": "The DeletedSite items on this page",
"items": {
"$ref": "#/definitions/DeletedSite"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"Deployment": {
"type": "object",
"description": "User credentials used for publishing activity.",
"properties": {
"properties": {
"$ref": "#/definitions/DeploymentProperties",
"description": "Deployment resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DeploymentBuildStatus": {
"type": "string",
"description": "Deployment build status.",
"enum": [
"TimedOut",
"RuntimeFailed",
"BuildAborted",
"BuildFailed",
"BuildRequestReceived",
"BuildPending",
"BuildInProgress",
"BuildSuccessful",
"PostBuildRestartRequired",
"StartPolling",
"StartPollingWithRestart",
"RuntimeStarting",
"RuntimeSuccessful"
],
"x-ms-enum": {
"name": "DeploymentBuildStatus",
"modelAsString": true,
"values": [
{
"name": "TimedOut",
"value": "TimedOut"
},
{
"name": "RuntimeFailed",
"value": "RuntimeFailed"
},
{
"name": "BuildAborted",
"value": "BuildAborted"
},
{
"name": "BuildFailed",
"value": "BuildFailed"
},
{
"name": "BuildRequestReceived",
"value": "BuildRequestReceived"
},
{
"name": "BuildPending",
"value": "BuildPending"
},
{
"name": "BuildInProgress",
"value": "BuildInProgress"
},
{
"name": "BuildSuccessful",
"value": "BuildSuccessful"
},
{
"name": "PostBuildRestartRequired",
"value": "PostBuildRestartRequired"
},
{
"name": "StartPolling",
"value": "StartPolling"
},
{
"name": "StartPollingWithRestart",
"value": "StartPollingWithRestart"
},
{
"name": "RuntimeStarting",
"value": "RuntimeStarting"
},
{
"name": "RuntimeSuccessful",
"value": "RuntimeSuccessful"
}
]
}
},
"DeploymentCollection": {
"type": "object",
"description": "Collection of app deployments.",
"properties": {
"value": {
"type": "array",
"description": "The Deployment items on this page",
"items": {
"$ref": "#/definitions/Deployment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DeploymentLocations": {
"type": "object",
"description": "List of available locations (regions or App Service Environments) for\ndeployment of App Service resources.",
"properties": {
"locations": {
"type": "array",
"description": "Available regions.",
"items": {
"$ref": "#/definitions/GeoRegion"
}
},
"hostingEnvironments": {
"type": "array",
"description": "Available App Service Environments with full descriptions of the environments.",
"items": {
"$ref": "#/definitions/AppServiceEnvironment"
},
"x-ms-identifiers": []
},
"hostingEnvironmentDeploymentInfos": {
"type": "array",
"description": "Available App Service Environments with basic information.",
"items": {
"$ref": "#/definitions/HostingEnvironmentDeploymentInfo"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"DeploymentProperties": {
"type": "object",
"description": "Deployment resource specific properties",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "Deployment status."
},
"message": {
"type": "string",
"description": "Details about deployment status."
},
"author": {
"type": "string",
"description": "Who authored the deployment."
},
"deployer": {
"type": "string",
"description": "Who performed the deployment."
},
"author_email": {
"type": "string",
"description": "Author email.",
"x-ms-client-name": "authorEmail"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Start time.",
"x-ms-client-name": "startTime"
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "End time.",
"x-ms-client-name": "endTime"
},
"active": {
"type": "boolean",
"description": "True if deployment is currently active, false if completed and null if not started."
},
"details": {
"type": "string",
"description": "Details on deployment."
}
}
},
"DetectorAbnormalTimePeriod": {
"type": "object",
"description": "Class representing Abnormal Time Period detected.",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the correlated event"
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of the correlated event"
},
"message": {
"type": "string",
"description": "Message describing the event"
},
"source": {
"type": "string",
"description": "Represents the name of the Detector"
},
"priority": {
"type": "number",
"format": "double",
"description": "Represents the rank of the Detector"
},
"metaData": {
"type": "array",
"description": "Downtime metadata",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"x-ms-identifiers": [
"name"
]
},
"type": {
"$ref": "#/definitions/IssueType",
"description": "Represents the type of the Detector"
},
"solutions": {
"type": "array",
"description": "List of proposed solutions",
"items": {
"$ref": "#/definitions/Solution"
}
}
}
},
"DetectorDefinition": {
"type": "object",
"description": "Class representing detector definition",
"properties": {
"displayName": {
"type": "string",
"description": "Display name of the detector",
"readOnly": true
},
"description": {
"type": "string",
"description": "Description of the detector",
"readOnly": true
},
"rank": {
"type": "number",
"format": "double",
"description": "Detector Rank",
"readOnly": true
},
"isEnabled": {
"type": "boolean",
"description": "Flag representing whether detector is enabled or not.",
"readOnly": true
}
}
},
"DetectorDefinitionResource": {
"type": "object",
"description": "ARM resource for a detector definition",
"properties": {
"properties": {
"$ref": "#/definitions/DetectorDefinition",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DetectorInfo": {
"type": "object",
"description": "Definition of Detector",
"properties": {
"id": {
"type": "string",
"description": "Id of detector",
"readOnly": true
},
"name": {
"type": "string",
"description": "Name of detector",
"readOnly": true
},
"description": {
"type": "string",
"description": "Short description of the detector and its purpose.",
"readOnly": true
},
"author": {
"type": "string",
"description": "Author of the detector.",
"readOnly": true
},
"category": {
"type": "string",
"description": "Problem category. This serves for organizing group for detectors.",
"readOnly": true
},
"supportTopicList": {
"type": "array",
"description": "List of Support Topics for which this detector is enabled.",
"items": {
"$ref": "#/definitions/SupportTopic"
},
"readOnly": true
},
"analysisType": {
"type": "array",
"description": "Analysis Types for which this detector should apply to.",
"items": {
"type": "string"
},
"readOnly": true
},
"type": {
"$ref": "#/definitions/DetectorType",
"description": "Whether this detector is an Analysis Detector or not.",
"readOnly": true
},
"score": {
"type": "number",
"format": "float",
"description": "Defines score of a detector to power ML based matching.",
"readOnly": true
}
}
},
"DetectorResponse": {
"type": "object",
"description": "Class representing Response from Detector",
"properties": {
"properties": {
"$ref": "#/definitions/DetectorResponseProperties",
"description": "DetectorResponse resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DetectorResponseCollection": {
"type": "object",
"description": "Collection of detector responses",
"properties": {
"value": {
"type": "array",
"description": "The DetectorResponse items on this page",
"items": {
"$ref": "#/definitions/DetectorResponse"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DetectorResponseProperties": {
"type": "object",
"description": "DetectorResponse resource specific properties",
"properties": {
"metadata": {
"$ref": "#/definitions/DetectorInfo",
"description": "metadata for the detector"
},
"dataset": {
"type": "array",
"description": "Data Set",
"items": {
"$ref": "#/definitions/DiagnosticData"
},
"x-ms-identifiers": []
},
"status": {
"$ref": "#/definitions/Status",
"description": "Indicates status of the most severe insight."
},
"dataProvidersMetadata": {
"type": "array",
"description": "Additional configuration for different data providers to be used by the UI",
"items": {
"$ref": "#/definitions/DataProviderMetadata"
},
"x-ms-identifiers": [
"providerName"
]
},
"suggestedUtterances": {
"$ref": "#/definitions/QueryUtterancesResults",
"description": "Suggested utterances where the detector can be applicable."
}
}
},
"DetectorType": {
"type": "string",
"description": "Whether this detector is an Analysis Detector or not.",
"enum": [
"Detector",
"Analysis",
"CategoryOverview"
],
"x-ms-enum": {
"name": "DetectorType",
"modelAsString": false
}
},
"DiagnosticAnalysis": {
"type": "object",
"description": "Class representing a diagnostic analysis done on an application",
"properties": {
"properties": {
"$ref": "#/definitions/DiagnosticAnalysisProperties",
"description": "DiagnosticAnalysis resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"DiagnosticAnalysisCollection": {
"type": "object",
"description": "Collection of Diagnostic Analyses",
"properties": {
"value": {
"type": "array",
"description": "The AnalysisDefinition items on this page",
"items": {
"$ref": "#/definitions/AnalysisDefinition"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DiagnosticAnalysisProperties": {
"type": "object",
"description": "DiagnosticAnalysis resource specific properties",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the period"
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of the period"
},
"abnormalTimePeriods": {
"type": "array",
"description": "List of time periods.",
"items": {
"$ref": "#/definitions/AbnormalTimePeriod"
},
"x-ms-identifiers": []
},
"payload": {
"type": "array",
"description": "Data by each detector",
"items": {
"$ref": "#/definitions/AnalysisData"
},
"x-ms-identifiers": [
"source"
]
},
"nonCorrelatedDetectors": {
"type": "array",
"description": "Data by each detector for detectors that did not corelate",
"items": {
"$ref": "#/definitions/DetectorDefinition"
},
"x-ms-identifiers": [
"displayName"
]
}
}
},
"DiagnosticCategory": {
"type": "object",
"description": "Class representing detector definition",
"properties": {
"properties": {
"$ref": "#/definitions/DiagnosticCategoryProperties",
"description": "DiagnosticCategory resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"DiagnosticCategoryCollection": {
"type": "object",
"description": "Collection of Diagnostic Categories",
"properties": {
"value": {
"type": "array",
"description": "The DiagnosticCategory items on this page",
"items": {
"$ref": "#/definitions/DiagnosticCategory"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DiagnosticCategoryProperties": {
"type": "object",
"description": "DiagnosticCategory resource specific properties",
"properties": {
"description": {
"type": "string",
"description": "Description of the diagnostic category",
"readOnly": true
}
}
},
"DiagnosticData": {
"type": "object",
"description": "Set of data with rendering instructions",
"properties": {
"table": {
"$ref": "#/definitions/DataTableResponseObject",
"description": "Data in table form"
},
"renderingProperties": {
"$ref": "#/definitions/Rendering",
"description": "Properties that describe how the table should be rendered"
}
}
},
"DiagnosticDetectorCollection": {
"type": "object",
"description": "Collection of Diagnostic Detectors",
"properties": {
"value": {
"type": "array",
"description": "The DetectorDefinitionResource items on this page",
"items": {
"$ref": "#/definitions/DetectorDefinitionResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"DiagnosticDetectorResponse": {
"type": "object",
"description": "Class representing Response from Diagnostic Detectors",
"properties": {
"properties": {
"$ref": "#/definitions/DiagnosticDetectorResponseProperties",
"description": "DiagnosticDetectorResponse resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"DiagnosticDetectorResponseProperties": {
"type": "object",
"description": "DiagnosticDetectorResponse resource specific properties",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the period"
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of the period"
},
"issueDetected": {
"type": "boolean",
"description": "Flag representing Issue was detected."
},
"detectorDefinition": {
"$ref": "#/definitions/DetectorDefinition",
"description": "Detector's definition"
},
"metrics": {
"type": "array",
"description": "Metrics provided by the detector",
"items": {
"$ref": "#/definitions/DiagnosticMetricSet"
},
"x-ms-identifiers": [
"name"
]
},
"abnormalTimePeriods": {
"type": "array",
"description": "List of Correlated events found by the detector",
"items": {
"$ref": "#/definitions/DetectorAbnormalTimePeriod"
},
"x-ms-identifiers": []
},
"data": {
"type": "array",
"description": "Additional Data that detector wants to send.",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"x-ms-identifiers": [
"name"
]
},
"responseMetaData": {
"$ref": "#/definitions/ResponseMetaData",
"description": "Meta Data"
}
}
},
"DiagnosticMetricSample": {
"type": "object",
"description": "Class representing Diagnostic Metric",
"properties": {
"timestamp": {
"type": "string",
"format": "date-time",
"description": "Time at which metric is measured"
},
"roleInstance": {
"type": "string",
"description": "Role Instance. Null if this counter is not per instance\nThis is returned and should be whichever instance name we desire to be returned\ni.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0)\nwhere RDWORKERNAME is Machine name below and RoleInstance name in parenthesis"
},
"total": {
"type": "number",
"format": "double",
"description": "Total value of the metric. If multiple measurements are made this will have sum of all."
},
"maximum": {
"type": "number",
"format": "double",
"description": "Maximum of the metric sampled during the time period"
},
"minimum": {
"type": "number",
"format": "double",
"description": "Minimum of the metric sampled during the time period"
},
"isAggregated": {
"type": "boolean",
"description": "Whether the values are aggregates across all workers or not"
}
}
},
"DiagnosticMetricSet": {
"type": "object",
"description": "Class representing Diagnostic Metric information",
"properties": {
"name": {
"type": "string",
"description": "Name of the metric"
},
"unit": {
"type": "string",
"description": "Metric's unit"
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the period"
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of the period"
},
"timeGrain": {
"type": "string",
"description": "Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D"
},
"values": {
"type": "array",
"description": "Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}",
"items": {
"$ref": "#/definitions/DiagnosticMetricSample"
},
"x-ms-identifiers": []
}
}
},
"Dimension": {
"type": "object",
"description": "Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app,\nwhere instance name is dimension of the metric HTTP request",
"properties": {
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"internalName": {
"type": "string"
},
"toBeExportedForShoebox": {
"type": "boolean"
}
}
},
"DnlResourceNameAvailability": {
"type": "object",
"description": "Information regarding availability of a resource name for DNL apps with regionalized default hostnames.",
"properties": {
"hostName": {
"type": "string"
},
"nameAvailable": {
"type": "boolean",
"description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both."
},
"reason": {
"$ref": "#/definitions/InAvailabilityReasonType",
"description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable."
},
"message": {
"type": "string",
"description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name."
}
}
},
"DnlResourceNameAvailabilityRequest": {
"type": "object",
"properties": {
"resourceGroupName": {
"type": "string",
"description": "Resource group name"
},
"autoGeneratedDomainNameLabelScope": {
"type": "string",
"description": "Indicates the endpoint name reuse scope.The default value is TenantReuse.\nSupported values are TenantReuse, SubscriptionReuse, ResourceGroupReuse, NoReuse"
},
"name": {
"type": "string",
"description": "Resource name to verify."
},
"type": {
"$ref": "#/definitions/CheckNameResourceTypes",
"description": "Resource type used for verification."
}
},
"required": [
"name",
"type"
]
},
"DnsVerificationTestResult": {
"type": "string",
"description": "DNS verification test result.",
"enum": [
"Passed",
"Failed",
"Skipped"
],
"x-ms-enum": {
"name": "DnsVerificationTestResult",
"modelAsString": false
}
},
"EnabledConfig": {
"type": "object",
"description": "Enabled configuration.",
"properties": {
"enabled": {
"type": "boolean",
"description": "True if configuration is enabled, false if it is disabled and null if configuration is not set."
}
}
},
"EndpointDependency": {
"type": "object",
"description": "A domain name that a service is reached at, including details of the current connection status.",
"properties": {
"domainName": {
"type": "string",
"description": "The domain name of the dependency."
},
"endpointDetails": {
"type": "array",
"description": "The IP Addresses and Ports used when connecting to DomainName.",
"items": {
"$ref": "#/definitions/EndpointDetail"
},
"x-ms-identifiers": [
"ipAddress",
"port"
]
}
}
},
"EndpointDetail": {
"type": "object",
"description": "Current TCP connectivity information from the App Service Environment to a single endpoint.",
"properties": {
"ipAddress": {
"type": "string",
"description": "An IP Address that Domain Name currently resolves to."
},
"port": {
"type": "integer",
"format": "int32",
"description": "The port an endpoint is connected to."
},
"latency": {
"type": "number",
"format": "double",
"description": "The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port."
},
"isAccessible": {
"type": "boolean",
"description": "Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port."
}
}
},
"EnterpriseGradeCdnStatus": {
"type": "string",
"description": "State indicating the status of the enterprise grade CDN serving traffic to the static web app.",
"enum": [
"Enabled",
"Enabling",
"Disabled",
"Disabling"
],
"x-ms-enum": {
"name": "EnterpriseGradeCdnStatus",
"modelAsString": true,
"values": [
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Enabling",
"value": "Enabling"
},
{
"name": "Disabled",
"value": "Disabled"
},
{
"name": "Disabling",
"value": "Disabling"
}
]
}
},
"EnvironmentVariable": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Environment variable name"
},
"value": {
"type": "string",
"description": "The value of this environment variable must be the name of an AppSetting. The actual value of the environment variable in container will be retrieved from the specified AppSetting at runtime. If the AppSetting is not found, the value will be set to an empty string in the container at runtime."
}
},
"required": [
"name",
"value"
]
},
"ErrorEntity": {
"type": "object",
"description": "Body of the error response returned from the API.",
"properties": {
"extendedCode": {
"type": "string",
"description": "Type of error."
},
"messageTemplate": {
"type": "string",
"description": "Message template."
},
"parameters": {
"type": "array",
"description": "Parameters for the template.",
"items": {
"type": "string"
}
},
"innerErrors": {
"type": "array",
"description": "Inner errors.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"x-ms-identifiers": []
},
"details": {
"type": "array",
"description": "Error Details.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"x-ms-identifiers": []
},
"target": {
"type": "string",
"description": "The error target."
},
"code": {
"type": "string",
"description": "Basic error code."
},
"message": {
"type": "string",
"description": "Any details of the error."
}
}
},
"ErrorInfo": {
"type": "object",
"description": "The error info.",
"properties": {
"code": {
"type": "string",
"description": "The error code."
}
},
"required": [
"code"
]
},
"ErrorProperties": {
"type": "object",
"description": "Error properties indicate why the Logic service was not able to process the incoming request. The reason is provided in the error message.",
"properties": {
"code": {
"type": "string",
"description": "Error code."
},
"message": {
"type": "string",
"description": "Error message indicating why the operation failed."
}
}
},
"ErrorResponse": {
"type": "object",
"description": "Error response indicates Logic service is not able to process the incoming request. The error property contains the error details.",
"properties": {
"error": {
"$ref": "#/definitions/ErrorProperties",
"description": "The error properties."
}
}
},
"Experiments": {
"type": "object",
"description": "Routing rules in production experiments.",
"properties": {
"rampUpRules": {
"type": "array",
"description": "List of ramp-up rules.",
"items": {
"$ref": "#/definitions/RampUpRule"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"Expression": {
"type": "object",
"description": "The expression.",
"properties": {
"text": {
"type": "string",
"description": "The text."
},
"value": {
"description": "Anything"
},
"subexpressions": {
"type": "array",
"description": "The sub expressions.",
"items": {
"$ref": "#/definitions/Expression"
},
"x-ms-identifiers": []
},
"error": {
"$ref": "#/definitions/AzureResourceErrorInfo",
"description": "The azure resource error info."
}
}
},
"ExpressionRoot": {
"type": "object",
"description": "The expression root.",
"properties": {
"path": {
"type": "string",
"description": "The path."
}
},
"allOf": [
{
"$ref": "#/definitions/Expression"
}
]
},
"ExpressionTraces": {
"type": "object",
"description": "The expression traces.",
"properties": {
"value": {},
"inputs": {
"type": "array",
"items": {
"$ref": "#/definitions/ExpressionRoot"
},
"x-ms-identifiers": [
"path"
]
},
"nextLink": {
"type": "string",
"description": "The link used to get the next page of recommendations."
}
}
},
"ExtendedLocation": {
"type": "object",
"description": "Extended Location.",
"properties": {
"name": {
"type": "string",
"description": "Name of extended location."
},
"type": {
"type": "string",
"description": "Type of extended location.",
"readOnly": true
}
}
},
"Facebook": {
"type": "object",
"description": "The configuration settings of the Facebook provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Facebook provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/AppRegistration",
"description": "The configuration settings of the app registration for the Facebook provider."
},
"graphApiVersion": {
"type": "string",
"description": "The version of the Facebook api to be used while logging in."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
}
}
},
"FileSystemApplicationLogsConfig": {
"type": "object",
"description": "Application logs to file system configuration.",
"properties": {
"level": {
"type": "string",
"description": "Log level.",
"default": "Off",
"enum": [
"Off",
"Verbose",
"Information",
"Warning",
"Error"
],
"x-ms-enum": {
"name": "LogLevel",
"modelAsString": false
}
}
}
},
"FileSystemHttpLogsConfig": {
"type": "object",
"description": "Http logs to file system configuration.",
"properties": {
"retentionInMb": {
"type": "integer",
"format": "int32",
"description": "Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100.",
"minimum": 25,
"maximum": 100
},
"retentionInDays": {
"type": "integer",
"format": "int32",
"description": "Retention in days.\nRemove files older than X days.\n0 or lower means no retention."
},
"enabled": {
"type": "boolean",
"description": "True if configuration is enabled, false if it is disabled and null if configuration is not set."
}
}
},
"FileSystemTokenStore": {
"type": "object",
"description": "The configuration settings of the storage of the tokens if a file system is used.",
"properties": {
"directory": {
"type": "string",
"description": "The directory in which the tokens will be stored."
}
}
},
"FlowAccessControlConfiguration": {
"type": "object",
"description": "The access control configuration.",
"properties": {
"triggers": {
"$ref": "#/definitions/FlowAccessControlConfigurationPolicy",
"description": "The access control configuration for invoking workflow triggers."
},
"contents": {
"$ref": "#/definitions/FlowAccessControlConfigurationPolicy",
"description": "The access control configuration for accessing workflow run contents."
},
"actions": {
"$ref": "#/definitions/FlowAccessControlConfigurationPolicy",
"description": "The access control configuration for workflow actions."
},
"workflowManagement": {
"$ref": "#/definitions/FlowAccessControlConfigurationPolicy",
"description": "The access control configuration for workflow management."
}
}
},
"FlowAccessControlConfigurationPolicy": {
"type": "object",
"description": "The access control configuration policy.",
"properties": {
"allowedCallerIpAddresses": {
"type": "array",
"description": "The allowed caller IP address ranges.",
"items": {
"$ref": "#/definitions/IpAddressRange"
},
"x-ms-identifiers": []
},
"openAuthenticationPolicies": {
"$ref": "#/definitions/OpenAuthenticationAccessPolicies",
"description": "The authentication policies for workflow."
}
}
},
"FlowEndpoints": {
"type": "object",
"description": "The flow endpoints configuration.",
"properties": {
"outgoingIpAddresses": {
"type": "array",
"description": "The outgoing ip address.",
"items": {
"$ref": "#/definitions/IpAddress"
},
"x-ms-identifiers": [
"address"
]
},
"accessEndpointIpAddresses": {
"type": "array",
"description": "The access endpoint ip address.",
"items": {
"$ref": "#/definitions/IpAddress"
},
"x-ms-identifiers": [
"address"
]
}
}
},
"FlowEndpointsConfiguration": {
"type": "object",
"description": "The endpoints configuration.",
"properties": {
"workflow": {
"$ref": "#/definitions/FlowEndpoints",
"description": "The workflow endpoints."
},
"connector": {
"$ref": "#/definitions/FlowEndpoints",
"description": "The connector endpoints."
}
}
},
"ForwardProxy": {
"type": "object",
"description": "The configuration settings of a forward proxy used to make the requests.",
"properties": {
"convention": {
"$ref": "#/definitions/ForwardProxyConvention",
"description": "The convention used to determine the url of the request made."
},
"customHostHeaderName": {
"type": "string",
"description": "The name of the header containing the host of the request."
},
"customProtoHeaderName": {
"type": "string",
"description": "The name of the header containing the scheme of the request."
}
}
},
"ForwardProxyConvention": {
"type": "string",
"description": "The convention used to determine the url of the request made.",
"enum": [
"NoProxy",
"Standard",
"Custom"
],
"x-ms-enum": {
"name": "ForwardProxyConvention",
"modelAsString": false
}
},
"FrontEndConfiguration": {
"type": "object",
"properties": {
"kind": {
"$ref": "#/definitions/FrontEndServiceType"
}
}
},
"FrontEndServiceType": {
"type": "string",
"enum": [
"NodePort",
"LoadBalancer"
],
"x-ms-enum": {
"name": "FrontEndServiceType",
"modelAsString": false
}
},
"FtpsState": {
"type": "string",
"description": "State of FTP / FTPS service",
"enum": [
"AllAllowed",
"FtpsOnly",
"Disabled"
],
"x-ms-enum": {
"name": "FtpsState",
"modelAsString": true,
"values": [
{
"name": "AllAllowed",
"value": "AllAllowed"
},
{
"name": "FtpsOnly",
"value": "FtpsOnly"
},
{
"name": "Disabled",
"value": "Disabled"
}
]
}
},
"FunctionAppConfig": {
"type": "object",
"description": "Function app configuration.",
"properties": {
"deployment": {
"$ref": "#/definitions/FunctionsDeployment",
"description": "Function app deployment configuration."
},
"runtime": {
"$ref": "#/definitions/FunctionsRuntime",
"description": "Function app runtime settings."
},
"scaleAndConcurrency": {
"$ref": "#/definitions/FunctionsScaleAndConcurrency",
"description": "Function app scale and concurrency settings."
},
"siteUpdateStrategy": {
"$ref": "#/definitions/FunctionsSiteUpdateStrategy",
"description": "Function app site update strategy configuration."
}
}
},
"FunctionAppMajorVersion": {
"type": "object",
"description": "Function App stack major version.",
"properties": {
"displayText": {
"type": "string",
"description": "Function App stack major version (display only).",
"readOnly": true
},
"value": {
"type": "string",
"description": "Function App stack major version name.",
"readOnly": true
},
"minorVersions": {
"type": "array",
"description": "Minor versions associated with the major version.",
"items": {
"$ref": "#/definitions/FunctionAppMinorVersion"
},
"readOnly": true,
"x-ms-identifiers": [
"value"
]
}
}
},
"FunctionAppMinorVersion": {
"type": "object",
"description": "Function App stack minor version.",
"properties": {
"displayText": {
"type": "string",
"description": "Function App stack (display only).",
"readOnly": true
},
"value": {
"type": "string",
"description": "Function App stack name.",
"readOnly": true
},
"stackSettings": {
"$ref": "#/definitions/FunctionAppRuntimes",
"description": "Settings associated with the minor version.",
"readOnly": true
}
}
},
"FunctionAppRuntimeSettings": {
"type": "object",
"description": "Function App runtime settings.",
"properties": {
"runtimeVersion": {
"type": "string",
"description": "Function App stack minor version (runtime only).",
"readOnly": true
},
"remoteDebuggingSupported": {
"type": "boolean",
"description": "true if remote debugging is supported for the stack; otherwise, false.",
"readOnly": true
},
"appInsightsSettings": {
"$ref": "#/definitions/AppInsightsWebAppStackSettings",
"description": "Application Insights settings associated with the minor version.",
"readOnly": true
},
"gitHubActionSettings": {
"$ref": "#/definitions/GitHubActionWebAppStackSettings",
"description": "GitHub Actions settings associated with the minor version.",
"readOnly": true
},
"appSettingsDictionary": {
"type": "object",
"description": "Application settings associated with the minor version.",
"additionalProperties": {
"type": "string"
},
"readOnly": true
},
"siteConfigPropertiesDictionary": {
"$ref": "#/definitions/SiteConfigPropertiesDictionary",
"description": "Configuration settings associated with the minor version.",
"readOnly": true
},
"supportedFunctionsExtensionVersions": {
"type": "array",
"description": "List of supported Functions extension versions.",
"items": {
"type": "string"
},
"readOnly": true
},
"isPreview": {
"type": "boolean",
"description": "true if the stack is in preview; otherwise, false.",
"readOnly": true
},
"isDeprecated": {
"type": "boolean",
"description": "true if the stack is deprecated; otherwise, false.",
"readOnly": true
},
"isHidden": {
"type": "boolean",
"description": "true if the stack should be hidden; otherwise, false.",
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"format": "date-time",
"description": "End-of-life date for the minor version.",
"readOnly": true
},
"isAutoUpdate": {
"type": "boolean",
"description": "true if the stack version is auto-updated; otherwise, false.",
"readOnly": true
},
"isEarlyAccess": {
"type": "boolean",
"description": "true if the minor version is early-access; otherwise, false.",
"readOnly": true
},
"isDefault": {
"type": "boolean",
"description": "true if the minor version the default; otherwise, false.",
"readOnly": true
}
}
},
"FunctionAppRuntimes": {
"type": "object",
"description": "Function App stack runtimes.",
"properties": {
"linuxRuntimeSettings": {
"$ref": "#/definitions/FunctionAppRuntimeSettings",
"description": "Linux-specific settings associated with the minor version.",
"readOnly": true
},
"windowsRuntimeSettings": {
"$ref": "#/definitions/FunctionAppRuntimeSettings",
"description": "Windows-specific settings associated with the minor version.",
"readOnly": true
}
}
},
"FunctionAppStack": {
"type": "object",
"description": "Function App Stack.",
"properties": {
"location": {
"type": "string",
"description": "Function App stack location.",
"readOnly": true
},
"properties": {
"$ref": "#/definitions/FunctionAppStackProperties",
"description": "FunctionAppStack resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"FunctionAppStackCollection": {
"type": "object",
"description": "Collection of Function app Stacks",
"properties": {
"value": {
"type": "array",
"description": "The FunctionAppStack items on this page",
"items": {
"$ref": "#/definitions/FunctionAppStack"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FunctionAppStackProperties": {
"type": "object",
"description": "FunctionAppStack resource specific properties",
"properties": {
"displayText": {
"type": "string",
"description": "Function App stack (display only).",
"readOnly": true
},
"value": {
"type": "string",
"description": "Function App stack name.",
"readOnly": true
},
"majorVersions": {
"type": "array",
"description": "List of major versions available.",
"items": {
"$ref": "#/definitions/FunctionAppMajorVersion"
},
"readOnly": true,
"x-ms-identifiers": [
"value"
]
},
"preferredOs": {
"$ref": "#/definitions/StackPreferredOs",
"description": "Function App stack preferred OS.",
"readOnly": true
}
}
},
"FunctionEnvelope": {
"type": "object",
"description": "Function information.",
"properties": {
"properties": {
"$ref": "#/definitions/FunctionEnvelopeProperties",
"description": "FunctionEnvelope resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"FunctionEnvelopeCollection": {
"type": "object",
"description": "Collection of Kudu function information elements.",
"properties": {
"value": {
"type": "array",
"description": "The FunctionEnvelope items on this page",
"items": {
"$ref": "#/definitions/FunctionEnvelope"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"FunctionEnvelopeProperties": {
"type": "object",
"description": "FunctionEnvelope resource specific properties",
"properties": {
"function_app_id": {
"type": "string",
"description": "Function App ID.",
"x-ms-client-name": "functionAppId"
},
"script_root_path_href": {
"type": "string",
"description": "Script root path URI.",
"x-ms-client-name": "scriptRootPathHref"
},
"script_href": {
"type": "string",
"description": "Script URI.",
"x-ms-client-name": "scriptHref"
},
"config_href": {
"type": "string",
"description": "Config URI.",
"x-ms-client-name": "configHref"
},
"test_data_href": {
"type": "string",
"description": "Test data URI.",
"x-ms-client-name": "testDataHref"
},
"secrets_file_href": {
"type": "string",
"description": "Secrets file URI.",
"x-ms-client-name": "secretsFileHref"
},
"href": {
"type": "string",
"description": "Function URI."
},
"config": {
"description": "Config information."
},
"files": {
"type": "object",
"description": "File list.",
"additionalProperties": {
"type": "string"
}
},
"test_data": {
"type": "string",
"description": "Test data used when testing via the Azure Portal.",
"x-ms-client-name": "testData"
},
"invoke_url_template": {
"type": "string",
"description": "The invocation URL",
"x-ms-client-name": "invokeUrlTemplate"
},
"language": {
"type": "string",
"description": "The function language"
},
"isDisabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the function is disabled"
}
}
},
"FunctionSecrets": {
"type": "object",
"description": "Function secrets.",
"properties": {
"key": {
"type": "string",
"description": "Secret key."
},
"trigger_url": {
"type": "string",
"description": "Trigger URL.",
"x-ms-client-name": "triggerUrl"
}
}
},
"FunctionsAlwaysReadyConfig": {
"type": "object",
"description": "Sets the number of 'Always Ready' instances for a function group or a specific function.",
"properties": {
"name": {
"type": "string",
"description": "Either a function group or a function name is required. For additional information see https://aka.ms/flexconsumption/alwaysready."
},
"instanceCount": {
"type": "integer",
"format": "int32",
"description": "Sets the number of 'Always Ready' instances for a given function group or a specific function. For additional information see https://aka.ms/flexconsumption/alwaysready."
}
}
},
"FunctionsDeployment": {
"type": "object",
"description": "Configuration section for the function app deployment.",
"properties": {
"storage": {
"$ref": "#/definitions/FunctionsDeploymentStorage",
"description": "Storage for deployed package used by the function app."
}
}
},
"FunctionsDeploymentStorage": {
"type": "object",
"description": "Storage for deployed package used by the function app.",
"properties": {
"type": {
"$ref": "#/definitions/FunctionsDeploymentStorageType",
"description": "Property to select Azure Storage type. Available options: blobContainer."
},
"value": {
"type": "string",
"format": "uri",
"description": "Property to set the URL for the selected Azure Storage type. Example: For blobContainer, the value could be https://.blob.core.windows.net/."
},
"authentication": {
"$ref": "#/definitions/FunctionsDeploymentStorageAuthentication",
"description": "Authentication method to access the storage account for deployment."
}
}
},
"FunctionsDeploymentStorageAuthentication": {
"type": "object",
"description": "Authentication method to access the storage account for deployment.",
"properties": {
"type": {
"$ref": "#/definitions/AuthenticationType",
"description": "Property to select authentication type to access the selected storage account. Available options: SystemAssignedIdentity, UserAssignedIdentity, StorageAccountConnectionString."
},
"userAssignedIdentityResourceId": {
"type": "string",
"description": "Use this property for UserAssignedIdentity. Set the resource ID of the identity. Do not set a value for this property when using other authentication type."
},
"storageAccountConnectionStringName": {
"type": "string",
"description": "Use this property for StorageAccountConnectionString. Set the name of the app setting that has the storage account connection string. Do not set a value for this property when using other authentication type."
}
}
},
"FunctionsDeploymentStorageType": {
"type": "string",
"description": "Property to select Azure Storage type. Available options: blobContainer.",
"enum": [
"blobContainer"
],
"x-ms-enum": {
"name": "FunctionsDeploymentStorageType",
"modelAsString": true,
"values": [
{
"name": "blobContainer",
"value": "blobContainer"
}
]
}
},
"FunctionsRuntime": {
"type": "object",
"description": "Function app runtime name and version.",
"properties": {
"name": {
"$ref": "#/definitions/RuntimeName",
"description": "Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom"
},
"version": {
"type": "string",
"description": "Function app runtime version. Example: 8 (for dotnet-isolated)",
"x-nullable": true
}
}
},
"FunctionsScaleAndConcurrency": {
"type": "object",
"description": "Scale and concurrency settings for the function app.",
"properties": {
"alwaysReady": {
"type": "array",
"description": "'Always Ready' configuration for the function app.",
"items": {
"$ref": "#/definitions/FunctionsAlwaysReadyConfig"
}
},
"maximumInstanceCount": {
"type": "integer",
"format": "int32",
"description": "The maximum number of instances for the function app."
},
"instanceMemoryMB": {
"type": "integer",
"format": "int32",
"description": "Set the amount of memory allocated to each instance of the function app in MB. CPU and network bandwidth are allocated proportionally."
},
"triggers": {
"$ref": "#/definitions/FunctionsScaleAndConcurrencyTriggers",
"description": "Scale and concurrency settings for the function app triggers."
}
}
},
"FunctionsScaleAndConcurrencyTriggers": {
"type": "object",
"description": "Scale and concurrency settings for the function app triggers.",
"properties": {
"http": {
"$ref": "#/definitions/FunctionsScaleAndConcurrencyTriggersHttp",
"description": "Scale and concurrency settings for the HTTP trigger."
}
}
},
"FunctionsScaleAndConcurrencyTriggersHttp": {
"type": "object",
"description": "Scale and concurrency settings for the HTTP trigger.",
"properties": {
"perInstanceConcurrency": {
"type": "integer",
"format": "int32",
"description": "The maximum number of concurrent HTTP trigger invocations per instance."
}
}
},
"FunctionsSiteUpdateStrategy": {
"type": "object",
"description": "Function app site update strategy configuration for deployments and site config updates.",
"properties": {
"type": {
"$ref": "#/definitions/SiteUpdateStrategyType",
"description": "Function app site update strategy type. Available options: Recreate, RollingUpdate"
}
}
},
"GeoRegion": {
"type": "object",
"description": "Geographical region.",
"properties": {
"properties": {
"$ref": "#/definitions/GeoRegionProperties",
"description": "GeoRegion resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"GeoRegionCollection": {
"type": "object",
"description": "Collection of geographical regions.",
"properties": {
"value": {
"type": "array",
"description": "The GeoRegion items on this page",
"items": {
"$ref": "#/definitions/GeoRegion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"GeoRegionProperties": {
"type": "object",
"description": "GeoRegion resource specific properties",
"properties": {
"description": {
"type": "string",
"description": "Region description.",
"readOnly": true
},
"displayName": {
"type": "string",
"description": "Display name for region.",
"readOnly": true
},
"orgDomain": {
"type": "string",
"description": "Display name for region.",
"readOnly": true
}
}
},
"GitHub": {
"type": "object",
"description": "The configuration settings of the GitHub provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the GitHub provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/ClientRegistration",
"description": "The configuration settings of the app registration for the GitHub provider."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
}
}
},
"GitHubActionCodeConfiguration": {
"type": "object",
"description": "The GitHub action code configuration.",
"properties": {
"runtimeStack": {
"type": "string",
"description": "Runtime stack is used to determine the workflow file content for code base apps."
},
"runtimeVersion": {
"type": "string",
"description": "Runtime version is used to determine what build version to set in the workflow file."
}
}
},
"GitHubActionConfiguration": {
"type": "object",
"description": "The GitHub action configuration.",
"properties": {
"codeConfiguration": {
"$ref": "#/definitions/GitHubActionCodeConfiguration",
"description": "GitHub Action code configuration."
},
"containerConfiguration": {
"$ref": "#/definitions/GitHubActionContainerConfiguration",
"description": "GitHub Action container configuration."
},
"isLinux": {
"type": "boolean",
"description": "This will help determine the workflow configuration to select."
},
"generateWorkflowFile": {
"type": "boolean",
"description": "Workflow option to determine whether the workflow file should be generated and written to the repository."
}
}
},
"GitHubActionContainerConfiguration": {
"type": "object",
"description": "The GitHub action container configuration.",
"properties": {
"serverUrl": {
"type": "string",
"description": "The server URL for the container registry where the build will be hosted."
},
"imageName": {
"type": "string",
"description": "The image name for the build."
},
"username": {
"type": "string",
"description": "The username used to upload the image to the container registry."
},
"password": {
"type": "string",
"format": "password",
"description": "The password used to upload the image to the container registry.",
"x-ms-secret": true
}
}
},
"GitHubActionWebAppStackSettings": {
"type": "object",
"description": "GitHub Actions Web App stack settings.",
"properties": {
"isSupported": {
"type": "boolean",
"description": "true if GitHub Actions is supported for the stack; otherwise, false.",
"readOnly": true
},
"supportedVersion": {
"type": "string",
"description": "The minor version that is supported for GitHub Actions.",
"readOnly": true
}
}
},
"GlobalCsmSkuDescription": {
"type": "object",
"description": "A Global SKU Description.",
"properties": {
"name": {
"type": "string",
"description": "Name of the resource SKU."
},
"tier": {
"type": "string",
"description": "Service Tier of the resource SKU."
},
"size": {
"type": "string",
"description": "Size specifier of the resource SKU."
},
"family": {
"type": "string",
"description": "Family code of the resource SKU."
},
"capacity": {
"$ref": "#/definitions/SkuCapacity",
"description": "Min, max, and default scale values of the SKU."
},
"locations": {
"type": "array",
"description": "Locations of the SKU.",
"items": {
"type": "string"
}
},
"capabilities": {
"type": "array",
"description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
"items": {
"$ref": "#/definitions/Capability"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"GlobalValidation": {
"type": "object",
"description": "The configuration settings that determines the validation flow of users using App Service Authentication/Authorization.",
"properties": {
"requireAuthentication": {
"type": "boolean",
"description": "true if the authentication flow is required any request is made; otherwise, false."
},
"unauthenticatedClientAction": {
"$ref": "#/definitions/UnauthenticatedClientActionV2",
"description": "The action to take when an unauthenticated client attempts to access the app."
},
"redirectToProvider": {
"type": "string",
"description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."
},
"excludedPaths": {
"type": "array",
"description": "The paths for which unauthenticated flow would not be redirected to the login page.",
"items": {
"type": "string"
}
}
}
},
"Google": {
"type": "object",
"description": "The configuration settings of the Google provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Google provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/ClientRegistration",
"description": "The configuration settings of the app registration for the Google provider."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
},
"validation": {
"$ref": "#/definitions/AllowedAudiencesValidation",
"description": "The configuration settings of the Azure Active Directory token validation flow."
}
}
},
"HandlerMapping": {
"type": "object",
"description": "The IIS handler mappings used to define which handler processes HTTP requests with certain extension.\nFor example, it is used to configure php-cgi.exe process to handle all HTTP requests with *.php extension.",
"properties": {
"extension": {
"type": "string",
"description": "Requests with this extension will be handled using the specified FastCGI application."
},
"scriptProcessor": {
"type": "string",
"description": "The absolute path to the FastCGI application."
},
"arguments": {
"type": "string",
"description": "Command-line arguments to be passed to the script processor."
}
}
},
"HostKeys": {
"type": "object",
"description": "Functions host level keys.",
"properties": {
"masterKey": {
"type": "string",
"description": "Secret key."
},
"functionKeys": {
"type": "object",
"description": "Host level function keys.",
"additionalProperties": {
"type": "string"
}
},
"systemKeys": {
"type": "object",
"description": "System keys.",
"additionalProperties": {
"type": "string"
}
}
}
},
"HostNameBinding": {
"type": "object",
"description": "A hostname binding object.",
"properties": {
"properties": {
"$ref": "#/definitions/HostNameBindingProperties",
"description": "HostNameBinding resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"HostNameBindingCollection": {
"type": "object",
"description": "Collection of hostname bindings.",
"properties": {
"value": {
"type": "array",
"description": "The HostNameBinding items on this page",
"items": {
"$ref": "#/definitions/HostNameBinding"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"HostNameBindingProperties": {
"type": "object",
"description": "HostNameBinding resource specific properties",
"properties": {
"siteName": {
"type": "string",
"description": "App Service app name.",
"x-ms-mutability": [
"read",
"create"
]
},
"domainId": {
"type": "string",
"description": "Fully qualified ARM domain resource URI.",
"x-ms-mutability": [
"read",
"create"
]
},
"azureResourceName": {
"type": "string",
"description": "Azure resource name.",
"x-ms-mutability": [
"read",
"create"
]
},
"azureResourceType": {
"$ref": "#/definitions/AzureResourceType",
"description": "Azure resource type.",
"x-ms-mutability": [
"read",
"create"
]
},
"customHostNameDnsRecordType": {
"$ref": "#/definitions/CustomHostNameDnsRecordType",
"description": "Custom DNS record type.",
"x-ms-mutability": [
"read",
"create"
]
},
"hostNameType": {
"$ref": "#/definitions/HostNameType",
"description": "Hostname type.",
"x-ms-mutability": [
"read",
"create"
]
},
"sslState": {
"$ref": "#/definitions/SslState",
"description": "SSL type",
"x-ms-mutability": [
"read",
"create"
]
},
"thumbprint": {
"type": "string",
"description": "SSL certificate thumbprint",
"x-ms-mutability": [
"read",
"create"
]
},
"virtualIP": {
"type": "string",
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
"readOnly": true
}
}
},
"HostNameSslState": {
"type": "object",
"description": "SSL-enabled hostname.",
"properties": {
"name": {
"type": "string",
"description": "Hostname."
},
"sslState": {
"$ref": "#/definitions/SslState",
"description": "SSL type."
},
"virtualIP": {
"type": "string",
"description": "Virtual IP address assigned to the hostname if IP based SSL is enabled."
},
"thumbprint": {
"type": "string",
"description": "SSL certificate thumbprint."
},
"toUpdate": {
"type": "boolean",
"description": "Set to true to update existing hostname."
},
"hostType": {
"$ref": "#/definitions/HostType",
"description": "Indicates whether the hostname is a standard or repository hostname."
}
}
},
"HostNameType": {
"type": "string",
"description": "Hostname type.",
"enum": [
"Verified",
"Managed"
],
"x-ms-enum": {
"name": "HostNameType",
"modelAsString": false
}
},
"HostType": {
"type": "string",
"description": "Indicates whether the hostname is a standard or repository hostname.",
"enum": [
"Standard",
"Repository"
],
"x-ms-enum": {
"name": "HostType",
"modelAsString": false
}
},
"HostingEnvironmentDeploymentInfo": {
"type": "object",
"description": "Information needed to create resources on an App Service Environment.",
"properties": {
"name": {
"type": "string",
"description": "Name of the App Service Environment."
},
"location": {
"type": "string",
"description": "Location of the App Service Environment."
}
}
},
"HostingEnvironmentDiagnostics": {
"type": "object",
"description": "Diagnostics for an App Service Environment.",
"properties": {
"name": {
"type": "string",
"description": "Name/identifier of the diagnostics."
},
"diagnosticsOutput": {
"type": "string",
"description": "Diagnostics output."
}
}
},
"HostingEnvironmentProfile": {
"type": "object",
"description": "Specification for an App Service Environment to use for this resource.",
"properties": {
"id": {
"type": "string",
"description": "Resource ID of the App Service Environment."
},
"name": {
"type": "string",
"description": "Name of the App Service Environment.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Resource type of the App Service Environment.",
"readOnly": true
}
}
},
"HostingEnvironmentStatus": {
"type": "string",
"description": "Current status of the App Service Environment.",
"enum": [
"Preparing",
"Ready",
"Scaling",
"Deleting"
],
"x-ms-enum": {
"name": "HostingEnvironmentStatus",
"modelAsString": false
}
},
"HttpLogsConfig": {
"type": "object",
"description": "Http logs configuration.",
"properties": {
"fileSystem": {
"$ref": "#/definitions/FileSystemHttpLogsConfig",
"description": "Http logs to file system configuration."
},
"azureBlobStorage": {
"$ref": "#/definitions/AzureBlobStorageHttpLogsConfig",
"description": "Http logs to azure blob storage configuration."
}
}
},
"HttpSettings": {
"type": "object",
"description": "The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization.",
"properties": {
"requireHttps": {
"type": "boolean",
"description": "false if the authentication/authorization responses not having the HTTPS scheme are permissible; otherwise, true."
},
"routes": {
"$ref": "#/definitions/HttpSettingsRoutes",
"description": "The configuration settings of the paths HTTP requests."
},
"forwardProxy": {
"$ref": "#/definitions/ForwardProxy",
"description": "The configuration settings of a forward proxy used to make the requests."
}
}
},
"HttpSettingsRoutes": {
"type": "object",
"description": "The configuration settings of the paths HTTP requests.",
"properties": {
"apiPrefix": {
"type": "string",
"description": "The prefix that should precede all the authentication/authorization paths."
}
}
},
"HybridConnection": {
"type": "object",
"description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
"properties": {
"properties": {
"$ref": "#/definitions/HybridConnectionProperties",
"description": "HybridConnection resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"HybridConnectionCollection": {
"type": "object",
"description": "Collection of hostname bindings.",
"properties": {
"value": {
"type": "array",
"description": "The HybridConnection items on this page",
"items": {
"$ref": "#/definitions/HybridConnection"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"HybridConnectionKey": {
"type": "object",
"description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.",
"properties": {
"properties": {
"$ref": "#/definitions/HybridConnectionKeyProperties",
"description": "HybridConnectionKey resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"HybridConnectionKeyProperties": {
"type": "object",
"description": "HybridConnectionKey resource specific properties",
"properties": {
"sendKeyName": {
"type": "string",
"description": "The name of the send key.",
"readOnly": true
},
"sendKeyValue": {
"type": "string",
"description": "The value of the send key.",
"readOnly": true
}
}
},
"HybridConnectionLimits": {
"type": "object",
"description": "Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.",
"properties": {
"properties": {
"$ref": "#/definitions/HybridConnectionLimitsProperties",
"description": "HybridConnectionLimits resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"HybridConnectionLimitsProperties": {
"type": "object",
"description": "HybridConnectionLimits resource specific properties",
"properties": {
"current": {
"type": "integer",
"format": "int32",
"description": "The current number of Hybrid Connections.",
"readOnly": true
},
"maximum": {
"type": "integer",
"format": "int32",
"description": "The maximum number of Hybrid Connections allowed.",
"readOnly": true
}
}
},
"HybridConnectionProperties": {
"type": "object",
"description": "HybridConnection resource specific properties",
"properties": {
"serviceBusNamespace": {
"type": "string",
"description": "The name of the Service Bus namespace.",
"x-ms-mutability": [
"read",
"create"
]
},
"relayName": {
"type": "string",
"description": "The name of the Service Bus relay.",
"x-ms-mutability": [
"read",
"create"
]
},
"relayArmUri": {
"type": "string",
"description": "The ARM URI to the Service Bus relay."
},
"hostname": {
"type": "string",
"description": "The hostname of the endpoint."
},
"port": {
"type": "integer",
"format": "int32",
"description": "The port of the endpoint."
},
"sendKeyName": {
"type": "string",
"description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus."
},
"sendKeyValue": {
"type": "string",
"description": "The value of the Service Bus key. This is used to authenticate to Service Bus. In ARM this key will not be returned\nnormally, use the POST /listKeys API instead."
},
"serviceBusSuffix": {
"type": "string",
"description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net"
}
}
},
"IPMode": {
"type": "string",
"description": "Specifies the IP mode of the app.",
"enum": [
"IPv4",
"IPv6",
"IPv4AndIPv6"
],
"x-ms-enum": {
"name": "IPMode",
"modelAsString": false
}
},
"Identifier": {
"type": "object",
"description": "A domain specific resource identifier.",
"properties": {
"properties": {
"$ref": "#/definitions/IdentifierProperties",
"description": "Identifier resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"IdentifierCollection": {
"type": "object",
"description": "Collection of identifiers.",
"properties": {
"value": {
"type": "array",
"description": "The Identifier items on this page",
"items": {
"$ref": "#/definitions/Identifier"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"IdentifierProperties": {
"type": "object",
"description": "Identifier resource specific properties",
"properties": {
"id": {
"type": "string",
"description": "String representation of the identity.",
"x-ms-client-name": "value"
}
}
},
"IdentityProviders": {
"type": "object",
"description": "The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization.",
"properties": {
"azureActiveDirectory": {
"$ref": "#/definitions/AzureActiveDirectory",
"description": "The configuration settings of the Azure Active directory provider."
},
"facebook": {
"$ref": "#/definitions/Facebook",
"description": "The configuration settings of the Facebook provider."
},
"gitHub": {
"$ref": "#/definitions/GitHub",
"description": "The configuration settings of the GitHub provider."
},
"google": {
"$ref": "#/definitions/Google",
"description": "The configuration settings of the Google provider."
},
"legacyMicrosoftAccount": {
"$ref": "#/definitions/LegacyMicrosoftAccount",
"description": "The configuration settings of the legacy Microsoft Account provider."
},
"twitter": {
"$ref": "#/definitions/Twitter",
"description": "The configuration settings of the Twitter provider."
},
"apple": {
"$ref": "#/definitions/Apple",
"description": "The configuration settings of the Apple provider."
},
"azureStaticWebApps": {
"$ref": "#/definitions/AzureStaticWebApps",
"description": "The configuration settings of the Azure Static Web Apps provider."
},
"customOpenIdConnectProviders": {
"type": "object",
"description": "The map of the name of the alias of each custom Open ID Connect provider to the\nconfiguration settings of the custom Open ID Connect provider.",
"additionalProperties": {
"$ref": "#/definitions/CustomOpenIdConnectProvider"
}
}
}
},
"InAvailabilityReasonType": {
"type": "string",
"description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.",
"enum": [
"Invalid",
"AlreadyExists"
],
"x-ms-enum": {
"name": "InAvailabilityReasonType",
"modelAsString": true,
"values": [
{
"name": "Invalid",
"value": "Invalid"
},
{
"name": "AlreadyExists",
"value": "AlreadyExists"
}
]
}
},
"InboundEnvironmentEndpoint": {
"type": "object",
"description": "The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.",
"properties": {
"description": {
"type": "string",
"description": "Short text describing the purpose of the network traffic."
},
"endpoints": {
"type": "array",
"description": "The IP addresses that network traffic will originate from in cidr notation.",
"items": {
"type": "string"
}
},
"ports": {
"type": "array",
"description": "The ports that network traffic will arrive to the App Service Environment at.",
"items": {
"type": "string"
}
}
}
},
"InboundEnvironmentEndpointCollection": {
"type": "object",
"description": "Collection of Inbound Environment Endpoints",
"properties": {
"value": {
"type": "array",
"description": "The InboundEnvironmentEndpoint items on this page",
"items": {
"$ref": "#/definitions/InboundEnvironmentEndpoint"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"InsightStatus": {
"type": "string",
"description": "Level of the most severe insight generated by the detector.",
"enum": [
"Critical",
"Warning",
"Info",
"Success",
"None"
],
"x-ms-enum": {
"name": "InsightStatus",
"modelAsString": false
}
},
"InstallScript": {
"type": "object",
"description": "Server farm install script configuration.",
"properties": {
"name": {
"type": "string",
"description": "Name of the install script."
},
"source": {
"$ref": "#/definitions/InstallScriptSource",
"description": "Source of the install script."
}
}
},
"InstallScriptSource": {
"type": "object",
"description": "Object to hold install script reference.",
"properties": {
"sourceUri": {
"type": "string",
"description": "Install script source URI where the install script file will be fetched from."
},
"type": {
"$ref": "#/definitions/InstallScriptType",
"description": "Type of the install script."
}
}
},
"InstallScriptType": {
"type": "string",
"description": "Type of the install script.",
"enum": [
"RemoteAzureBlob",
"PlatformStorage"
],
"x-ms-enum": {
"name": "InstallScriptType",
"modelAsString": true,
"values": [
{
"name": "RemoteAzureBlob",
"value": "RemoteAzureBlob"
},
{
"name": "PlatformStorage",
"value": "PlatformStorage"
}
]
}
},
"IpAddress": {
"type": "object",
"description": "The ip address.",
"properties": {
"address": {
"type": "string",
"description": "The address."
}
}
},
"IpAddressRange": {
"type": "object",
"description": "The ip address range.",
"properties": {
"addressRange": {
"type": "string",
"description": "The IP address range."
}
}
},
"IpFilterTag": {
"type": "string",
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
"enum": [
"Default",
"XffProxy",
"ServiceTag"
],
"x-ms-enum": {
"name": "IpFilterTag",
"modelAsString": true,
"values": [
{
"name": "Default",
"value": "Default"
},
{
"name": "XffProxy",
"value": "XffProxy"
},
{
"name": "ServiceTag",
"value": "ServiceTag"
}
]
}
},
"IpSecurityRestriction": {
"type": "object",
"description": "IP security restriction on an app.",
"properties": {
"ipAddress": {
"type": "string",
"description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified."
},
"subnetMask": {
"type": "string",
"description": "Subnet mask for the range of IP addresses the restriction is valid for."
},
"vnetSubnetResourceId": {
"type": "string",
"description": "Virtual network resource id"
},
"vnetTrafficTag": {
"type": "integer",
"format": "int32",
"description": "(internal) Vnet traffic tag"
},
"subnetTrafficTag": {
"type": "integer",
"format": "int32",
"description": "(internal) Subnet traffic tag"
},
"action": {
"type": "string",
"description": "Allow or Deny access for this IP range."
},
"tag": {
"$ref": "#/definitions/IpFilterTag",
"description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies."
},
"priority": {
"type": "integer",
"format": "int32",
"description": "Priority of IP restriction rule."
},
"name": {
"type": "string",
"description": "IP restriction rule name."
},
"description": {
"type": "string",
"description": "IP restriction rule description."
},
"headers": {
"type": "object",
"description": "IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\nbut not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match.",
"additionalProperties": {
"items": {
"type": "string"
},
"type": "array"
}
}
}
},
"IssueType": {
"type": "string",
"description": "Represents the type of the Detector",
"enum": [
"ServiceIncident",
"AppDeployment",
"AppCrash",
"RuntimeIssueDetected",
"AseDeployment",
"UserIssue",
"PlatformIssue",
"Other"
],
"x-ms-enum": {
"name": "IssueType",
"modelAsString": false
}
},
"JsonSchema": {
"type": "object",
"description": "The JSON schema.",
"properties": {
"title": {
"type": "string",
"description": "The JSON title."
},
"content": {
"type": "string",
"description": "The JSON content."
}
}
},
"JwtClaimChecks": {
"type": "object",
"description": "The configuration settings of the checks that should be made while validating the JWT Claims.",
"properties": {
"allowedGroups": {
"type": "array",
"description": "The list of the allowed groups.",
"items": {
"type": "string"
}
},
"allowedClientApplications": {
"type": "array",
"description": "The list of the allowed client applications.",
"items": {
"type": "string"
}
}
}
},
"KeyInfo": {
"type": "object",
"description": "Function key info.",
"properties": {
"name": {
"type": "string",
"description": "Key name"
},
"value": {
"type": "string",
"description": "Key value"
}
}
},
"KeyType": {
"type": "string",
"description": "The key type.",
"enum": [
"NotSpecified",
"Primary",
"Secondary"
],
"x-ms-enum": {
"name": "KeyType",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Primary",
"value": "Primary"
},
{
"name": "Secondary",
"value": "Secondary"
}
]
}
},
"KeyValuePairStringObject": {
"type": "object",
"properties": {
"key": {
"type": "string",
"readOnly": true
},
"value": {
"description": "Any object",
"readOnly": true
}
}
},
"KeyVaultReferenceWithStatus": {
"type": "object",
"description": "Object to hold key vault reference and the resolution status",
"properties": {
"secretUri": {
"type": "string",
"description": "Key vault secret URI."
},
"referenceStatus": {
"type": "string",
"description": "Reference status of the key vault secret."
}
}
},
"KeyVaultSecretStatus": {
"type": "string",
"description": "Status of the Key Vault secret.",
"enum": [
"Initialized",
"WaitingOnCertificateOrder",
"Succeeded",
"CertificateOrderFailed",
"OperationNotPermittedOnKeyVault",
"AzureServiceUnauthorizedToAccessKeyVault",
"KeyVaultDoesNotExist",
"KeyVaultSecretDoesNotExist",
"UnknownError",
"ExternalPrivateKey",
"Unknown"
],
"x-ms-enum": {
"name": "KeyVaultSecretStatus",
"modelAsString": false
}
},
"Kind": {
"type": "string",
"description": "The workflow kind.",
"enum": [
"Stateful",
"Stateless"
],
"x-ms-enum": {
"name": "Kind",
"modelAsString": true,
"values": [
{
"name": "Stateful",
"value": "Stateful"
},
{
"name": "Stateless",
"value": "Stateless"
}
]
}
},
"KubeEnvironment": {
"type": "object",
"description": "A Kubernetes cluster specialized for web workloads by Azure App Service",
"properties": {
"properties": {
"$ref": "#/definitions/KubeEnvironmentProperties",
"description": "KubeEnvironment resource specific properties",
"x-ms-client-flatten": true
},
"extendedLocation": {
"$ref": "#/definitions/ExtendedLocation",
"description": "Extended Location."
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"KubeEnvironmentCollection": {
"type": "object",
"description": "Collection of Kubernetes Environments",
"properties": {
"value": {
"type": "array",
"description": "The KubeEnvironment items on this page",
"items": {
"$ref": "#/definitions/KubeEnvironment"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"KubeEnvironmentPatchResource": {
"type": "object",
"description": "ARM resource for a KubeEnvironment when patching",
"properties": {
"properties": {
"$ref": "#/definitions/KubeEnvironmentPatchResourceProperties",
"description": "KubeEnvironmentPatchResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"KubeEnvironmentPatchResourceProperties": {
"type": "object",
"description": "KubeEnvironmentPatchResource resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/KubeEnvironmentProvisioningState",
"description": "Provisioning state of the Kubernetes Environment.",
"readOnly": true
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
},
"internalLoadBalancerEnabled": {
"type": "boolean",
"description": "Only visible within Vnet/Subnet",
"x-ms-mutability": [
"read",
"create"
]
},
"defaultDomain": {
"type": "string",
"description": "Default Domain Name for the cluster",
"readOnly": true
},
"staticIp": {
"type": "string",
"description": "Static IP of the KubeEnvironment",
"x-ms-mutability": [
"read",
"create"
]
},
"arcConfiguration": {
"$ref": "#/definitions/ArcConfiguration",
"description": "Cluster configuration which determines the ARC cluster\ncomponents types. Eg: Choosing between BuildService kind,\nFrontEnd Service ArtifactsStorageType etc."
},
"appLogsConfiguration": {
"$ref": "#/definitions/AppLogsConfiguration",
"description": "Cluster configuration which enables the log daemon to export\napp logs to a destination. Currently only \"log-analytics\" is\nsupported"
},
"containerAppsConfiguration": {
"$ref": "#/definitions/ContainerAppsConfiguration",
"description": "Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration"
},
"aksResourceID": {
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"KubeEnvironmentProfile": {
"type": "object",
"description": "Specification for a Kubernetes Environment to use for this resource.",
"properties": {
"id": {
"type": "string",
"description": "Resource ID of the Kubernetes Environment."
},
"name": {
"type": "string",
"description": "Name of the Kubernetes Environment.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Resource type of the Kubernetes Environment.",
"readOnly": true
}
}
},
"KubeEnvironmentProperties": {
"type": "object",
"description": "KubeEnvironment resource specific properties",
"properties": {
"provisioningState": {
"$ref": "#/definitions/KubeEnvironmentProvisioningState",
"description": "Provisioning state of the Kubernetes Environment.",
"readOnly": true
},
"deploymentErrors": {
"type": "string",
"description": "Any errors that occurred during deployment or deployment validation",
"readOnly": true
},
"internalLoadBalancerEnabled": {
"type": "boolean",
"description": "Only visible within Vnet/Subnet",
"x-ms-mutability": [
"read",
"create"
]
},
"defaultDomain": {
"type": "string",
"description": "Default Domain Name for the cluster",
"readOnly": true
},
"staticIp": {
"type": "string",
"description": "Static IP of the KubeEnvironment",
"x-ms-mutability": [
"read",
"create"
]
},
"environmentType": {
"type": "string",
"description": "Type of Kubernetes Environment. Only supported for Container App Environments with value as Managed",
"x-ms-mutability": [
"read",
"create"
]
},
"arcConfiguration": {
"$ref": "#/definitions/ArcConfiguration",
"description": "Cluster configuration which determines the ARC cluster\ncomponents types. Eg: Choosing between BuildService kind,\nFrontEnd Service ArtifactsStorageType etc."
},
"appLogsConfiguration": {
"$ref": "#/definitions/AppLogsConfiguration",
"description": "Cluster configuration which enables the log daemon to export\napp logs to a destination. Currently only \"log-analytics\" is\nsupported"
},
"containerAppsConfiguration": {
"$ref": "#/definitions/ContainerAppsConfiguration",
"description": "Cluster configuration for Container Apps Environments to configure Dapr Instrumentation Key and VNET Configuration"
},
"aksResourceID": {
"type": "string",
"x-ms-mutability": [
"read",
"create"
]
}
}
},
"KubeEnvironmentProvisioningState": {
"type": "string",
"description": "Provisioning state of the Kubernetes Environment.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"Waiting",
"InitializationInProgress",
"InfrastructureSetupInProgress",
"InfrastructureSetupComplete",
"ScheduledForDelete",
"UpgradeRequested",
"UpgradeFailed"
],
"x-ms-enum": {
"name": "KubeEnvironmentProvisioningState",
"modelAsString": false
}
},
"LegacyMicrosoftAccount": {
"type": "object",
"description": "The configuration settings of the legacy Microsoft Account provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the legacy Microsoft Account provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/ClientRegistration",
"description": "The configuration settings of the app registration for the legacy Microsoft Account provider."
},
"login": {
"$ref": "#/definitions/LoginScopes",
"description": "The configuration settings of the login flow."
},
"validation": {
"$ref": "#/definitions/AllowedAudiencesValidation",
"description": "The configuration settings of the legacy Microsoft Account provider token validation flow."
}
}
},
"LinuxJavaContainerSettings": {
"type": "object",
"description": "Linux Java Container settings.",
"properties": {
"java11Runtime": {
"type": "string",
"description": "Java 11 version (runtime only).",
"readOnly": true
},
"java8Runtime": {
"type": "string",
"description": "Java 8 version (runtime only).",
"readOnly": true
},
"isPreview": {
"type": "boolean",
"description": "true if the stack is in preview; otherwise, false.",
"readOnly": true
},
"isDeprecated": {
"type": "boolean",
"description": "true if the stack is deprecated; otherwise, false.",
"readOnly": true
},
"isHidden": {
"type": "boolean",
"description": "true if the stack should be hidden; otherwise, false.",
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"format": "date-time",
"description": "End-of-life date for the minor version.",
"readOnly": true
},
"isAutoUpdate": {
"type": "boolean",
"description": "true if the stack version is auto-updated; otherwise, false.",
"readOnly": true
},
"isEarlyAccess": {
"type": "boolean",
"description": "true if the minor version is early-access; otherwise, false.",
"readOnly": true
}
}
},
"LoadBalancingMode": {
"type": "string",
"description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
"enum": [
"None",
"Web",
"Publishing",
"Web, Publishing"
],
"x-ms-enum": {
"name": "LoadBalancingMode",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "Web",
"value": "Web"
},
{
"name": "Publishing",
"value": "Publishing"
},
{
"name": "Web, Publishing",
"value": "Web, Publishing"
}
]
}
},
"LocalizableString": {
"type": "object",
"description": "Localizable string object containing the name and a localized value.",
"properties": {
"value": {
"type": "string",
"description": "Non-localized name."
},
"localizedValue": {
"type": "string",
"description": "Localized name."
}
}
},
"LogAnalyticsConfiguration": {
"type": "object",
"properties": {
"customerId": {
"type": "string"
},
"sharedKey": {
"type": "string",
"format": "password",
"x-ms-mutability": [
"update",
"create"
],
"x-ms-secret": true
}
}
},
"LogLevel": {
"type": "string",
"description": "Log level.",
"enum": [
"Off",
"Verbose",
"Information",
"Warning",
"Error"
],
"x-ms-enum": {
"name": "LogLevel",
"modelAsString": false
}
},
"LogSpecification": {
"type": "object",
"description": "Log Definition of a single resource metric.",
"properties": {
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"blobDuration": {
"type": "string"
},
"logFilterPattern": {
"type": "string"
}
}
},
"Login": {
"type": "object",
"description": "The configuration settings of the login flow of users using App Service Authentication/Authorization.",
"properties": {
"routes": {
"$ref": "#/definitions/LoginRoutes",
"description": "The routes that specify the endpoints used for login and logout requests."
},
"tokenStore": {
"$ref": "#/definitions/TokenStore",
"description": "The configuration settings of the token store."
},
"preserveUrlFragmentsForLogins": {
"type": "boolean",
"description": "true if the fragments from the request are preserved after the login request is made; otherwise, false."
},
"allowedExternalRedirectUrls": {
"type": "array",
"description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.",
"items": {
"type": "string"
}
},
"cookieExpiration": {
"$ref": "#/definitions/CookieExpiration",
"description": "The configuration settings of the session cookie's expiration."
},
"nonce": {
"$ref": "#/definitions/Nonce",
"description": "The configuration settings of the nonce used in the login flow."
}
}
},
"LoginRoutes": {
"type": "object",
"description": "The routes that specify the endpoints used for login and logout requests.",
"properties": {
"logoutEndpoint": {
"type": "string",
"description": "The endpoint at which a logout request should be made."
}
}
},
"LoginScopes": {
"type": "object",
"description": "The configuration settings of the login flow, including the scopes that should be requested.",
"properties": {
"scopes": {
"type": "array",
"description": "A list of the scopes that should be requested while authenticating.",
"items": {
"type": "string"
}
}
}
},
"MSDeploy": {
"type": "object",
"description": "MSDeploy ARM PUT information",
"properties": {
"properties": {
"$ref": "#/definitions/MSDeployProperties",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"MSDeployCore": {
"type": "object",
"description": "MSDeploy ARM PUT core information",
"properties": {
"packageUri": {
"type": "string",
"description": "Package URI"
},
"connectionString": {
"type": "string",
"description": "SQL Connection String"
},
"dbType": {
"type": "string",
"description": "Database Type"
},
"setParametersXmlFileUri": {
"type": "string",
"description": "URI of MSDeploy Parameters file. Must not be set if SetParameters is used."
},
"setParameters": {
"type": "object",
"description": "MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.",
"additionalProperties": {
"type": "string"
}
},
"skipAppData": {
"type": "boolean",
"description": "Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default."
},
"appOffline": {
"type": "boolean",
"description": "Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default."
}
}
},
"MSDeployLog": {
"type": "object",
"description": "MSDeploy log",
"properties": {
"properties": {
"$ref": "#/definitions/MSDeployLogProperties",
"description": "MSDeployLog resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"MSDeployLogEntry": {
"type": "object",
"description": "MSDeploy log entry",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"description": "Timestamp of log entry",
"readOnly": true
},
"type": {
"$ref": "#/definitions/MSDeployLogEntryType",
"description": "Log entry type",
"readOnly": true
},
"message": {
"type": "string",
"description": "Log entry message",
"readOnly": true
}
}
},
"MSDeployLogEntryType": {
"type": "string",
"description": "Log entry type",
"enum": [
"Message",
"Warning",
"Error"
],
"x-ms-enum": {
"name": "MSDeployLogEntryType",
"modelAsString": false
}
},
"MSDeployLogProperties": {
"type": "object",
"description": "MSDeployLog resource specific properties",
"properties": {
"entries": {
"type": "array",
"description": "List of log entry messages",
"items": {
"$ref": "#/definitions/MSDeployLogEntry"
},
"readOnly": true,
"x-ms-identifiers": []
}
}
},
"MSDeployProperties": {
"type": "object",
"description": "MSDeploy ARM PUT information properties",
"properties": {
"addOnPackages": {
"type": "array",
"description": "List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.",
"items": {
"$ref": "#/definitions/MSDeployCore"
},
"x-ms-identifiers": [
"packageUri"
]
}
},
"allOf": [
{
"$ref": "#/definitions/MSDeployCore"
}
]
},
"MSDeployProvisioningState": {
"type": "string",
"description": "Provisioning state",
"enum": [
"accepted",
"running",
"succeeded",
"failed",
"canceled"
],
"x-ms-enum": {
"name": "MSDeployProvisioningState",
"modelAsString": false
}
},
"MSDeployStatus": {
"type": "object",
"description": "MSDeploy ARM response",
"properties": {
"properties": {
"$ref": "#/definitions/MSDeployStatusProperties",
"description": "MSDeployStatus resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"MSDeployStatusProperties": {
"type": "object",
"description": "MSDeployStatus resource specific properties",
"properties": {
"deployer": {
"type": "string",
"description": "Username of deployer",
"readOnly": true
},
"provisioningState": {
"$ref": "#/definitions/MSDeployProvisioningState",
"description": "Provisioning state",
"readOnly": true
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of deploy operation",
"readOnly": true
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of deploy operation",
"readOnly": true
},
"complete": {
"type": "boolean",
"description": "Whether the deployment operation has completed",
"readOnly": true
}
}
},
"ManagedPipelineMode": {
"type": "string",
"description": "Managed pipeline mode.",
"enum": [
"Integrated",
"Classic"
],
"x-ms-enum": {
"name": "ManagedPipelineMode",
"modelAsString": false
}
},
"ManagedServiceIdentity": {
"type": "object",
"description": "Managed service identity.",
"properties": {
"type": {
"$ref": "#/definitions/ManagedServiceIdentityType",
"description": "Type of managed service identity."
},
"tenantId": {
"type": "string",
"description": "Tenant of managed service identity.",
"readOnly": true
},
"principalId": {
"type": "string",
"description": "Principal Id of managed service identity.",
"readOnly": true
},
"userAssignedIdentities": {
"type": "object",
"description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
"additionalProperties": {
"$ref": "#/definitions/UserAssignedIdentity"
}
}
}
},
"ManagedServiceIdentityType": {
"type": "string",
"description": "Type of managed service identity.",
"enum": [
"SystemAssigned",
"UserAssigned",
"SystemAssigned, UserAssigned",
"None"
],
"x-ms-enum": {
"name": "ManagedServiceIdentityType",
"modelAsString": false
}
},
"MetricAvailability": {
"type": "object",
"description": "Retention policy of a resource metric.",
"properties": {
"timeGrain": {
"type": "string"
},
"blobDuration": {
"type": "string"
}
}
},
"MetricSpecification": {
"type": "object",
"description": "Definition of a single resource metric.",
"properties": {
"name": {
"type": "string"
},
"displayName": {
"type": "string"
},
"displayDescription": {
"type": "string"
},
"unit": {
"type": "string"
},
"aggregationType": {
"type": "string"
},
"supportsInstanceLevelAggregation": {
"type": "boolean"
},
"enableRegionalMdmAccount": {
"type": "boolean"
},
"sourceMdmAccount": {
"type": "string"
},
"sourceMdmNamespace": {
"type": "string"
},
"metricFilterPattern": {
"type": "string"
},
"fillGapWithZero": {
"type": "boolean"
},
"isInternal": {
"type": "boolean"
},
"dimensions": {
"type": "array",
"items": {
"$ref": "#/definitions/Dimension"
},
"x-ms-identifiers": [
"name"
]
},
"category": {
"type": "string"
},
"availabilities": {
"type": "array",
"items": {
"$ref": "#/definitions/MetricAvailability"
},
"x-ms-identifiers": []
},
"supportedTimeGrainTypes": {
"type": "array",
"items": {
"type": "string"
}
},
"supportedAggregationTypes": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"MigrateMySqlRequest": {
"type": "object",
"description": "MySQL migration request.",
"properties": {
"properties": {
"$ref": "#/definitions/MigrateMySqlRequestProperties",
"description": "MigrateMySqlRequest resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"MigrateMySqlRequestProperties": {
"type": "object",
"description": "MigrateMySqlRequest resource specific properties",
"properties": {
"connectionString": {
"type": "string",
"description": "Connection string to the remote MySQL database."
},
"migrationType": {
"$ref": "#/definitions/MySqlMigrationType",
"description": "The type of migration operation to be done"
}
},
"required": [
"connectionString",
"migrationType"
]
},
"MigrateMySqlStatus": {
"type": "object",
"description": "MySQL migration status.",
"properties": {
"properties": {
"$ref": "#/definitions/MigrateMySqlStatusProperties",
"description": "MigrateMySqlStatus resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"MigrateMySqlStatusProperties": {
"type": "object",
"description": "MigrateMySqlStatus resource specific properties",
"properties": {
"migrationOperationStatus": {
"$ref": "#/definitions/OperationStatus",
"description": "Status of the migration task.",
"readOnly": true
},
"operationId": {
"type": "string",
"description": "Operation ID for the migration task.",
"readOnly": true
},
"localMySqlEnabled": {
"type": "boolean",
"description": "True if the web app has in app MySql enabled",
"readOnly": true
}
}
},
"MySqlMigrationType": {
"type": "string",
"description": "The type of migration operation to be done",
"enum": [
"LocalToRemote",
"RemoteToLocal"
],
"x-ms-enum": {
"name": "MySqlMigrationType",
"modelAsString": false
}
},
"NameIdentifier": {
"type": "object",
"description": "Identifies an object.",
"properties": {
"name": {
"type": "string",
"description": "Name of the object."
}
}
},
"NameValuePair": {
"type": "object",
"description": "Name value pair.",
"properties": {
"name": {
"type": "string",
"description": "Pair name."
},
"value": {
"type": "string",
"description": "Pair value."
}
}
},
"NetworkFeatures": {
"type": "object",
"description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).",
"properties": {
"properties": {
"$ref": "#/definitions/NetworkFeaturesProperties",
"description": "NetworkFeatures resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"NetworkFeaturesProperties": {
"type": "object",
"description": "NetworkFeatures resource specific properties",
"properties": {
"virtualNetworkName": {
"type": "string",
"description": "The Virtual Network name.",
"readOnly": true
},
"virtualNetworkConnection": {
"$ref": "#/definitions/VnetInfo",
"description": "The Virtual Network summary view.",
"readOnly": true
},
"hybridConnections": {
"type": "array",
"description": "The Hybrid Connections summary view.",
"items": {
"$ref": "#/definitions/RelayServiceConnectionEntity"
},
"readOnly": true
},
"hybridConnectionsV2": {
"type": "array",
"description": "The Hybrid Connection V2 (Service Bus) view.",
"items": {
"$ref": "#/definitions/HybridConnection"
},
"readOnly": true
}
}
},
"NetworkTrace": {
"type": "object",
"description": "Network trace",
"properties": {
"path": {
"type": "string",
"description": "Local file path for the captured network trace file."
},
"status": {
"type": "string",
"description": "Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed)."
},
"message": {
"type": "string",
"description": "Detailed message of a network trace operation, e.g. error message in case of failure."
}
}
},
"Nonce": {
"type": "object",
"description": "The configuration settings of the nonce used in the login flow.",
"properties": {
"validateNonce": {
"type": "boolean",
"description": "false if the nonce should not be validated while completing the login flow; otherwise, true."
},
"nonceExpirationInterval": {
"type": "string",
"description": "The time after the request is made when the nonce should expire."
}
}
},
"NotificationLevel": {
"type": "string",
"description": "Level indicating how critical this recommendation can impact.",
"enum": [
"Critical",
"Warning",
"Information",
"NonUrgentSuggestion"
],
"x-ms-enum": {
"name": "NotificationLevel",
"modelAsString": false
}
},
"OpenAuthenticationAccessPolicies": {
"type": "object",
"description": "AuthenticationPolicy of type Open.",
"properties": {
"policies": {
"type": "object",
"description": "Open authentication policies.",
"additionalProperties": {
"$ref": "#/definitions/OpenAuthenticationAccessPolicy"
}
}
}
},
"OpenAuthenticationAccessPolicy": {
"type": "object",
"description": "Open authentication access policy defined by user.",
"properties": {
"type": {
"$ref": "#/definitions/OpenAuthenticationProviderType",
"description": "Type of provider for OAuth."
},
"claims": {
"type": "array",
"description": "The access policy claims.",
"items": {
"$ref": "#/definitions/OpenAuthenticationPolicyClaim"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"OpenAuthenticationPolicyClaim": {
"type": "object",
"description": "Open authentication policy claim.",
"properties": {
"name": {
"type": "string",
"description": "The name of the claim."
},
"value": {
"type": "string",
"description": "The value of the claim."
}
}
},
"OpenAuthenticationProviderType": {
"type": "string",
"description": "Open authentication policy provider type.",
"enum": [
"AAD"
],
"x-ms-enum": {
"name": "OpenAuthenticationProviderType",
"modelAsString": true,
"values": [
{
"name": "AAD",
"value": "AAD"
}
]
}
},
"OpenIdConnectClientCredential": {
"type": "object",
"description": "The authentication client credentials of the custom Open ID Connect provider.",
"properties": {
"method": {
"type": "string",
"description": "The method that should be used to authenticate the user.",
"enum": [
"ClientSecretPost"
],
"x-ms-enum": {
"modelAsString": false
}
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting that contains the client secret for the custom Open ID Connect provider."
}
}
},
"OpenIdConnectConfig": {
"type": "object",
"description": "The configuration settings of the endpoints used for the custom Open ID Connect provider.",
"properties": {
"authorizationEndpoint": {
"type": "string",
"description": "The endpoint to be used to make an authorization request."
},
"tokenEndpoint": {
"type": "string",
"description": "The endpoint to be used to request a token."
},
"issuer": {
"type": "string",
"description": "The endpoint that issues the token."
},
"certificationUri": {
"type": "string",
"description": "The endpoint that provides the keys necessary to validate the token."
},
"wellKnownOpenIdConfiguration": {
"type": "string",
"description": "The endpoint that contains all the configuration endpoints for the provider."
}
}
},
"OpenIdConnectLogin": {
"type": "object",
"description": "The configuration settings of the login flow of the custom Open ID Connect provider.",
"properties": {
"nameClaimType": {
"type": "string",
"description": "The name of the claim that contains the users name."
},
"scopes": {
"type": "array",
"description": "A list of the scopes that should be requested while authenticating.",
"items": {
"type": "string"
}
}
}
},
"OpenIdConnectRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for the custom Open ID Connect provider.",
"properties": {
"clientId": {
"type": "string",
"description": "The client id of the custom Open ID Connect provider."
},
"clientCredential": {
"$ref": "#/definitions/OpenIdConnectClientCredential",
"description": "The authentication credentials of the custom Open ID Connect provider."
},
"openIdConnectConfiguration": {
"$ref": "#/definitions/OpenIdConnectConfig",
"description": "The configuration settings of the endpoints used for the custom Open ID Connect provider."
}
}
},
"Operation": {
"type": "object",
"description": "An operation on a resource.",
"properties": {
"id": {
"type": "string",
"description": "Operation ID."
},
"name": {
"type": "string",
"description": "Operation name."
},
"status": {
"$ref": "#/definitions/OperationStatus",
"description": "The current status of the operation."
},
"errors": {
"type": "array",
"description": "Any errors associate with the operation.",
"items": {
"$ref": "#/definitions/ErrorEntity"
},
"x-ms-identifiers": []
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Time when operation has started."
},
"modifiedTime": {
"type": "string",
"format": "date-time",
"description": "Time when operation has been updated."
},
"expirationTime": {
"type": "string",
"format": "date-time",
"description": "Time when operation will expire."
},
"geoMasterOperationId": {
"type": "string",
"format": "uuid",
"description": "Applicable only for stamp operation ids."
}
}
},
"OperationResult": {
"type": "object",
"description": "The operation result definition.",
"properties": {
"trackingId": {
"type": "string",
"description": "Gets the tracking id.",
"readOnly": true
},
"inputs": {
"description": "Gets the inputs.",
"readOnly": true
},
"inputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to inputs.",
"readOnly": true
},
"outputs": {
"description": "Gets the outputs.",
"readOnly": true
},
"outputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to outputs.",
"readOnly": true
},
"trackedProperties": {
"description": "Gets the tracked properties.",
"readOnly": true
},
"retryHistory": {
"type": "array",
"description": "Gets the retry histories.",
"items": {
"$ref": "#/definitions/RetryHistory"
},
"x-ms-identifiers": []
},
"iterationCount": {
"type": "integer",
"format": "int32"
}
},
"allOf": [
{
"$ref": "#/definitions/OperationResultProperties"
}
]
},
"OperationResultProperties": {
"type": "object",
"description": "The run operation result properties.",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "The start time of the workflow scope repetition."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The end time of the workflow scope repetition."
},
"correlation": {
"$ref": "#/definitions/RunActionCorrelation",
"description": "The correlation properties."
},
"status": {
"$ref": "#/definitions/WorkflowStatus",
"description": "The status of the workflow scope repetition."
},
"code": {
"type": "string",
"description": "The workflow scope repetition code."
},
"error": {
"description": "Anything"
}
}
},
"OperationStatus": {
"type": "string",
"description": "The current status of the operation.",
"enum": [
"InProgress",
"Failed",
"Succeeded",
"TimedOut",
"Created"
],
"x-ms-enum": {
"name": "OperationStatus",
"modelAsString": false
}
},
"OutboundEnvironmentEndpoint": {
"type": "object",
"description": "Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.",
"properties": {
"category": {
"type": "string",
"description": "The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory."
},
"endpoints": {
"type": "array",
"description": "The endpoints that the App Service Environment reaches the service at.",
"items": {
"$ref": "#/definitions/EndpointDependency"
},
"x-ms-identifiers": [
"domainName"
]
}
}
},
"OutboundEnvironmentEndpointCollection": {
"type": "object",
"description": "Paged collection of OutboundEnvironmentEndpoint items",
"properties": {
"value": {
"type": "array",
"description": "The OutboundEnvironmentEndpoint items on this page",
"items": {
"$ref": "#/definitions/OutboundEnvironmentEndpoint"
},
"x-ms-identifiers": [
"category"
]
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"OutboundVnetRouting": {
"type": "object",
"description": "Outbound traffic options over virtual network.",
"properties": {
"allTraffic": {
"type": "boolean",
"description": "Enables all other routing options defined in OutboundVnetRouting if this setting is set to true."
},
"applicationTraffic": {
"type": "boolean",
"description": "This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied. Previously called VnetRouteAllEnabled."
},
"contentShareTraffic": {
"type": "boolean",
"description": "Enables accessing content over virtual network. Previously called VnetContentShareEnabled"
},
"imagePullTraffic": {
"type": "boolean",
"description": "Enables pulling image over Virtual Network. Previously called VnetImagePullEnabled."
},
"backupRestoreTraffic": {
"type": "boolean",
"description": "Enables Backup and Restore operations over virtual network. Previously called VnetBackupRestoreEnabled"
}
}
},
"ParameterType": {
"type": "string",
"description": "The parameter type.",
"enum": [
"NotSpecified",
"String",
"SecureString",
"Int",
"Float",
"Bool",
"Array",
"Object",
"SecureObject"
],
"x-ms-enum": {
"name": "ParameterType",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "String",
"value": "String"
},
{
"name": "SecureString",
"value": "SecureString"
},
{
"name": "Int",
"value": "Int"
},
{
"name": "Float",
"value": "Float"
},
{
"name": "Bool",
"value": "Bool"
},
{
"name": "Array",
"value": "Array"
},
{
"name": "Object",
"value": "Object"
},
{
"name": "SecureObject",
"value": "SecureObject"
}
]
}
},
"PerfMonCounterCollection": {
"type": "object",
"description": "Collection of performance monitor counters.",
"properties": {
"value": {
"type": "array",
"description": "The PerfMonResponse items on this page",
"items": {
"$ref": "#/definitions/PerfMonResponse"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PerfMonResponse": {
"type": "object",
"description": "Performance monitor API response.",
"properties": {
"code": {
"type": "string",
"description": "The response code."
},
"message": {
"type": "string",
"description": "The message."
},
"data": {
"$ref": "#/definitions/PerfMonSet",
"description": "The performance monitor counters."
}
}
},
"PerfMonSample": {
"type": "object",
"description": "Performance monitor sample in a set.",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"description": "Point in time for which counter was measured."
},
"instanceName": {
"type": "string",
"description": "Name of the server on which the measurement is made."
},
"value": {
"type": "number",
"format": "double",
"description": "Value of counter at a certain time."
}
}
},
"PerfMonSet": {
"type": "object",
"description": "Metric information.",
"properties": {
"name": {
"type": "string",
"description": "Unique key name of the counter."
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Start time of the period."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "End time of the period."
},
"timeGrain": {
"type": "string",
"description": "Presented time grain."
},
"values": {
"type": "array",
"description": "Collection of workers that are active during this time.",
"items": {
"$ref": "#/definitions/PerfMonSample"
},
"x-ms-identifiers": []
}
}
},
"PremierAddOn": {
"type": "object",
"description": "Premier add-on.",
"properties": {
"properties": {
"$ref": "#/definitions/PremierAddOnProperties",
"description": "PremierAddOn resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"PremierAddOnOffer": {
"type": "object",
"description": "Premier add-on offer.",
"properties": {
"properties": {
"$ref": "#/definitions/PremierAddOnOfferProperties",
"description": "PremierAddOnOffer resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"PremierAddOnOfferCollection": {
"type": "object",
"description": "Collection of premier add-on offers.",
"properties": {
"value": {
"type": "array",
"description": "The PremierAddOnOffer items on this page",
"items": {
"$ref": "#/definitions/PremierAddOnOffer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PremierAddOnOfferProperties": {
"type": "object",
"description": "PremierAddOnOffer resource specific properties",
"properties": {
"sku": {
"type": "string",
"description": "Premier add on SKU."
},
"product": {
"type": "string",
"description": "Premier add on offer Product."
},
"vendor": {
"type": "string",
"description": "Premier add on offer Vendor."
},
"promoCodeRequired": {
"type": "boolean",
"description": "true if promotion code is required; otherwise, false."
},
"quota": {
"type": "integer",
"format": "int32",
"description": "Premier add on offer Quota."
},
"webHostingPlanRestrictions": {
"$ref": "#/definitions/AppServicePlanRestrictions",
"description": "App Service plans this offer is restricted to."
},
"privacyPolicyUrl": {
"type": "string",
"description": "Privacy policy URL."
},
"legalTermsUrl": {
"type": "string",
"description": "Legal terms URL."
},
"marketplacePublisher": {
"type": "string",
"description": "Marketplace publisher."
},
"marketplaceOffer": {
"type": "string",
"description": "Marketplace offer."
}
}
},
"PremierAddOnPatchResource": {
"type": "object",
"description": "ARM resource for a PremierAddOn.",
"properties": {
"properties": {
"$ref": "#/definitions/PremierAddOnPatchResourceProperties",
"description": "PremierAddOnPatchResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"PremierAddOnPatchResourceProperties": {
"type": "object",
"description": "PremierAddOnPatchResource resource specific properties",
"properties": {
"sku": {
"type": "string",
"description": "Premier add on SKU."
},
"product": {
"type": "string",
"description": "Premier add on Product."
},
"vendor": {
"type": "string",
"description": "Premier add on Vendor."
},
"marketplacePublisher": {
"type": "string",
"description": "Premier add on Marketplace publisher."
},
"marketplaceOffer": {
"type": "string",
"description": "Premier add on Marketplace offer."
}
}
},
"PremierAddOnProperties": {
"type": "object",
"description": "PremierAddOn resource specific properties",
"properties": {
"sku": {
"type": "string",
"description": "Premier add on SKU."
},
"product": {
"type": "string",
"description": "Premier add on Product."
},
"vendor": {
"type": "string",
"description": "Premier add on Vendor."
},
"marketplacePublisher": {
"type": "string",
"description": "Premier add on Marketplace publisher."
},
"marketplaceOffer": {
"type": "string",
"description": "Premier add on Marketplace offer."
}
}
},
"PrivateAccess": {
"type": "object",
"description": "Description of the parameters of Private Access for a Web Site.",
"properties": {
"properties": {
"$ref": "#/definitions/PrivateAccessProperties",
"description": "PrivateAccess resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"PrivateAccessProperties": {
"type": "object",
"description": "PrivateAccess resource specific properties",
"properties": {
"enabled": {
"type": "boolean",
"description": "Whether private access is enabled or not."
},
"virtualNetworks": {
"type": "array",
"description": "The Virtual Networks (and subnets) allowed to access the site privately.",
"items": {
"$ref": "#/definitions/PrivateAccessVirtualNetwork"
},
"x-ms-identifiers": [
"key"
]
}
}
},
"PrivateAccessSubnet": {
"type": "object",
"description": "Description of a Virtual Network subnet that is useable for private site access.",
"properties": {
"name": {
"type": "string",
"description": "The name of the subnet."
},
"key": {
"type": "integer",
"format": "int32",
"description": "The key (ID) of the subnet."
}
}
},
"PrivateAccessVirtualNetwork": {
"type": "object",
"description": "Description of a Virtual Network that is useable for private site access.",
"properties": {
"name": {
"type": "string",
"description": "The name of the Virtual Network."
},
"key": {
"type": "integer",
"format": "int32",
"description": "The key (ID) of the Virtual Network."
},
"resourceId": {
"type": "string",
"description": "The ARM uri of the Virtual Network"
},
"subnets": {
"type": "array",
"description": "A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.",
"items": {
"$ref": "#/definitions/PrivateAccessSubnet"
},
"x-ms-identifiers": [
"key"
]
}
}
},
"PrivateEndpointConnectionCollection": {
"type": "object",
"description": "Paged collection of RemotePrivateEndpointConnectionARMResource items",
"properties": {
"value": {
"type": "array",
"description": "The RemotePrivateEndpointConnectionARMResource items on this page",
"items": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PrivateLinkConnectionApprovalRequest": {
"type": "object",
"description": "A request to approve or reject a private endpoint connection",
"properties": {
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkConnectionState",
"description": "The state of a private link connection"
}
}
},
"PrivateLinkConnectionApprovalRequestResource": {
"type": "object",
"description": "Private Endpoint Connection Approval ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/PrivateLinkConnectionApprovalRequest",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"PrivateLinkConnectionState": {
"type": "object",
"description": "The state of a private link connection",
"properties": {
"status": {
"type": "string",
"description": "Status of a private link connection"
},
"description": {
"type": "string",
"description": "Description of a private link connection"
},
"actionsRequired": {
"type": "string",
"description": "ActionsRequired for a private link connection"
}
}
},
"PrivateLinkResource": {
"type": "object",
"description": "A private link resource",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string",
"description": "Name of a private link resource"
},
"type": {
"type": "string"
},
"properties": {
"$ref": "#/definitions/PrivateLinkResourceProperties",
"description": "Properties of a private link resource"
}
},
"required": [
"id",
"name",
"type",
"properties"
]
},
"PrivateLinkResourceProperties": {
"type": "object",
"description": "Properties of a private link resource",
"properties": {
"groupId": {
"type": "string",
"description": "GroupId of a private link resource",
"readOnly": true
},
"requiredMembers": {
"type": "array",
"description": "RequiredMembers of a private link resource",
"items": {
"type": "string"
},
"readOnly": true
},
"requiredZoneNames": {
"type": "array",
"description": "RequiredZoneNames of a private link resource",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"PrivateLinkResourcesWrapper": {
"type": "object",
"description": "Wrapper for a collection of private link resources",
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/PrivateLinkResource"
}
}
},
"required": [
"value"
]
},
"ProcessInfo": {
"type": "object",
"description": "Process Information.",
"properties": {
"properties": {
"$ref": "#/definitions/ProcessInfoProperties",
"description": "ProcessInfo resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ProcessInfoCollection": {
"type": "object",
"description": "Collection of Kudu process information elements.",
"properties": {
"value": {
"type": "array",
"description": "The ProcessInfo items on this page",
"items": {
"$ref": "#/definitions/ProcessInfo"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ProcessInfoProperties": {
"type": "object",
"description": "ProcessInfo resource specific properties",
"properties": {
"identifier": {
"type": "integer",
"format": "int32",
"description": "ARM Identifier for deployment.",
"readOnly": true
},
"deployment_name": {
"type": "string",
"description": "Deployment name.",
"x-ms-client-name": "deploymentName"
},
"href": {
"type": "string",
"description": "HRef URI."
},
"minidump": {
"type": "string",
"description": "Minidump URI."
},
"is_profile_running": {
"type": "boolean",
"description": "Is profile running?",
"x-ms-client-name": "isProfileRunning"
},
"is_iis_profile_running": {
"type": "boolean",
"description": "Is the IIS Profile running?",
"x-ms-client-name": "isIisProfileRunning"
},
"iis_profile_timeout_in_seconds": {
"type": "number",
"format": "double",
"description": "IIS Profile timeout (seconds).",
"x-ms-client-name": "iisProfileTimeoutInSeconds"
},
"parent": {
"type": "string",
"description": "Parent process."
},
"children": {
"type": "array",
"description": "Child process list.",
"items": {
"type": "string"
}
},
"threads": {
"type": "array",
"description": "Thread list.",
"items": {
"$ref": "#/definitions/ProcessThreadInfo"
}
},
"open_file_handles": {
"type": "array",
"description": "List of open files.",
"items": {
"type": "string"
},
"x-ms-client-name": "openFileHandles"
},
"modules": {
"type": "array",
"description": "List of modules.",
"items": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"file_name": {
"type": "string",
"description": "File name of this process.",
"x-ms-client-name": "fileName"
},
"command_line": {
"type": "string",
"description": "Command line.",
"x-ms-client-name": "commandLine"
},
"user_name": {
"type": "string",
"description": "User name.",
"x-ms-client-name": "userName"
},
"handle_count": {
"type": "integer",
"format": "int32",
"description": "Handle count.",
"x-ms-client-name": "handleCount"
},
"module_count": {
"type": "integer",
"format": "int32",
"description": "Module count.",
"x-ms-client-name": "moduleCount"
},
"thread_count": {
"type": "integer",
"format": "int32",
"description": "Thread count.",
"x-ms-client-name": "threadCount"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Start time.",
"x-ms-client-name": "startTime"
},
"total_cpu_time": {
"type": "string",
"description": "Total CPU time.",
"x-ms-client-name": "totalCpuTime"
},
"user_cpu_time": {
"type": "string",
"description": "User CPU time.",
"x-ms-client-name": "userCpuTime"
},
"privileged_cpu_time": {
"type": "string",
"description": "Privileged CPU time.",
"x-ms-client-name": "privilegedCpuTime"
},
"working_set": {
"type": "integer",
"format": "int64",
"description": "Working set.",
"x-ms-client-name": "workingSet"
},
"peak_working_set": {
"type": "integer",
"format": "int64",
"description": "Peak working set.",
"x-ms-client-name": "peakWorkingSet"
},
"private_memory": {
"type": "integer",
"format": "int64",
"description": "Private memory size.",
"x-ms-client-name": "privateMemory"
},
"virtual_memory": {
"type": "integer",
"format": "int64",
"description": "Virtual memory size.",
"x-ms-client-name": "virtualMemory"
},
"peak_virtual_memory": {
"type": "integer",
"format": "int64",
"description": "Peak virtual memory usage.",
"x-ms-client-name": "peakVirtualMemory"
},
"paged_system_memory": {
"type": "integer",
"format": "int64",
"description": "Paged system memory.",
"x-ms-client-name": "pagedSystemMemory"
},
"non_paged_system_memory": {
"type": "integer",
"format": "int64",
"description": "Non-paged system memory.",
"x-ms-client-name": "nonPagedSystemMemory"
},
"paged_memory": {
"type": "integer",
"format": "int64",
"description": "Paged memory.",
"x-ms-client-name": "pagedMemory"
},
"peak_paged_memory": {
"type": "integer",
"format": "int64",
"description": "Peak paged memory.",
"x-ms-client-name": "peakPagedMemory"
},
"time_stamp": {
"type": "string",
"format": "date-time",
"description": "Time stamp.",
"x-ms-client-name": "timeStamp"
},
"environment_variables": {
"type": "object",
"description": "List of environment variables.",
"additionalProperties": {
"type": "string"
},
"x-ms-client-name": "environmentVariables"
},
"is_scm_site": {
"type": "boolean",
"description": "Is this the SCM site?",
"x-ms-client-name": "isScmSite"
},
"is_webjob": {
"type": "boolean",
"description": "Is this a Web Job?",
"x-ms-client-name": "isWebjob"
},
"description": {
"type": "string",
"description": "Description of process."
}
}
},
"ProcessModuleInfo": {
"type": "object",
"description": "Process Module Information.",
"properties": {
"properties": {
"$ref": "#/definitions/ProcessModuleInfoProperties",
"description": "ProcessModuleInfo resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ProcessModuleInfoCollection": {
"type": "object",
"description": "Collection of Kudu thread information elements.",
"properties": {
"value": {
"type": "array",
"description": "The ProcessModuleInfo items on this page",
"items": {
"$ref": "#/definitions/ProcessModuleInfo"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ProcessModuleInfoProperties": {
"type": "object",
"description": "ProcessModuleInfo resource specific properties",
"properties": {
"base_address": {
"type": "string",
"description": "Base address. Used as module identifier in ARM resource URI.",
"x-ms-client-name": "baseAddress"
},
"file_name": {
"type": "string",
"description": "File name.",
"x-ms-client-name": "fileName"
},
"href": {
"type": "string",
"description": "HRef URI."
},
"file_path": {
"type": "string",
"description": "File path.",
"x-ms-client-name": "filePath"
},
"module_memory_size": {
"type": "integer",
"format": "int32",
"description": "Module memory size.",
"x-ms-client-name": "moduleMemorySize"
},
"file_version": {
"type": "string",
"description": "File version.",
"x-ms-client-name": "fileVersion"
},
"file_description": {
"type": "string",
"description": "File description.",
"x-ms-client-name": "fileDescription"
},
"product": {
"type": "string",
"description": "Product name."
},
"product_version": {
"type": "string",
"description": "Product version.",
"x-ms-client-name": "productVersion"
},
"is_debug": {
"type": "boolean",
"description": "Is debug?",
"x-ms-client-name": "isDebug"
},
"language": {
"type": "string",
"description": "Module language (locale)."
}
}
},
"ProcessThreadInfo": {
"type": "object",
"description": "Process Thread Information.",
"properties": {
"properties": {
"$ref": "#/definitions/ProcessThreadInfoProperties",
"description": "ProcessThreadInfo resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"ProcessThreadInfoCollection": {
"type": "object",
"description": "Collection of Kudu thread information elements.",
"properties": {
"value": {
"type": "array",
"description": "The ProcessThreadInfo items on this page",
"items": {
"$ref": "#/definitions/ProcessThreadInfo"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ProcessThreadInfoProperties": {
"type": "object",
"description": "ProcessThreadInfo resource specific properties",
"properties": {
"identifier": {
"type": "integer",
"format": "int32",
"description": "Site extension ID.",
"readOnly": true
},
"href": {
"type": "string",
"description": "HRef URI."
},
"process": {
"type": "string",
"description": "Process URI."
},
"start_address": {
"type": "string",
"description": "Start address.",
"x-ms-client-name": "startAddress"
},
"current_priority": {
"type": "integer",
"format": "int32",
"description": "Current thread priority.",
"x-ms-client-name": "currentPriority"
},
"priority_level": {
"type": "string",
"description": "Thread priority level.",
"x-ms-client-name": "priorityLevel"
},
"base_priority": {
"type": "integer",
"format": "int32",
"description": "Base priority.",
"x-ms-client-name": "basePriority"
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Start time.",
"x-ms-client-name": "startTime"
},
"total_processor_time": {
"type": "string",
"description": "Total processor time.",
"x-ms-client-name": "totalProcessorTime"
},
"user_processor_time": {
"type": "string",
"description": "User processor time.",
"x-ms-client-name": "userProcessorTime"
},
"state": {
"type": "string",
"description": "Thread state."
},
"wait_reason": {
"type": "string",
"description": "Wait reason.",
"x-ms-client-name": "waitReason"
}
}
},
"ProvisioningState": {
"type": "string",
"description": "Provisioning state of the App Service Plan.",
"enum": [
"Succeeded",
"Failed",
"Canceled",
"InProgress",
"Deleting"
],
"x-ms-enum": {
"name": "ProvisioningState",
"modelAsString": false
}
},
"ProxyOnlyResource": {
"type": "object",
"description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
"properties": {
"id": {
"type": "string",
"description": "Resource Id.",
"readOnly": true
},
"name": {
"type": "string",
"description": "Resource Name.",
"readOnly": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
},
"type": {
"type": "string",
"description": "Resource type.",
"readOnly": true
}
}
},
"PublicCertificate": {
"type": "object",
"description": "Public certificate object",
"properties": {
"properties": {
"$ref": "#/definitions/PublicCertificateProperties",
"description": "PublicCertificate resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"PublicCertificateCollection": {
"type": "object",
"description": "Collection of public certificates",
"properties": {
"value": {
"type": "array",
"description": "The PublicCertificate items on this page",
"items": {
"$ref": "#/definitions/PublicCertificate"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PublicCertificateLocation": {
"type": "string",
"description": "Public Certificate Location",
"enum": [
"CurrentUserMy",
"LocalMachineMy",
"Unknown"
],
"x-ms-enum": {
"name": "PublicCertificateLocation",
"modelAsString": false
}
},
"PublicCertificateProperties": {
"type": "object",
"description": "PublicCertificate resource specific properties",
"properties": {
"blob": {
"type": "string",
"format": "byte",
"description": "Public Certificate byte array"
},
"publicCertificateLocation": {
"$ref": "#/definitions/PublicCertificateLocation",
"description": "Public Certificate Location"
},
"thumbprint": {
"type": "string",
"description": "Certificate Thumbprint",
"readOnly": true
}
}
},
"PublishingCredentialsPoliciesCollection": {
"type": "object",
"description": "Publishing Credentials Policies entity collection ARM resource.",
"properties": {
"value": {
"type": "array",
"description": "The CsmPublishingCredentialsPoliciesEntity items on this page",
"items": {
"$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"PublishingProfileFormat": {
"type": "string",
"description": "Name of the format. Valid values are:\nFileZilla3\nWebDeploy -- default\nFtp",
"enum": [
"FileZilla3",
"WebDeploy",
"Ftp"
],
"x-ms-enum": {
"name": "PublishingProfileFormat",
"modelAsString": true,
"values": [
{
"name": "FileZilla3",
"value": "FileZilla3"
},
{
"name": "WebDeploy",
"value": "WebDeploy"
},
{
"name": "Ftp",
"value": "Ftp"
}
]
}
},
"PushSettings": {
"type": "object",
"description": "Push settings for the App.",
"properties": {
"properties": {
"$ref": "#/definitions/PushSettingsProperties",
"description": "PushSettings resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"PushSettingsProperties": {
"type": "object",
"description": "PushSettings resource specific properties",
"properties": {
"isPushEnabled": {
"type": "boolean",
"description": "Gets or sets a flag indicating whether the Push endpoint is enabled."
},
"tagWhitelistJson": {
"type": "string",
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint."
},
"tagsRequiringAuth": {
"type": "string",
"description": "Gets or sets a JSON string containing a list of tags that require user authentication to be used in the push registration endpoint.\nTags can consist of alphanumeric characters and the following:\n'_', '@', '#', '.', ':', '-'. \nValidation should be performed at the PushRequestHandler."
},
"dynamicTagsJson": {
"type": "string",
"description": "Gets or sets a JSON string containing a list of dynamic tags that will be evaluated from user claims in the push registration endpoint."
}
},
"required": [
"isPushEnabled"
]
},
"QueryUtterancesResult": {
"type": "object",
"description": "Result for utterances query.",
"properties": {
"sampleUtterance": {
"$ref": "#/definitions/SampleUtterance",
"description": "A sample utterance."
},
"score": {
"type": "number",
"format": "float",
"description": "Score of a sample utterance."
}
}
},
"QueryUtterancesResults": {
"type": "object",
"description": "Suggested utterances where the detector can be applicable",
"properties": {
"query": {
"type": "string",
"description": "Search Query."
},
"results": {
"type": "array",
"description": "Array of utterance results for search query.",
"items": {
"$ref": "#/definitions/QueryUtterancesResult"
},
"x-ms-identifiers": []
}
}
},
"RampUpRule": {
"type": "object",
"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.",
"properties": {
"actionHostName": {
"type": "string",
"description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net."
},
"reroutePercentage": {
"type": "number",
"format": "double",
"description": "Percentage of the traffic which will be redirected to ActionHostName."
},
"changeStep": {
"type": "number",
"format": "double",
"description": "In auto ramp up scenario this is the step to add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or\nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm\ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl."
},
"changeIntervalInMinutes": {
"type": "integer",
"format": "int32",
"description": "Specifies interval in minutes to reevaluate ReroutePercentage."
},
"minReroutePercentage": {
"type": "number",
"format": "double",
"description": "Specifies lower boundary above which ReroutePercentage will stay."
},
"maxReroutePercentage": {
"type": "number",
"format": "double",
"description": "Specifies upper boundary below which ReroutePercentage will stay."
},
"changeDecisionCallbackUrl": {
"type": "string",
"description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified."
},
"name": {
"type": "string",
"description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment."
}
}
},
"Recommendation": {
"type": "object",
"description": "Represents a recommendation result generated by the recommendation engine.",
"properties": {
"properties": {
"$ref": "#/definitions/RecommendationProperties",
"description": "Recommendation resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"RecommendationCollection": {
"type": "object",
"description": "Collection of recommendations.",
"properties": {
"value": {
"type": "array",
"description": "The Recommendation items on this page",
"items": {
"$ref": "#/definitions/Recommendation"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"RecommendationProperties": {
"type": "object",
"description": "Recommendation resource specific properties",
"properties": {
"creationTime": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this instance was created."
},
"recommendationId": {
"type": "string",
"format": "uuid",
"description": "A GUID value that each recommendation object is associated with."
},
"resourceId": {
"type": "string",
"description": "Full ARM resource ID string that this recommendation object is associated with."
},
"resourceScope": {
"$ref": "#/definitions/ResourceScopeType",
"description": "Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site."
},
"ruleName": {
"type": "string",
"description": "Unique name of the rule."
},
"displayName": {
"type": "string",
"description": "UI friendly name of the rule (may not be unique)."
},
"message": {
"type": "string",
"description": "Recommendation text."
},
"level": {
"$ref": "#/definitions/NotificationLevel",
"description": "Level indicating how critical this recommendation can impact."
},
"channels": {
"$ref": "#/definitions/Channels",
"description": "List of channels that this recommendation can apply."
},
"categoryTags": {
"type": "array",
"description": "The list of category tags that this recommendation belongs to.",
"items": {
"type": "string"
},
"readOnly": true
},
"actionName": {
"type": "string",
"description": "Name of action recommended by this object."
},
"enabled": {
"type": "integer",
"format": "int32",
"description": "True if this recommendation is still valid (i.e. \"actionable\"). False if it is invalid."
},
"states": {
"type": "array",
"description": "The list of states of this recommendation. If it's null then it should be considered \"Active\".",
"items": {
"type": "string"
}
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "The beginning time in UTC of a range that the recommendation refers to."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The end time in UTC of a range that the recommendation refers to."
},
"nextNotificationTime": {
"type": "string",
"format": "date-time",
"description": "When to notify this recommendation next in UTC. Null means that this will never be notified anymore."
},
"notificationExpirationTime": {
"type": "string",
"format": "date-time",
"description": "Date and time in UTC when this notification expires."
},
"notifiedTime": {
"type": "string",
"format": "date-time",
"description": "Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet."
},
"score": {
"type": "number",
"format": "double",
"description": "A metric value measured by the rule."
},
"isDynamic": {
"type": "boolean",
"description": "True if this is associated with a dynamically added rule"
},
"extensionName": {
"type": "string",
"description": "Extension name of the portal if exists."
},
"bladeName": {
"type": "string",
"description": "Deep link to a blade on the portal."
},
"forwardLink": {
"type": "string",
"description": "Forward link to an external document associated with the rule."
}
}
},
"RecommendationRule": {
"type": "object",
"description": "Represents a recommendation rule that the recommendation engine can perform.",
"properties": {
"properties": {
"$ref": "#/definitions/RecommendationRuleProperties",
"description": "RecommendationRule resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"RecommendationRuleProperties": {
"type": "object",
"description": "RecommendationRule resource specific properties",
"properties": {
"recommendationName": {
"type": "string",
"description": "Unique name of the rule."
},
"displayName": {
"type": "string",
"description": "UI friendly name of the rule."
},
"message": {
"type": "string",
"description": "Localized name of the rule (Good for UI)."
},
"recommendationId": {
"type": "string",
"format": "uuid",
"description": "Recommendation ID of an associated recommendation object tied to the rule, if exists.\nIf such an object doesn't exist, it is set to null."
},
"description": {
"type": "string",
"description": "Localized detailed description of the rule."
},
"actionName": {
"type": "string",
"description": "Name of action that is recommended by this rule in string."
},
"level": {
"$ref": "#/definitions/NotificationLevel",
"description": "Level of impact indicating how critical this rule is."
},
"channels": {
"$ref": "#/definitions/Channels",
"description": "List of available channels that this rule applies."
},
"categoryTags": {
"type": "array",
"description": "The list of category tags that this recommendation rule belongs to.",
"items": {
"type": "string"
},
"readOnly": true
},
"isDynamic": {
"type": "boolean",
"description": "True if this is associated with a dynamically added rule"
},
"extensionName": {
"type": "string",
"description": "Extension name of the portal if exists. Applicable to dynamic rule only."
},
"bladeName": {
"type": "string",
"description": "Deep link to a blade on the portal. Applicable to dynamic rule only."
},
"forwardLink": {
"type": "string",
"description": "Forward link to an external document associated with the rule. Applicable to dynamic rule only."
}
}
},
"RecurrenceFrequency": {
"type": "string",
"description": "The recurrence frequency.",
"enum": [
"NotSpecified",
"Second",
"Minute",
"Hour",
"Day",
"Week",
"Month",
"Year"
],
"x-ms-enum": {
"name": "RecurrenceFrequency",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Second",
"value": "Second"
},
{
"name": "Minute",
"value": "Minute"
},
{
"name": "Hour",
"value": "Hour"
},
{
"name": "Day",
"value": "Day"
},
{
"name": "Week",
"value": "Week"
},
{
"name": "Month",
"value": "Month"
},
{
"name": "Year",
"value": "Year"
}
]
}
},
"RecurrenceSchedule": {
"type": "object",
"description": "The recurrence schedule.",
"properties": {
"minutes": {
"type": "array",
"description": "The minutes.",
"items": {
"type": "integer",
"format": "int32"
}
},
"hours": {
"type": "array",
"description": "The hours.",
"items": {
"type": "integer",
"format": "int32"
}
},
"weekDays": {
"type": "array",
"description": "The days of the week.",
"items": {
"$ref": "#/definitions/DaysOfWeek"
}
},
"monthDays": {
"type": "array",
"description": "The month days.",
"items": {
"type": "integer",
"format": "int32"
}
},
"monthlyOccurrences": {
"type": "array",
"description": "The monthly occurrences.",
"items": {
"$ref": "#/definitions/RecurrenceScheduleOccurrence"
},
"x-ms-identifiers": []
}
}
},
"RecurrenceScheduleOccurrence": {
"type": "object",
"description": "The recurrence schedule occurrence.",
"properties": {
"day": {
"$ref": "#/definitions/DayOfWeek",
"description": "The day of the week."
},
"occurrence": {
"type": "integer",
"format": "int32",
"description": "The occurrence."
}
}
},
"RedundancyMode": {
"type": "string",
"description": "Site redundancy mode",
"enum": [
"None",
"Manual",
"Failover",
"ActiveActive",
"GeoRedundant"
],
"x-ms-enum": {
"name": "RedundancyMode",
"modelAsString": false
}
},
"RegenerateActionParameter": {
"type": "object",
"description": "The access key regenerate action content.",
"properties": {
"keyType": {
"$ref": "#/definitions/KeyType",
"description": "The key type."
}
}
},
"RegistryAdapter": {
"type": "object",
"description": "Server farm registry adapter configuration.",
"properties": {
"registryKey": {
"type": "string",
"description": "Registry key for the adapter."
},
"type": {
"$ref": "#/definitions/RegistryAdapterType",
"description": "Type of the registry adapter."
},
"keyVaultSecretReference": {
"$ref": "#/definitions/KeyVaultReferenceWithStatus",
"description": "Key vault reference to the value that will be placed in the registry location"
}
}
},
"RegistryAdapterType": {
"type": "string",
"description": "Type of the registry adapter.",
"enum": [
"Binary",
"String",
"Expand_String",
"Multi_String",
"DWord",
"QWord"
],
"x-ms-enum": {
"name": "RegistryAdapterType",
"modelAsString": true,
"values": [
{
"name": "Binary",
"value": "Binary"
},
{
"name": "String",
"value": "String"
},
{
"name": "Expand_String",
"value": "Expand_String"
},
{
"name": "Multi_String",
"value": "Multi_String"
},
{
"name": "DWord",
"value": "DWord"
},
{
"name": "QWord",
"value": "QWord"
}
]
}
},
"RelayServiceConnectionEntity": {
"type": "object",
"description": "Hybrid Connection for an App Service app.",
"properties": {
"properties": {
"$ref": "#/definitions/RelayServiceConnectionEntityProperties",
"description": "RelayServiceConnectionEntity resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"RelayServiceConnectionEntityProperties": {
"type": "object",
"description": "RelayServiceConnectionEntity resource specific properties",
"properties": {
"entityName": {
"type": "string"
},
"entityConnectionString": {
"type": "string"
},
"resourceType": {
"type": "string"
},
"resourceConnectionString": {
"type": "string"
},
"hostname": {
"type": "string"
},
"port": {
"type": "integer",
"format": "int32"
},
"biztalkUri": {
"type": "string"
}
}
},
"RemotePrivateEndpointConnection": {
"type": "object",
"description": "A remote private endpoint connection",
"properties": {
"properties": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionProperties",
"description": "RemotePrivateEndpointConnection resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"RemotePrivateEndpointConnectionARMResource": {
"type": "object",
"description": "Remote Private Endpoint Connection ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/RemotePrivateEndpointConnectionARMResourceProperties",
"description": "RemotePrivateEndpointConnectionARMResource resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"RemotePrivateEndpointConnectionARMResourceProperties": {
"type": "object",
"description": "RemotePrivateEndpointConnectionARMResource resource specific properties",
"properties": {
"provisioningState": {
"type": "string",
"readOnly": true
},
"privateEndpoint": {
"$ref": "#/definitions/ArmIdWrapper",
"description": "PrivateEndpoint of a remote private endpoint connection"
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkConnectionState",
"description": "The state of a private link connection"
},
"ipAddresses": {
"type": "array",
"description": "Private IPAddresses mapped to the remote private endpoint",
"items": {
"type": "string"
}
}
}
},
"RemotePrivateEndpointConnectionProperties": {
"type": "object",
"description": "RemotePrivateEndpointConnection resource specific properties",
"properties": {
"provisioningState": {
"type": "string",
"readOnly": true
},
"privateEndpoint": {
"$ref": "#/definitions/ArmIdWrapper",
"description": "PrivateEndpoint of a remote private endpoint connection"
},
"privateLinkServiceConnectionState": {
"$ref": "#/definitions/PrivateLinkConnectionState",
"description": "The state of a private link connection"
},
"ipAddresses": {
"type": "array",
"description": "Private IPAddresses mapped to the remote private endpoint",
"items": {
"type": "string"
}
}
}
},
"Rendering": {
"type": "object",
"description": "Instructions for rendering the data",
"properties": {
"type": {
"$ref": "#/definitions/RenderingType",
"description": "Rendering Type"
},
"title": {
"type": "string",
"description": "Title of data"
},
"description": {
"type": "string",
"description": "Description of the data that will help it be interpreted"
}
}
},
"RenderingType": {
"type": "string",
"description": "Rendering Type",
"enum": [
"NoGraph",
"Table",
"TimeSeries",
"TimeSeriesPerInstance",
"PieChart",
"DataSummary",
"Email",
"Insights",
"DynamicInsight",
"Markdown",
"Detector",
"DropDown",
"Card",
"Solution",
"Guage",
"Form",
"ChangeSets",
"ChangeAnalysisOnboarding",
"ChangesView",
"AppInsight",
"DependencyGraph",
"DownTime",
"SummaryCard",
"SearchComponent",
"AppInsightEnablement"
],
"x-ms-enum": {
"name": "RenderingType",
"modelAsString": false
}
},
"RepetitionIndex": {
"type": "object",
"description": "The workflow run action repetition index.",
"properties": {
"scopeName": {
"type": "string",
"description": "The scope."
},
"itemIndex": {
"type": "integer",
"format": "int32",
"description": "The index."
}
},
"required": [
"itemIndex"
]
},
"Request": {
"type": "object",
"description": "A request.",
"properties": {
"headers": {
"description": "A list of all the headers attached to the request."
},
"uri": {
"type": "string",
"description": "The destination for the request."
},
"method": {
"type": "string",
"description": "The HTTP method used for the request."
}
}
},
"RequestHistory": {
"type": "object",
"description": "The request history.",
"properties": {
"properties": {
"$ref": "#/definitions/RequestHistoryProperties",
"description": "The request history properties."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"RequestHistoryListResult": {
"type": "object",
"description": "The response of a RequestHistory list operation.",
"properties": {
"value": {
"type": "array",
"description": "The RequestHistory items on this page",
"items": {
"$ref": "#/definitions/RequestHistory"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"RequestHistoryProperties": {
"type": "object",
"description": "The request history.",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "The time the request started."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "The time the request ended."
},
"request": {
"$ref": "#/definitions/Request",
"description": "The request."
},
"response": {
"$ref": "#/definitions/Response",
"description": "The response."
}
}
},
"RequestsBasedTrigger": {
"type": "object",
"description": "Trigger based on total requests.",
"properties": {
"count": {
"type": "integer",
"format": "int32",
"description": "Request Count."
},
"timeInterval": {
"type": "string",
"description": "Time interval."
}
}
},
"ResolveStatus": {
"type": "string",
"enum": [
"Initialized",
"Resolved",
"InvalidSyntax",
"MSINotEnabled",
"VaultNotFound",
"SecretNotFound",
"SecretVersionNotFound",
"AccessToKeyVaultDenied",
"OtherReasons",
"FetchTimedOut",
"UnauthorizedClient"
],
"x-ms-enum": {
"name": "ResolveStatus",
"modelAsString": false
}
},
"ResourceCollection": {
"type": "object",
"description": "Collection of resources.",
"properties": {
"value": {
"type": "array",
"description": "Collection of resources.",
"items": {
"type": "string"
}
},
"nextLink": {
"type": "string",
"description": "Link to next page of resources."
}
},
"required": [
"value"
]
},
"ResourceConfig": {
"type": "object",
"description": "Function app resource requirements.",
"properties": {
"cpu": {
"type": "number",
"format": "double",
"description": "Required CPU in cores, e.g. 0.5"
},
"memory": {
"type": "string",
"description": "Required memory, e.g. \"1Gi\""
}
}
},
"ResourceHealthMetadata": {
"type": "object",
"description": "Used for getting ResourceHealthCheck settings.",
"properties": {
"properties": {
"$ref": "#/definitions/ResourceHealthMetadataProperties",
"description": "ResourceHealthMetadata resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"ResourceHealthMetadataCollection": {
"type": "object",
"description": "Collection of resource health metadata.",
"properties": {
"value": {
"type": "array",
"description": "The ResourceHealthMetadata items on this page",
"items": {
"$ref": "#/definitions/ResourceHealthMetadata"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ResourceHealthMetadataProperties": {
"type": "object",
"description": "ResourceHealthMetadata resource specific properties",
"properties": {
"category": {
"type": "string",
"description": "The category that the resource matches in the RHC Policy File"
},
"signalAvailability": {
"type": "boolean",
"description": "Is there a health signal for the resource"
}
}
},
"ResourceMetricAvailability": {
"type": "object",
"description": "Metrics availability and retention.",
"properties": {
"timeGrain": {
"type": "string",
"description": "Time grain .",
"readOnly": true
},
"retention": {
"type": "string",
"description": "Retention period for the current time grain.",
"readOnly": true
}
}
},
"ResourceMetricDefinition": {
"type": "object",
"description": "Metadata for the metrics.",
"properties": {
"properties": {
"$ref": "#/definitions/ResourceMetricDefinitionProperties",
"description": "ResourceMetricDefinition resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"ResourceMetricDefinitionCollection": {
"type": "object",
"description": "Collection of metric definitions.",
"properties": {
"value": {
"type": "array",
"description": "The ResourceMetricDefinition items on this page",
"items": {
"$ref": "#/definitions/ResourceMetricDefinition"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"ResourceMetricDefinitionProperties": {
"type": "object",
"description": "ResourceMetricDefinition resource specific properties",
"properties": {
"unit": {
"type": "string",
"description": "Unit of the metric.",
"readOnly": true
},
"primaryAggregationType": {
"type": "string",
"description": "Primary aggregation type.",
"readOnly": true
},
"metricAvailabilities": {
"type": "array",
"description": "List of time grains supported for the metric together with retention period.",
"items": {
"$ref": "#/definitions/ResourceMetricAvailability"
},
"readOnly": true,
"x-ms-identifiers": []
},
"resourceUri": {
"type": "string",
"description": "Resource URI.",
"readOnly": true
},
"properties": {
"type": "object",
"description": "Resource metric definition properties.",
"additionalProperties": {
"type": "string"
},
"readOnly": true
}
}
},
"ResourceNameAvailability": {
"type": "object",
"description": "Information regarding availability of a resource name.",
"properties": {
"nameAvailable": {
"type": "boolean",
"description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both."
},
"reason": {
"$ref": "#/definitions/InAvailabilityReasonType",
"description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable."
},
"message": {
"type": "string",
"description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name."
}
}
},
"ResourceNameAvailabilityRequest": {
"type": "object",
"description": "Resource name availability request content.",
"properties": {
"name": {
"type": "string",
"description": "Resource name to verify."
},
"type": {
"$ref": "#/definitions/CheckNameResourceTypes",
"description": "Resource type used for verification."
},
"isFqdn": {
"type": "boolean",
"description": "Is fully qualified domain name."
},
"environmentId": {
"type": "string",
"description": "Azure Resource Manager ID of the customer's selected Container Apps Environment on which to host the Function app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}"
}
},
"required": [
"name",
"type"
]
},
"ResourceReference": {
"type": "object",
"description": "The resource reference.",
"properties": {
"id": {
"type": "string",
"description": "The resource id."
},
"name": {
"type": "string",
"description": "Gets the resource name.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Gets the resource type.",
"readOnly": true
}
}
},
"ResourceScopeType": {
"type": "string",
"description": "Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.",
"enum": [
"ServerFarm",
"Subscription",
"WebSite"
],
"x-ms-enum": {
"name": "ResourceScopeType",
"modelAsString": true,
"values": [
{
"name": "ServerFarm",
"value": "ServerFarm"
},
{
"name": "Subscription",
"value": "Subscription"
},
{
"name": "WebSite",
"value": "WebSite"
}
]
}
},
"Response": {
"type": "object",
"description": "A response.",
"properties": {
"headers": {
"description": "A list of all the headers attached to the response."
},
"statusCode": {
"type": "integer",
"format": "int32",
"description": "The status code of the response."
},
"bodyLink": {
"$ref": "#/definitions/ContentLink",
"description": "Details on the location of the body content."
}
}
},
"ResponseMessageEnvelopeRemotePrivateEndpointConnection": {
"type": "object",
"description": "Message envelope that contains the common Azure resource manager properties and the resource provider specific content.",
"properties": {
"id": {
"type": "string",
"description": "Resource Id. Typically ID is populated only for responses to GET requests. Caller is responsible for passing in this\nvalue for GET requests only.\nFor example: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupId}/providers/Microsoft.Web/sites/{sitename}"
},
"name": {
"type": "string",
"description": "Name of resource."
},
"type": {
"type": "string",
"description": "Type of resource e.g \"Microsoft.Web/sites\"."
},
"location": {
"type": "string",
"description": "Geographical region resource belongs to e.g. SouthCentralUS, SouthEastAsia."
},
"tags": {
"type": "object",
"description": "Tags associated with resource.",
"additionalProperties": {
"type": "string"
}
},
"plan": {
"$ref": "#/definitions/ArmPlan",
"description": "Azure resource manager plan."
},
"properties": {
"$ref": "#/definitions/RemotePrivateEndpointConnection",
"description": "Resource specific properties."
},
"sku": {
"$ref": "#/definitions/SkuDescription",
"description": "SKU description of the resource."
},
"status": {
"type": "string",
"description": "Azure-AsyncOperation Status info."
},
"error": {
"$ref": "#/definitions/ErrorEntity",
"description": "Azure-AsyncOperation Error info."
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "MSI resource"
},
"zones": {
"type": "array",
"description": "Logical Availability Zones the service is hosted in",
"items": {
"type": "string"
}
}
}
},
"ResponseMetaData": {
"type": "object",
"properties": {
"dataSource": {
"$ref": "#/definitions/DataSource",
"description": "Source of the Data"
}
}
},
"RestoreRequest": {
"type": "object",
"description": "Description of a restore request.",
"properties": {
"properties": {
"$ref": "#/definitions/RestoreRequestProperties",
"description": "RestoreRequest resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"RestoreRequestProperties": {
"type": "object",
"description": "RestoreRequest resource specific properties",
"properties": {
"storageAccountUrl": {
"type": "string",
"description": "SAS URL to the container."
},
"blobName": {
"type": "string",
"description": "Name of a blob which contains the backup."
},
"overwrite": {
"type": "boolean",
"description": "true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app."
},
"siteName": {
"type": "string",
"description": "Name of an app."
},
"databases": {
"type": "array",
"description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.",
"items": {
"$ref": "#/definitions/DatabaseBackupSetting"
},
"x-ms-identifiers": [
"name"
]
},
"ignoreConflictingHostNames": {
"type": "boolean",
"description": "Changes a logic when restoring an app with custom domains. true to remove custom domains automatically. If false, custom domains are added to \\nthe app's object when it is being restored, but that might fail due to conflicts during the operation.",
"default": false
},
"ignoreDatabases": {
"type": "boolean",
"description": "Ignore the databases and only restore the site content",
"default": false
},
"appServicePlan": {
"type": "string",
"description": "Specify app service plan that will own restored site."
},
"operationType": {
"type": "string",
"description": "Operation type.",
"default": "Default",
"enum": [
"Default",
"Clone",
"Relocation",
"Snapshot",
"CloudFS"
],
"x-ms-enum": {
"name": "BackupRestoreOperationType",
"modelAsString": false
}
},
"adjustConnectionStrings": {
"type": "boolean",
"description": "true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false."
},
"hostingEnvironment": {
"type": "string",
"description": "App Service Environment name, if needed (only when restoring an app to an App Service Environment)."
}
},
"required": [
"storageAccountUrl",
"overwrite"
]
},
"RetryHistory": {
"type": "object",
"description": "The retry history.",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Gets the start time."
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Gets the end time."
},
"code": {
"type": "string",
"description": "Gets the status code."
},
"clientRequestId": {
"type": "string",
"description": "Gets the client request Id."
},
"serviceRequestId": {
"type": "string",
"description": "Gets the service request Id."
},
"error": {
"$ref": "#/definitions/ErrorResponse",
"description": "Gets the error response."
}
}
},
"RouteType": {
"type": "string",
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network.",
"enum": [
"DEFAULT",
"INHERITED",
"STATIC"
],
"x-ms-enum": {
"name": "RouteType",
"modelAsString": true,
"values": [
{
"name": "DEFAULT",
"value": "DEFAULT"
},
{
"name": "INHERITED",
"value": "INHERITED"
},
{
"name": "STATIC",
"value": "STATIC"
}
]
}
},
"RunActionCorrelation": {
"type": "object",
"description": "The workflow run action correlation properties.",
"properties": {
"actionTrackingId": {
"type": "string",
"description": "The action tracking identifier."
}
},
"allOf": [
{
"$ref": "#/definitions/RunCorrelation"
}
]
},
"RunCorrelation": {
"type": "object",
"description": "The correlation properties.",
"properties": {
"clientTrackingId": {
"type": "string",
"description": "The client tracking identifier."
},
"clientKeywords": {
"type": "array",
"description": "The client keywords.",
"items": {
"type": "string"
}
}
}
},
"RuntimeName": {
"type": "string",
"description": "Function app runtime name. Available options: dotnet-isolated, node, java, powershell, python, custom",
"enum": [
"dotnet-isolated",
"node",
"java",
"powershell",
"python",
"custom"
],
"x-ms-enum": {
"name": "RuntimeName",
"modelAsString": true,
"values": [
{
"name": "dotnet-isolated",
"value": "dotnet-isolated"
},
{
"name": "node",
"value": "node"
},
{
"name": "java",
"value": "java"
},
{
"name": "powershell",
"value": "powershell"
},
{
"name": "python",
"value": "python"
},
{
"name": "custom",
"value": "custom"
}
]
}
},
"SampleUtterance": {
"type": "object",
"description": "Sample utterance.",
"properties": {
"text": {
"type": "string",
"description": "Text attribute of sample utterance."
},
"links": {
"type": "array",
"description": "Links attribute of sample utterance.",
"items": {
"type": "string"
}
},
"qid": {
"type": "string",
"description": "Question id of sample utterance (for stackoverflow questions titles)."
}
}
},
"ScmType": {
"type": "string",
"description": "SCM type.",
"enum": [
"None",
"Dropbox",
"Tfs",
"LocalGit",
"GitHub",
"CodePlexGit",
"CodePlexHg",
"BitbucketGit",
"BitbucketHg",
"ExternalGit",
"ExternalHg",
"OneDrive",
"VSO",
"VSTSRM"
],
"x-ms-enum": {
"name": "ScmType",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None"
},
{
"name": "Dropbox",
"value": "Dropbox"
},
{
"name": "Tfs",
"value": "Tfs"
},
{
"name": "LocalGit",
"value": "LocalGit"
},
{
"name": "GitHub",
"value": "GitHub"
},
{
"name": "CodePlexGit",
"value": "CodePlexGit"
},
{
"name": "CodePlexHg",
"value": "CodePlexHg"
},
{
"name": "BitbucketGit",
"value": "BitbucketGit"
},
{
"name": "BitbucketHg",
"value": "BitbucketHg"
},
{
"name": "ExternalGit",
"value": "ExternalGit"
},
{
"name": "ExternalHg",
"value": "ExternalHg"
},
{
"name": "OneDrive",
"value": "OneDrive"
},
{
"name": "VSO",
"value": "VSO"
},
{
"name": "VSTSRM",
"value": "VSTSRM"
}
]
}
},
"ServerFarmInstance": {
"type": "object",
"description": "Represents details of a single instance in a server farm.",
"properties": {
"instanceName": {
"type": "string",
"description": "The instance name.",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-zA-Z0-9]+$"
},
"ipAddress": {
"type": "string",
"description": "The instance IP address."
},
"status": {
"type": "string",
"description": "The instance status."
}
}
},
"ServerFarmInstanceDetails": {
"type": "object",
"description": "Represents instance details for an app service plan.",
"properties": {
"serverFarmName": {
"type": "string",
"description": "The server farm name."
},
"instances": {
"type": "array",
"description": "The list of server farm instances.",
"items": {
"$ref": "#/definitions/ServerFarmInstance"
},
"x-ms-identifiers": []
},
"instanceCount": {
"type": "integer",
"format": "int32",
"description": "The total number of instances."
}
}
},
"ServerFarmNetworkSettings": {
"type": "object",
"description": "Network settings for an app service plan.",
"properties": {
"virtualNetworkSubnetId": {
"type": "string",
"description": "Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration. This must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"
}
}
},
"ServerFarmRdpDetails": {
"type": "object",
"description": "Server Farm RDP connection details.",
"properties": {
"rdpPassword": {
"type": "string",
"format": "password",
"description": "The RDP password for the server farm.",
"x-ms-secret": true
},
"rdpPasswordExpiry": {
"type": "string",
"format": "date-time",
"description": "The RDP password expiry date."
}
}
},
"ServiceSpecification": {
"type": "object",
"description": "Resource metrics service provided by Microsoft.Insights resource provider.",
"properties": {
"metricSpecifications": {
"type": "array",
"items": {
"$ref": "#/definitions/MetricSpecification"
},
"x-ms-identifiers": [
"name"
]
},
"logSpecifications": {
"type": "array",
"items": {
"$ref": "#/definitions/LogSpecification"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"Site": {
"type": "object",
"description": "A web app, a mobile app backend, or an API app.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteProperties",
"description": "Site resource specific properties",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
},
"extendedLocation": {
"$ref": "#/definitions/ExtendedLocation",
"description": "Extended Location."
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"SiteAuthSettings": {
"type": "object",
"description": "Configuration settings for the Azure App Service Authentication / Authorization feature.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteAuthSettingsProperties",
"description": "SiteAuthSettings resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SiteAuthSettingsProperties": {
"type": "object",
"description": "SiteAuthSettings resource specific properties",
"properties": {
"enabled": {
"type": "boolean",
"description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false."
},
"runtimeVersion": {
"type": "string",
"description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module."
},
"unauthenticatedClientAction": {
"$ref": "#/definitions/UnauthenticatedClientAction",
"description": "The action to take when an unauthenticated client attempts to access the app."
},
"tokenStoreEnabled": {
"type": "boolean",
"description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\nThe default is false."
},
"allowedExternalRedirectUrls": {
"type": "array",
"description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.",
"items": {
"type": "string"
}
},
"defaultProvider": {
"$ref": "#/definitions/BuiltInAuthenticationProvider",
"description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\"."
},
"tokenRefreshExtensionHours": {
"type": "number",
"format": "double",
"description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."
},
"clientId": {
"type": "string",
"description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or\nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"
},
"clientSecret": {
"type": "string",
"description": "The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html"
},
"clientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret of the relying party application."
},
"clientSecretCertificateThumbprint": {
"type": "string",
"description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional."
},
"issuer": {
"type": "string",
"description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. `https://sts.windows.net/{tenant-guid}/`.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html"
},
"validateIssuer": {
"type": "boolean",
"description": "Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such."
},
"allowedAudiences": {
"type": "array",
"description": "Allowed audience values to consider when validating JSON Web Tokens issued by\nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting.",
"items": {
"type": "string"
}
},
"additionalLoginParams": {
"type": "array",
"description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".",
"items": {
"type": "string"
}
},
"aadClaimsAuthorization": {
"type": "string",
"description": "Gets a JSON string containing the Azure AD Acl settings."
},
"googleClientId": {
"type": "string",
"description": "The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"
},
"googleClientSecret": {
"type": "string",
"description": "The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/"
},
"googleClientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret associated with\nthe Google web application."
},
"googleOAuthScopes": {
"type": "array",
"description": "The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
"items": {
"type": "string"
}
},
"facebookAppId": {
"type": "string",
"description": "The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"
},
"facebookAppSecret": {
"type": "string",
"description": "The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login"
},
"facebookAppSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the app secret used for Facebook Login."
},
"facebookOAuthScopes": {
"type": "array",
"description": "The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
"items": {
"type": "string"
}
},
"gitHubClientId": {
"type": "string",
"description": "The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login"
},
"gitHubClientSecret": {
"type": "string",
"description": "The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login."
},
"gitHubClientSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the client secret of the Github\napp used for GitHub Login."
},
"gitHubOAuthScopes": {
"type": "array",
"description": "The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional",
"items": {
"type": "string"
}
},
"twitterConsumerKey": {
"type": "string",
"description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"
},
"twitterConsumerSecret": {
"type": "string",
"description": "The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"
},
"twitterConsumerSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."
},
"microsoftAccountClientId": {
"type": "string",
"description": "The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"
},
"microsoftAccountClientSecret": {
"type": "string",
"description": "The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm"
},
"microsoftAccountClientSecretSettingName": {
"type": "string",
"description": "The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication."
},
"microsoftAccountOAuthScopes": {
"type": "array",
"description": "The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx",
"items": {
"type": "string"
}
},
"isAuthFromFile": {
"type": "string",
"description": "\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise"
},
"authFilePath": {
"type": "string",
"description": "The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory."
},
"configVersion": {
"type": "string",
"description": "The ConfigVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of the control plane for Authentication / Authorization."
}
}
},
"SiteAuthSettingsV2": {
"type": "object",
"description": "Configuration settings for the Azure App Service Authentication / Authorization V2 feature.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteAuthSettingsV2Properties",
"description": "SiteAuthSettingsV2 resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SiteAuthSettingsV2Properties": {
"type": "object",
"description": "SiteAuthSettingsV2 resource specific properties",
"properties": {
"platform": {
"$ref": "#/definitions/AuthPlatform",
"description": "The configuration settings of the platform of App Service Authentication/Authorization."
},
"globalValidation": {
"$ref": "#/definitions/GlobalValidation",
"description": "The configuration settings that determines the validation flow of users using App Service Authentication/Authorization."
},
"identityProviders": {
"$ref": "#/definitions/IdentityProviders",
"description": "The configuration settings of each of the identity providers used to configure App Service Authentication/Authorization."
},
"login": {
"$ref": "#/definitions/Login",
"description": "The configuration settings of the login flow of users using App Service Authentication/Authorization."
},
"httpSettings": {
"$ref": "#/definitions/HttpSettings",
"description": "The configuration settings of the HTTP requests for authentication and authorization requests made against App Service Authentication/Authorization."
}
}
},
"SiteAvailabilityState": {
"type": "string",
"description": "Management information availability state for the app.",
"enum": [
"Normal",
"Limited",
"DisasterRecoveryMode"
],
"x-ms-enum": {
"name": "SiteAvailabilityState",
"modelAsString": false
}
},
"SiteCloneability": {
"type": "object",
"description": "Represents whether or not an app is cloneable.",
"properties": {
"result": {
"$ref": "#/definitions/CloneAbilityResult",
"description": "Name of app."
},
"blockingFeatures": {
"type": "array",
"description": "List of features enabled on app that prevent cloning.",
"items": {
"$ref": "#/definitions/SiteCloneabilityCriterion"
},
"x-ms-identifiers": [
"name"
]
},
"unsupportedFeatures": {
"type": "array",
"description": "List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned\nbut the features in this list will not be set up on cloned app.",
"items": {
"$ref": "#/definitions/SiteCloneabilityCriterion"
},
"x-ms-identifiers": [
"name"
]
},
"blockingCharacteristics": {
"type": "array",
"description": "List of blocking application characteristics.",
"items": {
"$ref": "#/definitions/SiteCloneabilityCriterion"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"SiteCloneabilityCriterion": {
"type": "object",
"description": "An app cloneability criterion.",
"properties": {
"name": {
"type": "string",
"description": "Name of criterion."
},
"description": {
"type": "string",
"description": "Description of criterion."
}
}
},
"SiteConfig": {
"type": "object",
"description": "Configuration of an App Service app.",
"properties": {
"numberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "Number of workers."
},
"defaultDocuments": {
"type": "array",
"description": "Default documents.",
"items": {
"type": "string"
}
},
"netFrameworkVersion": {
"type": "string",
"description": ".NET Framework version.",
"default": "v4.6"
},
"phpVersion": {
"type": "string",
"description": "Version of PHP."
},
"pythonVersion": {
"type": "string",
"description": "Version of Python."
},
"nodeVersion": {
"type": "string",
"description": "Version of Node.js."
},
"powerShellVersion": {
"type": "string",
"description": "Version of PowerShell."
},
"linuxFxVersion": {
"type": "string",
"description": "Linux App Framework and version"
},
"windowsFxVersion": {
"type": "string",
"description": "Xenon App Framework and version"
},
"requestTracingEnabled": {
"type": "boolean",
"description": "true if request tracing is enabled; otherwise, false."
},
"requestTracingExpirationTime": {
"type": "string",
"format": "date-time",
"description": "Request tracing expiration time."
},
"remoteDebuggingEnabled": {
"type": "boolean",
"description": "true if remote debugging is enabled; otherwise, false."
},
"remoteDebuggingVersion": {
"type": "string",
"description": "Remote debugging version."
},
"httpLoggingEnabled": {
"type": "boolean",
"description": "true if HTTP logging is enabled; otherwise, false."
},
"acrUseManagedIdentityCreds": {
"type": "boolean",
"description": "Flag to use Managed Identity Creds for ACR pull"
},
"acrUserManagedIdentityID": {
"type": "string",
"description": "If using user managed identity, the user managed identity ClientId"
},
"logsDirectorySizeLimit": {
"type": "integer",
"format": "int32",
"description": "HTTP logs directory size limit."
},
"detailedErrorLoggingEnabled": {
"type": "boolean",
"description": "true if detailed error logging is enabled; otherwise, false."
},
"publishingUsername": {
"type": "string",
"description": "Publishing user name."
},
"appSettings": {
"type": "array",
"description": "Application settings. This property is not returned in response to normal create and read requests since it may contain sensitive information.",
"items": {
"$ref": "#/definitions/NameValuePair"
},
"x-ms-identifiers": [
"name"
],
"x-ms-mutability": [
"update",
"create"
]
},
"metadata": {
"type": "array",
"description": "Application metadata. This property cannot be retrieved, since it may contain secrets.",
"items": {
"$ref": "#/definitions/NameValuePair"
},
"x-ms-identifiers": [
"name"
],
"x-ms-mutability": [
"update",
"create"
]
},
"connectionStrings": {
"type": "array",
"description": "Connection strings. This property is not returned in response to normal create and read requests since it may contain sensitive information.",
"items": {
"$ref": "#/definitions/ConnStringInfo"
},
"x-ms-identifiers": [
"name"
],
"x-ms-mutability": [
"update",
"create"
]
},
"machineKey": {
"$ref": "#/definitions/SiteMachineKey",
"description": "Site MachineKey.",
"readOnly": true
},
"handlerMappings": {
"type": "array",
"description": "Handler mappings.",
"items": {
"$ref": "#/definitions/HandlerMapping"
},
"x-ms-identifiers": [
"extension"
]
},
"documentRoot": {
"type": "string",
"description": "Document root."
},
"scmType": {
"$ref": "#/definitions/ScmType",
"description": "SCM type."
},
"use32BitWorkerProcess": {
"type": "boolean",
"description": "true to use 32-bit worker process; otherwise, false."
},
"webSocketsEnabled": {
"type": "boolean",
"description": "true if WebSocket is enabled; otherwise, false."
},
"alwaysOn": {
"type": "boolean",
"description": "true if Always On is enabled; otherwise, false."
},
"javaVersion": {
"type": "string",
"description": "Java version."
},
"javaContainer": {
"type": "string",
"description": "Java container."
},
"javaContainerVersion": {
"type": "string",
"description": "Java container version."
},
"appCommandLine": {
"type": "string",
"description": "App command line to launch."
},
"managedPipelineMode": {
"$ref": "#/definitions/ManagedPipelineMode",
"description": "Managed pipeline mode."
},
"virtualApplications": {
"type": "array",
"description": "Virtual applications.",
"items": {
"$ref": "#/definitions/VirtualApplication"
},
"x-ms-identifiers": [
"virtualPath"
]
},
"loadBalancing": {
"$ref": "#/definitions/SiteLoadBalancing",
"description": "Site load balancing."
},
"experiments": {
"$ref": "#/definitions/Experiments",
"description": "This is work around for polymorphic types."
},
"limits": {
"$ref": "#/definitions/SiteLimits",
"description": "Site limits."
},
"autoHealEnabled": {
"type": "boolean",
"description": "true if Auto Heal is enabled; otherwise, false."
},
"autoHealRules": {
"$ref": "#/definitions/AutoHealRules",
"description": "Auto Heal rules."
},
"tracingOptions": {
"type": "string",
"description": "Tracing options."
},
"vnetName": {
"type": "string",
"description": "Virtual Network name.",
"x-ms-mutability": [
"read",
"create"
]
},
"vnetRouteAllEnabled": {
"type": "boolean",
"description": "Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied."
},
"vnetPrivatePortsCount": {
"type": "integer",
"format": "int32",
"description": "The number of private ports assigned to this app. These will be assigned dynamically on runtime."
},
"cors": {
"$ref": "#/definitions/CorsSettings",
"description": "Cross-Origin Resource Sharing (CORS) settings."
},
"push": {
"$ref": "#/definitions/PushSettings",
"description": "Push endpoint settings."
},
"apiDefinition": {
"$ref": "#/definitions/ApiDefinitionInfo",
"description": "Information about the formal API definition for the app."
},
"apiManagementConfig": {
"$ref": "#/definitions/ApiManagementConfig",
"description": "Azure API management settings linked to the app."
},
"autoSwapSlotName": {
"type": "string",
"description": "Auto-swap slot name."
},
"localMySqlEnabled": {
"type": "boolean",
"description": "true to enable local MySQL; otherwise, false.",
"default": false
},
"managedServiceIdentityId": {
"type": "integer",
"format": "int32",
"description": "Managed Service Identity Id"
},
"xManagedServiceIdentityId": {
"type": "integer",
"format": "int32",
"description": "Explicit Managed Service Identity Id"
},
"keyVaultReferenceIdentity": {
"type": "string",
"description": "Identity to use for Key Vault Reference authentication."
},
"ipSecurityRestrictions": {
"type": "array",
"description": "IP security restrictions for main.",
"items": {
"$ref": "#/definitions/IpSecurityRestriction"
},
"x-ms-identifiers": [
"name"
]
},
"ipSecurityRestrictionsDefaultAction": {
"$ref": "#/definitions/DefaultAction",
"description": "Default action for main access restriction if no rules are matched."
},
"scmIpSecurityRestrictions": {
"type": "array",
"description": "IP security restrictions for scm.",
"items": {
"$ref": "#/definitions/IpSecurityRestriction"
},
"x-ms-identifiers": [
"name"
]
},
"scmIpSecurityRestrictionsDefaultAction": {
"$ref": "#/definitions/DefaultAction",
"description": "Default action for scm access restriction if no rules are matched."
},
"scmIpSecurityRestrictionsUseMain": {
"type": "boolean",
"description": "IP security restrictions for scm to use main."
},
"http20Enabled": {
"type": "boolean",
"description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
"default": true
},
"http20ProxyFlag": {
"type": "integer",
"format": "int32",
"description": "Http20ProxyFlag: Configures a website to allow http2.0 to pass be proxied all the way to the app. 0 = disabled, 1 = pass through all http2 traffic, 2 = pass through gRPC only.",
"default": 0
},
"minTlsVersion": {
"$ref": "#/definitions/SupportedTlsVersions",
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests"
},
"minTlsCipherSuite": {
"$ref": "#/definitions/TlsCipherSuites",
"description": "The minimum strength TLS cipher suite allowed for an application"
},
"scmMinTlsVersion": {
"$ref": "#/definitions/SupportedTlsVersions",
"description": "ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site"
},
"ftpsState": {
"$ref": "#/definitions/FtpsState",
"description": "State of FTP / FTPS service"
},
"preWarmedInstanceCount": {
"type": "integer",
"format": "int32",
"description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
"minimum": 0,
"maximum": 10
},
"functionAppScaleLimit": {
"type": "integer",
"format": "int32",
"description": "Maximum number of workers that a site can scale out to.\nThis setting only applies to the Consumption and Elastic Premium Plans",
"minimum": 0
},
"elasticWebAppScaleLimit": {
"type": "integer",
"format": "int32",
"description": "Maximum number of workers that a site can scale out to.\nThis setting only applies to apps in plans where ElasticScaleEnabled is true",
"minimum": 0
},
"healthCheckPath": {
"type": "string",
"description": "Health check path"
},
"functionsRuntimeScaleMonitoringEnabled": {
"type": "boolean",
"description": "Gets or sets a value indicating whether functions runtime scale monitoring is enabled. When enabled,\nthe ScaleController will not monitor event sources directly, but will instead call to the\nruntime to get scale status."
},
"websiteTimeZone": {
"type": "string",
"description": "Sets the time zone a site uses for generating timestamps. Compatible with Linux and Windows App Service. Setting the WEBSITE_TIME_ZONE app setting takes precedence over this config. For Linux, expects tz database values https://www.iana.org/time-zones (for a quick reference see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). For Windows, expects one of the time zones listed under HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\Windows NT\\CurrentVersion\\Time Zones"
},
"minimumElasticInstanceCount": {
"type": "integer",
"format": "int32",
"description": "Number of minimum instance count for a site\nThis setting only applies to the Elastic Plans",
"minimum": 0,
"maximum": 20
},
"azureStorageAccounts": {
"type": "object",
"description": "List of Azure Storage Accounts.",
"additionalProperties": {
"$ref": "#/definitions/AzureStorageInfoValue"
}
},
"publicNetworkAccess": {
"type": "string",
"description": "Property to allow or block all public traffic."
}
}
},
"SiteConfigPropertiesDictionary": {
"type": "object",
"description": "Site config properties dictionary.",
"properties": {
"use32BitWorkerProcess": {
"type": "boolean",
"description": "true if use32BitWorkerProcess should be set to true for the stack; otherwise, false.",
"readOnly": true
},
"linuxFxVersion": {
"type": "string",
"description": "LinuxFxVersion configuration setting.",
"readOnly": true
},
"javaVersion": {
"type": "string",
"description": "JavaVersion configuration setting.",
"readOnly": true
},
"powerShellVersion": {
"type": "string",
"description": "PowerShellVersion configuration setting.",
"readOnly": true
}
}
},
"SiteConfigResource": {
"type": "object",
"description": "Web app configuration ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteConfig",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SiteConfigResourceCollection": {
"type": "object",
"description": "Collection of site configurations.",
"properties": {
"value": {
"type": "array",
"description": "The SiteConfigResource items on this page",
"items": {
"$ref": "#/definitions/SiteConfigResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SiteConfigurationSnapshotInfo": {
"type": "object",
"description": "A snapshot of a web app configuration.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfoProperties",
"description": "SiteConfigurationSnapshotInfo resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SiteConfigurationSnapshotInfoCollection": {
"type": "object",
"description": "Collection of metadata for the app configuration snapshots that can be restored.",
"properties": {
"value": {
"type": "array",
"description": "The SiteConfigurationSnapshotInfo items on this page",
"items": {
"$ref": "#/definitions/SiteConfigurationSnapshotInfo"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SiteConfigurationSnapshotInfoProperties": {
"type": "object",
"description": "SiteConfigurationSnapshotInfo resource specific properties",
"properties": {
"time": {
"type": "string",
"format": "date-time",
"description": "The time the snapshot was taken.",
"readOnly": true
},
"snapshotId": {
"type": "integer",
"format": "int32",
"description": "The id of the snapshot",
"readOnly": true
}
}
},
"SiteContainer": {
"type": "object",
"description": "Container of a site",
"properties": {
"properties": {
"$ref": "#/definitions/SiteContainerProperties",
"description": "SiteContainer resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SiteContainerCollection": {
"type": "object",
"description": "Collection of site containers",
"properties": {
"value": {
"type": "array",
"description": "The SiteContainer items on this page",
"items": {
"$ref": "#/definitions/SiteContainer"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SiteContainerProperties": {
"type": "object",
"description": "SiteContainer resource specific properties",
"properties": {
"image": {
"type": "string",
"description": "Image Name"
},
"targetPort": {
"type": "string",
"description": "Target Port"
},
"isMain": {
"type": "boolean",
"description": "true if the container is the main site container; false otherwise."
},
"startUpCommand": {
"type": "string",
"description": "StartUp Command"
},
"authType": {
"$ref": "#/definitions/AuthType",
"description": "Auth Type"
},
"userName": {
"type": "string",
"description": "User Name"
},
"passwordSecret": {
"type": "string",
"description": "Password Secret"
},
"userManagedIdentityClientId": {
"type": "string",
"description": "UserManagedIdentity ClientId"
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Created Time",
"readOnly": true
},
"lastModifiedTime": {
"type": "string",
"format": "date-time",
"description": "Last Modified Time",
"readOnly": true
},
"volumeMounts": {
"type": "array",
"description": "List of volume mounts",
"items": {
"$ref": "#/definitions/VolumeMount"
},
"x-ms-identifiers": []
},
"inheritAppSettingsAndConnectionStrings": {
"type": "boolean",
"description": "true if all AppSettings and ConnectionStrings have to be passed to the container as environment variables; false otherwise."
},
"environmentVariables": {
"type": "array",
"description": "List of environment variables",
"items": {
"$ref": "#/definitions/EnvironmentVariable"
}
}
},
"required": [
"image",
"isMain"
]
},
"SiteDnsConfig": {
"type": "object",
"properties": {
"dnsServers": {
"type": "array",
"description": "List of custom DNS servers to be used by an app for lookups. Maximum 5 dns servers can be set.",
"items": {
"type": "string"
}
},
"dnsAltServer": {
"type": "string",
"description": "Alternate DNS server to be used by apps. This property replicates the WEBSITE_DNS_ALT_SERVER app setting."
},
"dnsRetryAttemptTimeout": {
"type": "integer",
"format": "int32",
"description": "Timeout for a single dns lookup in seconds. Allowed range: 1-30. Default is 3."
},
"dnsRetryAttemptCount": {
"type": "integer",
"format": "int32",
"description": "Total number of retries for dns lookup. Allowed range: 1-5. Default is 3."
},
"dnsMaxCacheTimeout": {
"type": "integer",
"format": "int32",
"description": "Custom time for DNS to be cached in seconds. Allowed range: 0-60. Default is 30 seconds. 0 means caching disabled."
},
"dnsLegacySortOrder": {
"type": "boolean",
"description": "Indicates that sites using Virtual network custom DNS servers are still sorting the list of DNS servers. Read-Only.",
"readOnly": true
}
}
},
"SiteExtensionInfo": {
"type": "object",
"description": "Site Extension Information.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteExtensionInfoProperties",
"description": "SiteExtensionInfo resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SiteExtensionInfoCollection": {
"type": "object",
"description": "Collection of Kudu site extension information elements.",
"properties": {
"value": {
"type": "array",
"description": "The SiteExtensionInfo items on this page",
"items": {
"$ref": "#/definitions/SiteExtensionInfo"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SiteExtensionInfoProperties": {
"type": "object",
"description": "SiteExtensionInfo resource specific properties",
"properties": {
"extension_id": {
"type": "string",
"description": "Site extension ID.",
"x-ms-client-name": "extensionId"
},
"title": {
"type": "string"
},
"extension_type": {
"$ref": "#/definitions/SiteExtensionType",
"description": "Site extension type.",
"x-ms-client-name": "extensionType"
},
"summary": {
"type": "string",
"description": "Summary description."
},
"description": {
"type": "string",
"description": "Detailed description."
},
"version": {
"type": "string",
"description": "Version information."
},
"extension_url": {
"type": "string",
"description": "Extension URL.",
"x-ms-client-name": "extensionUrl"
},
"project_url": {
"type": "string",
"description": "Project URL.",
"x-ms-client-name": "projectUrl"
},
"icon_url": {
"type": "string",
"description": "Icon URL.",
"x-ms-client-name": "iconUrl"
},
"license_url": {
"type": "string",
"description": "License URL.",
"x-ms-client-name": "licenseUrl"
},
"feed_url": {
"type": "string",
"description": "Feed URL.",
"x-ms-client-name": "feedUrl"
},
"authors": {
"type": "array",
"description": "List of authors.",
"items": {
"type": "string"
}
},
"installer_command_line_params": {
"type": "string",
"description": "Installer command line parameters.",
"x-ms-client-name": "installerCommandLineParams"
},
"published_date_time": {
"type": "string",
"format": "date-time",
"description": "Published timestamp.",
"x-ms-client-name": "publishedDateTime"
},
"download_count": {
"type": "integer",
"format": "int32",
"description": "Count of downloads.",
"x-ms-client-name": "downloadCount"
},
"local_is_latest_version": {
"type": "boolean",
"description": "true if the local version is the latest version; false otherwise.",
"x-ms-client-name": "localIsLatestVersion"
},
"local_path": {
"type": "string",
"description": "Local path.",
"x-ms-client-name": "localPath"
},
"installed_date_time": {
"type": "string",
"format": "date-time",
"description": "Installed timestamp.",
"x-ms-client-name": "installedDateTime"
},
"provisioningState": {
"type": "string",
"description": "Provisioning state."
},
"comment": {
"type": "string",
"description": "Site Extension comment."
}
}
},
"SiteExtensionType": {
"type": "string",
"description": "Site extension type.",
"enum": [
"Gallery",
"WebRoot"
],
"x-ms-enum": {
"name": "SiteExtensionType",
"modelAsString": false
}
},
"SiteLimits": {
"type": "object",
"description": "Metric limits set on an app.",
"properties": {
"maxPercentageCpu": {
"type": "number",
"format": "double",
"description": "Maximum allowed CPU usage percentage."
},
"maxMemoryInMb": {
"type": "integer",
"format": "int64",
"description": "Maximum allowed memory usage in MB."
},
"maxDiskSizeInMb": {
"type": "integer",
"format": "int64",
"description": "Maximum allowed disk size usage in MB."
}
}
},
"SiteLoadBalancing": {
"type": "string",
"description": "Site load balancing.",
"enum": [
"WeightedRoundRobin",
"LeastRequests",
"LeastResponseTime",
"WeightedTotalTraffic",
"RequestHash",
"PerSiteRoundRobin",
"LeastRequestsWithTieBreaker"
],
"x-ms-enum": {
"name": "SiteLoadBalancing",
"modelAsString": false
}
},
"SiteLogsConfig": {
"type": "object",
"description": "Configuration of App Service site logs.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteLogsConfigProperties",
"description": "SiteLogsConfig resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SiteLogsConfigProperties": {
"type": "object",
"description": "SiteLogsConfig resource specific properties",
"properties": {
"applicationLogs": {
"$ref": "#/definitions/ApplicationLogsConfig",
"description": "Application logs configuration."
},
"httpLogs": {
"$ref": "#/definitions/HttpLogsConfig",
"description": "HTTP logs configuration."
},
"failedRequestsTracing": {
"$ref": "#/definitions/EnabledConfig",
"description": "Failed requests tracing configuration."
},
"detailedErrorMessages": {
"$ref": "#/definitions/EnabledConfig",
"description": "Detailed error messages configuration."
}
}
},
"SiteMachineKey": {
"type": "object",
"description": "MachineKey of an app.",
"properties": {
"validation": {
"type": "string",
"description": "MachineKey validation."
},
"validationKey": {
"type": "string",
"description": "Validation key."
},
"decryption": {
"type": "string",
"description": "Algorithm used for decryption."
},
"decryptionKey": {
"type": "string",
"description": "Decryption key."
}
}
},
"SitePatchResource": {
"type": "object",
"description": "ARM resource for a site.",
"properties": {
"properties": {
"$ref": "#/definitions/SitePatchResourceProperties",
"description": "SitePatchResource resource specific properties",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SitePatchResourceProperties": {
"type": "object",
"description": "SitePatchResource resource specific properties",
"properties": {
"state": {
"type": "string",
"description": "Current state of the app.",
"readOnly": true
},
"hostNames": {
"type": "array",
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true
},
"repositorySiteName": {
"type": "string",
"description": "Name of the repository site.",
"readOnly": true
},
"usageState": {
"$ref": "#/definitions/UsageState",
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"readOnly": true
},
"enabled": {
"type": "boolean",
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."
},
"enabledHostNames": {
"type": "array",
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true
},
"availabilityState": {
"$ref": "#/definitions/SiteAvailabilityState",
"description": "Management information availability state for the app.",
"readOnly": true
},
"hostNameSslStates": {
"type": "array",
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"$ref": "#/definitions/HostNameSslState"
},
"x-ms-identifiers": [
"name"
]
},
"serverFarmId": {
"type": "string",
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."
},
"reserved": {
"type": "boolean",
"description": "true if reserved; otherwise, false.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"isXenon": {
"type": "boolean",
"description": "Obsolete: Hyper-V sandbox.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"hyperV": {
"type": "boolean",
"description": "Hyper-V sandbox.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"lastModifiedTimeUtc": {
"type": "string",
"format": "date-time",
"description": "Last time the app was modified, in UTC. Read-only.",
"readOnly": true
},
"dnsConfiguration": {
"$ref": "#/definitions/SiteDnsConfig",
"description": "Property to configure various DNS related settings for a site."
},
"siteConfig": {
"$ref": "#/definitions/SiteConfig",
"description": "Configuration of the app."
},
"trafficManagerHostNames": {
"type": "array",
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true
},
"scmSiteAlsoStopped": {
"type": "boolean",
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"default": false
},
"targetSwapSlot": {
"type": "string",
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true
},
"hostingEnvironmentProfile": {
"$ref": "#/definitions/HostingEnvironmentProfile",
"description": "App Service Environment to use for the app.",
"x-ms-mutability": [
"read",
"create"
]
},
"clientAffinityEnabled": {
"type": "boolean",
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true."
},
"clientAffinityProxyEnabled": {
"type": "boolean",
"description": "true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false."
},
"clientCertEnabled": {
"type": "boolean",
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."
},
"clientCertMode": {
"$ref": "#/definitions/ClientCertMode",
"description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."
},
"clientCertExclusionPaths": {
"type": "string",
"description": "client certificate authentication comma-separated exclusion paths"
},
"hostNamesDisabled": {
"type": "boolean",
"description": "true to disable the public hostnames of the app; otherwise, false.\\n If true, the app is only accessible via API management process."
},
"customDomainVerificationId": {
"type": "string",
"description": "Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."
},
"outboundIpAddresses": {
"type": "string",
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true
},
"possibleOutboundIpAddresses": {
"type": "string",
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true
},
"containerSize": {
"type": "integer",
"format": "int32",
"description": "Size of the function container."
},
"dailyMemoryTimeQuota": {
"type": "integer",
"format": "int32",
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only)."
},
"suspendedTill": {
"type": "string",
"format": "date-time",
"description": "App suspended till in case memory-time quota is exceeded.",
"readOnly": true
},
"maxNumberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"readOnly": true
},
"cloningInfo": {
"$ref": "#/definitions/CloningInfo",
"description": "If specified during app creation, the app is cloned from a source app.",
"x-ms-mutability": [
"create"
]
},
"resourceGroup": {
"type": "string",
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true
},
"isDefaultContainer": {
"type": "boolean",
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true
},
"defaultHostName": {
"type": "string",
"description": "Default hostname of the app. Read-only.",
"readOnly": true
},
"slotSwapStatus": {
"$ref": "#/definitions/SlotSwapStatus",
"description": "Status of the last deployment slot swap operation.",
"readOnly": true
},
"httpsOnly": {
"type": "boolean",
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"
},
"redundancyMode": {
"$ref": "#/definitions/RedundancyMode",
"description": "Site redundancy mode"
},
"inProgressOperationId": {
"type": "string",
"format": "uuid",
"description": "Specifies an operation id if this site has a pending operation.",
"readOnly": true
},
"publicNetworkAccess": {
"type": "string",
"description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string."
},
"storageAccountRequired": {
"type": "boolean",
"description": "Checks if Customer provided storage account is required"
},
"keyVaultReferenceIdentity": {
"type": "string",
"description": "Identity to use for Key Vault Reference authentication."
},
"virtualNetworkSubnetId": {
"type": "string",
"description": "Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"
}
}
},
"SitePhpErrorLogFlag": {
"type": "object",
"description": "Used for getting PHP error logging flag.",
"properties": {
"properties": {
"$ref": "#/definitions/SitePhpErrorLogFlagProperties",
"description": "SitePhpErrorLogFlag resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SitePhpErrorLogFlagProperties": {
"type": "object",
"description": "SitePhpErrorLogFlag resource specific properties",
"properties": {
"localLogErrors": {
"type": "string",
"description": "Local log_errors setting."
},
"masterLogErrors": {
"type": "string",
"description": "Master log_errors setting."
},
"localLogErrorsMaxLength": {
"type": "string",
"description": "Local log_errors_max_len setting."
},
"masterLogErrorsMaxLength": {
"type": "string",
"description": "Master log_errors_max_len setting."
}
}
},
"SiteProperties": {
"type": "object",
"description": "Site resource specific properties",
"properties": {
"state": {
"type": "string",
"description": "Current state of the app.",
"readOnly": true
},
"hostNames": {
"type": "array",
"description": "Hostnames associated with the app.",
"items": {
"type": "string"
},
"readOnly": true
},
"repositorySiteName": {
"type": "string",
"description": "Name of the repository site.",
"readOnly": true
},
"usageState": {
"$ref": "#/definitions/UsageState",
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"readOnly": true
},
"enabled": {
"type": "boolean",
"description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline)."
},
"enabledHostNames": {
"type": "array",
"description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
"items": {
"type": "string"
},
"readOnly": true
},
"availabilityState": {
"$ref": "#/definitions/SiteAvailabilityState",
"description": "Management information availability state for the app.",
"readOnly": true
},
"hostNameSslStates": {
"type": "array",
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"items": {
"$ref": "#/definitions/HostNameSslState"
},
"x-ms-identifiers": [
"name"
]
},
"serverFarmId": {
"type": "string",
"description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\"."
},
"reserved": {
"type": "boolean",
"description": "true if reserved; otherwise, false.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"isXenon": {
"type": "boolean",
"description": "Obsolete: Hyper-V sandbox.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"hyperV": {
"type": "boolean",
"description": "Hyper-V sandbox.",
"default": false,
"x-ms-mutability": [
"read",
"create"
]
},
"lastModifiedTimeUtc": {
"type": "string",
"format": "date-time",
"description": "Last time the app was modified, in UTC. Read-only.",
"readOnly": true
},
"dnsConfiguration": {
"$ref": "#/definitions/SiteDnsConfig",
"description": "Property to configure various DNS related settings for a site."
},
"outboundVnetRouting": {
"$ref": "#/definitions/OutboundVnetRouting",
"description": "Property to configure various outbound traffic routing options over virtual network for a site"
},
"siteConfig": {
"$ref": "#/definitions/SiteConfig",
"description": "Configuration of an App Service app. This property is not returned in response to normal create and read requests since it may contain sensitive information.",
"x-ms-mutability": [
"update",
"create"
]
},
"functionAppConfig": {
"$ref": "#/definitions/FunctionAppConfig",
"description": "Configuration specific of the Azure Function app."
},
"daprConfig": {
"$ref": "#/definitions/DaprConfig",
"description": "Dapr configuration of the app."
},
"workloadProfileName": {
"type": "string",
"description": "Workload profile name for function app to execute on."
},
"resourceConfig": {
"$ref": "#/definitions/ResourceConfig",
"description": "Function app resource requirements."
},
"trafficManagerHostNames": {
"type": "array",
"description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
"items": {
"type": "string"
},
"readOnly": true
},
"scmSiteAlsoStopped": {
"type": "boolean",
"description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
"default": false
},
"targetSwapSlot": {
"type": "string",
"description": "Specifies which deployment slot this app will swap into. Read-only.",
"readOnly": true
},
"hostingEnvironmentProfile": {
"$ref": "#/definitions/HostingEnvironmentProfile",
"description": "App Service Environment to use for the app.",
"x-ms-mutability": [
"read",
"create"
]
},
"clientAffinityEnabled": {
"type": "boolean",
"description": "true to enable client affinity; false to stop sending session affinity cookies, which route client requests in the same session to the same instance. Default is true.",
"default": false
},
"clientAffinityPartitioningEnabled": {
"type": "boolean",
"description": "true to enable client affinity partitioning using CHIPS cookies, this will add the partitioned property to the affinity cookies; false to stop sending partitioned affinity cookies. Default is false."
},
"clientAffinityProxyEnabled": {
"type": "boolean",
"description": "true to override client affinity cookie domain with X-Forwarded-Host request header. false to use default domain. Default is false."
},
"clientCertEnabled": {
"type": "boolean",
"description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false."
},
"clientCertMode": {
"$ref": "#/definitions/ClientCertMode",
"description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted."
},
"clientCertExclusionPaths": {
"type": "string",
"description": "client certificate authentication comma-separated exclusion paths"
},
"ipMode": {
"$ref": "#/definitions/IPMode",
"description": "Specifies the IP mode of the app."
},
"endToEndEncryptionEnabled": {
"type": "boolean",
"description": "Whether to use end to end encryption between the FrontEnd and the Worker"
},
"sshEnabled": {
"type": "boolean",
"description": "Whether to enable ssh access."
},
"hostNamesDisabled": {
"type": "boolean",
"description": "true to disable the public hostnames of the app; otherwise, false.\nIf true, the app is only accessible via API management process."
},
"customDomainVerificationId": {
"type": "string",
"description": "Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification."
},
"outboundIpAddresses": {
"type": "string",
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from tenants that site can be hosted with current settings. Read-only.",
"readOnly": true
},
"possibleOutboundIpAddresses": {
"type": "string",
"description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants except dataComponent. Read-only.",
"readOnly": true
},
"containerSize": {
"type": "integer",
"format": "int32",
"description": "Size of the function container."
},
"dailyMemoryTimeQuota": {
"type": "integer",
"format": "int32",
"description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only)."
},
"suspendedTill": {
"type": "string",
"format": "date-time",
"description": "App suspended till in case memory-time quota is exceeded.",
"readOnly": true
},
"maxNumberOfWorkers": {
"type": "integer",
"format": "int32",
"description": "Maximum number of workers.\nThis only applies to Functions container.",
"readOnly": true
},
"cloningInfo": {
"$ref": "#/definitions/CloningInfo",
"description": "If specified during app creation, the app is cloned from a source app.",
"x-ms-mutability": [
"create"
]
},
"resourceGroup": {
"type": "string",
"description": "Name of the resource group the app belongs to. Read-only.",
"readOnly": true
},
"isDefaultContainer": {
"type": "boolean",
"description": "true if the app is a default container; otherwise, false.",
"readOnly": true
},
"defaultHostName": {
"type": "string",
"description": "Default hostname of the app. Read-only.",
"readOnly": true
},
"slotSwapStatus": {
"$ref": "#/definitions/SlotSwapStatus",
"description": "Status of the last deployment slot swap operation.",
"readOnly": true
},
"httpsOnly": {
"type": "boolean",
"description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests"
},
"redundancyMode": {
"$ref": "#/definitions/RedundancyMode",
"description": "Site redundancy mode"
},
"inProgressOperationId": {
"type": "string",
"format": "uuid",
"description": "Specifies an operation id if this site has a pending operation.",
"readOnly": true
},
"publicNetworkAccess": {
"type": "string",
"description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string."
},
"storageAccountRequired": {
"type": "boolean",
"description": "Checks if Customer provided storage account is required"
},
"keyVaultReferenceIdentity": {
"type": "string",
"description": "Identity to use for Key Vault Reference authentication."
},
"autoGeneratedDomainNameLabelScope": {
"$ref": "#/definitions/AutoGeneratedDomainNameLabelScope",
"description": "Specifies the scope of uniqueness for the default hostname during resource creation"
},
"virtualNetworkSubnetId": {
"type": "string",
"description": "Azure Resource Manager ID of the Virtual network and subnet to be joined by Regional VNET Integration.\nThis must be of the form /subscriptions/{subscriptionName}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}"
},
"managedEnvironmentId": {
"type": "string",
"description": "Azure Resource Manager ID of the customer's selected Managed Environment on which to host this app. This must be of the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.App/managedEnvironments/{managedEnvironmentName}"
},
"sku": {
"type": "string",
"description": "Current SKU of application based on associated App Service Plan. Some valid SKU values are Free, Shared, Basic, Dynamic, FlexConsumption, Standard, Premium, PremiumV2, PremiumV3, Isolated, IsolatedV2",
"readOnly": true
}
}
},
"SiteRuntimeState": {
"type": "string",
"enum": [
"READY",
"STOPPED",
"UNKNOWN"
],
"x-ms-enum": {
"name": "SiteRuntimeState",
"modelAsString": false
}
},
"SiteSourceControl": {
"type": "object",
"description": "Source control configuration for an app.",
"properties": {
"properties": {
"$ref": "#/definitions/SiteSourceControlProperties",
"description": "SiteSourceControl resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SiteSourceControlProperties": {
"type": "object",
"description": "SiteSourceControl resource specific properties",
"properties": {
"repoUrl": {
"type": "string",
"description": "Repository or source control URL.",
"x-ms-mutability": [
"read",
"create"
]
},
"branch": {
"type": "string",
"description": "Name of branch to use for deployment.",
"x-ms-mutability": [
"read",
"create"
]
},
"isManualIntegration": {
"type": "boolean",
"description": "true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).",
"x-ms-mutability": [
"read",
"create"
]
},
"isGitHubAction": {
"type": "boolean",
"description": "true if this is deployed via GitHub action.",
"x-ms-mutability": [
"read",
"create"
]
},
"deploymentRollbackEnabled": {
"type": "boolean",
"description": "true to enable deployment rollback; otherwise, false.",
"x-ms-mutability": [
"read",
"create"
]
},
"isMercurial": {
"type": "boolean",
"description": "true for a Mercurial repository; false for a Git repository.",
"x-ms-mutability": [
"read",
"create"
]
},
"gitHubActionConfiguration": {
"$ref": "#/definitions/GitHubActionConfiguration",
"description": "If GitHub Action is selected, than the associated configuration."
}
}
},
"SiteUpdateStrategyType": {
"type": "string",
"description": "Function app site update strategy type. Available options: Recreate, RollingUpdate",
"enum": [
"Recreate",
"RollingUpdate"
],
"x-ms-enum": {
"name": "SiteUpdateStrategyType",
"modelAsString": true,
"values": [
{
"name": "Recreate",
"value": "Recreate",
"description": "If the app is under load and a deployment or site state update occurs, all pods will be removed\nand will need to be Recreated all at once. This is the default behavior."
},
{
"name": "RollingUpdate",
"value": "RollingUpdate",
"description": "If the app is under load and a deployment or site state update occurs, pods will be drained in\nbatches and gradually replaced, thus minimizing impact to throughput."
}
]
}
},
"SkuCapacity": {
"type": "object",
"description": "Description of the App Service plan scale options.",
"properties": {
"minimum": {
"type": "integer",
"format": "int32",
"description": "Minimum number of workers for this App Service plan SKU."
},
"maximum": {
"type": "integer",
"format": "int32",
"description": "Maximum number of workers for this App Service plan SKU."
},
"elasticMaximum": {
"type": "integer",
"format": "int32",
"description": "Maximum number of Elastic workers for this App Service plan SKU."
},
"default": {
"type": "integer",
"format": "int32",
"description": "Default number of workers for this App Service plan SKU."
},
"scaleType": {
"type": "string",
"description": "Available scale configurations for an App Service plan."
}
}
},
"SkuDescription": {
"type": "object",
"description": "Description of a SKU for a scalable resource.",
"properties": {
"name": {
"type": "string",
"description": "Name of the resource SKU."
},
"tier": {
"type": "string",
"description": "Service tier of the resource SKU."
},
"size": {
"type": "string",
"description": "Size specifier of the resource SKU."
},
"family": {
"type": "string",
"description": "Family code of the resource SKU."
},
"capacity": {
"type": "integer",
"format": "int32",
"description": "Current number of instances assigned to the resource."
},
"skuCapacity": {
"$ref": "#/definitions/SkuCapacity",
"description": "Min, max, and default scale values of the SKU."
},
"locations": {
"type": "array",
"description": "Locations of the SKU.",
"items": {
"type": "string"
}
},
"capabilities": {
"type": "array",
"description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
"items": {
"$ref": "#/definitions/Capability"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"SkuInfo": {
"type": "object",
"description": "SKU discovery information.",
"properties": {
"resourceType": {
"type": "string",
"description": "Resource type that this SKU applies to."
},
"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."
}
}
},
"SkuInfoCollection": {
"type": "object",
"description": "Paged collection of SkuInfo items",
"properties": {
"value": {
"type": "array",
"description": "The SkuInfo items on this page",
"items": {
"$ref": "#/definitions/SkuInfo"
},
"x-ms-identifiers": [
"/sku/name",
"resourceType"
]
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SkuInfos": {
"type": "object",
"description": "Collection of SKU information.",
"properties": {
"resourceType": {
"type": "string",
"description": "Resource type that this SKU applies to."
},
"skus": {
"type": "array",
"description": "List of SKUs the subscription is able to use.",
"items": {
"$ref": "#/definitions/GlobalCsmSkuDescription"
},
"x-ms-identifiers": [
"name"
]
}
}
},
"SlotConfigNames": {
"type": "object",
"description": "Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app.",
"properties": {
"connectionStringNames": {
"type": "array",
"description": "List of connection string names.",
"items": {
"type": "string"
}
},
"appSettingNames": {
"type": "array",
"description": "List of application settings names.",
"items": {
"type": "string"
}
},
"azureStorageConfigNames": {
"type": "array",
"description": "List of external Azure storage account identifiers.",
"items": {
"type": "string"
}
}
}
},
"SlotConfigNamesResource": {
"type": "object",
"description": "Slot Config names azure resource.",
"properties": {
"properties": {
"$ref": "#/definitions/SlotConfigNames",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SlotDifference": {
"type": "object",
"description": "A setting difference between two deployment slots of an app.",
"properties": {
"properties": {
"$ref": "#/definitions/SlotDifferenceProperties",
"description": "SlotDifference resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SlotDifferenceCollection": {
"type": "object",
"description": "Collection of slot differences.",
"properties": {
"value": {
"type": "array",
"description": "The SlotDifference items on this page",
"items": {
"$ref": "#/definitions/SlotDifference"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SlotDifferenceProperties": {
"type": "object",
"description": "SlotDifference resource specific properties",
"properties": {
"level": {
"type": "string",
"description": "Level of the difference: Information, Warning or Error.",
"readOnly": true
},
"settingType": {
"type": "string",
"description": "The type of the setting: General, AppSetting or ConnectionString.",
"readOnly": true
},
"diffRule": {
"type": "string",
"description": "Rule that describes how to process the setting difference during a slot swap.",
"readOnly": true
},
"settingName": {
"type": "string",
"description": "Name of the setting.",
"readOnly": true
},
"valueInCurrentSlot": {
"type": "string",
"description": "Value of the setting in the current slot.",
"readOnly": true
},
"valueInTargetSlot": {
"type": "string",
"description": "Value of the setting in the target slot.",
"readOnly": true
},
"description": {
"type": "string",
"description": "Description of the setting difference.",
"readOnly": true
}
}
},
"SlotSwapStatus": {
"type": "object",
"description": "The status of the last successful slot swap operation.",
"properties": {
"timestampUtc": {
"type": "string",
"format": "date-time",
"description": "The time the last successful slot swap completed.",
"readOnly": true
},
"sourceSlotName": {
"type": "string",
"description": "The source slot of the last swap operation.",
"readOnly": true
},
"destinationSlotName": {
"type": "string",
"description": "The destination slot of the last swap operation.",
"readOnly": true
}
}
},
"SlowRequestsBasedTrigger": {
"type": "object",
"description": "Trigger based on request execution time.",
"properties": {
"timeTaken": {
"type": "string",
"description": "Time taken."
},
"path": {
"type": "string",
"description": "Request Path."
},
"count": {
"type": "integer",
"format": "int32",
"description": "Request Count."
},
"timeInterval": {
"type": "string",
"description": "Time interval."
}
}
},
"Snapshot": {
"type": "object",
"description": "A snapshot of an app.",
"properties": {
"properties": {
"$ref": "#/definitions/SnapshotProperties",
"description": "Snapshot resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SnapshotCollection": {
"type": "object",
"description": "Collection of snapshots which can be used to revert an app to a previous time.",
"properties": {
"value": {
"type": "array",
"description": "The Snapshot items on this page",
"items": {
"$ref": "#/definitions/Snapshot"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SnapshotProperties": {
"type": "object",
"description": "Snapshot resource specific properties",
"properties": {
"time": {
"type": "string",
"description": "The time the snapshot was taken.",
"readOnly": true
}
}
},
"SnapshotRecoverySource": {
"type": "object",
"description": "Specifies the web app that snapshot contents will be retrieved from.",
"properties": {
"location": {
"type": "string",
"description": "Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS"
},
"id": {
"type": "string",
"description": "ARM resource ID of the source app.\n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and\n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots."
}
}
},
"SnapshotRestoreRequest": {
"type": "object",
"description": "Details about app recovery operation.",
"properties": {
"properties": {
"$ref": "#/definitions/SnapshotRestoreRequestProperties",
"description": "SnapshotRestoreRequest resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SnapshotRestoreRequestProperties": {
"type": "object",
"description": "SnapshotRestoreRequest resource specific properties",
"properties": {
"snapshotTime": {
"type": "string",
"description": "Point in time in which the app restore should be done, formatted as a DateTime string."
},
"recoverySource": {
"$ref": "#/definitions/SnapshotRecoverySource",
"description": "Optional. Specifies the web app that snapshot contents will be retrieved from.\nIf empty, the targeted web app will be used as the source."
},
"overwrite": {
"type": "boolean",
"description": "If true the restore operation can overwrite source app; otherwise, false."
},
"recoverConfiguration": {
"type": "boolean",
"description": "If true, site configuration, in addition to content, will be reverted."
},
"ignoreConflictingHostNames": {
"type": "boolean",
"description": "If true, custom hostname conflicts will be ignored when recovering to a target web app.\nThis setting is only necessary when RecoverConfiguration is enabled."
},
"useDRSecondary": {
"type": "boolean",
"description": "If true, the snapshot is retrieved from DRSecondary endpoint."
}
},
"required": [
"overwrite"
]
},
"Solution": {
"type": "object",
"description": "Class Representing Solution for problems detected.",
"properties": {
"id": {
"type": "number",
"format": "double",
"description": "Solution Id."
},
"displayName": {
"type": "string",
"description": "Display Name of the solution"
},
"order": {
"type": "number",
"format": "double",
"description": "Order of the solution."
},
"description": {
"type": "string",
"description": "Description of the solution"
},
"type": {
"$ref": "#/definitions/SolutionType",
"description": "Type of Solution"
},
"data": {
"type": "array",
"description": "Solution Data.",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"x-ms-identifiers": [
"name"
]
},
"metadata": {
"type": "array",
"description": "Solution Metadata.",
"items": {
"type": "array",
"items": {
"$ref": "#/definitions/NameValuePair"
}
},
"x-ms-identifiers": [
"name"
]
}
}
},
"SolutionType": {
"type": "string",
"description": "Type of Solution",
"enum": [
"QuickSolution",
"DeepInvestigation",
"BestPractices"
],
"x-ms-enum": {
"name": "SolutionType",
"modelAsString": false
}
},
"SourceControl": {
"type": "object",
"description": "The source control OAuth token.",
"properties": {
"properties": {
"$ref": "#/definitions/SourceControlProperties",
"description": "SourceControl resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SourceControlCollection": {
"type": "object",
"description": "Collection of source controls.",
"properties": {
"value": {
"type": "array",
"description": "The SourceControl items on this page",
"items": {
"$ref": "#/definitions/SourceControl"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"SourceControlProperties": {
"type": "object",
"description": "SourceControl resource specific properties",
"properties": {
"token": {
"type": "string",
"description": "OAuth access token."
},
"tokenSecret": {
"type": "string",
"description": "OAuth access token secret."
},
"refreshToken": {
"type": "string",
"description": "OAuth refresh token."
},
"expirationTime": {
"type": "string",
"format": "date-time",
"description": "OAuth token expiration."
}
}
},
"SslState": {
"type": "string",
"description": "SSL type",
"enum": [
"Disabled",
"SniEnabled",
"IpBasedEnabled"
],
"x-ms-enum": {
"name": "SslState",
"modelAsString": false
}
},
"StackMajorVersion": {
"type": "object",
"description": "Application stack major version.",
"properties": {
"displayVersion": {
"type": "string",
"description": "Application stack major version (display only)."
},
"runtimeVersion": {
"type": "string",
"description": "Application stack major version (runtime only)."
},
"isDefault": {
"type": "boolean",
"description": "true if this is the default major version; otherwise, false."
},
"minorVersions": {
"type": "array",
"description": "Minor versions associated with the major version.",
"items": {
"$ref": "#/definitions/StackMinorVersion"
},
"x-ms-identifiers": [
"runtimeVersion"
]
},
"applicationInsights": {
"type": "boolean",
"description": "true if this supports Application Insights; otherwise, false."
},
"isPreview": {
"type": "boolean",
"description": "true if this stack is in Preview, otherwise false."
},
"isDeprecated": {
"type": "boolean",
"description": "true if this stack has been deprecated, otherwise false."
},
"isHidden": {
"type": "boolean",
"description": "true if this stack should be hidden for new customers on portal, otherwise false."
},
"appSettingsDictionary": {
"type": "object",
"description": "\n\n\nExample: All the function apps need AppSetting: \"FUNCTIONS_WORKER_RUNTIME\" to be set stack name",
"additionalProperties": {}
},
"siteConfigPropertiesDictionary": {
"type": "object",
"description": "\n\n\nExample: All Linux Function Apps, need Use32BitWorkerProcess to be set to 0",
"additionalProperties": {}
}
}
},
"StackMinorVersion": {
"type": "object",
"description": "Application stack minor version.",
"properties": {
"displayVersion": {
"type": "string",
"description": "Application stack minor version (display only)."
},
"runtimeVersion": {
"type": "string",
"description": "Application stack minor version (runtime only)."
},
"isDefault": {
"type": "boolean",
"description": "true if this is the default minor version; otherwise, false."
},
"isRemoteDebuggingEnabled": {
"type": "boolean",
"description": "true if this supports Remote Debugging, otherwise false."
}
}
},
"StackPreferredOs": {
"type": "string",
"description": "Function App stack preferred OS.",
"enum": [
"Windows",
"Linux"
],
"x-ms-enum": {
"name": "StackPreferredOs",
"modelAsString": false
}
},
"StagingEnvironmentPolicy": {
"type": "string",
"description": "State indicating whether staging environments are allowed or not allowed for a static web app.",
"enum": [
"Enabled",
"Disabled"
],
"x-ms-enum": {
"name": "StagingEnvironmentPolicy",
"modelAsString": false
}
},
"StampCapacity": {
"type": "object",
"description": "Stamp capacity information.",
"properties": {
"name": {
"type": "string",
"description": "Name of the stamp."
},
"availableCapacity": {
"type": "integer",
"format": "int64",
"description": "Available capacity (# of machines, bytes of storage etc...)."
},
"totalCapacity": {
"type": "integer",
"format": "int64",
"description": "Total capacity (# of machines, bytes of storage etc...)."
},
"unit": {
"type": "string",
"description": "Name of the unit."
},
"computeMode": {
"$ref": "#/definitions/ComputeModeOptions",
"description": "Shared/dedicated workers."
},
"workerSize": {
"$ref": "#/definitions/WorkerSizeOptions",
"description": "Size of the machines."
},
"workerSizeId": {
"type": "integer",
"format": "int32",
"description": "Size ID of machines:\n0 - Small\n1 - Medium\n2 - Large"
},
"excludeFromCapacityAllocation": {
"type": "boolean",
"description": "If true, it includes basic apps.\nBasic apps are not used for capacity allocation."
},
"isApplicableForAllComputeModes": {
"type": "boolean",
"description": "true if capacity is applicable for all apps; otherwise, false."
},
"siteMode": {
"type": "string",
"description": "Shared or Dedicated."
},
"isLinux": {
"type": "boolean",
"description": "Is this a linux stamp capacity"
}
}
},
"StampCapacityCollection": {
"type": "object",
"description": "Paged collection of StampCapacity items",
"properties": {
"value": {
"type": "array",
"description": "The StampCapacity items on this page",
"items": {
"$ref": "#/definitions/StampCapacity"
},
"x-ms-identifiers": [
"name"
]
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSite": {
"type": "object",
"description": "A static site.",
"properties": {
"defaultHostname": {
"type": "string",
"description": "The default autogenerated hostname for the static site.",
"readOnly": true
},
"repositoryUrl": {
"type": "string",
"description": "URL for the repository of the static site."
},
"branch": {
"type": "string",
"description": "The target branch in the repository."
},
"customDomains": {
"type": "array",
"description": "The custom domains associated with this static site.",
"items": {
"type": "string"
},
"readOnly": true
},
"repositoryToken": {
"type": "string",
"description": "A user's github repository token. This is used to setup the Github Actions workflow file and API secrets."
},
"buildProperties": {
"$ref": "#/definitions/StaticSiteBuildProperties",
"description": "Build properties to configure on the repository."
},
"privateEndpointConnections": {
"type": "array",
"description": "Private endpoint connections",
"items": {
"$ref": "#/definitions/ResponseMessageEnvelopeRemotePrivateEndpointConnection"
},
"readOnly": true
},
"stagingEnvironmentPolicy": {
"$ref": "#/definitions/StagingEnvironmentPolicy",
"description": "State indicating whether staging environments are allowed or not allowed for a static web app."
},
"allowConfigFileUpdates": {
"type": "boolean",
"description": "false if config file is locked for this static web app; otherwise, true."
},
"templateProperties": {
"$ref": "#/definitions/StaticSiteTemplateOptions",
"description": "Template options for generating a new repository."
},
"contentDistributionEndpoint": {
"type": "string",
"description": "The content distribution endpoint for the static site.",
"readOnly": true
},
"keyVaultReferenceIdentity": {
"type": "string",
"description": "Identity to use for Key Vault Reference authentication.",
"readOnly": true
},
"userProvidedFunctionApps": {
"type": "array",
"description": "User provided function apps registered with the static site",
"items": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionApp"
},
"readOnly": true
},
"linkedBackends": {
"type": "array",
"description": "Backends linked to the static side",
"items": {
"$ref": "#/definitions/StaticSiteLinkedBackend"
},
"readOnly": true,
"x-ms-identifiers": []
},
"provider": {
"type": "string",
"description": "The provider that submitted the last deployment to the primary environment of the static site."
},
"enterpriseGradeCdnStatus": {
"$ref": "#/definitions/EnterpriseGradeCdnStatus",
"description": "State indicating the status of the enterprise grade CDN serving traffic to the static web app."
},
"publicNetworkAccess": {
"type": "string",
"description": "State indicating whether public traffic are allowed or not for a static web app. Allowed Values: 'Enabled', 'Disabled' or an empty string."
},
"databaseConnections": {
"type": "array",
"description": "Database connections for the static site",
"items": {
"$ref": "#/definitions/DatabaseConnectionOverview"
},
"readOnly": true,
"x-ms-identifiers": [
"name"
]
}
}
},
"StaticSiteARMResource": {
"type": "object",
"description": "Concrete tracked resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSite",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
},
"sku": {
"$ref": "#/definitions/SkuDescription",
"description": "Description of a SKU for a scalable resource."
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"StaticSiteBasicAuthPropertiesARMResource": {
"type": "object",
"description": "Static site basic auth properties ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResourceProperties",
"description": "StaticSiteBasicAuthPropertiesARMResource resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"StaticSiteBasicAuthPropertiesARMResourceProperties": {
"type": "object",
"description": "StaticSiteBasicAuthPropertiesARMResource resource specific properties",
"properties": {
"password": {
"type": "string",
"description": "The password for basic auth."
},
"secretUrl": {
"type": "string",
"description": "Url to the secret in Key Vault."
},
"applicableEnvironmentsMode": {
"type": "string",
"description": "State indicating if basic auth is enabled and for what environments it is active."
},
"environments": {
"type": "array",
"description": "The list of enabled environments for Basic Auth if ApplicableEnvironmentsMode is set to SpecifiedEnvironments.",
"items": {
"type": "string"
}
},
"secretState": {
"type": "string",
"description": "State indicating if basic auth has a secret and what type it is.",
"readOnly": true
}
},
"required": [
"applicableEnvironmentsMode"
]
},
"StaticSiteBasicAuthPropertiesCollection": {
"type": "object",
"description": "Collection of static site basic auth.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteBasicAuthPropertiesARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteBasicAuthPropertiesARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteBuildARMResource": {
"type": "object",
"description": "Static Site Build ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteBuildARMResourceProperties",
"description": "StaticSiteBuildARMResource resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"StaticSiteBuildARMResourceProperties": {
"type": "object",
"description": "StaticSiteBuildARMResource resource specific properties",
"properties": {
"buildId": {
"type": "string",
"description": "An identifier for the static site build.",
"readOnly": true
},
"sourceBranch": {
"type": "string",
"description": "The source branch.",
"readOnly": true
},
"pullRequestTitle": {
"type": "string",
"description": "The title of a pull request that a static site build is related to.",
"readOnly": true
},
"hostname": {
"type": "string",
"description": "The hostname for a static site build.",
"readOnly": true
},
"createdTimeUtc": {
"type": "string",
"format": "date-time",
"description": "When this build was created.",
"readOnly": true
},
"lastUpdatedOn": {
"type": "string",
"format": "date-time",
"description": "When this build was updated.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/BuildStatus",
"description": "The status of the static site build.",
"readOnly": true
},
"userProvidedFunctionApps": {
"type": "array",
"description": "User provided function apps registered with the static site build",
"items": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionApp"
},
"readOnly": true
},
"linkedBackends": {
"type": "array",
"description": "Backends linked to the static side build",
"items": {
"$ref": "#/definitions/StaticSiteLinkedBackend"
},
"readOnly": true,
"x-ms-identifiers": []
},
"databaseConnections": {
"type": "array",
"description": "Database connections for the static site build",
"items": {
"$ref": "#/definitions/DatabaseConnectionOverview"
},
"readOnly": true,
"x-ms-identifiers": [
"name"
]
}
}
},
"StaticSiteBuildCollection": {
"type": "object",
"description": "Collection of static site builds.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteBuildARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteBuildARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteBuildProperties": {
"type": "object",
"description": "Build properties for the static site.",
"properties": {
"appLocation": {
"type": "string",
"description": "The path to the app code within the repository."
},
"apiLocation": {
"type": "string",
"description": "The path to the api code within the repository."
},
"appArtifactLocation": {
"type": "string",
"description": "Deprecated: The path of the app artifacts after building (deprecated in favor of OutputLocation)"
},
"outputLocation": {
"type": "string",
"description": "The output path of the app after building."
},
"appBuildCommand": {
"type": "string",
"description": "A custom command to run during deployment of the static content application."
},
"apiBuildCommand": {
"type": "string",
"description": "A custom command to run during deployment of the Azure Functions API application."
},
"skipGithubActionWorkflowGeneration": {
"type": "boolean",
"description": "Skip Github Action workflow generation."
},
"githubActionSecretNameOverride": {
"type": "string",
"description": "Github Action secret name override."
}
}
},
"StaticSiteCollection": {
"type": "object",
"description": "Collection of static sites.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteCustomDomainOverviewARMResource": {
"type": "object",
"description": "Static Site Custom Domain Overview ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResourceProperties",
"description": "StaticSiteCustomDomainOverviewARMResource resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"StaticSiteCustomDomainOverviewARMResourceProperties": {
"type": "object",
"description": "StaticSiteCustomDomainOverviewARMResource resource specific properties",
"properties": {
"domainName": {
"type": "string",
"description": "The domain name for the static site custom domain.",
"readOnly": true
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the custom domain was created for the static site.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/CustomDomainStatus",
"description": "The status of the custom domain",
"readOnly": true
},
"validationToken": {
"type": "string",
"description": "The TXT record validation token",
"readOnly": true
},
"errorMessage": {
"type": "string",
"readOnly": true
}
}
},
"StaticSiteCustomDomainOverviewCollection": {
"type": "object",
"description": "Collection of static site custom domains.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteCustomDomainOverviewARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteCustomDomainRequestPropertiesARMResource": {
"type": "object",
"description": "Static Site Custom Domain Request Properties ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteCustomDomainRequestPropertiesARMResourceProperties",
"description": "StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteCustomDomainRequestPropertiesARMResourceProperties": {
"type": "object",
"description": "StaticSiteCustomDomainRequestPropertiesARMResource resource specific properties",
"properties": {
"validationMethod": {
"type": "string",
"description": "Validation method for adding a custom domain",
"default": "cname-delegation"
}
}
},
"StaticSiteDatabaseConnectionConfigurationFileOverview": {
"type": "object",
"description": "A database connection configuration file",
"properties": {
"fileName": {
"type": "string",
"description": "The name of the configuration file.",
"readOnly": true
},
"contents": {
"type": "string",
"description": "The Base64 encoding of the file contents.",
"readOnly": true
},
"type": {
"type": "string",
"description": "The type of configuration file.",
"readOnly": true
}
}
},
"StaticSiteFunctionOverviewARMResource": {
"type": "object",
"description": "Static Site Function Overview ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteFunctionOverviewARMResourceProperties",
"description": "StaticSiteFunctionOverviewARMResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteFunctionOverviewARMResourceProperties": {
"type": "object",
"description": "StaticSiteFunctionOverviewARMResource resource specific properties",
"properties": {
"functionName": {
"type": "string",
"description": "The name for the function",
"readOnly": true
},
"triggerType": {
"$ref": "#/definitions/TriggerTypes",
"description": "The trigger type of the function",
"readOnly": true
}
}
},
"StaticSiteFunctionOverviewCollection": {
"type": "object",
"description": "Collection of static site functions.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteFunctionOverviewARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteFunctionOverviewARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteLinkedBackend": {
"type": "object",
"description": "Static Site Linked Backend ARM resource.",
"properties": {
"backendResourceId": {
"type": "string",
"description": "The resource id of the backend linked to the static site"
},
"region": {
"type": "string",
"description": "The region of the backend linked to the static site"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the backend was linked to the static site.",
"readOnly": true
},
"provisioningState": {
"type": "string",
"description": "The provisioning state of the linking process.",
"readOnly": true
}
}
},
"StaticSiteLinkedBackendARMResource": {
"type": "object",
"description": "Static Site Linked Backend ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResourceProperties",
"description": "StaticSiteLinkedBackendARMResource resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"StaticSiteLinkedBackendARMResourceProperties": {
"type": "object",
"description": "StaticSiteLinkedBackendARMResource resource specific properties",
"properties": {
"backendResourceId": {
"type": "string",
"description": "The resource id of the backend linked to the static site"
},
"region": {
"type": "string",
"description": "The region of the backend linked to the static site"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the backend was linked to the static site.",
"readOnly": true
},
"provisioningState": {
"type": "string",
"description": "The provisioning state of the linking process.",
"readOnly": true
}
}
},
"StaticSiteLinkedBackendsCollection": {
"type": "object",
"description": "Collection of static site linked backends.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteLinkedBackendARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteLinkedBackendARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSitePatchResource": {
"type": "object",
"description": "ARM resource for a static site when patching",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSite",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteResetPropertiesARMResource": {
"type": "object",
"description": "Static Site Reset Properties ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteResetPropertiesARMResourceProperties",
"description": "StaticSiteResetPropertiesARMResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteResetPropertiesARMResourceProperties": {
"type": "object",
"description": "StaticSiteResetPropertiesARMResource resource specific properties",
"properties": {
"repositoryToken": {
"type": "string",
"description": "The token which proves admin privileges to the repository."
},
"shouldUpdateRepository": {
"type": "boolean",
"description": "Determines whether the repository should be updated with the new properties."
}
}
},
"StaticSiteTemplateOptions": {
"type": "object",
"description": "Template Options for the static site.",
"properties": {
"templateRepositoryUrl": {
"type": "string",
"description": "URL of the template repository. The newly generated repository will be based on this one."
},
"owner": {
"type": "string",
"description": "Owner of the newly generated repository."
},
"repositoryName": {
"type": "string",
"description": "Name of the newly generated repository."
},
"description": {
"type": "string",
"description": "Description of the newly generated repository."
},
"isPrivate": {
"type": "boolean",
"description": "Whether or not the newly generated repository is a private repository. Defaults to false (i.e. public)."
}
}
},
"StaticSiteUserARMResource": {
"type": "object",
"description": "Static Site User ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteUserARMResourceProperties",
"description": "StaticSiteUserARMResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteUserARMResourceProperties": {
"type": "object",
"description": "StaticSiteUserARMResource resource specific properties",
"properties": {
"provider": {
"type": "string",
"description": "The identity provider for the static site user.",
"readOnly": true
},
"userId": {
"type": "string",
"description": "The user id for the static site user.",
"readOnly": true
},
"displayName": {
"type": "string",
"description": "The display name for the static site user.",
"readOnly": true
},
"roles": {
"type": "string",
"description": "The roles for the static site user, in free-form string format"
}
}
},
"StaticSiteUserCollection": {
"type": "object",
"description": "Collection of static site custom users.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteUserARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteUserARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteUserInvitationRequestResource": {
"type": "object",
"description": "Static sites user roles invitation resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteUserInvitationRequestResourceProperties",
"description": "StaticSiteUserInvitationRequestResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteUserInvitationRequestResourceProperties": {
"type": "object",
"description": "StaticSiteUserInvitationRequestResource resource specific properties",
"properties": {
"domain": {
"type": "string",
"description": "The domain name for the static site custom domain."
},
"provider": {
"type": "string",
"description": "The identity provider for the static site user."
},
"userDetails": {
"type": "string",
"description": "The user id for the static site user."
},
"roles": {
"type": "string",
"description": "The roles for the static site user, in free-form string format"
},
"numHoursToExpiration": {
"type": "integer",
"format": "int32",
"description": "The number of hours the sas token stays valid"
}
}
},
"StaticSiteUserInvitationResponseResource": {
"type": "object",
"description": "Static sites user roles invitation link resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteUserInvitationResponseResourceProperties",
"description": "StaticSiteUserInvitationResponseResource resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteUserInvitationResponseResourceProperties": {
"type": "object",
"description": "StaticSiteUserInvitationResponseResource resource specific properties",
"properties": {
"expiresOn": {
"type": "string",
"format": "date-time",
"description": "The expiration time of the invitation",
"readOnly": true
},
"invitationUrl": {
"type": "string",
"description": "The url for the invitation link",
"readOnly": true
}
}
},
"StaticSiteUserProvidedFunctionApp": {
"type": "object",
"description": "A static site user provided function.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppProperties",
"description": "StaticSiteUserProvidedFunctionApp resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSiteUserProvidedFunctionAppARMResource": {
"type": "object",
"description": "Static Site User Provided Function App ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResourceProperties",
"description": "StaticSiteUserProvidedFunctionAppARMResource resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"StaticSiteUserProvidedFunctionAppARMResourceProperties": {
"type": "object",
"description": "StaticSiteUserProvidedFunctionAppARMResource resource specific properties",
"properties": {
"functionAppResourceId": {
"type": "string",
"description": "The resource id of the function app registered with the static site"
},
"functionAppRegion": {
"type": "string",
"description": "The region of the function app registered with the static site"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the function app was registered with the static site.",
"readOnly": true
}
}
},
"StaticSiteUserProvidedFunctionAppProperties": {
"type": "object",
"description": "StaticSiteUserProvidedFunctionApp resource specific properties",
"properties": {
"functionAppResourceId": {
"type": "string",
"description": "The resource id of the function app registered with the static site"
},
"functionAppRegion": {
"type": "string",
"description": "The region of the function app registered with the static site"
},
"createdOn": {
"type": "string",
"format": "date-time",
"description": "The date and time on which the function app was registered with the static site.",
"readOnly": true
}
}
},
"StaticSiteUserProvidedFunctionAppsCollection": {
"type": "object",
"description": "Collection of static site user provided function apps.",
"properties": {
"value": {
"type": "array",
"description": "The StaticSiteUserProvidedFunctionAppARMResource items on this page",
"items": {
"$ref": "#/definitions/StaticSiteUserProvidedFunctionAppARMResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"StaticSiteZipDeployment": {
"type": "object",
"description": "A static site zip deployment.",
"properties": {
"appZipUrl": {
"type": "string",
"description": "URL for the zipped app content"
},
"apiZipUrl": {
"type": "string",
"description": "URL for the zipped api content"
},
"deploymentTitle": {
"type": "string",
"description": "A title to label the deployment"
},
"provider": {
"type": "string",
"description": "The provider submitting this deployment"
},
"functionLanguage": {
"type": "string",
"description": "The language of the api content, if it exists"
}
}
},
"StaticSiteZipDeploymentARMResource": {
"type": "object",
"description": "Static site zip deployment ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSiteZipDeployment",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSitesWorkflowPreview": {
"type": "object",
"description": "Preview for the Static Site Workflow to be generated",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSitesWorkflowPreviewProperties",
"description": "StaticSitesWorkflowPreview resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSitesWorkflowPreviewProperties": {
"type": "object",
"description": "StaticSitesWorkflowPreview resource specific properties",
"properties": {
"path": {
"type": "string",
"description": "The path for the workflow file to be generated",
"readOnly": true
},
"contents": {
"type": "string",
"description": "The contents for the workflow file to be generated",
"readOnly": true
}
}
},
"StaticSitesWorkflowPreviewRequest": {
"type": "object",
"description": "Request entity for previewing the Static Site workflow",
"properties": {
"properties": {
"$ref": "#/definitions/StaticSitesWorkflowPreviewRequestProperties",
"description": "StaticSitesWorkflowPreviewRequest resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StaticSitesWorkflowPreviewRequestProperties": {
"type": "object",
"description": "StaticSitesWorkflowPreviewRequest resource specific properties",
"properties": {
"repositoryUrl": {
"type": "string",
"description": "URL for the repository of the static site."
},
"branch": {
"type": "string",
"description": "The target branch in the repository."
},
"buildProperties": {
"$ref": "#/definitions/StaticSiteBuildProperties",
"description": "Build properties to configure on the repository."
}
}
},
"Status": {
"type": "object",
"description": "Identify the status of the most severe insight generated by the detector.",
"properties": {
"message": {
"type": "string",
"description": "Descriptive message."
},
"statusId": {
"$ref": "#/definitions/InsightStatus",
"description": "Level of the most severe insight generated by the detector."
}
}
},
"StatusCodesBasedTrigger": {
"type": "object",
"description": "Trigger based on status code.",
"properties": {
"status": {
"type": "integer",
"format": "int32",
"description": "HTTP status code."
},
"subStatus": {
"type": "integer",
"format": "int32",
"description": "Request Sub Status."
},
"win32Status": {
"type": "integer",
"format": "int32",
"description": "Win32 error code."
},
"count": {
"type": "integer",
"format": "int32",
"description": "Request Count."
},
"timeInterval": {
"type": "string",
"description": "Time interval."
},
"path": {
"type": "string",
"description": "Request Path"
}
}
},
"StatusCodesRangeBasedTrigger": {
"type": "object",
"description": "Trigger based on range of status codes.",
"properties": {
"statusCodes": {
"type": "string",
"description": "HTTP status code."
},
"path": {
"type": "string"
},
"count": {
"type": "integer",
"format": "int32",
"description": "Request Count."
},
"timeInterval": {
"type": "string",
"description": "Time interval."
}
}
},
"StatusOptions": {
"type": "string",
"description": "App Service plan status.",
"enum": [
"Ready",
"Pending",
"Creating"
],
"x-ms-enum": {
"name": "StatusOptions",
"modelAsString": false
}
},
"StorageMigrationOptions": {
"type": "object",
"description": "Options for app content migration.",
"properties": {
"properties": {
"$ref": "#/definitions/StorageMigrationOptionsProperties",
"description": "StorageMigrationOptions resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StorageMigrationOptionsProperties": {
"type": "object",
"description": "StorageMigrationOptions resource specific properties",
"properties": {
"azurefilesConnectionString": {
"type": "string",
"description": "AzureFiles connection string.",
"x-ms-mutability": [
"create"
]
},
"azurefilesShare": {
"type": "string",
"description": "AzureFiles share.",
"x-ms-mutability": [
"create"
]
},
"switchSiteAfterMigration": {
"type": "boolean",
"description": "trueif the app should be switched over; otherwise, false.",
"default": false,
"x-ms-mutability": [
"create"
]
},
"blockWriteAccessToSite": {
"type": "boolean",
"description": "true if the app should be read only during copy operation; otherwise, false.",
"default": false,
"x-ms-mutability": [
"create"
]
}
},
"required": [
"azurefilesConnectionString",
"azurefilesShare"
]
},
"StorageMigrationResponse": {
"type": "object",
"description": "Response for a migration of app content request.",
"properties": {
"properties": {
"$ref": "#/definitions/StorageMigrationResponseProperties",
"description": "StorageMigrationResponse resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StorageMigrationResponseProperties": {
"type": "object",
"description": "StorageMigrationResponse resource specific properties",
"properties": {
"operationId": {
"type": "string",
"description": "When server starts the migration process, it will return an operation ID identifying that particular migration operation.",
"readOnly": true
}
}
},
"StorageMount": {
"type": "object",
"description": "Server farm storage mount configuration.",
"properties": {
"name": {
"type": "string",
"description": "Name of the storage mount."
},
"type": {
"$ref": "#/definitions/StorageMountType",
"description": "Type of the storage mount."
},
"source": {
"type": "string",
"description": "Source of the fileshare/storage."
},
"destinationPath": {
"type": "string",
"description": "Path on worker where storage will be mounted."
},
"credentialsKeyVaultReference": {
"$ref": "#/definitions/KeyVaultReferenceWithStatus",
"description": "KV reference to the credentials to connect to the share."
}
}
},
"StorageMountType": {
"type": "string",
"description": "Type of the storage mount.",
"enum": [
"AzureFiles",
"LocalStorage",
"FileShare"
],
"x-ms-enum": {
"name": "StorageMountType",
"modelAsString": true,
"values": [
{
"name": "AzureFiles",
"value": "AzureFiles"
},
{
"name": "LocalStorage",
"value": "LocalStorage"
},
{
"name": "FileShare",
"value": "FileShare"
}
]
}
},
"StorageType": {
"type": "string",
"enum": [
"LocalNode",
"NetworkFileSystem"
],
"x-ms-enum": {
"name": "StorageType",
"modelAsString": false
}
},
"StringDictionary": {
"type": "object",
"description": "String dictionary resource.",
"properties": {
"properties": {
"type": "object",
"description": "Settings.",
"additionalProperties": {
"type": "string"
},
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"StringList": {
"type": "object",
"description": "String list resource.",
"properties": {
"properties": {
"type": "array",
"description": "List of string resources.",
"items": {
"type": "string"
}
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"SupportTopic": {
"type": "object",
"description": "Defines a unique Support Topic",
"properties": {
"id": {
"type": "string",
"description": "Support Topic Id",
"readOnly": true
},
"pesId": {
"type": "string",
"description": "Unique resource Id",
"readOnly": true
}
}
},
"SupportedTlsVersions": {
"type": "string",
"description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
"enum": [
"1.0",
"1.1",
"1.2",
"1.3"
],
"x-ms-enum": {
"name": "SupportedTlsVersions",
"modelAsString": true,
"values": [
{
"name": "1.0",
"value": "1.0"
},
{
"name": "1.1",
"value": "1.1"
},
{
"name": "1.2",
"value": "1.2"
},
{
"name": "1.3",
"value": "1.3"
}
]
}
},
"SwiftVirtualNetwork": {
"type": "object",
"description": "Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.",
"properties": {
"properties": {
"$ref": "#/definitions/SwiftVirtualNetworkProperties",
"description": "SwiftVirtualNetwork resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"SwiftVirtualNetworkProperties": {
"type": "object",
"description": "SwiftVirtualNetwork resource specific properties",
"properties": {
"subnetResourceId": {
"type": "string",
"description": "The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first."
},
"swiftSupported": {
"type": "boolean",
"description": "A flag that specifies if the scale unit this Web App is on supports Swift integration."
}
}
},
"TlsCipherSuites": {
"type": "string",
"description": "The minimum strength TLS cipher suite allowed for an application",
"enum": [
"TLS_AES_256_GCM_SHA384",
"TLS_AES_128_GCM_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
"TLS_RSA_WITH_AES_256_GCM_SHA384",
"TLS_RSA_WITH_AES_128_GCM_SHA256",
"TLS_RSA_WITH_AES_256_CBC_SHA256",
"TLS_RSA_WITH_AES_128_CBC_SHA256",
"TLS_RSA_WITH_AES_256_CBC_SHA",
"TLS_RSA_WITH_AES_128_CBC_SHA"
],
"x-ms-enum": {
"name": "TlsCipherSuites",
"modelAsString": true,
"values": [
{
"name": "TLS_AES_256_GCM_SHA384",
"value": "TLS_AES_256_GCM_SHA384"
},
{
"name": "TLS_AES_128_GCM_SHA256",
"value": "TLS_AES_128_GCM_SHA256"
},
{
"name": "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384",
"value": "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384"
},
{
"name": "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256",
"value": "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256"
},
{
"name": "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256",
"value": "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256"
},
{
"name": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384",
"value": "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384"
},
{
"name": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256",
"value": "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256"
},
{
"name": "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384",
"value": "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
},
{
"name": "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256",
"value": "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256"
},
{
"name": "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA",
"value": "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA"
},
{
"name": "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA",
"value": "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
},
{
"name": "TLS_RSA_WITH_AES_256_GCM_SHA384",
"value": "TLS_RSA_WITH_AES_256_GCM_SHA384"
},
{
"name": "TLS_RSA_WITH_AES_128_GCM_SHA256",
"value": "TLS_RSA_WITH_AES_128_GCM_SHA256"
},
{
"name": "TLS_RSA_WITH_AES_256_CBC_SHA256",
"value": "TLS_RSA_WITH_AES_256_CBC_SHA256"
},
{
"name": "TLS_RSA_WITH_AES_128_CBC_SHA256",
"value": "TLS_RSA_WITH_AES_128_CBC_SHA256"
},
{
"name": "TLS_RSA_WITH_AES_256_CBC_SHA",
"value": "TLS_RSA_WITH_AES_256_CBC_SHA"
},
{
"name": "TLS_RSA_WITH_AES_128_CBC_SHA",
"value": "TLS_RSA_WITH_AES_128_CBC_SHA"
}
]
}
},
"TokenStore": {
"type": "object",
"description": "The configuration settings of the token store.",
"properties": {
"enabled": {
"type": "boolean",
"description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\nThe default is false."
},
"tokenRefreshExtensionHours": {
"type": "number",
"format": "double",
"description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours."
},
"fileSystem": {
"$ref": "#/definitions/FileSystemTokenStore",
"description": "The configuration settings of the storage of the tokens if a file system is used."
},
"azureBlobStorage": {
"$ref": "#/definitions/BlobStorageTokenStore",
"description": "The configuration settings of the storage of the tokens if blob storage is used."
}
}
},
"TriggerTypes": {
"type": "string",
"description": "The trigger type of the function",
"enum": [
"HttpTrigger",
"Unknown"
],
"x-ms-enum": {
"name": "TriggerTypes",
"modelAsString": true,
"values": [
{
"name": "HttpTrigger",
"value": "HttpTrigger"
},
{
"name": "Unknown",
"value": "Unknown"
}
]
}
},
"TriggeredJobHistory": {
"type": "object",
"description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.",
"properties": {
"properties": {
"$ref": "#/definitions/TriggeredJobHistoryProperties",
"description": "TriggeredJobHistory resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"TriggeredJobHistoryCollection": {
"type": "object",
"description": "Collection of Kudu continuous web job information elements.",
"properties": {
"value": {
"type": "array",
"description": "The TriggeredJobHistory items on this page",
"items": {
"$ref": "#/definitions/TriggeredJobHistory"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"TriggeredJobHistoryProperties": {
"type": "object",
"description": "TriggeredJobHistory resource specific properties",
"properties": {
"runs": {
"type": "array",
"description": "List of triggered web job runs.",
"items": {
"$ref": "#/definitions/TriggeredJobRun"
},
"x-ms-identifiers": [
"web_job_id"
]
}
}
},
"TriggeredJobRun": {
"type": "object",
"description": "Triggered Web Job Run Information.",
"properties": {
"web_job_id": {
"type": "string",
"description": "Job ID.",
"x-ms-client-name": "webJobId"
},
"web_job_name": {
"type": "string",
"description": "Job name.",
"x-ms-client-name": "webJobName"
},
"status": {
"$ref": "#/definitions/TriggeredWebJobStatus",
"description": "Job status."
},
"start_time": {
"type": "string",
"format": "date-time",
"description": "Start time.",
"x-ms-client-name": "startTime"
},
"end_time": {
"type": "string",
"format": "date-time",
"description": "End time.",
"x-ms-client-name": "endTime"
},
"duration": {
"type": "string",
"description": "Job duration."
},
"output_url": {
"type": "string",
"description": "Output URL.",
"x-ms-client-name": "outputUrl"
},
"error_url": {
"type": "string",
"description": "Error URL.",
"x-ms-client-name": "errorUrl"
},
"url": {
"type": "string",
"description": "Job URL."
},
"job_name": {
"type": "string",
"description": "Job name.",
"x-ms-client-name": "jobName"
},
"trigger": {
"type": "string",
"description": "Job trigger."
}
}
},
"TriggeredWebJob": {
"type": "object",
"description": "Triggered Web Job Information.",
"properties": {
"properties": {
"$ref": "#/definitions/TriggeredWebJobProperties",
"description": "TriggeredWebJob resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"TriggeredWebJobCollection": {
"type": "object",
"description": "Collection of Kudu continuous web job information elements.",
"properties": {
"value": {
"type": "array",
"description": "The TriggeredWebJob items on this page",
"items": {
"$ref": "#/definitions/TriggeredWebJob"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"TriggeredWebJobProperties": {
"type": "object",
"description": "TriggeredWebJob resource specific properties",
"properties": {
"latest_run": {
"$ref": "#/definitions/TriggeredJobRun",
"description": "Latest job run information.",
"x-ms-client-name": "latestRun"
},
"history_url": {
"type": "string",
"description": "History URL.",
"x-ms-client-name": "historyUrl"
},
"scheduler_logs_url": {
"type": "string",
"description": "Scheduler Logs URL.",
"x-ms-client-name": "schedulerLogsUrl"
},
"run_command": {
"type": "string",
"description": "Run command.",
"x-ms-client-name": "runCommand"
},
"url": {
"type": "string",
"description": "Job URL."
},
"extra_info_url": {
"type": "string",
"description": "Extra Info URL.",
"x-ms-client-name": "extraInfoUrl"
},
"web_job_type": {
"$ref": "#/definitions/WebJobType",
"description": "Job type.",
"x-ms-client-name": "webJobType"
},
"error": {
"type": "string",
"description": "Error information."
},
"using_sdk": {
"type": "boolean",
"description": "Using SDK?",
"x-ms-client-name": "usingSdk"
},
"publicNetworkAccess": {
"type": "string",
"description": "Property to allow or block all public traffic. Allowed Values: 'Enabled', 'Disabled' or an empty string."
},
"storageAccountRequired": {
"type": "boolean",
"description": "Checks if Customer provided storage account is required"
},
"settings": {
"type": "object",
"description": "Job settings.",
"additionalProperties": {}
}
}
},
"TriggeredWebJobStatus": {
"type": "string",
"description": "Job status.",
"enum": [
"Success",
"Failed",
"Error"
],
"x-ms-enum": {
"name": "TriggeredWebJobStatus",
"modelAsString": false
}
},
"Twitter": {
"type": "object",
"description": "The configuration settings of the Twitter provider.",
"properties": {
"enabled": {
"type": "boolean",
"description": "false if the Twitter provider should not be enabled despite the set registration; otherwise, true."
},
"registration": {
"$ref": "#/definitions/TwitterRegistration",
"description": "The configuration settings of the app registration for the Twitter provider."
}
}
},
"TwitterRegistration": {
"type": "object",
"description": "The configuration settings of the app registration for the Twitter provider.",
"properties": {
"consumerKey": {
"type": "string",
"description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in"
},
"consumerSecretSettingName": {
"type": "string",
"description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in."
}
}
},
"UnauthenticatedClientAction": {
"type": "string",
"description": "The action to take when an unauthenticated client attempts to access the app.",
"enum": [
"RedirectToLoginPage",
"AllowAnonymous"
],
"x-ms-enum": {
"name": "UnauthenticatedClientAction",
"modelAsString": false
}
},
"UnauthenticatedClientActionV2": {
"type": "string",
"description": "The action to take when an unauthenticated client attempts to access the app.",
"enum": [
"RedirectToLoginPage",
"AllowAnonymous",
"Return401",
"Return403"
],
"x-ms-enum": {
"name": "UnauthenticatedClientActionV2",
"modelAsString": false
}
},
"UpgradeAvailability": {
"type": "string",
"description": "Whether an upgrade is available for this App Service Environment.",
"enum": [
"None",
"Ready"
],
"x-ms-enum": {
"name": "UpgradeAvailability",
"modelAsString": true,
"values": [
{
"name": "None",
"value": "None",
"description": "No upgrade is currently available for this App Service Environment"
},
{
"name": "Ready",
"value": "Ready",
"description": "An upgrade is ready to be manually initiated on this App Service Environment"
}
]
}
},
"Usage": {
"type": "object",
"description": "Usage of the quota resource.",
"properties": {
"properties": {
"$ref": "#/definitions/UsageProperties",
"description": "Usage resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"UsageCollection": {
"type": "object",
"description": "Collection of usages.",
"properties": {
"value": {
"type": "array",
"description": "The Usage items on this page",
"items": {
"$ref": "#/definitions/Usage"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"UsageProperties": {
"type": "object",
"description": "Usage resource specific properties",
"properties": {
"displayName": {
"type": "string",
"description": "Friendly name shown in the UI.",
"readOnly": true
},
"resourceName": {
"type": "string",
"description": "Name of the quota resource.",
"readOnly": true
},
"unit": {
"type": "string",
"description": "Units of measurement for the quota resource.",
"readOnly": true
},
"currentValue": {
"type": "integer",
"format": "int64",
"description": "The current value of the resource counter.",
"readOnly": true
},
"limit": {
"type": "integer",
"format": "int64",
"description": "The resource limit.",
"readOnly": true
},
"nextResetTime": {
"type": "string",
"format": "date-time",
"description": "Next reset time for the resource counter.",
"readOnly": true
},
"computeMode": {
"$ref": "#/definitions/ComputeModeOptions",
"description": "Compute mode used for this usage.",
"readOnly": true
},
"siteMode": {
"type": "string",
"description": "Site mode used for this usage.",
"readOnly": true
}
}
},
"UsageState": {
"type": "string",
"description": "State indicating whether the app has exceeded its quota usage. Read-only.",
"enum": [
"Normal",
"Exceeded"
],
"x-ms-enum": {
"name": "UsageState",
"modelAsString": false
}
},
"User": {
"type": "object",
"description": "User credentials used for publishing activity.",
"properties": {
"properties": {
"$ref": "#/definitions/UserProperties",
"description": "User resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"UserAssignedIdentity": {
"type": "object",
"description": "User Assigned identity.",
"properties": {
"principalId": {
"type": "string",
"description": "Principal Id of user assigned identity",
"readOnly": true
},
"clientId": {
"type": "string",
"description": "Client Id of user assigned identity",
"readOnly": true
}
}
},
"UserProperties": {
"type": "object",
"description": "User resource specific properties",
"properties": {
"publishingUserName": {
"type": "string",
"description": "Username used for publishing."
},
"publishingPassword": {
"type": "string",
"format": "password",
"description": "Password used for publishing.",
"x-ms-secret": true
},
"publishingPasswordHash": {
"type": "string",
"format": "password",
"description": "Password hash used for publishing.",
"x-ms-secret": true
},
"publishingPasswordHashSalt": {
"type": "string",
"format": "password",
"description": "Password hash salt used for publishing.",
"x-ms-secret": true
},
"scmUri": {
"type": "string",
"description": "Url of SCM site."
}
},
"required": [
"publishingUserName"
]
},
"ValidateProperties": {
"type": "object",
"description": "App properties used for validation.",
"properties": {
"serverFarmId": {
"type": "string",
"description": "ARM resource ID of an App Service plan that would host the app."
},
"skuName": {
"type": "string",
"description": "Name of the target SKU for the App Service plan."
},
"needLinuxWorkers": {
"type": "boolean",
"description": "true if App Service plan is for Linux workers; otherwise, false."
},
"isSpot": {
"type": "boolean",
"description": "true if App Service plan is for Spot instances; otherwise, false."
},
"capacity": {
"type": "integer",
"format": "int32",
"description": "Target capacity of the App Service plan (number of VMs).",
"minimum": 1
},
"hostingEnvironment": {
"type": "string",
"description": "Name of App Service Environment where app or App Service plan should be created."
},
"isXenon": {
"type": "boolean",
"description": "true if App Service plan is running as a windows container"
},
"containerRegistryBaseUrl": {
"type": "string",
"description": "Base URL of the container registry"
},
"containerRegistryUsername": {
"type": "string",
"description": "Username for to access the container registry"
},
"containerRegistryPassword": {
"type": "string",
"description": "Password for to access the container registry"
},
"containerImageRepository": {
"type": "string",
"description": "Repository name (image name)"
},
"containerImageTag": {
"type": "string",
"description": "Image tag"
},
"containerImagePlatform": {
"type": "string",
"description": "Platform (windows or linux)"
},
"appServiceEnvironment": {
"$ref": "#/definitions/AppServiceEnvironment",
"description": "App Service Environment Properties"
}
}
},
"ValidateRequest": {
"type": "object",
"description": "Resource validation request content.",
"properties": {
"name": {
"type": "string",
"description": "Resource name to verify."
},
"type": {
"$ref": "#/definitions/ValidateResourceTypes",
"description": "Resource type used for verification."
},
"location": {
"type": "string",
"description": "Expected location of the resource."
},
"properties": {
"$ref": "#/definitions/ValidateProperties",
"description": "Properties of the resource to validate.",
"x-ms-client-flatten": true
}
},
"required": [
"name",
"type",
"location",
"properties"
]
},
"ValidateResourceTypes": {
"type": "string",
"description": "Resource type used for verification.",
"enum": [
"ServerFarm",
"Site",
"Microsoft.Web/hostingEnvironments"
],
"x-ms-enum": {
"name": "ValidateResourceTypes",
"modelAsString": true,
"values": [
{
"name": "ServerFarm",
"value": "ServerFarm"
},
{
"name": "Site",
"value": "Site"
},
{
"name": "Microsoft.Web/hostingEnvironments",
"value": "Microsoft.Web/hostingEnvironments"
}
]
}
},
"ValidateResponse": {
"type": "object",
"description": "Describes the result of resource validation.",
"properties": {
"status": {
"type": "string",
"description": "Result of validation."
},
"error": {
"$ref": "#/definitions/ValidateResponseError",
"description": "Error details for the case when validation fails."
}
}
},
"ValidateResponseError": {
"type": "object",
"description": "Error details for when validation fails.",
"properties": {
"code": {
"type": "string",
"description": "Validation error code."
},
"message": {
"type": "string",
"description": "Validation error message."
}
}
},
"VirtualApplication": {
"type": "object",
"description": "Virtual application in an app.",
"properties": {
"virtualPath": {
"type": "string",
"description": "Virtual path."
},
"physicalPath": {
"type": "string",
"description": "Physical path."
},
"preloadEnabled": {
"type": "boolean",
"description": "true if preloading is enabled; otherwise, false."
},
"virtualDirectories": {
"type": "array",
"description": "Virtual directories for virtual application.",
"items": {
"$ref": "#/definitions/VirtualDirectory"
},
"x-ms-identifiers": [
"virtualPath"
]
}
}
},
"VirtualDirectory": {
"type": "object",
"description": "Directory for virtual application.",
"properties": {
"virtualPath": {
"type": "string",
"description": "Path to virtual application."
},
"physicalPath": {
"type": "string",
"description": "Physical path."
}
}
},
"VirtualIPMapping": {
"type": "object",
"description": "Virtual IP mapping.",
"properties": {
"virtualIP": {
"type": "string",
"description": "Virtual IP address."
},
"internalHttpPort": {
"type": "integer",
"format": "int32",
"description": "Internal HTTP port."
},
"internalHttpsPort": {
"type": "integer",
"format": "int32",
"description": "Internal HTTPS port."
},
"inUse": {
"type": "boolean",
"description": "Is virtual IP mapping in use."
},
"serviceName": {
"type": "string",
"description": "name of the service that virtual IP is assigned to"
}
}
},
"VirtualNetworkProfile": {
"type": "object",
"description": "Specification for using a Virtual Network.",
"properties": {
"id": {
"type": "string",
"description": "Resource id of the Virtual Network."
},
"name": {
"type": "string",
"description": "Name of the Virtual Network (read-only).",
"readOnly": true
},
"type": {
"type": "string",
"description": "Resource type of the Virtual Network (read-only).",
"readOnly": true
},
"subnet": {
"type": "string",
"description": "Subnet within the Virtual Network."
}
},
"required": [
"id"
]
},
"VnetGateway": {
"type": "object",
"description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
"properties": {
"properties": {
"$ref": "#/definitions/VnetGatewayProperties",
"description": "VnetGateway resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"VnetGatewayProperties": {
"type": "object",
"description": "VnetGateway resource specific properties",
"properties": {
"vnetName": {
"type": "string",
"description": "The Virtual Network name.",
"x-ms-mutability": [
"read",
"create"
]
},
"vpnPackageUri": {
"type": "string",
"description": "The URI where the VPN package can be downloaded.",
"x-ms-mutability": [
"update",
"create"
]
}
},
"required": [
"vpnPackageUri"
]
},
"VnetInfo": {
"type": "object",
"description": "Virtual Network information contract.",
"properties": {
"vnetResourceId": {
"type": "string",
"description": "The Virtual Network's resource ID."
},
"certThumbprint": {
"type": "string",
"description": "The client certificate thumbprint.",
"readOnly": true
},
"certBlob": {
"type": "string",
"description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \\nPoint-To-Site VPN connection."
},
"routes": {
"type": "array",
"description": "The routes that this Virtual Network connection uses.",
"items": {
"$ref": "#/definitions/VnetRoute"
},
"readOnly": true
},
"resyncRequired": {
"type": "boolean",
"description": "true if a resync is required; otherwise, false.",
"readOnly": true
},
"dnsServers": {
"type": "string",
"description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses."
},
"isSwift": {
"type": "boolean",
"description": "Flag that is used to denote if this is VNET injection"
}
}
},
"VnetInfoResource": {
"type": "object",
"description": "Virtual Network information ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/VnetInfo",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"VnetParameters": {
"type": "object",
"description": "The required set of inputs to validate a VNET",
"properties": {
"properties": {
"$ref": "#/definitions/VnetParametersProperties",
"description": "VnetParameters resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"VnetParametersProperties": {
"type": "object",
"description": "VnetParameters resource specific properties",
"properties": {
"vnetResourceGroup": {
"type": "string",
"description": "The Resource Group of the VNET to be validated"
},
"vnetName": {
"type": "string",
"description": "The name of the VNET to be validated"
},
"vnetSubnetName": {
"type": "string",
"description": "The subnet name to be validated"
},
"subnetResourceId": {
"type": "string",
"description": "The ARM Resource ID of the subnet to validate"
}
}
},
"VnetRoute": {
"type": "object",
"description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
"properties": {
"properties": {
"$ref": "#/definitions/VnetRouteProperties",
"description": "VnetRoute resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"VnetRouteProperties": {
"type": "object",
"description": "VnetRoute resource specific properties",
"properties": {
"startAddress": {
"type": "string",
"description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified."
},
"endAddress": {
"type": "string",
"description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted."
},
"routeType": {
"$ref": "#/definitions/RouteType",
"description": "The type of route this is:\nDEFAULT - By default, every app has routes to the local address ranges specified by RFC1918\nINHERITED - Routes inherited from the real Virtual Network routes\nSTATIC - Static route set on the app only\n\nThese values will be used for syncing an app's routes with those from a Virtual Network."
}
}
},
"VnetValidationFailureDetails": {
"type": "object",
"description": "A class that describes the reason for a validation failure.",
"properties": {
"properties": {
"$ref": "#/definitions/VnetValidationFailureDetailsProperties",
"description": "VnetValidationFailureDetails resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"VnetValidationFailureDetailsProperties": {
"type": "object",
"description": "VnetValidationFailureDetails resource specific properties",
"properties": {
"message": {
"type": "string",
"description": "Text describing the validation outcome."
},
"failed": {
"type": "boolean",
"description": "A flag describing whether or not validation failed."
},
"failedTests": {
"type": "array",
"description": "A list of tests that failed in the validation.",
"items": {
"$ref": "#/definitions/VnetValidationTestFailure"
}
},
"warnings": {
"type": "array",
"description": "A list of warnings generated during validation.",
"items": {
"$ref": "#/definitions/VnetValidationTestFailure"
}
}
}
},
"VnetValidationTestFailure": {
"type": "object",
"description": "A class that describes a test that failed during NSG and UDR validation.",
"properties": {
"properties": {
"$ref": "#/definitions/VnetValidationTestFailureProperties",
"description": "VnetValidationTestFailure resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"VnetValidationTestFailureProperties": {
"type": "object",
"description": "VnetValidationTestFailure resource specific properties",
"properties": {
"testName": {
"type": "string",
"description": "The name of the test that failed."
},
"details": {
"type": "string",
"description": "The details of what caused the failure, e.g. the blocking rule name, etc."
}
}
},
"VolumeMount": {
"type": "object",
"properties": {
"volumeSubPath": {
"type": "string",
"description": "Sub path in the volume where volume is mounted from."
},
"containerMountPath": {
"type": "string",
"description": "Target path on the container where volume is mounted on"
},
"data": {
"type": "string",
"description": "Config Data to be mounted on the volume"
},
"readOnly": {
"type": "boolean",
"description": "Boolean to specify if the mount is read only on the container"
}
},
"required": [
"volumeSubPath",
"containerMountPath"
]
},
"WebAppCollection": {
"type": "object",
"description": "Collection of App Service apps.",
"properties": {
"value": {
"type": "array",
"description": "The Site items on this page",
"items": {
"$ref": "#/definitions/Site"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WebAppInstanceStatusCollection": {
"type": "object",
"description": "Collection of app instances.",
"properties": {
"value": {
"type": "array",
"description": "The WebSiteInstanceStatus items on this page",
"items": {
"$ref": "#/definitions/WebSiteInstanceStatus"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WebAppMajorVersion": {
"type": "object",
"description": "Web App stack major version.",
"properties": {
"displayText": {
"type": "string",
"description": "Web App stack major version (display only).",
"readOnly": true
},
"value": {
"type": "string",
"description": "Web App stack major version name.",
"readOnly": true
},
"minorVersions": {
"type": "array",
"description": "Minor versions associated with the major version.",
"items": {
"$ref": "#/definitions/WebAppMinorVersion"
},
"readOnly": true,
"x-ms-identifiers": [
"value"
]
}
}
},
"WebAppMinorVersion": {
"type": "object",
"description": "Web App stack minor version.",
"properties": {
"displayText": {
"type": "string",
"description": "Web App stack minor version (display only).",
"readOnly": true
},
"value": {
"type": "string",
"description": "Web App stack major version name.",
"readOnly": true
},
"stackSettings": {
"$ref": "#/definitions/WebAppRuntimes",
"description": "Settings associated with the minor version.",
"readOnly": true
}
}
},
"WebAppRuntimeSettings": {
"type": "object",
"description": "Web App runtime settings.",
"properties": {
"runtimeVersion": {
"type": "string",
"description": "Web App stack minor version (runtime only).",
"readOnly": true
},
"remoteDebuggingSupported": {
"type": "boolean",
"description": "true if remote debugging is supported for the stack; otherwise, false.",
"readOnly": true
},
"appInsightsSettings": {
"$ref": "#/definitions/AppInsightsWebAppStackSettings",
"description": "Application Insights settings associated with the minor version.",
"readOnly": true
},
"gitHubActionSettings": {
"$ref": "#/definitions/GitHubActionWebAppStackSettings",
"description": "GitHub Actions settings associated with the minor version.",
"readOnly": true
},
"isPreview": {
"type": "boolean",
"description": "true if the stack is in preview; otherwise, false.",
"readOnly": true
},
"isDeprecated": {
"type": "boolean",
"description": "true if the stack is deprecated; otherwise, false.",
"readOnly": true
},
"isHidden": {
"type": "boolean",
"description": "true if the stack should be hidden; otherwise, false.",
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"format": "date-time",
"description": "End-of-life date for the minor version.",
"readOnly": true
},
"isAutoUpdate": {
"type": "boolean",
"description": "true if the stack version is auto-updated; otherwise, false.",
"readOnly": true
},
"isEarlyAccess": {
"type": "boolean",
"description": "true if the minor version is early-access; otherwise, false.",
"readOnly": true
}
}
},
"WebAppRuntimes": {
"type": "object",
"description": "Web App stack runtimes.",
"properties": {
"linuxRuntimeSettings": {
"$ref": "#/definitions/WebAppRuntimeSettings",
"description": "Linux-specific settings associated with the minor version.",
"readOnly": true
},
"windowsRuntimeSettings": {
"$ref": "#/definitions/WebAppRuntimeSettings",
"description": "Windows-specific settings associated with the minor version.",
"readOnly": true
},
"linuxContainerSettings": {
"$ref": "#/definitions/LinuxJavaContainerSettings",
"description": "Linux-specific settings associated with the Java container minor version.",
"readOnly": true
},
"windowsContainerSettings": {
"$ref": "#/definitions/WindowsJavaContainerSettings",
"description": "Windows-specific settings associated with the Java container minor version.",
"readOnly": true
}
}
},
"WebAppStack": {
"type": "object",
"description": "Web App stack.",
"properties": {
"location": {
"type": "string",
"description": "Web App stack location.",
"readOnly": true
},
"properties": {
"$ref": "#/definitions/WebAppStackProperties",
"description": "WebAppStack resource specific properties",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "#/definitions/ProxyOnlyResource"
}
]
},
"WebAppStackCollection": {
"type": "object",
"description": "Collection of Web app Stacks",
"properties": {
"value": {
"type": "array",
"description": "The WebAppStack items on this page",
"items": {
"$ref": "#/definitions/WebAppStack"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WebAppStackProperties": {
"type": "object",
"description": "WebAppStack resource specific properties",
"properties": {
"displayText": {
"type": "string",
"description": "Web App stack (display only).",
"readOnly": true
},
"value": {
"type": "string",
"description": "Web App stack name.",
"readOnly": true
},
"majorVersions": {
"type": "array",
"description": "List of major versions available.",
"items": {
"$ref": "#/definitions/WebAppMajorVersion"
},
"readOnly": true,
"x-ms-identifiers": [
"value"
]
},
"preferredOs": {
"$ref": "#/definitions/StackPreferredOs",
"description": "Web App stack preferred OS.",
"readOnly": true
}
}
},
"WebJob": {
"type": "object",
"description": "Web Job Information.",
"properties": {
"properties": {
"$ref": "#/definitions/WebJobProperties",
"description": "WebJob resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WebJobCollection": {
"type": "object",
"description": "Collection of Kudu web job information elements.",
"properties": {
"value": {
"type": "array",
"description": "The WebJob items on this page",
"items": {
"$ref": "#/definitions/WebJob"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WebJobProperties": {
"type": "object",
"description": "WebJob resource specific properties",
"properties": {
"run_command": {
"type": "string",
"description": "Run command.",
"x-ms-client-name": "runCommand"
},
"url": {
"type": "string",
"description": "Job URL."
},
"extra_info_url": {
"type": "string",
"description": "Extra Info URL.",
"x-ms-client-name": "extraInfoUrl"
},
"web_job_type": {
"$ref": "#/definitions/WebJobType",
"description": "Job type.",
"x-ms-client-name": "webJobType"
},
"error": {
"type": "string",
"description": "Error information."
},
"using_sdk": {
"type": "boolean",
"description": "Using SDK?",
"x-ms-client-name": "usingSdk"
},
"settings": {
"type": "object",
"description": "Job settings.",
"additionalProperties": {}
}
}
},
"WebJobType": {
"type": "string",
"description": "Job type.",
"enum": [
"Continuous",
"Triggered"
],
"x-ms-enum": {
"name": "WebJobType",
"modelAsString": false
}
},
"WebSiteInstanceStatus": {
"type": "object",
"description": "Concrete proxy resource types can be created by aliasing this type using a specific property type.",
"properties": {
"properties": {
"$ref": "#/definitions/WebSiteInstanceStatusProperties",
"description": "WebSiteInstanceStatus resource specific properties",
"x-ms-client-flatten": true
},
"kind": {
"type": "string",
"description": "Kind of resource."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WebSiteInstanceStatusProperties": {
"type": "object",
"description": "WebSiteInstanceStatus resource specific properties",
"properties": {
"state": {
"$ref": "#/definitions/SiteRuntimeState"
},
"statusUrl": {
"type": "string",
"description": "Link to the GetStatusApi in Kudu"
},
"detectorUrl": {
"type": "string",
"description": "Link to the Diagnose and Solve Portal"
},
"consoleUrl": {
"type": "string",
"description": "Link to the console to web app instance"
},
"healthCheckUrl": {
"type": "string",
"description": "Link to the console to web app instance"
},
"containers": {
"type": "object",
"description": "Dictionary of ",
"additionalProperties": {
"$ref": "#/definitions/ContainerInfo"
}
},
"physicalZone": {
"type": "string",
"description": "The physical zone that the instance is in"
}
}
},
"WindowsJavaContainerSettings": {
"type": "object",
"description": "Windows Java Container settings.",
"properties": {
"javaContainer": {
"type": "string",
"description": "Java container (runtime only).",
"readOnly": true
},
"javaContainerVersion": {
"type": "string",
"description": "Java container version (runtime only).",
"readOnly": true
},
"isPreview": {
"type": "boolean",
"description": "true if the stack is in preview; otherwise, false.",
"readOnly": true
},
"isDeprecated": {
"type": "boolean",
"description": "true if the stack is deprecated; otherwise, false.",
"readOnly": true
},
"isHidden": {
"type": "boolean",
"description": "true if the stack should be hidden; otherwise, false.",
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"format": "date-time",
"description": "End-of-life date for the minor version.",
"readOnly": true
},
"isAutoUpdate": {
"type": "boolean",
"description": "true if the stack version is auto-updated; otherwise, false.",
"readOnly": true
},
"isEarlyAccess": {
"type": "boolean",
"description": "true if the minor version is early-access; otherwise, false.",
"readOnly": true
}
}
},
"WorkerPool": {
"type": "object",
"description": "Worker pool of an App Service Environment.",
"properties": {
"workerSizeId": {
"type": "integer",
"format": "int32",
"description": "Worker size ID for referencing this worker pool."
},
"computeMode": {
"$ref": "#/definitions/ComputeModeOptions",
"description": "Shared or dedicated app hosting."
},
"workerSize": {
"type": "string",
"description": "VM size of the worker pool instances."
},
"workerCount": {
"type": "integer",
"format": "int32",
"description": "Number of instances in the worker pool."
},
"instanceNames": {
"type": "array",
"description": "Names of all instances in the worker pool (read only).",
"items": {
"type": "string"
},
"readOnly": true
}
}
},
"WorkerPoolCollection": {
"type": "object",
"description": "Collection of worker pools.",
"properties": {
"value": {
"type": "array",
"description": "The WorkerPoolResource items on this page",
"items": {
"$ref": "#/definitions/WorkerPoolResource"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkerPoolResource": {
"type": "object",
"description": "Worker pool of an App Service Environment ARM resource.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkerPool",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"sku": {
"$ref": "#/definitions/SkuDescription",
"description": "Description of a SKU for a scalable resource."
},
"kind": {
"type": "string",
"description": "Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind."
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkerSizeOptions": {
"type": "string",
"description": "Size of the machines.",
"enum": [
"Small",
"Medium",
"Large",
"D1",
"D2",
"D3",
"SmallV3",
"MediumV3",
"LargeV3",
"NestedSmall",
"NestedSmallLinux",
"Default"
],
"x-ms-enum": {
"name": "WorkerSizeOptions",
"modelAsString": false
}
},
"Workflow": {
"type": "object",
"description": "The workflow type.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowProperties",
"description": "The workflow properties.",
"x-ms-client-flatten": true
},
"identity": {
"$ref": "#/definitions/ManagedServiceIdentity",
"description": "Managed service identity."
}
},
"allOf": [
{
"$ref": "#/definitions/WorkflowResource"
}
]
},
"WorkflowArtifacts": {
"type": "object",
"description": "The workflow filter.",
"properties": {
"appSettings": {
"description": "Application settings of the workflow."
},
"files": {
"type": "object",
"description": "Files of the app.",
"additionalProperties": {}
},
"filesToDelete": {
"type": "array",
"description": "Files of the app to delete.",
"items": {
"type": "string"
}
}
}
},
"WorkflowEnvelope": {
"type": "object",
"description": "Workflow properties definition.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowEnvelopeProperties",
"description": "Additional workflow properties."
},
"kind": {
"type": "string",
"description": "The resource kind."
},
"location": {
"type": "string",
"description": "The resource location.",
"x-ms-mutability": [
"read",
"create"
]
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkflowEnvelopeCollection": {
"type": "object",
"description": "Collection of Kudu workflow information elements.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowEnvelope items on this page",
"items": {
"$ref": "#/definitions/WorkflowEnvelope"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowEnvelopeProperties": {
"type": "object",
"description": "Additional workflow properties.",
"properties": {
"files": {
"type": "object",
"description": "Gets or sets the files.",
"additionalProperties": {}
},
"flowState": {
"$ref": "#/definitions/WorkflowState",
"description": "Gets or sets the state of the workflow."
},
"health": {
"$ref": "#/definitions/WorkflowHealth",
"description": "Gets or sets workflow health."
}
}
},
"WorkflowHealth": {
"type": "object",
"description": "Represents the workflow health.",
"properties": {
"state": {
"$ref": "#/definitions/WorkflowHealthState",
"description": "Gets or sets the workflow health state."
},
"error": {
"$ref": "#/definitions/ErrorEntity",
"description": "Gets or sets the workflow error."
}
},
"required": [
"state"
]
},
"WorkflowHealthState": {
"type": "string",
"description": "Gets or sets the workflow health state.",
"enum": [
"NotSpecified",
"Healthy",
"Unhealthy",
"Unknown"
],
"x-ms-enum": {
"name": "WorkflowHealthState",
"modelAsString": false
}
},
"WorkflowOutputParameter": {
"type": "object",
"description": "The workflow output parameter.",
"properties": {
"error": {
"description": "Gets the error.",
"readOnly": true
}
},
"allOf": [
{
"$ref": "#/definitions/WorkflowParameter"
}
]
},
"WorkflowParameter": {
"type": "object",
"description": "The workflow parameters.",
"properties": {
"type": {
"$ref": "#/definitions/ParameterType",
"description": "The type."
},
"value": {
"description": "The value."
},
"metadata": {
"description": "The metadata."
},
"description": {
"type": "string",
"description": "The description."
}
}
},
"WorkflowProperties": {
"type": "object",
"description": "The workflow properties.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/WorkflowProvisioningState",
"description": "Gets the provisioning state.",
"readOnly": true
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Gets the created time.",
"readOnly": true
},
"changedTime": {
"type": "string",
"format": "date-time",
"description": "Gets the changed time.",
"readOnly": true
},
"state": {
"$ref": "#/definitions/WorkflowState",
"description": "The state."
},
"version": {
"type": "string",
"description": "Gets the version.",
"readOnly": true
},
"accessEndpoint": {
"type": "string",
"description": "Gets the access endpoint.",
"readOnly": true
},
"endpointsConfiguration": {
"$ref": "#/definitions/FlowEndpointsConfiguration",
"description": "The endpoints configuration."
},
"accessControl": {
"$ref": "#/definitions/FlowAccessControlConfiguration",
"description": "The access control configuration."
},
"sku": {
"$ref": "#/definitions/WorkflowSku",
"description": "The sku.",
"readOnly": true
},
"integrationAccount": {
"$ref": "#/definitions/ResourceReference",
"description": "The integration account."
},
"integrationServiceEnvironment": {
"$ref": "#/definitions/ResourceReference",
"description": "The integration service environment."
},
"definition": {
"description": "The definition."
},
"parameters": {
"type": "object",
"description": "The parameters.",
"additionalProperties": {
"$ref": "#/definitions/WorkflowParameter"
}
},
"kind": {
"$ref": "#/definitions/Kind",
"description": "The workflow kind."
}
}
},
"WorkflowProvisioningState": {
"type": "string",
"description": "The workflow provisioning state.",
"enum": [
"NotSpecified",
"Accepted",
"Running",
"Ready",
"Creating",
"Created",
"Deleting",
"Deleted",
"Canceled",
"Failed",
"Succeeded",
"Moving",
"Updating",
"Registering",
"Registered",
"Unregistering",
"Unregistered",
"Completed",
"Renewing",
"Pending",
"Waiting",
"InProgress"
],
"x-ms-enum": {
"name": "WorkflowProvisioningState",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Accepted",
"value": "Accepted"
},
{
"name": "Running",
"value": "Running"
},
{
"name": "Ready",
"value": "Ready"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Created",
"value": "Created"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Deleted",
"value": "Deleted"
},
{
"name": "Canceled",
"value": "Canceled"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Moving",
"value": "Moving"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Registering",
"value": "Registering"
},
{
"name": "Registered",
"value": "Registered"
},
{
"name": "Unregistering",
"value": "Unregistering"
},
{
"name": "Unregistered",
"value": "Unregistered"
},
{
"name": "Completed",
"value": "Completed"
},
{
"name": "Renewing",
"value": "Renewing"
},
{
"name": "Pending",
"value": "Pending"
},
{
"name": "Waiting",
"value": "Waiting"
},
{
"name": "InProgress",
"value": "InProgress"
}
]
}
},
"WorkflowResource": {
"type": "object",
"description": "The base resource type.",
"properties": {
"id": {
"type": "string",
"description": "The resource id.",
"readOnly": true
},
"name": {
"type": "string",
"description": "Gets the resource name.",
"readOnly": true
},
"type": {
"type": "string",
"description": "Gets the resource type.",
"readOnly": true
},
"location": {
"type": "string",
"description": "The resource location."
},
"tags": {
"type": "object",
"description": "The resource tags.",
"additionalProperties": {
"type": "string"
}
}
}
},
"WorkflowRun": {
"type": "object",
"description": "The workflow run.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowRunProperties",
"description": "The workflow run properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkflowRunAction": {
"type": "object",
"description": "The workflow run action.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowRunActionProperties",
"description": "The workflow run action properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkflowRunActionListResult": {
"type": "object",
"description": "The response of a WorkflowRunAction list operation.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowRunAction items on this page",
"items": {
"$ref": "#/definitions/WorkflowRunAction"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowRunActionProperties": {
"type": "object",
"description": "The workflow run action properties.",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Gets the start time.",
"readOnly": true
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Gets the end time.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/WorkflowStatus",
"description": "Gets the status.",
"readOnly": true
},
"code": {
"type": "string",
"description": "Gets the code.",
"readOnly": true
},
"error": {
"description": "Gets the error.",
"readOnly": true
},
"trackingId": {
"type": "string",
"description": "Gets the tracking id.",
"readOnly": true
},
"correlation": {
"$ref": "#/definitions/RunActionCorrelation",
"description": "The correlation properties."
},
"inputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to inputs.",
"readOnly": true
},
"outputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to outputs.",
"readOnly": true
},
"trackedProperties": {
"description": "Gets the tracked properties.",
"readOnly": true
},
"retryHistory": {
"type": "array",
"description": "Gets the retry histories.",
"items": {
"$ref": "#/definitions/RetryHistory"
},
"x-ms-identifiers": []
}
}
},
"WorkflowRunActionRepetitionDefinition": {
"type": "object",
"description": "The workflow run action repetition definition.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowRunActionRepetitionProperties",
"description": "The workflow run action repetition properties definition.",
"x-ms-client-flatten": true
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"WorkflowRunActionRepetitionDefinitionCollection": {
"type": "object",
"description": "A collection of workflow run action repetitions.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowRunActionRepetitionDefinition items on this page",
"items": {
"$ref": "#/definitions/WorkflowRunActionRepetitionDefinition"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowRunActionRepetitionProperties": {
"type": "object",
"description": "The workflow run action repetition properties definition.",
"properties": {
"repetitionIndexes": {
"type": "array",
"description": "The repetition indexes.",
"items": {
"$ref": "#/definitions/RepetitionIndex"
},
"x-ms-identifiers": [
"itemIndex"
]
}
},
"allOf": [
{
"$ref": "#/definitions/OperationResult"
}
]
},
"WorkflowRunListResult": {
"type": "object",
"description": "The response of a WorkflowRun list operation.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowRun items on this page",
"items": {
"$ref": "#/definitions/WorkflowRun"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowRunProperties": {
"type": "object",
"description": "The workflow run properties.",
"properties": {
"waitEndTime": {
"type": "string",
"format": "date-time",
"description": "Gets the wait end time.",
"readOnly": true
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Gets the start time.",
"readOnly": true
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Gets the end time.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/WorkflowStatus",
"description": "Gets the status.",
"readOnly": true
},
"code": {
"type": "string",
"description": "Gets the code.",
"readOnly": true
},
"error": {
"description": "Gets the error.",
"readOnly": true
},
"correlationId": {
"type": "string",
"description": "Gets the correlation id.",
"readOnly": true
},
"correlation": {
"$ref": "#/definitions/Correlation",
"description": "The run correlation."
},
"workflow": {
"$ref": "#/definitions/ResourceReference",
"description": "Gets the reference to workflow version.",
"readOnly": true
},
"trigger": {
"$ref": "#/definitions/WorkflowRunTrigger",
"description": "Gets the fired trigger.",
"readOnly": true
},
"outputs": {
"type": "object",
"description": "Gets the outputs.",
"additionalProperties": {
"$ref": "#/definitions/WorkflowOutputParameter"
},
"readOnly": true
},
"response": {
"$ref": "#/definitions/WorkflowRunTrigger",
"description": "Gets the response of the flow run.",
"readOnly": true
}
}
},
"WorkflowRunTrigger": {
"type": "object",
"description": "The workflow run trigger.",
"properties": {
"name": {
"type": "string",
"description": "Gets the name.",
"readOnly": true
},
"inputs": {
"description": "Gets the inputs.",
"readOnly": true
},
"inputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to inputs.",
"readOnly": true
},
"outputs": {
"description": "Gets the outputs.",
"readOnly": true
},
"outputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to outputs.",
"readOnly": true
},
"scheduledTime": {
"type": "string",
"format": "date-time",
"description": "Gets the scheduled time.",
"readOnly": true
},
"startTime": {
"type": "string",
"format": "date-time",
"description": "Gets the start time.",
"readOnly": true
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Gets the end time.",
"readOnly": true
},
"trackingId": {
"type": "string",
"description": "Gets the tracking id.",
"readOnly": true
},
"correlation": {
"$ref": "#/definitions/Correlation",
"description": "The run correlation."
},
"code": {
"type": "string",
"description": "Gets the code.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/WorkflowStatus",
"description": "Gets the status.",
"readOnly": true
},
"error": {
"description": "Gets the error.",
"readOnly": true
},
"trackedProperties": {
"description": "Gets the tracked properties.",
"readOnly": true
}
}
},
"WorkflowSku": {
"type": "object",
"description": "The sku type.",
"properties": {
"name": {
"$ref": "#/definitions/WorkflowSkuName",
"description": "The name."
},
"plan": {
"$ref": "#/definitions/ResourceReference",
"description": "The reference to plan."
}
},
"required": [
"name"
]
},
"WorkflowSkuName": {
"type": "string",
"description": "The sku name.",
"enum": [
"NotSpecified",
"Free",
"Shared",
"Basic",
"Standard",
"Premium"
],
"x-ms-enum": {
"name": "WorkflowSkuName",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Free",
"value": "Free"
},
{
"name": "Shared",
"value": "Shared"
},
{
"name": "Basic",
"value": "Basic"
},
{
"name": "Standard",
"value": "Standard"
},
{
"name": "Premium",
"value": "Premium"
}
]
}
},
"WorkflowState": {
"type": "string",
"description": "The workflow state.",
"enum": [
"NotSpecified",
"Completed",
"Enabled",
"Disabled",
"Deleted",
"Suspended"
],
"x-ms-enum": {
"name": "WorkflowState",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Completed",
"value": "Completed"
},
{
"name": "Enabled",
"value": "Enabled"
},
{
"name": "Disabled",
"value": "Disabled"
},
{
"name": "Deleted",
"value": "Deleted"
},
{
"name": "Suspended",
"value": "Suspended"
}
]
}
},
"WorkflowStatus": {
"type": "string",
"description": "The workflow status.",
"enum": [
"NotSpecified",
"Paused",
"Running",
"Waiting",
"Succeeded",
"Skipped",
"Suspended",
"Cancelled",
"Failed",
"Faulted",
"TimedOut",
"Aborted",
"Ignored"
],
"x-ms-enum": {
"name": "WorkflowStatus",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Paused",
"value": "Paused"
},
{
"name": "Running",
"value": "Running"
},
{
"name": "Waiting",
"value": "Waiting"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Skipped",
"value": "Skipped"
},
{
"name": "Suspended",
"value": "Suspended"
},
{
"name": "Cancelled",
"value": "Cancelled"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Faulted",
"value": "Faulted"
},
{
"name": "TimedOut",
"value": "TimedOut"
},
{
"name": "Aborted",
"value": "Aborted"
},
{
"name": "Ignored",
"value": "Ignored"
}
]
}
},
"WorkflowTrigger": {
"type": "object",
"description": "The workflow trigger.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowTriggerProperties",
"description": "The workflow trigger properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkflowTriggerCallbackUrl": {
"type": "object",
"description": "The workflow trigger callback URL.",
"properties": {
"value": {
"type": "string",
"description": "Gets the workflow trigger callback URL.",
"readOnly": true
},
"method": {
"type": "string",
"description": "Gets the workflow trigger callback URL HTTP method.",
"readOnly": true
},
"basePath": {
"type": "string",
"description": "Gets the workflow trigger callback URL base path.",
"readOnly": true
},
"relativePath": {
"type": "string",
"description": "Gets the workflow trigger callback URL relative path.",
"readOnly": true
},
"relativePathParameters": {
"type": "array",
"description": "Gets the workflow trigger callback URL relative path parameters.",
"items": {
"type": "string"
}
},
"queries": {
"$ref": "#/definitions/WorkflowTriggerListCallbackUrlQueries",
"description": "Gets the workflow trigger callback URL query parameters."
}
}
},
"WorkflowTriggerHistory": {
"type": "object",
"description": "The workflow trigger history.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowTriggerHistoryProperties",
"description": "Gets the workflow trigger history properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/ProxyResource"
}
]
},
"WorkflowTriggerHistoryListResult": {
"type": "object",
"description": "The response of a WorkflowTriggerHistory list operation.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowTriggerHistory items on this page",
"items": {
"$ref": "#/definitions/WorkflowTriggerHistory"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowTriggerHistoryProperties": {
"type": "object",
"description": "The workflow trigger history properties.",
"properties": {
"startTime": {
"type": "string",
"format": "date-time",
"description": "Gets the start time.",
"readOnly": true
},
"endTime": {
"type": "string",
"format": "date-time",
"description": "Gets the end time.",
"readOnly": true
},
"scheduledTime": {
"type": "string",
"format": "date-time",
"description": "The scheduled time.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/WorkflowStatus",
"description": "Gets the status.",
"readOnly": true
},
"code": {
"type": "string",
"description": "Gets the code.",
"readOnly": true
},
"error": {
"description": "Gets the error.",
"readOnly": true
},
"trackingId": {
"type": "string",
"description": "Gets the tracking id.",
"readOnly": true
},
"correlation": {
"$ref": "#/definitions/Correlation",
"description": "The run correlation."
},
"inputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to input parameters.",
"readOnly": true
},
"outputsLink": {
"$ref": "#/definitions/ContentLink",
"description": "Gets the link to output parameters.",
"readOnly": true
},
"fired": {
"type": "boolean",
"description": "The value indicating whether trigger was fired.",
"readOnly": true
},
"run": {
"$ref": "#/definitions/ResourceReference",
"description": "Gets the reference to workflow run.",
"readOnly": true
}
}
},
"WorkflowTriggerListCallbackUrlQueries": {
"type": "object",
"description": "Gets the workflow trigger callback URL query parameters.",
"properties": {
"api-version": {
"type": "string",
"description": "The api version.",
"x-ms-client-name": "apiVersion"
},
"sp": {
"type": "string",
"description": "The SAS permissions."
},
"sv": {
"type": "string",
"description": "The SAS version."
},
"sig": {
"type": "string",
"description": "The SAS signature."
},
"se": {
"type": "string",
"description": "The SAS timestamp."
}
}
},
"WorkflowTriggerListResult": {
"type": "object",
"description": "The response of a WorkflowTrigger list operation.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowTrigger items on this page",
"items": {
"$ref": "#/definitions/WorkflowTrigger"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowTriggerProperties": {
"type": "object",
"description": "The workflow trigger properties.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/WorkflowTriggerProvisioningState",
"description": "Gets the provisioning state.",
"readOnly": true
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Gets the created time.",
"readOnly": true
},
"changedTime": {
"type": "string",
"format": "date-time",
"description": "Gets the changed time.",
"readOnly": true
},
"state": {
"$ref": "#/definitions/WorkflowState",
"description": "Gets the state.",
"readOnly": true
},
"status": {
"$ref": "#/definitions/WorkflowStatus",
"description": "Gets the status.",
"readOnly": true
},
"lastExecutionTime": {
"type": "string",
"format": "date-time",
"description": "Gets the last execution time.",
"readOnly": true
},
"nextExecutionTime": {
"type": "string",
"format": "date-time",
"description": "Gets the next execution time.",
"readOnly": true
},
"recurrence": {
"$ref": "#/definitions/WorkflowTriggerRecurrence",
"description": "Gets the workflow trigger recurrence.",
"readOnly": true
},
"workflow": {
"$ref": "#/definitions/ResourceReference",
"description": "Gets the reference to workflow.",
"readOnly": true
}
}
},
"WorkflowTriggerProvisioningState": {
"type": "string",
"description": "The workflow trigger provisioning state.",
"enum": [
"NotSpecified",
"Accepted",
"Running",
"Ready",
"Creating",
"Created",
"Deleting",
"Deleted",
"Canceled",
"Failed",
"Succeeded",
"Moving",
"Updating",
"Registering",
"Registered",
"Unregistering",
"Unregistered",
"Completed"
],
"x-ms-enum": {
"name": "WorkflowTriggerProvisioningState",
"modelAsString": true,
"values": [
{
"name": "NotSpecified",
"value": "NotSpecified"
},
{
"name": "Accepted",
"value": "Accepted"
},
{
"name": "Running",
"value": "Running"
},
{
"name": "Ready",
"value": "Ready"
},
{
"name": "Creating",
"value": "Creating"
},
{
"name": "Created",
"value": "Created"
},
{
"name": "Deleting",
"value": "Deleting"
},
{
"name": "Deleted",
"value": "Deleted"
},
{
"name": "Canceled",
"value": "Canceled"
},
{
"name": "Failed",
"value": "Failed"
},
{
"name": "Succeeded",
"value": "Succeeded"
},
{
"name": "Moving",
"value": "Moving"
},
{
"name": "Updating",
"value": "Updating"
},
{
"name": "Registering",
"value": "Registering"
},
{
"name": "Registered",
"value": "Registered"
},
{
"name": "Unregistering",
"value": "Unregistering"
},
{
"name": "Unregistered",
"value": "Unregistered"
},
{
"name": "Completed",
"value": "Completed"
}
]
}
},
"WorkflowTriggerRecurrence": {
"type": "object",
"description": "The workflow trigger recurrence.",
"properties": {
"frequency": {
"$ref": "#/definitions/RecurrenceFrequency",
"description": "The frequency."
},
"interval": {
"type": "integer",
"format": "int32",
"description": "The interval."
},
"startTime": {
"type": "string",
"description": "The start time."
},
"endTime": {
"type": "string",
"description": "The end time."
},
"timeZone": {
"type": "string",
"description": "The time zone."
},
"schedule": {
"$ref": "#/definitions/RecurrenceSchedule",
"description": "The recurrence schedule."
}
}
},
"WorkflowVersion": {
"type": "object",
"description": "The workflow version.",
"properties": {
"properties": {
"$ref": "#/definitions/WorkflowVersionProperties",
"description": "The workflow version properties.",
"x-ms-client-flatten": true
}
},
"allOf": [
{
"$ref": "../../../../../../common-types/resource-management/v5/types.json#/definitions/TrackedResource"
}
]
},
"WorkflowVersionListResult": {
"type": "object",
"description": "The response of a WorkflowVersion list operation.",
"properties": {
"value": {
"type": "array",
"description": "The WorkflowVersion items on this page",
"items": {
"$ref": "#/definitions/WorkflowVersion"
}
},
"nextLink": {
"type": "string",
"format": "uri",
"description": "The link to the next page of items"
}
},
"required": [
"value"
]
},
"WorkflowVersionProperties": {
"type": "object",
"description": "The workflow version properties.",
"properties": {
"provisioningState": {
"$ref": "#/definitions/WorkflowProvisioningState",
"description": "The provisioning state.",
"readOnly": true
},
"createdTime": {
"type": "string",
"format": "date-time",
"description": "Gets the created time.",
"readOnly": true
},
"changedTime": {
"type": "string",
"format": "date-time",
"description": "Gets the changed time.",
"readOnly": true
},
"state": {
"$ref": "#/definitions/WorkflowState",
"description": "The state."
},
"version": {
"type": "string",
"description": "Gets the version.",
"readOnly": true
},
"accessEndpoint": {
"type": "string",
"description": "Gets the access endpoint.",
"readOnly": true
},
"endpointsConfiguration": {
"$ref": "#/definitions/FlowEndpointsConfiguration",
"description": "The endpoints configuration."
},
"accessControl": {
"$ref": "#/definitions/FlowAccessControlConfiguration",
"description": "The access control configuration."
},
"sku": {
"$ref": "#/definitions/WorkflowSku",
"description": "The sku.",
"readOnly": true
},
"integrationAccount": {
"$ref": "#/definitions/ResourceReference",
"description": "The integration account."
},
"definition": {
"description": "The definition."
},
"parameters": {
"type": "object",
"description": "The parameters.",
"additionalProperties": {
"$ref": "#/definitions/WorkflowParameter"
}
}
}
},
"stringApplicationJson": {
"type": "string"
}
},
"parameters": {}
}