diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/2015-08-01/AppServiceCertificateOrders.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/2015-08-01/AppServiceCertificateOrders.json
index a3996798ff08..87202f66fa8b 100644
--- a/specification/web/resource-manager/Microsoft.CertificateRegistration/2015-08-01/AppServiceCertificateOrders.json
+++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/2015-08-01/AppServiceCertificateOrders.json
@@ -655,7 +655,7 @@
"description": "Email address",
"required": true,
"schema": {
- "$ref": "#/definitions/NameIdentifier"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/NameIdentifier"
}
},
{
@@ -891,7 +891,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -1095,7 +1095,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1279,7 +1279,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1295,7 +1295,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -1365,7 +1365,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1391,7 +1391,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -1432,47 +1432,12 @@
}
}
},
- "NameIdentifier": {
- "description": "Identifies an object.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the object.",
- "type": "string"
- }
- }
- },
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
"ReissueCertificateOrderRequest": {
"description": "Class representing certificate reissue request.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -1507,7 +1472,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -1532,45 +1497,6 @@
}
}
},
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
- },
"SiteSeal": {
"description": "Site seal",
"required": [
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/Domains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/Domains.json
index 93f008aa849e..8016d31713e9 100644
--- a/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/Domains.json
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/Domains.json
@@ -30,7 +30,7 @@
"description": "Name of the domain.",
"required": true,
"schema": {
- "$ref": "#/definitions/NameIdentifier"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/NameIdentifier"
}
},
{
@@ -667,7 +667,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -937,7 +937,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -978,7 +978,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1270,16 +1270,6 @@
}
}
},
- "NameIdentifier": {
- "description": "Identifies an object.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the object.",
- "type": "string"
- }
- }
- },
"NameIdentifierCollection": {
"description": "Collection of domain name identifiers.",
"required": [
@@ -1291,7 +1281,7 @@
"description": "Collection of resources.",
"type": "array",
"items": {
- "$ref": "#/definitions/NameIdentifier"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/NameIdentifier"
}
},
"nextLink": {
@@ -1299,70 +1289,6 @@
"type": "string"
}
}
- },
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
}
},
"parameters": {
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json
index a551aaacba3c..a08a14a46c5d 100644
--- a/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json
@@ -124,31 +124,6 @@
}
},
"definitions": {
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
"TldLegalAgreement": {
"description": "Legal agreement for a top level domain.",
"required": [
@@ -201,7 +176,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../../Microsoft.Web/2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
diff --git a/specification/web/resource-manager/Microsoft.Web/2016-03-01/Certificates.json b/specification/web/resource-manager/Microsoft.Web/2016-03-01/Certificates.json
index ef4b3b8ba8e0..abb867e6d1b4 100644
--- a/specification/web/resource-manager/Microsoft.Web/2016-03-01/Certificates.json
+++ b/specification/web/resource-manager/Microsoft.Web/2016-03-01/Certificates.json
@@ -239,7 +239,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "./CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -327,7 +327,7 @@
"readOnly": true
},
"hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
+ "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the certificate.",
"readOnly": true
},
@@ -400,7 +400,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -488,7 +488,7 @@
"readOnly": true
},
"hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
+ "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the certificate.",
"readOnly": true
},
@@ -535,90 +535,6 @@
"x-ms-client-flatten": true
}
}
- },
- "HostingEnvironmentProfile": {
- "description": "Specification for an App Service Environment to use for this resource.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource ID of the App Service Environment.",
- "type": "string"
- },
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the App Service Environment.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
}
},
"parameters": {
diff --git a/specification/web/resource-manager/Microsoft.Web/2016-03-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/2016-03-01/CommonDefinitions.json
index db432dd033c3..c5c524bf1a64 100644
--- a/specification/web/resource-manager/Microsoft.Web/2016-03-01/CommonDefinitions.json
+++ b/specification/web/resource-manager/Microsoft.Web/2016-03-01/CommonDefinitions.json
@@ -1,2549 +1,2565 @@
{
- "swagger": "2.0",
- "info": {
- "version": "2016-03-01",
- "title": "Common Definitions"
+ "swagger": "2.0",
+ "info": {
+ "version": "2016-03-01",
+ "title": "Common Definitions"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "paths": {},
+ "definitions": {
+ "ApiDefinitionInfo": {
+ "description": "Information about the formal API definition for the app.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "The URL of the API definition.",
+ "type": "string"
+ }
+ }
},
- "host": "management.azure.com",
- "schemes": [
- "https"
- ],
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "paths": {},
- "definitions": {
- "ApiDefinitionInfo": {
- "description": "Information about the formal API definition for the app.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL of the API definition.",
- "type": "string"
- }
- }
+ "AppServiceEnvironment": {
+ "description": "Description of an App Service Environment.",
+ "required": [
+ "name",
+ "location",
+ "virtualNetwork",
+ "workerPools"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the App Service Environment.",
+ "type": "string"
},
- "AppServiceEnvironment": {
- "description": "Description of an App Service Environment.",
- "required": [
- "name",
- "location",
- "virtualNetwork",
- "workerPools"
- ],
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string"
- },
- "location": {
- "description": "Location of the App Service Environment, e.g. \"West US\".",
- "type": "string"
- },
- "provisioningState": {
- "description": "Provisioning state of the App Service Environment.",
- "enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": false
- }
- },
- "status": {
- "description": "Current status of the App Service Environment.",
- "enum": [
- "Preparing",
- "Ready",
- "Scaling",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "HostingEnvironmentStatus",
- "modelAsString": false
- }
- },
- "vnetName": {
- "description": "Name of the Virtual Network for the App Service Environment.",
- "type": "string"
- },
- "vnetResourceGroupName": {
- "description": "Resource group of the Virtual Network.",
- "type": "string"
- },
- "vnetSubnetName": {
- "description": "Subnet of the Virtual Network.",
- "type": "string"
- },
- "virtualNetwork": {
- "$ref": "#/definitions/VirtualNetworkProfile",
- "description": "Description of the Virtual Network."
- },
- "internalLoadBalancingMode": {
- "description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
- "enum": [
- "None",
- "Web",
- "Publishing"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "InternalLoadBalancingMode",
- "modelAsString": false
- }
- },
- "multiSize": {
- "description": "Front-end VM size, e.g. \"Medium\", \"Large\".",
- "type": "string"
- },
- "multiRoleCount": {
- "format": "int32",
- "description": "Number of front-end instances.",
- "type": "integer"
- },
- "workerPools": {
- "description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/WorkerPool"
- }
- },
- "ipsslAddressCount": {
- "format": "int32",
- "description": "Number of IP SSL addresses reserved for the App Service Environment.",
- "type": "integer"
- },
- "databaseEdition": {
- "description": "Edition of the metadata database for the App Service Environment, e.g. \"Standard\".",
- "type": "string",
- "readOnly": true
- },
- "databaseServiceObjective": {
- "description": "Service objective of the metadata database for the App Service Environment, e.g. \"S0\".",
- "type": "string",
- "readOnly": true
- },
- "upgradeDomains": {
- "format": "int32",
- "description": "Number of upgrade domains of the App Service Environment.",
- "type": "integer",
- "readOnly": true
- },
- "subscriptionId": {
- "description": "Subscription of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "dnsSuffix": {
- "description": "DNS suffix of the App Service Environment.",
- "type": "string"
- },
- "lastAction": {
- "description": "Last deployment action on the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "lastActionResult": {
- "description": "Result of the last deployment action on the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "allowedMultiSizes": {
- "description": "List of comma separated strings describing which VM sizes are allowed for front-ends.",
- "type": "string",
- "readOnly": true
- },
- "allowedWorkerSizes": {
- "description": "List of comma separated strings describing which VM sizes are allowed for workers.",
- "type": "string",
- "readOnly": true
- },
- "maximumNumberOfMachines": {
- "format": "int32",
- "description": "Maximum number of VMs in the App Service Environment.",
- "type": "integer",
- "readOnly": true
- },
- "vipMappings": {
- "description": "Description of IP SSL mapping for the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualIPMapping"
- },
- "readOnly": true
- },
- "environmentCapacities": {
- "description": "Current total, used, and available worker capacities.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StampCapacity"
- },
- "readOnly": true
- },
- "networkAccessControlList": {
- "description": "Access control list for controlling traffic to the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NetworkAccessControlEntry"
- }
- },
- "environmentIsHealthy": {
- "description": "True/false indicating whether the App Service Environment is healthy.",
- "type": "boolean",
- "readOnly": true
- },
- "environmentStatus": {
- "description": "Detailed message about with results of the last check of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "resourceGroup": {
- "description": "Resource group of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "frontEndScaleFactor": {
- "format": "int32",
- "description": "Scale factor for front-ends.",
- "type": "integer"
- },
- "defaultFrontEndScaleFactor": {
- "format": "int32",
- "description": "Default Scale Factor for FrontEnds.",
- "type": "integer",
- "readOnly": true
- },
- "apiManagementAccountId": {
- "description": "API Management Account associated with the App Service Environment.",
- "type": "string"
- },
- "suspended": {
- "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).",
- "type": "boolean"
- },
- "dynamicCacheEnabled": {
- "description": "True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
- "type": "boolean"
- },
- "clusterSettings": {
- "description": "Custom settings for changing the behavior of the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "userWhitelistedIpRanges": {
- "description": "User added ip ranges to whitelist on ASE db",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
+ "location": {
+ "description": "Location of the App Service Environment, e.g. \"West US\".",
+ "type": "string"
},
- "AppServicePlan": {
- "description": "App Service plan.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "description": "AppServicePlan resource specific properties",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "Name for the App Service plan.",
- "type": "string"
- },
- "workerTierName": {
- "description": "Target worker tier assigned to the App Service plan.",
- "type": "string"
- },
- "status": {
- "description": "App Service plan status.",
- "enum": [
- "Ready",
- "Pending",
- "Creating"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "StatusOptions",
- "modelAsString": false
- }
- },
- "subscription": {
- "description": "App Service plan subscription.",
- "type": "string",
- "readOnly": true
- },
- "adminSiteName": {
- "description": "App Service plan administration site.",
- "type": "string"
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "Specification for the App Service Environment to use for the App Service plan.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "maximumNumberOfWorkers": {
- "format": "int32",
- "description": "Maximum number of instances that can be assigned to this App Service plan.",
- "type": "integer",
- "readOnly": true
- },
- "geoRegion": {
- "description": "Geographical location for the App Service plan.",
- "type": "string",
- "readOnly": true
- },
- "perSiteScaling": {
- "description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.",
- "default": false,
- "type": "boolean"
- },
- "numberOfSites": {
- "format": "int32",
- "description": "Number of apps assigned to this App Service plan.",
- "type": "integer",
- "readOnly": true
- },
- "isSpot": {
- "description": "If true, this App Service Plan owns spot instances.",
- "type": "boolean"
- },
- "spotExpirationTime": {
- "format": "date-time",
- "description": "The time when the server farm expires. Valid only if it is a spot server farm.",
- "type": "string"
- },
- "resourceGroup": {
- "description": "Resource group of the App Service plan.",
- "type": "string",
- "readOnly": true
- },
- "reserved": {
- "description": "Reserved.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "targetWorkerCount": {
- "format": "int32",
- "description": "Scaling worker count.",
- "type": "integer"
- },
- "targetWorkerSizeId": {
- "format": "int32",
- "description": "Scaling worker size ID.",
- "type": "integer"
- },
- "provisioningState": {
- "description": "Provisioning state of the App Service Environment.",
- "enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": false
- }
- }
- },
- "x-ms-client-flatten": true
- },
- "sku": {
- "$ref": "#/definitions/SkuDescription"
- }
- }
+ "provisioningState": {
+ "description": "Provisioning state of the App Service Environment.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false
+ }
},
- "AppServicePlanCollection": {
- "description": "Collection of App Service plans.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/AppServicePlan"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
+ "status": {
+ "description": "Current status of the App Service Environment.",
+ "enum": [
+ "Preparing",
+ "Ready",
+ "Scaling",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "HostingEnvironmentStatus",
+ "modelAsString": false
+ }
},
- "AutoHealActions": {
- "description": "Actions which to take by the auto-heal module when a rule is triggered.",
- "type": "object",
- "properties": {
- "actionType": {
- "description": "Predefined action to be taken.",
- "enum": [
- "Recycle",
- "LogEvent",
- "CustomAction"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AutoHealActionType",
- "modelAsString": false
- }
- },
- "customAction": {
- "$ref": "#/definitions/AutoHealCustomAction",
- "description": "Custom action to be taken."
- },
- "minProcessExecutionTime": {
- "description": "Minimum time the process must execute\nbefore taking the action",
- "type": "string"
- }
- }
+ "vnetName": {
+ "description": "Name of the Virtual Network for the App Service Environment.",
+ "type": "string"
},
- "AutoHealCustomAction": {
- "description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
- "type": "object",
- "properties": {
- "exe": {
- "description": "Executable to be run.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the executable.",
- "type": "string"
- }
- }
+ "vnetResourceGroupName": {
+ "description": "Resource group of the Virtual Network.",
+ "type": "string"
},
- "AutoHealRules": {
- "description": "Rules that can be defined for auto-heal.",
- "type": "object",
- "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."
- }
- }
+ "vnetSubnetName": {
+ "description": "Subnet of the Virtual Network.",
+ "type": "string"
},
- "AutoHealTriggers": {
- "description": "Triggers for auto-heal.",
- "type": "object",
- "properties": {
- "requests": {
- "$ref": "#/definitions/RequestsBasedTrigger",
- "description": "A rule based on total requests."
- },
- "privateBytesInKB": {
- "format": "int32",
- "description": "A rule based on private bytes.",
- "type": "integer"
- },
- "statusCodes": {
- "description": "A rule based on status codes.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StatusCodesBasedTrigger"
- }
- },
- "slowRequests": {
- "$ref": "#/definitions/SlowRequestsBasedTrigger",
- "description": "A rule based on request execution time."
- }
- }
+ "virtualNetwork": {
+ "$ref": "#/definitions/VirtualNetworkProfile",
+ "description": "Description of the Virtual Network."
},
- "Capability": {
- "description": "Describes the capabilities/features allowed for a specific SKU.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the SKU capability.",
- "type": "string"
- },
- "value": {
- "description": "Value of the SKU capability.",
- "type": "string"
- },
- "reason": {
- "description": "Reason of the SKU capability.",
- "type": "string"
- }
- }
+ "internalLoadBalancingMode": {
+ "description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
+ "enum": [
+ "None",
+ "Web",
+ "Publishing"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InternalLoadBalancingMode",
+ "modelAsString": false
+ }
},
- "CloningInfo": {
- "description": "Information needed for cloning operation.",
- "required": [
- "sourceWebAppId"
- ],
- "type": "object",
- "properties": {
- "correlationId": {
- "format": "uuid",
- "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- },
- "overwrite": {
- "description": "true to overwrite destination app; otherwise, false.",
- "type": "boolean"
- },
- "cloneCustomHostNames": {
- "description": "true to clone custom hostnames from source app; otherwise, false.",
- "type": "boolean"
- },
- "cloneSourceControl": {
- "description": "true to clone source control from source app; otherwise, false.",
- "type": "boolean"
- },
- "sourceWebAppId": {
- "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.",
- "type": "string"
- },
- "hostingEnvironment": {
- "description": "App Service Environment.",
- "type": "string"
- },
- "appSettingsOverrides": {
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "configureLoadBalancing": {
- "description": "true to configure load balancing for source and destination app.",
- "type": "boolean"
- },
- "trafficManagerProfileId": {
- "description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
- "type": "string"
- },
- "trafficManagerProfileName": {
- "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
- "type": "string"
- }
- }
+ "multiSize": {
+ "description": "Front-end VM size, e.g. \"Medium\", \"Large\".",
+ "type": "string"
},
- "ConnStringInfo": {
- "description": "Database connection string information.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of connection string.",
- "type": "string"
- },
- "connectionString": {
- "description": "Connection string value.",
- "type": "string"
- },
- "type": {
- "description": "Type of database.",
- "enum": [
- "MySql",
- "SQLServer",
- "SQLAzure",
- "Custom",
- "NotificationHub",
- "ServiceBus",
- "EventHub",
- "ApiHub",
- "DocDb",
- "RedisCache",
- "PostgreSQL"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ConnectionStringType",
- "modelAsString": false
- }
- }
- }
+ "multiRoleCount": {
+ "format": "int32",
+ "description": "Number of front-end instances.",
+ "type": "integer"
},
- "CorsSettings": {
- "description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
- "type": "object",
- "properties": {
- "allowedOrigins": {
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
+ "workerPools": {
+ "description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WorkerPool"
+ }
},
- "CsmUsageQuota": {
- "description": "Usage of the quota resource.",
- "type": "object",
- "properties": {
- "unit": {
- "description": "Units of measurement for the quota resourse.",
- "type": "string"
- },
- "nextResetTime": {
- "format": "date-time",
- "description": "Next reset time for the resource counter.",
- "type": "string"
- },
- "currentValue": {
- "format": "int64",
- "description": "The current value of the resource counter.",
- "type": "integer"
- },
- "limit": {
- "format": "int64",
- "description": "The resource limit.",
- "type": "integer"
- },
- "name": {
- "$ref": "#/definitions/LocalizableString",
- "description": "Quota name."
- }
- }
+ "ipsslAddressCount": {
+ "format": "int32",
+ "description": "Number of IP SSL addresses reserved for the App Service Environment.",
+ "type": "integer"
},
- "CsmUsageQuotaCollection": {
- "description": "Collection of CSM usage quotas.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CsmUsageQuota"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
+ "databaseEdition": {
+ "description": "Edition of the metadata database for the App Service Environment, e.g. \"Standard\".",
+ "type": "string",
+ "readOnly": true
},
- "ErrorEntity": {
- "description": "Body of the error response returned from the API.",
- "type": "object",
- "properties": {
- "extendedCode": {
- "description": "Type of error.",
- "type": "string"
- },
- "messageTemplate": {
- "description": "Message template.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the template.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "innerErrors": {
- "description": "Inner errors.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ErrorEntity"
- }
- },
- "code": {
- "description": "Basic error code.",
- "type": "string"
- },
- "message": {
- "description": "Any details of the error.",
- "type": "string"
- }
- }
+ "databaseServiceObjective": {
+ "description": "Service objective of the metadata database for the App Service Environment, e.g. \"S0\".",
+ "type": "string",
+ "readOnly": true
},
- "Experiments": {
- "description": "Routing rules in production experiments.",
- "type": "object",
- "properties": {
- "rampUpRules": {
- "description": "List of ramp-up rules.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/RampUpRule"
- }
- }
- }
+ "upgradeDomains": {
+ "format": "int32",
+ "description": "Number of upgrade domains of the App Service Environment.",
+ "type": "integer",
+ "readOnly": true
},
- "HandlerMapping": {
- "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.",
- "type": "object",
- "properties": {
- "extension": {
- "description": "Requests with this extension will be handled using the specified FastCGI application.",
- "type": "string"
- },
- "scriptProcessor": {
- "description": "The absolute path to the FastCGI application.",
- "type": "string"
- },
- "arguments": {
- "description": "Command-line arguments to be passed to the script processor.",
- "type": "string"
- }
- }
+ "subscriptionId": {
+ "description": "Subscription of the App Service Environment.",
+ "type": "string",
+ "readOnly": true
},
- "HostNameSslState": {
- "description": "SSL-enabled hostname.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Hostname.",
- "type": "string"
- },
- "sslState": {
- "description": "SSL type.",
- "enum": [
- "Disabled",
- "SniEnabled",
- "IpBasedEnabled"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SslState",
- "modelAsString": false
- }
- },
- "virtualIP": {
- "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
- "type": "string"
- },
- "thumbprint": {
- "description": "SSL certificate thumbprint.",
- "type": "string"
- },
- "toUpdate": {
- "description": "Set to true to update existing hostname.",
- "type": "boolean"
- },
- "hostType": {
- "description": "Indicates whether the hostname is a standard or repository hostname.",
- "enum": [
- "Standard",
- "Repository"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "HostType",
- "modelAsString": false
- }
- }
- }
+ "dnsSuffix": {
+ "description": "DNS suffix of the App Service Environment.",
+ "type": "string"
},
- "HostingEnvironmentProfile": {
- "description": "Specification for an App Service Environment to use for this resource.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource ID of the App Service Environment.",
- "type": "string"
- },
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the App Service Environment.",
- "type": "string",
- "readOnly": true
- }
- }
+ "lastAction": {
+ "description": "Last deployment action on the App Service Environment.",
+ "type": "string",
+ "readOnly": true
},
- "HybridConnection": {
- "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "HybridConnection resource specific properties",
- "properties": {
- "serviceBusNamespace": {
- "description": "The name of the Service Bus namespace.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "relayName": {
- "description": "The name of the Service Bus relay.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "relayArmUri": {
- "description": "The ARM URI to the Service Bus relay.",
- "type": "string"
- },
- "hostname": {
- "description": "The hostname of the endpoint.",
- "type": "string"
- },
- "port": {
- "format": "int32",
- "description": "The port of the endpoint.",
- "type": "integer"
- },
- "sendKeyName": {
- "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
- "type": "string"
- },
- "sendKeyValue": {
- "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.",
- "type": "string"
- },
- "serviceBusSuffix": {
- "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
+ "lastActionResult": {
+ "description": "Result of the last deployment action on the App Service Environment.",
+ "type": "string",
+ "readOnly": true
},
- "HybridConnectionKey": {
- "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "HybridConnectionKey resource specific properties",
- "properties": {
- "sendKeyName": {
- "description": "The name of the send key.",
- "type": "string",
- "readOnly": true
- },
- "sendKeyValue": {
- "description": "The value of the send key.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
+ "allowedMultiSizes": {
+ "description": "List of comma separated strings describing which VM sizes are allowed for front-ends.",
+ "type": "string",
+ "readOnly": true
},
- "IpSecurityRestriction": {
- "description": "IP security restriction on an app.",
- "required": [
- "ipAddress"
- ],
- "type": "object",
- "properties": {
- "ipAddress": {
- "description": "IP address the security restriction is valid for.",
- "type": "string"
- },
- "subnetMask": {
- "description": "Subnet mask for the range of IP addresses the restriction is valid for.",
- "type": "string"
- }
- }
+ "allowedWorkerSizes": {
+ "description": "List of comma separated strings describing which VM sizes are allowed for workers.",
+ "type": "string",
+ "readOnly": true
},
- "LocalizableString": {
- "description": "Localizable string object containing the name and a localized value.",
- "type": "object",
- "properties": {
- "value": {
- "description": "Non-localized name.",
- "type": "string"
- },
- "localizedValue": {
- "description": "Localized name.",
- "type": "string"
- }
- }
+ "maximumNumberOfMachines": {
+ "format": "int32",
+ "description": "Maximum number of VMs in the App Service Environment.",
+ "type": "integer",
+ "readOnly": true
},
- "ManagedServiceIdentity": {
- "description": "Managed service identity.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of managed service identity.",
- "enum": [
- "SystemAssigned"
- ],
- "x-ms-enum": {
- "name": "ManagedServiceIdentityType",
- "modelAsString": true
- }
- },
- "tenantId": {
- "description": "Tenant of managed service identity.",
- "type": "string",
- "readOnly": true
- },
- "principalId": {
- "description": "Principal Id of managed service identity.",
- "type": "string",
- "readOnly": true
- }
- }
+ "vipMappings": {
+ "description": "Description of IP SSL mapping for the App Service Environment.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualIPMapping"
+ },
+ "readOnly": true
},
- "NameIdentifier": {
- "description": "Identifies an object.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the object.",
- "type": "string"
- }
- }
+ "environmentCapacities": {
+ "description": "Current total, used, and available worker capacities.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StampCapacity"
+ },
+ "readOnly": true
},
- "NameValuePair": {
- "description": "Name value pair.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Pair name.",
- "type": "string"
- },
- "value": {
- "description": "Pair value.",
- "type": "string"
- }
- }
+ "networkAccessControlList": {
+ "description": "Access control list for controlling traffic to the App Service Environment.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkAccessControlEntry"
+ }
},
- "NetworkAccessControlEntry": {
- "description": "Network access control entry.",
- "type": "object",
- "properties": {
- "action": {
- "description": "Action object.",
- "enum": [
- "Permit",
- "Deny"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AccessControlEntryAction",
- "modelAsString": false
- }
- },
- "description": {
- "description": "Description.",
- "type": "string"
- },
- "order": {
- "format": "int32",
- "description": "Order of precedence.",
- "type": "integer"
- },
- "remoteSubnet": {
- "description": "Remote subnet.",
- "type": "string"
- }
- }
+ "environmentIsHealthy": {
+ "description": "True/false indicating whether the App Service Environment is healthy.",
+ "type": "boolean",
+ "readOnly": true
},
- "Operation": {
- "description": "Operation.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Operation ID.",
- "type": "string"
- },
- "name": {
- "description": "Operation name.",
- "type": "string"
- },
- "status": {
- "description": "The current status of the operation.",
- "enum": [
- "InProgress",
- "Failed",
- "Succeeded",
- "TimedOut",
- "Created"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "OperationStatus",
- "modelAsString": false
- }
- },
- "errors": {
- "description": "Any errors associate with the operation.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ErrorEntity"
- }
- },
- "createdTime": {
- "format": "date-time",
- "description": "Time when operation has started.",
- "type": "string"
- },
- "modifiedTime": {
- "format": "date-time",
- "description": "Time when operation has been updated.",
- "type": "string"
- },
- "expirationTime": {
- "format": "date-time",
- "description": "Time when operation will expire.",
- "type": "string"
- },
- "geoMasterOperationId": {
- "format": "uuid",
- "description": "Applicable only for stamp operation ids.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- }
- }
+ "environmentStatus": {
+ "description": "Detailed message about with results of the last check of the App Service Environment.",
+ "type": "string",
+ "readOnly": true
},
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
- "PushSettings": {
- "description": "Push settings for the App.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "PushSettings resource specific properties",
- "required": [
- "isPushEnabled"
- ],
- "properties": {
- "isPushEnabled": {
- "description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
- "type": "boolean"
- },
- "tagWhitelistJson": {
- "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
- "type": "string"
- },
- "tagsRequiringAuth": {
- "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.",
- "type": "string"
- },
- "dynamicTagsJson": {
- "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.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
+ "resourceGroup": {
+ "description": "Resource group of the App Service Environment.",
+ "type": "string",
+ "readOnly": true
},
- "RampUpRule": {
- "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
- "type": "object",
- "properties": {
- "actionHostName": {
- "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
- "type": "string"
- },
- "reroutePercentage": {
- "format": "double",
- "description": "Percentage of the traffic which will be redirected to ActionHostName.",
- "type": "number"
- },
- "changeStep": {
- "format": "double",
- "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
- "type": "number"
- },
- "changeIntervalInMinutes": {
- "format": "int32",
- "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.",
- "type": "integer"
- },
- "minReroutePercentage": {
- "format": "double",
- "description": "Specifies lower boundary above which ReroutePercentage will stay.",
- "type": "number"
- },
- "maxReroutePercentage": {
- "format": "double",
- "description": "Specifies upper boundary below which ReroutePercentage will stay.",
- "type": "number"
- },
- "changeDecisionCallbackUrl": {
- "description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
- "type": "string"
- },
- "name": {
- "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.",
- "type": "string"
- }
- }
+ "frontEndScaleFactor": {
+ "format": "int32",
+ "description": "Scale factor for front-ends.",
+ "type": "integer"
},
- "RequestsBasedTrigger": {
- "description": "Trigger based on total requests.",
- "type": "object",
- "properties": {
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
+ "defaultFrontEndScaleFactor": {
+ "format": "int32",
+ "description": "Default Scale Factor for FrontEnds.",
+ "type": "integer",
+ "readOnly": true
},
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
- },
- "ResourceMetric": {
- "description": "Object representing a metric for any resource .",
- "type": "object",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Metric unit.",
- "type": "string",
- "readOnly": true
- },
- "timeGrain": {
- "description": "Metric granularity. E.g PT1H, PT5M, P1D",
- "type": "string",
- "readOnly": true
- },
- "startTime": {
- "format": "date-time",
- "description": "Metric start time.",
- "type": "string",
- "readOnly": true
- },
- "endTime": {
- "format": "date-time",
- "description": "Metric end time.",
- "type": "string",
- "readOnly": true
- },
- "resourceId": {
- "description": "Metric resource Id.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "metricValues": {
- "description": "Metric values.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricValue"
- },
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
+ "apiManagementAccountId": {
+ "description": "API Management Account associated with the App Service Environment.",
+ "type": "string"
},
- "ResourceMetricAvailability": {
- "description": "Metrics availability and retention.",
- "type": "object",
- "properties": {
- "timeGrain": {
- "description": "Time grain .",
- "type": "string",
- "readOnly": true
- },
- "retention": {
- "description": "Retention period for the current time grain.",
- "type": "string",
- "readOnly": true
- }
- }
+ "suspended": {
+ "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).",
+ "type": "boolean"
},
- "ResourceMetricCollection": {
- "description": "Collection of metric responses.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetric"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
+ "dynamicCacheEnabled": {
+ "description": "True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
+ "type": "boolean"
},
- "ResourceMetricDefinition": {
- "description": "Metadata for the metrics.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "ResourceMetricDefinition resource specific properties",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of the metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Unit of the metric.",
- "type": "string",
- "readOnly": true
- },
- "primaryAggregationType": {
- "description": "Primary aggregation type.",
- "type": "string",
- "readOnly": true
- },
- "metricAvailabilities": {
- "description": "List of time grains supported for the metric together with retention period.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricAvailability"
- },
- "readOnly": true
- },
- "resourceUri": {
- "description": "Resource URI.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource ID.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
+ "clusterSettings": {
+ "description": "Custom settings for changing the behavior of the App Service Environment.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NameValuePair"
+ }
},
- "ResourceMetricDefinitionCollection": {
- "description": "Collection of metric definitions.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricDefinition"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
+ "userWhitelistedIpRanges": {
+ "description": "User added ip ranges to whitelist on ASE db",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "AppServicePlan": {
+ "description": "App Service plan.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AppServicePlan resource specific properties",
+ "required": [
+ "name"
+ ],
+ "properties": {
+ "name": {
+ "description": "Name for the App Service plan.",
+ "type": "string"
+ },
+ "workerTierName": {
+ "description": "Target worker tier assigned to the App Service plan.",
+ "type": "string"
+ },
+ "status": {
+ "description": "App Service plan status.",
+ "enum": [
+ "Ready",
+ "Pending",
+ "Creating"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StatusOptions",
+ "modelAsString": false
+ }
+ },
+ "subscription": {
+ "description": "App Service plan subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "adminSiteName": {
+ "description": "App Service plan administration site.",
+ "type": "string"
+ },
+ "hostingEnvironmentProfile": {
+ "$ref": "#/definitions/HostingEnvironmentProfile",
+ "description": "Specification for the App Service Environment to use for the App Service plan.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "maximumNumberOfWorkers": {
+ "format": "int32",
+ "description": "Maximum number of instances that can be assigned to this App Service plan.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "geoRegion": {
+ "description": "Geographical location for the App Service plan.",
+ "type": "string",
+ "readOnly": true
+ },
+ "perSiteScaling": {
+ "description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.",
+ "default": false,
+ "type": "boolean"
+ },
+ "numberOfSites": {
+ "format": "int32",
+ "description": "Number of apps assigned to this App Service plan.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "isSpot": {
+ "description": "If true, this App Service Plan owns spot instances.",
+ "type": "boolean"
+ },
+ "spotExpirationTime": {
+ "format": "date-time",
+ "description": "The time when the server farm expires. Valid only if it is a spot server farm.",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "description": "Resource group of the App Service plan.",
+ "type": "string",
+ "readOnly": true
+ },
+ "reserved": {
+ "description": "Reserved.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "targetWorkerCount": {
+ "format": "int32",
+ "description": "Scaling worker count.",
+ "type": "integer"
+ },
+ "targetWorkerSizeId": {
+ "format": "int32",
+ "description": "Scaling worker size ID.",
+ "type": "integer"
+ },
+ "provisioningState": {
+ "description": "Provisioning state of the App Service Environment.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false
+ }
}
+ },
+ "x-ms-client-flatten": true
},
- "ResourceMetricName": {
- "description": "Name of a metric for any resource .",
- "type": "object",
- "properties": {
- "value": {
- "description": "metric name value.",
- "type": "string",
- "readOnly": true
- },
- "localizedValue": {
- "description": "Localized metric name value.",
- "type": "string",
- "readOnly": true
- }
- }
+ "sku": {
+ "$ref": "#/definitions/SkuDescription"
+ }
+ }
+ },
+ "AppServicePlanCollection": {
+ "description": "Collection of App Service plans.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AppServicePlan"
+ }
},
- "ResourceMetricProperty": {
- "description": "Resource metric property.",
- "type": "object",
- "properties": {
- "key": {
- "description": "Key for resource metric property.",
- "type": "string"
- },
- "value": {
- "description": "Value of pair.",
- "type": "string"
- }
- }
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "AutoHealActions": {
+ "description": "Actions which to take by the auto-heal module when a rule is triggered.",
+ "type": "object",
+ "properties": {
+ "actionType": {
+ "description": "Predefined action to be taken.",
+ "enum": [
+ "Recycle",
+ "LogEvent",
+ "CustomAction"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AutoHealActionType",
+ "modelAsString": false
+ }
},
- "ResourceMetricValue": {
- "description": "Value of resource metric.",
- "type": "object",
- "properties": {
- "timestamp": {
- "description": "Value timestamp.",
- "type": "string",
- "readOnly": true
- },
- "average": {
- "format": "float",
- "description": "Value average.",
- "type": "number",
- "readOnly": true
- },
- "minimum": {
- "format": "float",
- "description": "Value minimum.",
- "type": "number",
- "readOnly": true
- },
- "maximum": {
- "format": "float",
- "description": "Value maximum.",
- "type": "number",
- "readOnly": true
- },
- "total": {
- "format": "float",
- "description": "Value total.",
- "type": "number",
- "readOnly": true
- },
- "count": {
- "format": "float",
- "description": "Value count.",
- "type": "number",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
+ "customAction": {
+ "$ref": "#/definitions/AutoHealCustomAction",
+ "description": "Custom action to be taken."
},
- "Site": {
- "description": "A web app, a mobile app backend, or an API app.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "description": "Site resource specific properties",
- "properties": {
- "state": {
- "description": "Current state of the app.",
- "type": "string",
- "readOnly": true
- },
- "hostNames": {
- "description": "Hostnames associated with the app.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "repositorySiteName": {
- "description": "Name of the repository site.",
- "type": "string",
- "readOnly": true
- },
- "usageState": {
- "description": "State indicating whether the app has exceeded its quota usage. Read-only.",
- "enum": [
- "Normal",
- "Exceeded"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "UsageState",
- "modelAsString": false
- }
- },
- "enabled": {
- "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
- "type": "boolean"
- },
- "enabledHostNames": {
- "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "availabilityState": {
- "description": "Management information availability state for the app.",
- "enum": [
- "Normal",
- "Limited",
- "DisasterRecoveryMode"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "SiteAvailabilityState",
- "modelAsString": false
- }
- },
- "hostNameSslStates": {
- "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HostNameSslState"
- }
- },
- "serverFarmId": {
- "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
- "type": "string"
- },
- "reserved": {
- "description": "true if reserved; otherwise, false.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "lastModifiedTimeUtc": {
- "format": "date-time",
- "description": "Last time the app was modified, in UTC. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "siteConfig": {
- "$ref": "#/definitions/SiteConfig",
- "description": "Configuration of the app."
- },
- "trafficManagerHostNames": {
- "description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "scmSiteAlsoStopped": {
- "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
- "default": false,
- "type": "boolean"
- },
- "targetSwapSlot": {
- "description": "Specifies which deployment slot this app will swap into. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "App Service Environment to use for the app.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "clientAffinityEnabled": {
- "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.",
- "type": "boolean"
- },
- "clientCertEnabled": {
- "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
- "type": "boolean"
- },
- "hostNamesDisabled": {
- "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
- "type": "boolean"
- },
- "outboundIpAddresses": {
- "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.",
- "type": "string",
- "readOnly": true
- },
- "possibleOutboundIpAddresses": {
- "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "containerSize": {
- "format": "int32",
- "description": "Size of the function container.",
- "type": "integer"
- },
- "dailyMemoryTimeQuota": {
- "format": "int32",
- "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
- "type": "integer"
- },
- "suspendedTill": {
- "format": "date-time",
- "description": "App suspended till in case memory-time quota is exceeded.",
- "type": "string",
- "readOnly": true
- },
- "maxNumberOfWorkers": {
- "format": "int32",
- "description": "Maximum number of workers.\nThis only applies to Functions container.",
- "type": "integer",
- "readOnly": true
- },
- "cloningInfo": {
- "$ref": "#/definitions/CloningInfo",
- "description": "If specified during app creation, the app is cloned from a source app.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "snapshotInfo": {
- "$ref": "#/definitions/SnapshotRecoveryRequest",
- "description": "If specified during app creation, the app is created from a previous snapshot.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "resourceGroup": {
- "description": "Name of the resource group the app belongs to. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "isDefaultContainer": {
- "description": "true if the app is a default container; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "defaultHostName": {
- "description": "Default hostname of the app. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "slotSwapStatus": {
- "$ref": "#/definitions/SlotSwapStatus",
- "description": "Status of the last deployment slot swap operation.",
- "readOnly": true
- },
- "httpsOnly": {
- "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
- "type": "boolean"
- }
- },
- "x-ms-client-flatten": true
- },
- "identity": {
- "$ref": "#/definitions/ManagedServiceIdentity"
- }
- }
+ "minProcessExecutionTime": {
+ "description": "Minimum time the process must execute\nbefore taking the action",
+ "type": "string"
+ }
+ }
+ },
+ "AutoHealCustomAction": {
+ "description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
+ "type": "object",
+ "properties": {
+ "exe": {
+ "description": "Executable to be run.",
+ "type": "string"
},
- "SiteConfig": {
- "description": "Configuration of an App Service app.",
- "type": "object",
- "properties": {
- "numberOfWorkers": {
- "format": "int32",
- "description": "Number of workers.",
- "type": "integer"
- },
- "defaultDocuments": {
- "description": "Default documents.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "netFrameworkVersion": {
- "description": ".NET Framework version.",
- "default": "v4.6",
- "type": "string"
- },
- "phpVersion": {
- "description": "Version of PHP.",
- "type": "string"
- },
- "pythonVersion": {
- "description": "Version of Python.",
- "type": "string"
- },
- "nodeVersion": {
- "description": "Version of Node.js.",
- "type": "string"
- },
- "linuxFxVersion": {
- "description": "Linux App Framework and version",
- "type": "string"
- },
- "requestTracingEnabled": {
- "description": "true if request tracing is enabled; otherwise, false.",
- "type": "boolean"
- },
- "requestTracingExpirationTime": {
- "format": "date-time",
- "description": "Request tracing expiration time.",
- "type": "string"
- },
- "remoteDebuggingEnabled": {
- "description": "true if remote debugging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "remoteDebuggingVersion": {
- "description": "Remote debugging version.",
- "type": "string"
- },
- "httpLoggingEnabled": {
- "description": "true if HTTP logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "logsDirectorySizeLimit": {
- "format": "int32",
- "description": "HTTP logs directory size limit.",
- "type": "integer"
- },
- "detailedErrorLoggingEnabled": {
- "description": "true if detailed error logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "publishingUsername": {
- "description": "Publishing user name.",
- "type": "string"
- },
- "appSettings": {
- "description": "Application settings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "connectionStrings": {
- "description": "Connection strings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ConnStringInfo"
- }
- },
- "machineKey": {
- "$ref": "#/definitions/SiteMachineKey",
- "description": "Site MachineKey.",
- "readOnly": true
- },
- "handlerMappings": {
- "description": "Handler mappings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HandlerMapping"
- }
- },
- "documentRoot": {
- "description": "Document root.",
- "type": "string"
- },
- "scmType": {
- "description": "SCM type.",
- "enum": [
- "None",
- "Dropbox",
- "Tfs",
- "LocalGit",
- "GitHub",
- "CodePlexGit",
- "CodePlexHg",
- "BitbucketGit",
- "BitbucketHg",
- "ExternalGit",
- "ExternalHg",
- "OneDrive",
- "VSO"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ScmType",
- "modelAsString": true
- }
- },
- "use32BitWorkerProcess": {
- "description": "true to use 32-bit worker process; otherwise, false.",
- "type": "boolean"
- },
- "webSocketsEnabled": {
- "description": "true if WebSocket is enabled; otherwise, false.",
- "type": "boolean"
- },
- "alwaysOn": {
- "description": "true if Always On is enabled; otherwise, false.",
- "type": "boolean"
- },
- "javaVersion": {
- "description": "Java version.",
- "type": "string"
- },
- "javaContainer": {
- "description": "Java container.",
- "type": "string"
- },
- "javaContainerVersion": {
- "description": "Java container version.",
- "type": "string"
- },
- "appCommandLine": {
- "description": "App command line to launch.",
- "type": "string"
- },
- "managedPipelineMode": {
- "description": "Managed pipeline mode.",
- "enum": [
- "Integrated",
- "Classic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ManagedPipelineMode",
- "modelAsString": false
- }
- },
- "virtualApplications": {
- "description": "Virtual applications.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualApplication"
- }
- },
- "loadBalancing": {
- "description": "Site load balancing.",
- "enum": [
- "WeightedRoundRobin",
- "LeastRequests",
- "LeastResponseTime",
- "WeightedTotalTraffic",
- "RequestHash"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SiteLoadBalancing",
- "modelAsString": false
- }
- },
- "experiments": {
- "$ref": "#/definitions/Experiments",
- "description": "This is work around for polymophic types."
- },
- "limits": {
- "$ref": "#/definitions/SiteLimits",
- "description": "Site limits."
- },
- "autoHealEnabled": {
- "description": "true if Auto Heal is enabled; otherwise, false.",
- "type": "boolean"
- },
- "autoHealRules": {
- "$ref": "#/definitions/AutoHealRules",
- "description": "Auto Heal rules."
- },
- "tracingOptions": {
- "description": "Tracing options.",
- "type": "string"
- },
- "vnetName": {
- "description": "Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "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."
- },
- "autoSwapSlotName": {
- "description": "Auto-swap slot name.",
- "type": "string"
- },
- "localMySqlEnabled": {
- "description": "true to enable local MySQL; otherwise, false.",
- "default": false,
- "type": "boolean"
- },
- "ipSecurityRestrictions": {
- "description": "IP security restrictions.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/IpSecurityRestriction"
- }
- }
- }
+ "parameters": {
+ "description": "Parameters for the executable.",
+ "type": "string"
+ }
+ }
+ },
+ "AutoHealRules": {
+ "description": "Rules that can be defined for auto-heal.",
+ "type": "object",
+ "properties": {
+ "triggers": {
+ "$ref": "#/definitions/AutoHealTriggers",
+ "description": "Conditions that describe when to execute the auto-heal actions."
},
- "SiteLimits": {
- "description": "Metric limits set on an app.",
- "type": "object",
- "properties": {
- "maxPercentageCpu": {
- "format": "double",
- "description": "Maximum allowed CPU usage percentage.",
- "type": "number"
- },
- "maxMemoryInMb": {
- "format": "int64",
- "description": "Maximum allowed memory usage in MB.",
- "type": "integer"
- },
- "maxDiskSizeInMb": {
- "format": "int64",
- "description": "Maximum allowed disk size usage in MB.",
- "type": "integer"
- }
- }
+ "actions": {
+ "$ref": "#/definitions/AutoHealActions",
+ "description": "Actions to be executed when a rule is triggered."
+ }
+ }
+ },
+ "AutoHealTriggers": {
+ "description": "Triggers for auto-heal.",
+ "type": "object",
+ "properties": {
+ "requests": {
+ "$ref": "#/definitions/RequestsBasedTrigger",
+ "description": "A rule based on total requests."
},
- "SiteMachineKey": {
- "description": "MachineKey of an app.",
- "type": "object",
- "properties": {
- "validation": {
- "description": "MachineKey validation.",
- "type": "string"
- },
- "validationKey": {
- "description": "Validation key.",
- "type": "string"
- },
- "decryption": {
- "description": "Decryption.",
- "type": "string"
- },
- "decryptionKey": {
- "description": "Decryption key.",
- "type": "string"
- }
- }
+ "privateBytesInKB": {
+ "format": "int32",
+ "description": "A rule based on private bytes.",
+ "type": "integer"
},
- "SkuCapacity": {
- "description": "Description of the App Service plan scale options.",
- "type": "object",
- "properties": {
- "minimum": {
- "format": "int32",
- "description": "Minimum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "maximum": {
- "format": "int32",
- "description": "Maximum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "default": {
- "format": "int32",
- "description": "Default number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "scaleType": {
- "description": "Available scale configurations for an App Service plan.",
- "type": "string"
- }
- }
+ "statusCodes": {
+ "description": "A rule based on status codes.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StatusCodesBasedTrigger"
+ }
},
- "SkuDescription": {
- "description": "Description of a SKU for a scalable resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the resource SKU.",
- "type": "string"
- },
- "tier": {
- "description": "Service tier of the resource SKU.",
- "type": "string"
- },
- "size": {
- "description": "Size specifier of the resource SKU.",
- "type": "string"
- },
- "family": {
- "description": "Family code of the resource SKU.",
- "type": "string"
- },
- "capacity": {
- "format": "int32",
- "description": "Current number of instances assigned to the resource.",
- "type": "integer"
- },
- "skuCapacity": {
- "$ref": "#/definitions/SkuCapacity",
- "description": "Min, max, and default scale values of the SKU."
- },
- "locations": {
- "description": "Locations of the SKU.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "capabilities": {
- "description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Capability"
- }
- }
- }
+ "slowRequests": {
+ "$ref": "#/definitions/SlowRequestsBasedTrigger",
+ "description": "A rule based on request execution time."
+ }
+ }
+ },
+ "Capability": {
+ "description": "Describes the capabilities/features allowed for a specific SKU.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the SKU capability.",
+ "type": "string"
},
- "SlotSwapStatus": {
- "description": "The status of the last successfull slot swap operation.",
- "type": "object",
- "properties": {
- "timestampUtc": {
- "format": "date-time",
- "description": "The time the last successful slot swap completed.",
- "type": "string",
- "readOnly": true
- },
- "sourceSlotName": {
- "description": "The source slot of the last swap operation.",
- "type": "string",
- "readOnly": true
- },
- "destinationSlotName": {
- "description": "The destination slot of the last swap operation.",
- "type": "string",
- "readOnly": true
- }
- }
+ "value": {
+ "description": "Value of the SKU capability.",
+ "type": "string"
},
- "SlowRequestsBasedTrigger": {
- "description": "Trigger based on request execution time.",
- "type": "object",
- "properties": {
- "timeTaken": {
- "description": "Time taken.",
- "type": "string"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
+ "reason": {
+ "description": "Reason of the SKU capability.",
+ "type": "string"
+ }
+ }
+ },
+ "CloningInfo": {
+ "description": "Information needed for cloning operation.",
+ "required": [
+ "sourceWebAppId"
+ ],
+ "type": "object",
+ "properties": {
+ "correlationId": {
+ "format": "uuid",
+ "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
+ "type": "string",
+ "example": "00000000-0000-0000-0000-000000000000"
},
- "SnapshotRecoveryRequest": {
- "description": "Details about app recovery operation.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "SnapshotRecoveryRequest resource specific properties",
- "required": [
- "overwrite"
- ],
- "properties": {
- "snapshotTime": {
- "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string.",
- "type": "string"
- },
- "recoveryTarget": {
- "$ref": "#/definitions/SnapshotRecoveryTarget",
- "description": "Specifies the web app that snapshot contents will be written to."
- },
- "overwrite": {
- "description": "If true the recovery operation can overwrite source app; otherwise, false.",
- "type": "boolean"
- },
- "recoverConfiguration": {
- "description": "If true, site configuration, in addition to content, will be reverted.",
- "type": "boolean"
- },
- "ignoreConflictingHostNames": {
- "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.",
- "type": "boolean"
- }
- },
- "x-ms-client-flatten": true
- }
- }
+ "overwrite": {
+ "description": "true to overwrite destination app; otherwise, false.",
+ "type": "boolean"
},
- "SnapshotRecoveryTarget": {
- "description": "Specifies the web app that snapshot contents will be written to.",
- "type": "object",
- "properties": {
- "location": {
- "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS",
- "type": "string"
- },
- "id": {
- "description": "ARM resource ID of the target 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.",
- "type": "string"
- }
- }
+ "cloneCustomHostNames": {
+ "description": "true to clone custom hostnames from source app; otherwise, false.",
+ "type": "boolean"
},
- "StampCapacity": {
- "description": "Stamp capacity information.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the stamp.",
- "type": "string"
- },
- "availableCapacity": {
- "format": "int64",
- "description": "Available capacity (# of machines, bytes of storage etc...).",
- "type": "integer"
- },
- "totalCapacity": {
- "format": "int64",
- "description": "Total capacity (# of machines, bytes of storage etc...).",
- "type": "integer"
- },
- "unit": {
- "description": "Name of the unit.",
- "type": "string"
- },
- "computeMode": {
- "description": "Shared/dedicated workers.",
- "enum": [
- "Shared",
- "Dedicated",
- "Dynamic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ComputeModeOptions",
- "modelAsString": false
- }
- },
- "workerSize": {
- "description": "Size of the machines.",
- "enum": [
- "Default",
- "Small",
- "Medium",
- "Large",
- "D1",
- "D2",
- "D3"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "WorkerSizeOptions",
- "modelAsString": false
- }
- },
- "workerSizeId": {
- "format": "int32",
- "description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
- "type": "integer"
- },
- "excludeFromCapacityAllocation": {
- "description": "If true, it includes basic apps.\nBasic apps are not used for capacity allocation.",
- "type": "boolean"
- },
- "isApplicableForAllComputeModes": {
- "description": "true if capacity is applicable for all apps; otherwise, false.",
- "type": "boolean"
- },
- "siteMode": {
- "description": "Shared or Dedicated.",
- "type": "string"
- }
- }
+ "cloneSourceControl": {
+ "description": "true to clone source control from source app; otherwise, false.",
+ "type": "boolean"
},
- "StatusCodesBasedTrigger": {
- "description": "Trigger based on status code.",
- "type": "object",
- "properties": {
- "status": {
- "format": "int32",
- "description": "HTTP status code.",
- "type": "integer"
- },
- "subStatus": {
- "format": "int32",
- "description": "SubStatus.",
- "type": "integer"
- },
- "win32Status": {
- "format": "int32",
- "description": "Win32 error code.",
- "type": "integer"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
+ "sourceWebAppId": {
+ "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.",
+ "type": "string"
},
- "User": {
- "description": "User crendentials used for publishing activity.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "User resource specific properties",
- "required": [
- "publishingUserName"
- ],
- "properties": {
- "name": {
- "description": "Username",
- "type": "string",
- "x-ms-client-name": "UserName"
- },
- "publishingUserName": {
- "description": "Username used for publishing.",
- "type": "string"
- },
- "publishingPassword": {
- "format": "password",
- "description": "Password used for publishing.",
- "type": "string"
- },
- "publishingPasswordHash": {
- "format": "password",
- "description": "Password hash used for publishing.",
- "type": "string"
- },
- "publishingPasswordHashSalt": {
- "format": "password",
- "description": "Password hash salt used for publishing.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
+ "hostingEnvironment": {
+ "description": "App Service Environment.",
+ "type": "string"
},
- "VirtualApplication": {
- "description": "Virtual application in an app.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Virtual path.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- },
- "preloadEnabled": {
- "description": "true if preloading is enabled; otherwise, false.",
- "type": "boolean"
- },
- "virtualDirectories": {
- "description": "Virtual directories for virtual application.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualDirectory"
- }
- }
- }
+ "appSettingsOverrides": {
+ "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.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
},
- "VirtualDirectory": {
- "description": "Directory for virtual application.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Path to virtual application.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- }
- }
+ "configureLoadBalancing": {
+ "description": "true to configure load balancing for source and destination app.",
+ "type": "boolean"
},
- "VirtualIPMapping": {
- "description": "Virtual IP mapping.",
- "type": "object",
- "properties": {
- "virtualIP": {
- "description": "Virtual IP address.",
- "type": "string"
- },
- "internalHttpPort": {
- "format": "int32",
- "description": "Internal HTTP port.",
- "type": "integer"
- },
- "internalHttpsPort": {
- "format": "int32",
- "description": "Internal HTTPS port.",
- "type": "integer"
- },
- "inUse": {
- "description": "Is virtual IP mapping in use.",
- "type": "boolean"
- }
+ "trafficManagerProfileId": {
+ "description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
+ "type": "string"
+ },
+ "trafficManagerProfileName": {
+ "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
+ "type": "string"
+ },
+ "ignoreQuotas": {
+ "description": "true if quotas should be ignored; otherwise, false.",
+ "type": "boolean"
+ }
+ }
+ },
+ "ConnStringInfo": {
+ "description": "Database connection string information.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of connection string.",
+ "type": "string"
+ },
+ "connectionString": {
+ "description": "Connection string value.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of database.",
+ "enum": [
+ "MySql",
+ "SQLServer",
+ "SQLAzure",
+ "Custom",
+ "NotificationHub",
+ "ServiceBus",
+ "EventHub",
+ "ApiHub",
+ "DocDb",
+ "RedisCache",
+ "PostgreSQL"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ConnectionStringType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "CorsSettings": {
+ "description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
+ "type": "object",
+ "properties": {
+ "allowedOrigins": {
+ "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.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "CsmUsageQuota": {
+ "description": "Usage of the quota resource.",
+ "type": "object",
+ "properties": {
+ "unit": {
+ "description": "Units of measurement for the quota resourse.",
+ "type": "string"
+ },
+ "nextResetTime": {
+ "format": "date-time",
+ "description": "Next reset time for the resource counter.",
+ "type": "string"
+ },
+ "currentValue": {
+ "format": "int64",
+ "description": "The current value of the resource counter.",
+ "type": "integer"
+ },
+ "limit": {
+ "format": "int64",
+ "description": "The resource limit.",
+ "type": "integer"
+ },
+ "name": {
+ "$ref": "#/definitions/LocalizableString",
+ "description": "Quota name."
+ }
+ }
+ },
+ "CsmUsageQuotaCollection": {
+ "description": "Collection of CSM usage quotas.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CsmUsageQuota"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "ErrorEntity": {
+ "description": "Body of the error response returned from the API.",
+ "type": "object",
+ "properties": {
+ "extendedCode": {
+ "description": "Type of error.",
+ "type": "string"
+ },
+ "messageTemplate": {
+ "description": "Message template.",
+ "type": "string"
+ },
+ "parameters": {
+ "description": "Parameters for the template.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "innerErrors": {
+ "description": "Inner errors.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorEntity"
+ }
+ },
+ "code": {
+ "description": "Basic error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Any details of the error.",
+ "type": "string"
+ }
+ }
+ },
+ "Experiments": {
+ "description": "Routing rules in production experiments.",
+ "type": "object",
+ "properties": {
+ "rampUpRules": {
+ "description": "List of ramp-up rules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RampUpRule"
+ }
+ }
+ }
+ },
+ "HandlerMapping": {
+ "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.",
+ "type": "object",
+ "properties": {
+ "extension": {
+ "description": "Requests with this extension will be handled using the specified FastCGI application.",
+ "type": "string"
+ },
+ "scriptProcessor": {
+ "description": "The absolute path to the FastCGI application.",
+ "type": "string"
+ },
+ "arguments": {
+ "description": "Command-line arguments to be passed to the script processor.",
+ "type": "string"
+ }
+ }
+ },
+ "HostNameSslState": {
+ "description": "SSL-enabled hostname.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Hostname.",
+ "type": "string"
+ },
+ "sslState": {
+ "description": "SSL type.",
+ "enum": [
+ "Disabled",
+ "SniEnabled",
+ "IpBasedEnabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SslState",
+ "modelAsString": false
+ }
+ },
+ "virtualIP": {
+ "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
+ "type": "string"
+ },
+ "thumbprint": {
+ "description": "SSL certificate thumbprint.",
+ "type": "string"
+ },
+ "toUpdate": {
+ "description": "Set to true to update existing hostname.",
+ "type": "boolean"
+ },
+ "hostType": {
+ "description": "Indicates whether the hostname is a standard or repository hostname.",
+ "enum": [
+ "Standard",
+ "Repository"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "HostType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "HostingEnvironmentProfile": {
+ "description": "Specification for an App Service Environment to use for this resource.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource ID of the App Service Environment.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the App Service Environment.",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type of the App Service Environment.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "HybridConnection": {
+ "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "HybridConnection resource specific properties",
+ "properties": {
+ "serviceBusNamespace": {
+ "description": "The name of the Service Bus namespace.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "relayName": {
+ "description": "The name of the Service Bus relay.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "relayArmUri": {
+ "description": "The ARM URI to the Service Bus relay.",
+ "type": "string"
+ },
+ "hostname": {
+ "description": "The hostname of the endpoint.",
+ "type": "string"
+ },
+ "port": {
+ "format": "int32",
+ "description": "The port of the endpoint.",
+ "type": "integer"
+ },
+ "sendKeyName": {
+ "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
+ "type": "string"
+ },
+ "sendKeyValue": {
+ "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.",
+ "type": "string"
+ },
+ "serviceBusSuffix": {
+ "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "HybridConnectionKey": {
+ "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "HybridConnectionKey resource specific properties",
+ "properties": {
+ "sendKeyName": {
+ "description": "The name of the send key.",
+ "type": "string",
+ "readOnly": true
+ },
+ "sendKeyValue": {
+ "description": "The value of the send key.",
+ "type": "string",
+ "readOnly": true
}
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "IpSecurityRestriction": {
+ "description": "IP security restriction on an app.",
+ "required": [
+ "ipAddress"
+ ],
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "IP address the security restriction is valid for.",
+ "type": "string"
},
- "VirtualNetworkProfile": {
- "description": "Specification for using a Virtual Network.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource id of the Virtual Network.",
- "type": "string"
- },
- "name": {
- "description": "Name of the Virtual Network (read-only).",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the Virtual Network (read-only).",
- "type": "string",
- "readOnly": true
- },
- "subnet": {
- "description": "Subnet within the Virtual Network.",
- "type": "string"
- }
+ "subnetMask": {
+ "description": "Subnet mask for the range of IP addresses the restriction is valid for.",
+ "type": "string"
+ }
+ }
+ },
+ "LocalizableString": {
+ "description": "Localizable string object containing the name and a localized value.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Non-localized name.",
+ "type": "string"
+ },
+ "localizedValue": {
+ "description": "Localized name.",
+ "type": "string"
+ }
+ }
+ },
+ "ManagedServiceIdentity": {
+ "description": "Managed service identity.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Type of managed service identity.",
+ "enum": [
+ "SystemAssigned"
+ ],
+ "x-ms-enum": {
+ "name": "ManagedServiceIdentityType",
+ "modelAsString": true
+ }
+ },
+ "tenantId": {
+ "description": "Tenant of managed service identity.",
+ "type": "string",
+ "readOnly": true
+ },
+ "principalId": {
+ "description": "Principal Id of managed service identity.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "NameIdentifier": {
+ "description": "Identifies an object.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the object.",
+ "type": "string"
+ }
+ }
+ },
+ "NameValuePair": {
+ "description": "Name value pair.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Pair name.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Pair value.",
+ "type": "string"
+ }
+ }
+ },
+ "NetworkAccessControlEntry": {
+ "description": "Network access control entry.",
+ "type": "object",
+ "properties": {
+ "action": {
+ "description": "Action object.",
+ "enum": [
+ "Permit",
+ "Deny"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AccessControlEntryAction",
+ "modelAsString": false
+ }
+ },
+ "description": {
+ "description": "Description.",
+ "type": "string"
+ },
+ "order": {
+ "format": "int32",
+ "description": "Order of precedence.",
+ "type": "integer"
+ },
+ "remoteSubnet": {
+ "description": "Remote subnet.",
+ "type": "string"
+ }
+ }
+ },
+ "Operation": {
+ "description": "Operation.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Operation ID.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Operation name.",
+ "type": "string"
+ },
+ "status": {
+ "description": "The current status of the operation.",
+ "enum": [
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "TimedOut",
+ "Created"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "OperationStatus",
+ "modelAsString": false
+ }
+ },
+ "errors": {
+ "description": "Any errors associate with the operation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ErrorEntity"
+ }
+ },
+ "createdTime": {
+ "format": "date-time",
+ "description": "Time when operation has started.",
+ "type": "string"
+ },
+ "modifiedTime": {
+ "format": "date-time",
+ "description": "Time when operation has been updated.",
+ "type": "string"
+ },
+ "expirationTime": {
+ "format": "date-time",
+ "description": "Time when operation will expire.",
+ "type": "string"
+ },
+ "geoMasterOperationId": {
+ "format": "uuid",
+ "description": "Applicable only for stamp operation ids.",
+ "type": "string",
+ "example": "00000000-0000-0000-0000-000000000000"
+ }
+ }
+ },
+ "ProxyOnlyResource": {
+ "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
+ "properties": {
+ "id": {
+ "description": "Resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource Name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "kind": {
+ "description": "Kind of resource.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "PushSettings": {
+ "description": "Push settings for the App.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "PushSettings resource specific properties",
+ "required": [
+ "isPushEnabled"
+ ],
+ "properties": {
+ "isPushEnabled": {
+ "description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
+ "type": "boolean"
+ },
+ "tagWhitelistJson": {
+ "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
+ "type": "string"
+ },
+ "tagsRequiringAuth": {
+ "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.",
+ "type": "string"
+ },
+ "dynamicTagsJson": {
+ "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.",
+ "type": "string"
}
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "RampUpRule": {
+ "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
+ "type": "object",
+ "properties": {
+ "actionHostName": {
+ "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
+ "type": "string"
+ },
+ "reroutePercentage": {
+ "format": "double",
+ "description": "Percentage of the traffic which will be redirected to ActionHostName.",
+ "type": "number"
+ },
+ "changeStep": {
+ "format": "double",
+ "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
+ "type": "number"
+ },
+ "changeIntervalInMinutes": {
+ "format": "int32",
+ "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.",
+ "type": "integer"
+ },
+ "minReroutePercentage": {
+ "format": "double",
+ "description": "Specifies lower boundary above which ReroutePercentage will stay.",
+ "type": "number"
+ },
+ "maxReroutePercentage": {
+ "format": "double",
+ "description": "Specifies upper boundary below which ReroutePercentage will stay.",
+ "type": "number"
},
- "VnetGateway": {
- "description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
+ "changeDecisionCallbackUrl": {
+ "description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.",
+ "type": "string"
+ }
+ }
+ },
+ "RequestsBasedTrigger": {
+ "description": "Trigger based on total requests.",
+ "type": "object",
+ "properties": {
+ "count": {
+ "format": "int32",
+ "description": "Count.",
+ "type": "integer"
+ },
+ "timeInterval": {
+ "description": "Time interval.",
+ "type": "string"
+ }
+ }
+ },
+ "Resource": {
+ "description": "Azure resource. This resource is tracked in Azure Resource Manager",
+ "required": [
+ "location"
+ ],
+ "properties": {
+ "id": {
+ "description": "Resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Resource Name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "kind": {
+ "description": "Kind of resource.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Resource Location.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "tags": {
+ "description": "Resource tags.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "ResourceMetric": {
+ "description": "Object representing a metric for any resource .",
+ "type": "object",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/ResourceMetricName",
+ "description": "Name of metric.",
+ "readOnly": true
+ },
+ "unit": {
+ "description": "Metric unit.",
+ "type": "string",
+ "readOnly": true
+ },
+ "timeGrain": {
+ "description": "Metric granularity. E.g PT1H, PT5M, P1D",
+ "type": "string",
+ "readOnly": true
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "Metric start time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "Metric end time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resourceId": {
+ "description": "Metric resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "Resource Id.",
+ "type": "string",
+ "readOnly": true
+ },
+ "metricValues": {
+ "description": "Metric values.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMetricValue"
+ },
+ "readOnly": true
+ },
+ "properties": {
+ "description": "Properties.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMetricProperty"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceMetricAvailability": {
+ "description": "Metrics availability and retention.",
+ "type": "object",
+ "properties": {
+ "timeGrain": {
+ "description": "Time grain .",
+ "type": "string",
+ "readOnly": true
+ },
+ "retention": {
+ "description": "Retention period for the current time grain.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceMetricCollection": {
+ "description": "Collection of metric responses.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMetric"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceMetricDefinition": {
+ "description": "Metadata for the metrics.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ResourceMetricDefinition resource specific properties",
+ "properties": {
+ "name": {
+ "$ref": "#/definitions/ResourceMetricName",
+ "description": "Name of the metric.",
+ "readOnly": true
+ },
+ "unit": {
+ "description": "Unit of the metric.",
+ "type": "string",
+ "readOnly": true
+ },
+ "primaryAggregationType": {
+ "description": "Primary aggregation type.",
+ "type": "string",
+ "readOnly": true
+ },
+ "metricAvailabilities": {
+ "description": "List of time grains supported for the metric together with retention period.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMetricAvailability"
+ },
+ "readOnly": true
+ },
+ "resourceUri": {
+ "description": "Resource URI.",
+ "type": "string",
+ "readOnly": true
+ },
+ "id": {
+ "description": "Resource ID.",
+ "type": "string",
+ "readOnly": true
+ },
"properties": {
- "properties": {
- "description": "VnetGateway resource specific properties",
- "required": [
- "vpnPackageUri"
- ],
- "properties": {
- "vnetName": {
- "description": "The Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "vpnPackageUri": {
- "description": "The URI where the VPN package can be downloaded.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ]
- }
- },
- "x-ms-client-flatten": true
- }
+ "description": "Properties.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "readOnly": true
}
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ResourceMetricDefinitionCollection": {
+ "description": "Collection of metric definitions.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMetricDefinition"
+ }
},
- "VnetInfo": {
- "description": "Virtual Network information contract.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetInfo resource specific properties",
- "properties": {
- "vnetResourceId": {
- "description": "The Virtual Network's resource ID.",
- "type": "string"
- },
- "certThumbprint": {
- "description": "The client certificate thumbprint.",
- "type": "string",
- "readOnly": true
- },
- "certBlob": {
- "format": "byte",
- "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
- "type": "string"
- },
- "routes": {
- "description": "The routes that this Virtual Network connection uses.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VnetRoute"
- },
- "readOnly": true
- },
- "resyncRequired": {
- "description": "true if a resync is required; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "dnsServers": {
- "description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceMetricName": {
+ "description": "Name of a metric for any resource .",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "metric name value.",
+ "type": "string",
+ "readOnly": true
+ },
+ "localizedValue": {
+ "description": "Localized metric name value.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceMetricProperty": {
+ "description": "Resource metric property.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "Key for resource metric property.",
+ "type": "string"
+ },
+ "value": {
+ "description": "Value of pair.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceMetricValue": {
+ "description": "Value of resource metric.",
+ "type": "object",
+ "properties": {
+ "timestamp": {
+ "description": "Value timestamp.",
+ "type": "string",
+ "readOnly": true
+ },
+ "average": {
+ "format": "float",
+ "description": "Value average.",
+ "type": "number",
+ "readOnly": true
+ },
+ "minimum": {
+ "format": "float",
+ "description": "Value minimum.",
+ "type": "number",
+ "readOnly": true
+ },
+ "maximum": {
+ "format": "float",
+ "description": "Value maximum.",
+ "type": "number",
+ "readOnly": true
+ },
+ "total": {
+ "format": "float",
+ "description": "Value total.",
+ "type": "number",
+ "readOnly": true
+ },
+ "count": {
+ "format": "float",
+ "description": "Value count.",
+ "type": "number",
+ "readOnly": true
+ },
+ "properties": {
+ "description": "Properties.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceMetricProperty"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "Site": {
+ "description": "A web app, a mobile app backend, or an API app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Site resource specific properties",
+ "properties": {
+ "state": {
+ "description": "Current state of the app.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostNames": {
+ "description": "Hostnames associated with the app.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "repositorySiteName": {
+ "description": "Name of the repository site.",
+ "type": "string",
+ "readOnly": true
+ },
+ "usageState": {
+ "description": "State indicating whether the app has exceeded its quota usage. Read-only.",
+ "enum": [
+ "Normal",
+ "Exceeded"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "UsageState",
+ "modelAsString": false
+ }
+ },
+ "enabled": {
+ "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
+ "type": "boolean"
+ },
+ "enabledHostNames": {
+ "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "availabilityState": {
+ "description": "Management information availability state for the app.",
+ "enum": [
+ "Normal",
+ "Limited",
+ "DisasterRecoveryMode"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "SiteAvailabilityState",
+ "modelAsString": false
+ }
+ },
+ "hostNameSslStates": {
+ "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HostNameSslState"
+ }
+ },
+ "serverFarmId": {
+ "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
+ "type": "string"
+ },
+ "reserved": {
+ "description": "true if reserved; otherwise, false.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "lastModifiedTimeUtc": {
+ "format": "date-time",
+ "description": "Last time the app was modified, in UTC. Read-only.",
+ "type": "string",
+ "readOnly": true
+ },
+ "siteConfig": {
+ "$ref": "#/definitions/SiteConfig",
+ "description": "Configuration of the app."
+ },
+ "trafficManagerHostNames": {
+ "description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "scmSiteAlsoStopped": {
+ "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
+ "default": false,
+ "type": "boolean"
+ },
+ "targetSwapSlot": {
+ "description": "Specifies which deployment slot this app will swap into. Read-only.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostingEnvironmentProfile": {
+ "$ref": "#/definitions/HostingEnvironmentProfile",
+ "description": "App Service Environment to use for the app.",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "clientAffinityEnabled": {
+ "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.",
+ "type": "boolean"
+ },
+ "clientCertEnabled": {
+ "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
+ "type": "boolean"
+ },
+ "hostNamesDisabled": {
+ "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
+ "type": "boolean"
+ },
+ "outboundIpAddresses": {
+ "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.",
+ "type": "string",
+ "readOnly": true
+ },
+ "possibleOutboundIpAddresses": {
+ "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.",
+ "type": "string",
+ "readOnly": true
+ },
+ "containerSize": {
+ "format": "int32",
+ "description": "Size of the function container.",
+ "type": "integer"
+ },
+ "dailyMemoryTimeQuota": {
+ "format": "int32",
+ "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
+ "type": "integer"
+ },
+ "suspendedTill": {
+ "format": "date-time",
+ "description": "App suspended till in case memory-time quota is exceeded.",
+ "type": "string",
+ "readOnly": true
+ },
+ "maxNumberOfWorkers": {
+ "format": "int32",
+ "description": "Maximum number of workers.\nThis only applies to Functions container.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "cloningInfo": {
+ "$ref": "#/definitions/CloningInfo",
+ "description": "If specified during app creation, the app is cloned from a source app.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "snapshotInfo": {
+ "$ref": "#/definitions/SnapshotRecoveryRequest",
+ "description": "If specified during app creation, the app is created from a previous snapshot.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "resourceGroup": {
+ "description": "Name of the resource group the app belongs to. Read-only.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isDefaultContainer": {
+ "description": "true if the app is a default container; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "defaultHostName": {
+ "description": "Default hostname of the app. Read-only.",
+ "type": "string",
+ "readOnly": true
+ },
+ "slotSwapStatus": {
+ "$ref": "#/definitions/SlotSwapStatus",
+ "description": "Status of the last deployment slot swap operation.",
+ "readOnly": true
+ },
+ "httpsOnly": {
+ "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
+ "type": "boolean"
}
+ },
+ "x-ms-client-flatten": true
},
- "VnetRoute": {
- "description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetRoute resource specific properties",
- "properties": {
- "name": {
- "description": "The name of this route. This is only returned by the server and does not need to be set by the client.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ],
- "x-ms-client-name": "vnetRouteName"
- },
- "startAddress": {
- "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
- "type": "string"
- },
- "endAddress": {
- "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
- "type": "string"
- },
- "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.",
- "enum": [
- "DEFAULT",
- "INHERITED",
- "STATIC"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "RouteType",
- "modelAsString": true
- }
- }
- },
- "x-ms-client-flatten": true
- }
+ "identity": {
+ "$ref": "#/definitions/ManagedServiceIdentity"
+ }
+ }
+ },
+ "SiteConfig": {
+ "description": "Configuration of an App Service app.",
+ "type": "object",
+ "properties": {
+ "numberOfWorkers": {
+ "format": "int32",
+ "description": "Number of workers.",
+ "type": "integer"
+ },
+ "defaultDocuments": {
+ "description": "Default documents.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "netFrameworkVersion": {
+ "description": ".NET Framework version.",
+ "default": "v4.6",
+ "type": "string"
+ },
+ "phpVersion": {
+ "description": "Version of PHP.",
+ "type": "string"
+ },
+ "pythonVersion": {
+ "description": "Version of Python.",
+ "type": "string"
+ },
+ "nodeVersion": {
+ "description": "Version of Node.js.",
+ "type": "string"
+ },
+ "linuxFxVersion": {
+ "description": "Linux App Framework and version",
+ "type": "string"
+ },
+ "requestTracingEnabled": {
+ "description": "true if request tracing is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "requestTracingExpirationTime": {
+ "format": "date-time",
+ "description": "Request tracing expiration time.",
+ "type": "string"
+ },
+ "remoteDebuggingEnabled": {
+ "description": "true if remote debugging is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "remoteDebuggingVersion": {
+ "description": "Remote debugging version.",
+ "type": "string"
+ },
+ "httpLoggingEnabled": {
+ "description": "true if HTTP logging is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "logsDirectorySizeLimit": {
+ "format": "int32",
+ "description": "HTTP logs directory size limit.",
+ "type": "integer"
+ },
+ "detailedErrorLoggingEnabled": {
+ "description": "true if detailed error logging is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "publishingUsername": {
+ "description": "Publishing user name.",
+ "type": "string"
+ },
+ "appSettings": {
+ "description": "Application settings.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NameValuePair"
+ }
+ },
+ "connectionStrings": {
+ "description": "Connection strings.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ConnStringInfo"
+ }
+ },
+ "machineKey": {
+ "$ref": "#/definitions/SiteMachineKey",
+ "description": "Site MachineKey.",
+ "readOnly": true
+ },
+ "handlerMappings": {
+ "description": "Handler mappings.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HandlerMapping"
+ }
+ },
+ "documentRoot": {
+ "description": "Document root.",
+ "type": "string"
+ },
+ "scmType": {
+ "description": "SCM type.",
+ "enum": [
+ "None",
+ "Dropbox",
+ "Tfs",
+ "LocalGit",
+ "GitHub",
+ "CodePlexGit",
+ "CodePlexHg",
+ "BitbucketGit",
+ "BitbucketHg",
+ "ExternalGit",
+ "ExternalHg",
+ "OneDrive",
+ "VSO"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ScmType",
+ "modelAsString": true
+ }
+ },
+ "use32BitWorkerProcess": {
+ "description": "true to use 32-bit worker process; otherwise, false.",
+ "type": "boolean"
+ },
+ "webSocketsEnabled": {
+ "description": "true if WebSocket is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "alwaysOn": {
+ "description": "true if Always On is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "javaVersion": {
+ "description": "Java version.",
+ "type": "string"
+ },
+ "javaContainer": {
+ "description": "Java container.",
+ "type": "string"
+ },
+ "javaContainerVersion": {
+ "description": "Java container version.",
+ "type": "string"
+ },
+ "appCommandLine": {
+ "description": "App command line to launch.",
+ "type": "string"
+ },
+ "managedPipelineMode": {
+ "description": "Managed pipeline mode.",
+ "enum": [
+ "Integrated",
+ "Classic"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ManagedPipelineMode",
+ "modelAsString": false
+ }
+ },
+ "virtualApplications": {
+ "description": "Virtual applications.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualApplication"
+ }
+ },
+ "loadBalancing": {
+ "description": "Site load balancing.",
+ "enum": [
+ "WeightedRoundRobin",
+ "LeastRequests",
+ "LeastResponseTime",
+ "WeightedTotalTraffic",
+ "RequestHash"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SiteLoadBalancing",
+ "modelAsString": false
+ }
+ },
+ "experiments": {
+ "$ref": "#/definitions/Experiments",
+ "description": "This is work around for polymophic types."
+ },
+ "limits": {
+ "$ref": "#/definitions/SiteLimits",
+ "description": "Site limits."
+ },
+ "autoHealEnabled": {
+ "description": "true if Auto Heal is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "autoHealRules": {
+ "$ref": "#/definitions/AutoHealRules",
+ "description": "Auto Heal rules."
+ },
+ "tracingOptions": {
+ "description": "Tracing options.",
+ "type": "string"
+ },
+ "vnetName": {
+ "description": "Virtual Network name.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "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."
+ },
+ "autoSwapSlotName": {
+ "description": "Auto-swap slot name.",
+ "type": "string"
+ },
+ "localMySqlEnabled": {
+ "description": "true to enable local MySQL; otherwise, false.",
+ "default": false,
+ "type": "boolean"
+ },
+ "ipSecurityRestrictions": {
+ "description": "IP security restrictions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IpSecurityRestriction"
+ }
+ }
+ }
+ },
+ "SiteLimits": {
+ "description": "Metric limits set on an app.",
+ "type": "object",
+ "properties": {
+ "maxPercentageCpu": {
+ "format": "double",
+ "description": "Maximum allowed CPU usage percentage.",
+ "type": "number"
+ },
+ "maxMemoryInMb": {
+ "format": "int64",
+ "description": "Maximum allowed memory usage in MB.",
+ "type": "integer"
+ },
+ "maxDiskSizeInMb": {
+ "format": "int64",
+ "description": "Maximum allowed disk size usage in MB.",
+ "type": "integer"
+ }
+ }
+ },
+ "SiteMachineKey": {
+ "description": "MachineKey of an app.",
+ "type": "object",
+ "properties": {
+ "validation": {
+ "description": "MachineKey validation.",
+ "type": "string"
+ },
+ "validationKey": {
+ "description": "Validation key.",
+ "type": "string"
+ },
+ "decryption": {
+ "description": "Decryption.",
+ "type": "string"
+ },
+ "decryptionKey": {
+ "description": "Decryption key.",
+ "type": "string"
+ }
+ }
+ },
+ "SkuCapacity": {
+ "description": "Description of the App Service plan scale options.",
+ "type": "object",
+ "properties": {
+ "minimum": {
+ "format": "int32",
+ "description": "Minimum number of workers for this App Service plan SKU.",
+ "type": "integer"
+ },
+ "maximum": {
+ "format": "int32",
+ "description": "Maximum number of workers for this App Service plan SKU.",
+ "type": "integer"
+ },
+ "default": {
+ "format": "int32",
+ "description": "Default number of workers for this App Service plan SKU.",
+ "type": "integer"
+ },
+ "scaleType": {
+ "description": "Available scale configurations for an App Service plan.",
+ "type": "string"
+ }
+ }
+ },
+ "SkuDescription": {
+ "description": "Description of a SKU for a scalable resource.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the resource SKU.",
+ "type": "string"
+ },
+ "tier": {
+ "description": "Service tier of the resource SKU.",
+ "type": "string"
+ },
+ "size": {
+ "description": "Size specifier of the resource SKU.",
+ "type": "string"
+ },
+ "family": {
+ "description": "Family code of the resource SKU.",
+ "type": "string"
+ },
+ "capacity": {
+ "format": "int32",
+ "description": "Current number of instances assigned to the resource.",
+ "type": "integer"
+ },
+ "skuCapacity": {
+ "$ref": "#/definitions/SkuCapacity",
+ "description": "Min, max, and default scale values of the SKU."
+ },
+ "locations": {
+ "description": "Locations of the SKU.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "capabilities": {
+ "description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Capability"
+ }
+ }
+ }
+ },
+ "SlotSwapStatus": {
+ "description": "The status of the last successfull slot swap operation.",
+ "type": "object",
+ "properties": {
+ "timestampUtc": {
+ "format": "date-time",
+ "description": "The time the last successful slot swap completed.",
+ "type": "string",
+ "readOnly": true
+ },
+ "sourceSlotName": {
+ "description": "The source slot of the last swap operation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "destinationSlotName": {
+ "description": "The destination slot of the last swap operation.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SlowRequestsBasedTrigger": {
+ "description": "Trigger based on request execution time.",
+ "type": "object",
+ "properties": {
+ "timeTaken": {
+ "description": "Time taken.",
+ "type": "string"
+ },
+ "count": {
+ "format": "int32",
+ "description": "Count.",
+ "type": "integer"
+ },
+ "timeInterval": {
+ "description": "Time interval.",
+ "type": "string"
+ }
+ }
+ },
+ "SnapshotRecoveryRequest": {
+ "description": "Details about app recovery operation.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SnapshotRecoveryRequest resource specific properties",
+ "required": [
+ "overwrite"
+ ],
+ "properties": {
+ "snapshotTime": {
+ "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string.",
+ "type": "string"
+ },
+ "recoveryTarget": {
+ "$ref": "#/definitions/SnapshotRecoveryTarget",
+ "description": "Specifies the web app that snapshot contents will be written to."
+ },
+ "overwrite": {
+ "description": "If true the recovery operation can overwrite source app; otherwise, false.",
+ "type": "boolean"
+ },
+ "recoverConfiguration": {
+ "description": "If true, site configuration, in addition to content, will be reverted.",
+ "type": "boolean"
+ },
+ "ignoreConflictingHostNames": {
+ "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.",
+ "type": "boolean"
}
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SnapshotRecoveryTarget": {
+ "description": "Specifies the web app that snapshot contents will be written to.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS",
+ "type": "string"
},
- "WebAppCollection": {
- "description": "Collection of App Service apps.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Site"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
+ "id": {
+ "description": "ARM resource ID of the target 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.",
+ "type": "string"
+ }
+ }
+ },
+ "StampCapacity": {
+ "description": "Stamp capacity information.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the stamp.",
+ "type": "string"
+ },
+ "availableCapacity": {
+ "format": "int64",
+ "description": "Available capacity (# of machines, bytes of storage etc...).",
+ "type": "integer"
+ },
+ "totalCapacity": {
+ "format": "int64",
+ "description": "Total capacity (# of machines, bytes of storage etc...).",
+ "type": "integer"
+ },
+ "unit": {
+ "description": "Name of the unit.",
+ "type": "string"
+ },
+ "computeMode": {
+ "description": "Shared/dedicated workers.",
+ "enum": [
+ "Shared",
+ "Dedicated",
+ "Dynamic"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ComputeModeOptions",
+ "modelAsString": false
+ }
+ },
+ "workerSize": {
+ "description": "Size of the machines.",
+ "enum": [
+ "Default",
+ "Small",
+ "Medium",
+ "Large",
+ "D1",
+ "D2",
+ "D3"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WorkerSizeOptions",
+ "modelAsString": false
+ }
+ },
+ "workerSizeId": {
+ "format": "int32",
+ "description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
+ "type": "integer"
+ },
+ "excludeFromCapacityAllocation": {
+ "description": "If true, it includes basic apps.\nBasic apps are not used for capacity allocation.",
+ "type": "boolean"
+ },
+ "isApplicableForAllComputeModes": {
+ "description": "true if capacity is applicable for all apps; otherwise, false.",
+ "type": "boolean"
+ },
+ "siteMode": {
+ "description": "Shared or Dedicated.",
+ "type": "string"
+ }
+ }
+ },
+ "StatusCodesBasedTrigger": {
+ "description": "Trigger based on status code.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "format": "int32",
+ "description": "HTTP status code.",
+ "type": "integer"
+ },
+ "subStatus": {
+ "format": "int32",
+ "description": "SubStatus.",
+ "type": "integer"
+ },
+ "win32Status": {
+ "format": "int32",
+ "description": "Win32 error code.",
+ "type": "integer"
+ },
+ "count": {
+ "format": "int32",
+ "description": "Count.",
+ "type": "integer"
+ },
+ "timeInterval": {
+ "description": "Time interval.",
+ "type": "string"
+ }
+ }
+ },
+ "User": {
+ "description": "User crendentials used for publishing activity.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "User resource specific properties",
+ "required": [
+ "publishingUserName"
+ ],
+ "properties": {
+ "name": {
+ "description": "Username",
+ "type": "string",
+ "x-ms-client-name": "UserName"
+ },
+ "publishingUserName": {
+ "description": "Username used for publishing.",
+ "type": "string"
+ },
+ "publishingPassword": {
+ "format": "password",
+ "description": "Password used for publishing.",
+ "type": "string"
+ },
+ "publishingPasswordHash": {
+ "format": "password",
+ "description": "Password hash used for publishing.",
+ "type": "string"
+ },
+ "publishingPasswordHashSalt": {
+ "format": "password",
+ "description": "Password hash salt used for publishing.",
+ "type": "string"
}
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "VirtualApplication": {
+ "description": "Virtual application in an app.",
+ "type": "object",
+ "properties": {
+ "virtualPath": {
+ "description": "Virtual path.",
+ "type": "string"
},
- "WorkerPool": {
- "description": "Worker pool of an App Service Environment.",
- "type": "object",
- "properties": {
- "workerSizeId": {
- "format": "int32",
- "description": "Worker size ID for referencing this worker pool.",
- "type": "integer"
- },
- "computeMode": {
- "description": "Shared or dedicated app hosting.",
- "enum": [
- "Shared",
- "Dedicated",
- "Dynamic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ComputeModeOptions",
- "modelAsString": false
- }
- },
- "workerSize": {
- "description": "VM size of the worker pool instances.",
- "type": "string"
- },
- "workerCount": {
- "format": "int32",
- "description": "Number of instances in the worker pool.",
- "type": "integer"
- },
- "instanceNames": {
- "description": "Names of all instances in the worker pool (read only).",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- }
+ "physicalPath": {
+ "description": "Physical path.",
+ "type": "string"
+ },
+ "preloadEnabled": {
+ "description": "true if preloading is enabled; otherwise, false.",
+ "type": "boolean"
+ },
+ "virtualDirectories": {
+ "description": "Virtual directories for virtual application.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VirtualDirectory"
+ }
+ }
+ }
+ },
+ "VirtualDirectory": {
+ "description": "Directory for virtual application.",
+ "type": "object",
+ "properties": {
+ "virtualPath": {
+ "description": "Path to virtual application.",
+ "type": "string"
+ },
+ "physicalPath": {
+ "description": "Physical path.",
+ "type": "string"
+ }
+ }
+ },
+ "VirtualIPMapping": {
+ "description": "Virtual IP mapping.",
+ "type": "object",
+ "properties": {
+ "virtualIP": {
+ "description": "Virtual IP address.",
+ "type": "string"
+ },
+ "internalHttpPort": {
+ "format": "int32",
+ "description": "Internal HTTP port.",
+ "type": "integer"
+ },
+ "internalHttpsPort": {
+ "format": "int32",
+ "description": "Internal HTTPS port.",
+ "type": "integer"
+ },
+ "inUse": {
+ "description": "Is virtual IP mapping in use.",
+ "type": "boolean"
+ }
+ }
+ },
+ "VirtualNetworkProfile": {
+ "description": "Specification for using a Virtual Network.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "Resource id of the Virtual Network.",
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the Virtual Network (read-only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Resource type of the Virtual Network (read-only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "subnet": {
+ "description": "Subnet within the Virtual Network.",
+ "type": "string"
+ }
+ }
+ },
+ "VnetGateway": {
+ "description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "VnetGateway resource specific properties",
+ "required": [
+ "vpnPackageUri"
+ ],
+ "properties": {
+ "vnetName": {
+ "description": "The Virtual Network name.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "vpnPackageUri": {
+ "description": "The URI where the VPN package can be downloaded.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "update"
+ ]
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "VnetInfo": {
+ "description": "Virtual Network information contract.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "VnetInfo resource specific properties",
+ "properties": {
+ "vnetResourceId": {
+ "description": "The Virtual Network's resource ID.",
+ "type": "string"
+ },
+ "certThumbprint": {
+ "description": "The client certificate thumbprint.",
+ "type": "string",
+ "readOnly": true
+ },
+ "certBlob": {
+ "format": "byte",
+ "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
+ "type": "string"
+ },
+ "routes": {
+ "description": "The routes that this Virtual Network connection uses.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VnetRoute"
+ },
+ "readOnly": true
+ },
+ "resyncRequired": {
+ "description": "true if a resync is required; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "dnsServers": {
+ "description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "VnetRoute": {
+ "description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "VnetRoute resource specific properties",
+ "properties": {
+ "name": {
+ "description": "The name of this route. This is only returned by the server and does not need to be set by the client.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ],
+ "x-ms-client-name": "vnetRouteName"
+ },
+ "startAddress": {
+ "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
+ "type": "string"
+ },
+ "endAddress": {
+ "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
+ "type": "string"
+ },
+ "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.",
+ "enum": [
+ "DEFAULT",
+ "INHERITED",
+ "STATIC"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RouteType",
+ "modelAsString": true
+ }
}
+ },
+ "x-ms-client-flatten": true
}
+ }
+ },
+ "WebAppCollection": {
+ "description": "Collection of App Service apps.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Site"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string"
+ }
+ }
+ },
+ "WorkerPool": {
+ "description": "Worker pool of an App Service Environment.",
+ "type": "object",
+ "properties": {
+ "workerSizeId": {
+ "format": "int32",
+ "description": "Worker size ID for referencing this worker pool.",
+ "type": "integer"
+ },
+ "computeMode": {
+ "description": "Shared or dedicated app hosting.",
+ "enum": [
+ "Shared",
+ "Dedicated",
+ "Dynamic"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ComputeModeOptions",
+ "modelAsString": false
+ }
+ },
+ "workerSize": {
+ "description": "VM size of the worker pool instances.",
+ "type": "string"
+ },
+ "workerCount": {
+ "format": "int32",
+ "description": "Number of instances in the worker pool.",
+ "type": "integer"
+ },
+ "instanceNames": {
+ "description": "Names of all instances in the worker pool (read only).",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "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"
+ }
+ }
+ },
+ "security": [
+ {
+ "azure_auth": [
+ "user_impersonation"
+ ]
}
+ ]
}
\ No newline at end of file
diff --git a/specification/web/resource-manager/Microsoft.Web/2016-03-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/2016-03-01/ResourceProvider.json
index c27d25e7ea8c..c954aedbe6fa 100644
--- a/specification/web/resource-manager/Microsoft.Web/2016-03-01/ResourceProvider.json
+++ b/specification/web/resource-manager/Microsoft.Web/2016-03-01/ResourceProvider.json
@@ -29,7 +29,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/User"
+ "$ref": "./CommonDefinitions.json#/definitions/User"
}
}
}
@@ -45,7 +45,7 @@
"description": "Details of publishing user",
"required": true,
"schema": {
- "$ref": "#/definitions/User"
+ "$ref": "./CommonDefinitions.json#/definitions/User"
}
},
{
@@ -56,7 +56,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/User"
+ "$ref": "./CommonDefinitions.json#/definitions/User"
}
}
}
@@ -441,251 +441,6 @@
}
},
"definitions": {
- "AppServiceEnvironment": {
- "description": "Description of an App Service Environment.",
- "required": [
- "name",
- "location",
- "virtualNetwork",
- "workerPools"
- ],
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string"
- },
- "location": {
- "description": "Location of the App Service Environment, e.g. \"West US\".",
- "type": "string"
- },
- "provisioningState": {
- "description": "Provisioning state of the App Service Environment.",
- "enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": false
- }
- },
- "status": {
- "description": "Current status of the App Service Environment.",
- "enum": [
- "Preparing",
- "Ready",
- "Scaling",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "HostingEnvironmentStatus",
- "modelAsString": false
- }
- },
- "vnetName": {
- "description": "Name of the Virtual Network for the App Service Environment.",
- "type": "string"
- },
- "vnetResourceGroupName": {
- "description": "Resource group of the Virtual Network.",
- "type": "string"
- },
- "vnetSubnetName": {
- "description": "Subnet of the Virtual Network.",
- "type": "string"
- },
- "virtualNetwork": {
- "$ref": "#/definitions/VirtualNetworkProfile",
- "description": "Description of the Virtual Network."
- },
- "internalLoadBalancingMode": {
- "description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
- "enum": [
- "None",
- "Web",
- "Publishing"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "InternalLoadBalancingMode",
- "modelAsString": false
- }
- },
- "multiSize": {
- "description": "Front-end VM size, e.g. \"Medium\", \"Large\".",
- "type": "string"
- },
- "multiRoleCount": {
- "format": "int32",
- "description": "Number of front-end instances.",
- "type": "integer"
- },
- "workerPools": {
- "description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/WorkerPool"
- }
- },
- "ipsslAddressCount": {
- "format": "int32",
- "description": "Number of IP SSL addresses reserved for the App Service Environment.",
- "type": "integer"
- },
- "databaseEdition": {
- "description": "Edition of the metadata database for the App Service Environment, e.g. \"Standard\".",
- "type": "string",
- "readOnly": true
- },
- "databaseServiceObjective": {
- "description": "Service objective of the metadata database for the App Service Environment, e.g. \"S0\".",
- "type": "string",
- "readOnly": true
- },
- "upgradeDomains": {
- "format": "int32",
- "description": "Number of upgrade domains of the App Service Environment.",
- "type": "integer",
- "readOnly": true
- },
- "subscriptionId": {
- "description": "Subscription of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "dnsSuffix": {
- "description": "DNS suffix of the App Service Environment.",
- "type": "string"
- },
- "lastAction": {
- "description": "Last deployment action on the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "lastActionResult": {
- "description": "Result of the last deployment action on the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "allowedMultiSizes": {
- "description": "List of comma separated strings describing which VM sizes are allowed for front-ends.",
- "type": "string",
- "readOnly": true
- },
- "allowedWorkerSizes": {
- "description": "List of comma separated strings describing which VM sizes are allowed for workers.",
- "type": "string",
- "readOnly": true
- },
- "maximumNumberOfMachines": {
- "format": "int32",
- "description": "Maximum number of VMs in the App Service Environment.",
- "type": "integer",
- "readOnly": true
- },
- "vipMappings": {
- "description": "Description of IP SSL mapping for the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualIPMapping"
- },
- "readOnly": true
- },
- "environmentCapacities": {
- "description": "Current total, used, and available worker capacities.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StampCapacity"
- },
- "readOnly": true
- },
- "networkAccessControlList": {
- "description": "Access control list for controlling traffic to the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NetworkAccessControlEntry"
- }
- },
- "environmentIsHealthy": {
- "description": "True/false indicating whether the App Service Environment is healthy.",
- "type": "boolean",
- "readOnly": true
- },
- "environmentStatus": {
- "description": "Detailed message about with results of the last check of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "resourceGroup": {
- "description": "Resource group of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "frontEndScaleFactor": {
- "format": "int32",
- "description": "Scale factor for front-ends.",
- "type": "integer"
- },
- "defaultFrontEndScaleFactor": {
- "format": "int32",
- "description": "Default Scale Factor for FrontEnds.",
- "type": "integer",
- "readOnly": true
- },
- "apiManagementAccountId": {
- "description": "API Management Account associated with the App Service Environment.",
- "type": "string"
- },
- "suspended": {
- "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).",
- "type": "boolean"
- },
- "dynamicCacheEnabled": {
- "description": "True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
- "type": "boolean"
- },
- "clusterSettings": {
- "description": "Custom settings for changing the behavior of the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "userWhitelistedIpRanges": {
- "description": "User added ip ranges to whitelist on ASE db",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "Capability": {
- "description": "Describes the capabilities/features allowed for a specific SKU.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the SKU capability.",
- "type": "string"
- },
- "value": {
- "description": "Value of the SKU capability.",
- "type": "string"
- },
- "reason": {
- "description": "Reason of the SKU capability.",
- "type": "string"
- }
- }
- },
"CsmMoveResourceEnvelope": {
"description": "Object with a list of the resources that need to be moved and the resource group they should be moved to.",
"type": "object",
@@ -719,7 +474,7 @@
"description": "Available App Service Environments with full descriptions of the environments.",
"type": "array",
"items": {
- "$ref": "#/definitions/AppServiceEnvironment"
+ "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment"
}
},
"hostingEnvironmentDeploymentInfos": {
@@ -736,7 +491,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -804,7 +559,7 @@
"type": "string"
},
"capacity": {
- "$ref": "#/definitions/SkuCapacity",
+ "$ref": "./CommonDefinitions.json#/definitions/SkuCapacity",
"description": "Min, max, and default scale values of the SKU."
},
"locations": {
@@ -818,7 +573,7 @@
"description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
"type": "array",
"items": {
- "$ref": "#/definitions/Capability"
+ "$ref": "./CommonDefinitions.json#/definitions/Capability"
}
}
}
@@ -837,57 +592,12 @@
}
}
},
- "NameValuePair": {
- "description": "Name value pair.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Pair name.",
- "type": "string"
- },
- "value": {
- "description": "Pair value.",
- "type": "string"
- }
- }
- },
- "NetworkAccessControlEntry": {
- "description": "Network access control entry.",
- "type": "object",
- "properties": {
- "action": {
- "description": "Action object.",
- "enum": [
- "Permit",
- "Deny"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AccessControlEntryAction",
- "modelAsString": false
- }
- },
- "description": {
- "description": "Description.",
- "type": "string"
- },
- "order": {
- "format": "int32",
- "description": "Order of precedence.",
- "type": "integer"
- },
- "remoteSubnet": {
- "description": "Remote subnet.",
- "type": "string"
- }
- }
- },
"PremierAddOnOffer": {
"description": "Premier add-on offer.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -976,31 +686,6 @@
}
}
},
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
"ResourceNameAvailability": {
"description": "Information regarding availbility of a resource name.",
"type": "object",
@@ -1058,31 +743,6 @@
}
}
},
- "SkuCapacity": {
- "description": "Description of the App Service plan scale options.",
- "type": "object",
- "properties": {
- "minimum": {
- "format": "int32",
- "description": "Minimum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "maximum": {
- "format": "int32",
- "description": "Maximum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "default": {
- "format": "int32",
- "description": "Default number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "scaleType": {
- "description": "Available scale configurations for an App Service plan.",
- "type": "string"
- }
- }
- },
"SkuInfos": {
"description": "Collection of SKU information.",
"type": "object",
@@ -1105,7 +765,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1158,121 +818,6 @@
}
}
},
- "StampCapacity": {
- "description": "Stamp capacity information.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the stamp.",
- "type": "string"
- },
- "availableCapacity": {
- "format": "int64",
- "description": "Available capacity (# of machines, bytes of storage etc...).",
- "type": "integer"
- },
- "totalCapacity": {
- "format": "int64",
- "description": "Total capacity (# of machines, bytes of storage etc...).",
- "type": "integer"
- },
- "unit": {
- "description": "Name of the unit.",
- "type": "string"
- },
- "computeMode": {
- "description": "Shared/dedicated workers.",
- "enum": [
- "Shared",
- "Dedicated",
- "Dynamic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ComputeModeOptions",
- "modelAsString": false
- }
- },
- "workerSize": {
- "description": "Size of the machines.",
- "enum": [
- "Default",
- "Small",
- "Medium",
- "Large",
- "D1",
- "D2",
- "D3"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "WorkerSizeOptions",
- "modelAsString": false
- }
- },
- "workerSizeId": {
- "format": "int32",
- "description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
- "type": "integer"
- },
- "excludeFromCapacityAllocation": {
- "description": "If true, it includes basic apps.\nBasic apps are not used for capacity allocation.",
- "type": "boolean"
- },
- "isApplicableForAllComputeModes": {
- "description": "true if capacity is applicable for all apps; otherwise, false.",
- "type": "boolean"
- },
- "siteMode": {
- "description": "Shared or Dedicated.",
- "type": "string"
- }
- }
- },
- "User": {
- "description": "User crendentials used for publishing activity.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "User resource specific properties",
- "required": [
- "publishingUserName"
- ],
- "properties": {
- "name": {
- "description": "Username",
- "type": "string",
- "x-ms-client-name": "UserName"
- },
- "publishingUserName": {
- "description": "Username used for publishing.",
- "type": "string"
- },
- "publishingPassword": {
- "format": "password",
- "description": "Password used for publishing.",
- "type": "string"
- },
- "publishingPasswordHash": {
- "format": "password",
- "description": "Password hash used for publishing.",
- "type": "string"
- },
- "publishingPasswordHashSalt": {
- "format": "password",
- "description": "Password hash salt used for publishing.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
"ValidateProperties": {
"description": "App properties used for validation.",
"type": "object",
@@ -1370,60 +915,12 @@
}
}
},
- "VirtualIPMapping": {
- "description": "Virtual IP mapping.",
- "type": "object",
- "properties": {
- "virtualIP": {
- "description": "Virtual IP address.",
- "type": "string"
- },
- "internalHttpPort": {
- "format": "int32",
- "description": "Internal HTTP port.",
- "type": "integer"
- },
- "internalHttpsPort": {
- "format": "int32",
- "description": "Internal HTTPS port.",
- "type": "integer"
- },
- "inUse": {
- "description": "Is virtual IP mapping in use.",
- "type": "boolean"
- }
- }
- },
- "VirtualNetworkProfile": {
- "description": "Specification for using a Virtual Network.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource id of the Virtual Network.",
- "type": "string"
- },
- "name": {
- "description": "Name of the Virtual Network (read-only).",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the Virtual Network (read-only).",
- "type": "string",
- "readOnly": true
- },
- "subnet": {
- "description": "Subnet within the Virtual Network.",
- "type": "string"
- }
- }
- },
"VnetParameters": {
"description": "The required set of inputs to validate a VNET",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1452,7 +949,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1480,7 +977,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -1499,47 +996,6 @@
"x-ms-client-flatten": true
}
}
- },
- "WorkerPool": {
- "description": "Worker pool of an App Service Environment.",
- "type": "object",
- "properties": {
- "workerSizeId": {
- "format": "int32",
- "description": "Worker size ID for referencing this worker pool.",
- "type": "integer"
- },
- "computeMode": {
- "description": "Shared or dedicated app hosting.",
- "enum": [
- "Shared",
- "Dedicated",
- "Dynamic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ComputeModeOptions",
- "modelAsString": false
- }
- },
- "workerSize": {
- "description": "VM size of the worker pool instances.",
- "type": "string"
- },
- "workerCount": {
- "format": "int32",
- "description": "Number of instances in the worker pool.",
- "type": "integer"
- },
- "instanceNames": {
- "description": "Names of all instances in the worker pool (read only).",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- }
- }
}
},
"parameters": {
diff --git a/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json
index 41b689fdaabc..cbff303ec52d 100644
--- a/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json
+++ b/specification/web/resource-manager/Microsoft.Web/2016-08-01/WebApps.json
@@ -35,7 +35,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -73,7 +73,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -112,7 +112,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
"404": {
@@ -144,7 +144,7 @@
"description": "A JSON representation of the app properties. See example.",
"required": true,
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
{
@@ -182,13 +182,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
}
},
@@ -311,13 +311,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
}
}
@@ -1309,7 +1309,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/User"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/User"
}
}
},
@@ -1341,7 +1341,7 @@
"description": "Push settings associated with web app.",
"required": true,
"schema": {
- "$ref": "#/definitions/PushSettings"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/PushSettings"
}
},
{
@@ -1355,7 +1355,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/PushSettings"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/PushSettings"
}
}
}
@@ -1391,7 +1391,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/PushSettings"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/PushSettings"
}
}
}
@@ -3047,7 +3047,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -3090,7 +3090,7 @@
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
},
{
@@ -3104,7 +3104,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -3195,7 +3195,7 @@
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
},
{
@@ -3209,7 +3209,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -3259,7 +3259,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnectionKey"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnectionKey"
}
}
}
@@ -3295,7 +3295,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -4240,7 +4240,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -4292,7 +4292,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -4393,7 +4393,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/Operation"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Operation"
}
}
},
@@ -5481,7 +5481,7 @@
"description": "Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
"required": true,
"schema": {
- "$ref": "#/definitions/SnapshotRecoveryRequest"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SnapshotRecoveryRequest"
}
},
{
@@ -5787,7 +5787,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -5833,7 +5833,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
"404": {
@@ -5865,7 +5865,7 @@
"description": "A JSON representation of the app properties. See example.",
"required": true,
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
{
@@ -5910,13 +5910,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
}
},
@@ -6053,13 +6053,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
},
"202": {
"description": "Asynchronous operation in progress.",
"schema": {
- "$ref": "#/definitions/Site"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Site"
}
}
}
@@ -7219,7 +7219,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/User"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/User"
}
}
},
@@ -7251,7 +7251,7 @@
"description": "Push settings associated with web app.",
"required": true,
"schema": {
- "$ref": "#/definitions/PushSettings"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/PushSettings"
}
},
{
@@ -7272,7 +7272,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/PushSettings"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/PushSettings"
}
}
}
@@ -7315,7 +7315,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/PushSettings"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/PushSettings"
}
}
}
@@ -9151,7 +9151,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -9194,7 +9194,7 @@
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
},
{
@@ -9215,7 +9215,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -9313,7 +9313,7 @@
"description": "The details of the hybrid connection.",
"required": true,
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
},
{
@@ -9334,7 +9334,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -9391,7 +9391,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnectionKey"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnectionKey"
}
}
}
@@ -9434,7 +9434,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -10519,7 +10519,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -10578,7 +10578,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -11836,7 +11836,7 @@
"description": "Snapshot data used for web app recovery. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
"required": true,
"schema": {
- "$ref": "#/definitions/SnapshotRecoveryRequest"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SnapshotRecoveryRequest"
}
},
{
@@ -13032,7 +13032,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/CsmUsageQuotaCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
}
}
},
@@ -13080,7 +13080,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -13131,7 +13131,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -13167,7 +13167,7 @@
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
},
{
@@ -13188,7 +13188,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -13272,7 +13272,7 @@
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
},
{
@@ -13293,7 +13293,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -13350,7 +13350,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
"404": {
@@ -13396,7 +13396,7 @@
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
{
@@ -13417,7 +13417,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
}
}
@@ -13460,7 +13460,7 @@
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
{
@@ -13481,7 +13481,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
}
}
@@ -14328,7 +14328,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/CsmUsageQuotaCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
}
}
},
@@ -14369,7 +14369,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -14413,7 +14413,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -14449,7 +14449,7 @@
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
},
{
@@ -14463,7 +14463,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -14540,7 +14540,7 @@
"description": "Properties of the Virtual Network connection. See example.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
},
{
@@ -14554,7 +14554,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -14604,7 +14604,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
"404": {
@@ -14650,7 +14650,7 @@
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
{
@@ -14664,7 +14664,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
}
}
@@ -14707,7 +14707,7 @@
"description": "The properties to update this gateway with.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
{
@@ -14721,7 +14721,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
}
}
@@ -14811,16 +14811,6 @@
}
},
"definitions": {
- "ApiDefinitionInfo": {
- "description": "Information about the formal API definition for the app.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL of the API definition.",
- "type": "string"
- }
- }
- },
"ApplicationLogsConfig": {
"description": "Application logs configuration.",
"type": "object",
@@ -14839,87 +14829,6 @@
}
}
},
- "AutoHealActions": {
- "description": "Actions which to take by the auto-heal module when a rule is triggered.",
- "type": "object",
- "properties": {
- "actionType": {
- "description": "Predefined action to be taken.",
- "enum": [
- "Recycle",
- "LogEvent",
- "CustomAction"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AutoHealActionType",
- "modelAsString": false
- }
- },
- "customAction": {
- "$ref": "#/definitions/AutoHealCustomAction",
- "description": "Custom action to be taken."
- },
- "minProcessExecutionTime": {
- "description": "Minimum time the process must execute\nbefore taking the action",
- "type": "string"
- }
- }
- },
- "AutoHealCustomAction": {
- "description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
- "type": "object",
- "properties": {
- "exe": {
- "description": "Executable to be run.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the executable.",
- "type": "string"
- }
- }
- },
- "AutoHealRules": {
- "description": "Rules that can be defined for auto-heal.",
- "type": "object",
- "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": {
- "description": "Triggers for auto-heal.",
- "type": "object",
- "properties": {
- "requests": {
- "$ref": "#/definitions/RequestsBasedTrigger",
- "description": "A rule based on total requests."
- },
- "privateBytesInKB": {
- "format": "int32",
- "description": "A rule based on private bytes.",
- "type": "integer"
- },
- "statusCodes": {
- "description": "A rule based on status codes.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StatusCodesBasedTrigger"
- }
- },
- "slowRequests": {
- "$ref": "#/definitions/SlowRequestsBasedTrigger",
- "description": "A rule based on request execution time."
- }
- }
- },
"AzureBlobStorageApplicationLogsConfig": {
"description": "Application logs azure blob storage configuration.",
"type": "object",
@@ -15002,7 +14911,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15135,7 +15044,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15242,99 +15151,6 @@
}
}
},
- "CloningInfo": {
- "description": "Information needed for cloning operation.",
- "required": [
- "sourceWebAppId"
- ],
- "type": "object",
- "properties": {
- "correlationId": {
- "format": "uuid",
- "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- },
- "overwrite": {
- "description": "true to overwrite destination app; otherwise, false.",
- "type": "boolean"
- },
- "cloneCustomHostNames": {
- "description": "true to clone custom hostnames from source app; otherwise, false.",
- "type": "boolean"
- },
- "cloneSourceControl": {
- "description": "true to clone source control from source app; otherwise, false.",
- "type": "boolean"
- },
- "sourceWebAppId": {
- "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.",
- "type": "string"
- },
- "hostingEnvironment": {
- "description": "App Service Environment.",
- "type": "string"
- },
- "appSettingsOverrides": {
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "configureLoadBalancing": {
- "description": "true to configure load balancing for source and destination app.",
- "type": "boolean"
- },
- "trafficManagerProfileId": {
- "description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
- "type": "string"
- },
- "trafficManagerProfileName": {
- "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
- "type": "string"
- },
- "ignoreQuotas": {
- "description": "true if quotas should be ignored; otherwise, false.",
- "type": "boolean"
- }
- }
- },
- "ConnStringInfo": {
- "description": "Database connection string information.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of connection string.",
- "type": "string"
- },
- "connectionString": {
- "description": "Connection string value.",
- "type": "string"
- },
- "type": {
- "description": "Type of database.",
- "enum": [
- "MySql",
- "SQLServer",
- "SQLAzure",
- "Custom",
- "NotificationHub",
- "ServiceBus",
- "EventHub",
- "ApiHub",
- "DocDb",
- "RedisCache",
- "PostgreSQL"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ConnectionStringType",
- "modelAsString": false
- }
- }
- }
- },
"ConnStringValueTypePair": {
"description": "Database connection string value to type pair.",
"required": [
@@ -15375,7 +15191,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15394,7 +15210,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15493,19 +15309,6 @@
}
}
},
- "CorsSettings": {
- "description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
- "type": "object",
- "properties": {
- "allowedOrigins": {
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
"CsmPublishingProfileOptions": {
"description": "Publishing options for requested profile.",
"type": "object",
@@ -15543,61 +15346,12 @@
}
}
},
- "CsmUsageQuota": {
- "description": "Usage of the quota resource.",
- "type": "object",
- "properties": {
- "unit": {
- "description": "Units of measurement for the quota resourse.",
- "type": "string"
- },
- "nextResetTime": {
- "format": "date-time",
- "description": "Next reset time for the resource counter.",
- "type": "string"
- },
- "currentValue": {
- "format": "int64",
- "description": "The current value of the resource counter.",
- "type": "integer"
- },
- "limit": {
- "format": "int64",
- "description": "The resource limit.",
- "type": "integer"
- },
- "name": {
- "$ref": "#/definitions/LocalizableString",
- "description": "Quota name."
- }
- }
- },
- "CsmUsageQuotaCollection": {
- "description": "Collection of CSM usage quotas.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CsmUsageQuota"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
"CustomHostnameAnalysisResult": {
"description": "Custom domain analysis.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15624,7 +15378,7 @@
}
},
"customDomainVerificationFailureInfo": {
- "$ref": "#/definitions/ErrorEntity",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ErrorEntity",
"description": "Raw failure information if DNS verification fails.",
"readOnly": true
},
@@ -15722,7 +15476,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15815,55 +15569,6 @@
}
}
},
- "ErrorEntity": {
- "description": "Body of the error response returned from the API.",
- "type": "object",
- "properties": {
- "extendedCode": {
- "description": "Type of error.",
- "type": "string"
- },
- "messageTemplate": {
- "description": "Message template.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the template.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "innerErrors": {
- "description": "Inner errors.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ErrorEntity"
- }
- },
- "code": {
- "description": "Basic error code.",
- "type": "string"
- },
- "message": {
- "description": "Any details of the error.",
- "type": "string"
- }
- }
- },
- "Experiments": {
- "description": "Routing rules in production experiments.",
- "type": "object",
- "properties": {
- "rampUpRules": {
- "description": "List of ramp-up rules.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/RampUpRule"
- }
- }
- }
- },
"FileSystemApplicationLogsConfig": {
"description": "Application logs to file system configuration.",
"type": "object",
@@ -15913,7 +15618,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -15995,7 +15700,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16015,30 +15720,12 @@
}
}
},
- "HandlerMapping": {
- "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.",
- "type": "object",
- "properties": {
- "extension": {
- "description": "Requests with this extension will be handled using the specified FastCGI application.",
- "type": "string"
- },
- "scriptProcessor": {
- "description": "The absolute path to the FastCGI application.",
- "type": "string"
- },
- "arguments": {
- "description": "Command-line arguments to be passed to the script processor.",
- "type": "string"
- }
- }
- },
"HostNameBinding": {
"description": "A hostname binding object.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16172,73 +15859,6 @@
}
}
},
- "HostNameSslState": {
- "description": "SSL-enabled hostname.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Hostname.",
- "type": "string"
- },
- "sslState": {
- "description": "SSL type.",
- "enum": [
- "Disabled",
- "SniEnabled",
- "IpBasedEnabled"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SslState",
- "modelAsString": false
- }
- },
- "virtualIP": {
- "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
- "type": "string"
- },
- "thumbprint": {
- "description": "SSL certificate thumbprint.",
- "type": "string"
- },
- "toUpdate": {
- "description": "Set to true to update existing hostname.",
- "type": "boolean"
- },
- "hostType": {
- "description": "Indicates whether the hostname is a standard or repository hostname.",
- "enum": [
- "Standard",
- "Repository"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "HostType",
- "modelAsString": false
- }
- }
- }
- },
- "HostingEnvironmentProfile": {
- "description": "Specification for an App Service Environment to use for this resource.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource ID of the App Service Environment.",
- "type": "string"
- },
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the App Service Environment.",
- "type": "string",
- "readOnly": true
- }
- }
- },
"HttpLogsConfig": {
"description": "Http logs configuration.",
"type": "object",
@@ -16253,105 +15873,20 @@
}
}
},
- "HybridConnection": {
- "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
+ "Identifier": {
+ "description": "Identifier.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "description": "HybridConnection resource specific properties",
+ "description": "Identifier resource specific properties",
"properties": {
- "serviceBusNamespace": {
- "description": "The name of the Service Bus namespace.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "relayName": {
- "description": "The name of the Service Bus relay.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "relayArmUri": {
- "description": "The ARM URI to the Service Bus relay.",
- "type": "string"
- },
- "hostname": {
- "description": "The hostname of the endpoint.",
- "type": "string"
- },
- "port": {
- "format": "int32",
- "description": "The port of the endpoint.",
- "type": "integer"
- },
- "sendKeyName": {
- "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
- "type": "string"
- },
- "sendKeyValue": {
- "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.",
- "type": "string"
- },
- "serviceBusSuffix": {
- "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "HybridConnectionKey": {
- "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "HybridConnectionKey resource specific properties",
- "properties": {
- "sendKeyName": {
- "description": "The name of the send key.",
- "type": "string",
- "readOnly": true
- },
- "sendKeyValue": {
- "description": "The value of the send key.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "Identifier": {
- "description": "Identifier.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "Identifier resource specific properties",
- "properties": {
- "id": {
- "description": "String representation of the identity.",
+ "id": {
+ "description": "String representation of the identity.",
"type": "string"
}
},
@@ -16379,43 +15914,12 @@
}
}
},
- "IpSecurityRestriction": {
- "description": "IP security restriction on an app.",
- "required": [
- "ipAddress"
- ],
- "type": "object",
- "properties": {
- "ipAddress": {
- "description": "IP address the security restriction is valid for.",
- "type": "string"
- },
- "subnetMask": {
- "description": "Subnet mask for the range of IP addresses the restriction is valid for.",
- "type": "string"
- }
- }
- },
- "LocalizableString": {
- "description": "Localizable string object containing the name and a localized value.",
- "type": "object",
- "properties": {
- "value": {
- "description": "Non-localized name.",
- "type": "string"
- },
- "localizedValue": {
- "description": "Localized name.",
- "type": "string"
- }
- }
- },
"MSDeploy": {
"description": "MSDeploy ARM PUT information",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16477,7 +15981,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16533,7 +16037,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16583,38 +16087,12 @@
}
}
},
- "ManagedServiceIdentity": {
- "description": "Managed service identity.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of managed service identity.",
- "enum": [
- "SystemAssigned"
- ],
- "x-ms-enum": {
- "name": "ManagedServiceIdentityType",
- "modelAsString": true
- }
- },
- "tenantId": {
- "description": "Tenant of managed service identity.",
- "type": "string",
- "readOnly": true
- },
- "principalId": {
- "description": "Principal Id of managed service identity.",
- "type": "string",
- "readOnly": true
- }
- }
- },
"MigrateMySqlRequest": {
"description": "MySQL migration request.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16651,7 +16129,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16689,26 +16167,12 @@
}
}
},
- "NameValuePair": {
- "description": "Name value pair.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Pair name.",
- "type": "string"
- },
- "value": {
- "description": "Pair value.",
- "type": "string"
- }
- }
- },
"NetworkFeatures": {
"description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -16721,7 +16185,7 @@
"readOnly": true
},
"virtualNetworkConnection": {
- "$ref": "#/definitions/VnetInfo",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo",
"description": "The Virtual Network summary view.",
"readOnly": true
},
@@ -16737,7 +16201,7 @@
"description": "The Hybrid Connection V2 (Service Bus) view.",
"type": "array",
"items": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
},
"readOnly": true
}
@@ -16746,63 +16210,6 @@
}
}
},
- "Operation": {
- "description": "Operation.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Operation ID.",
- "type": "string"
- },
- "name": {
- "description": "Operation name.",
- "type": "string"
- },
- "status": {
- "description": "The current status of the operation.",
- "enum": [
- "InProgress",
- "Failed",
- "Succeeded",
- "TimedOut",
- "Created"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "OperationStatus",
- "modelAsString": false
- }
- },
- "errors": {
- "description": "Any errors associate with the operation.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ErrorEntity"
- }
- },
- "createdTime": {
- "format": "date-time",
- "description": "Time when operation has started.",
- "type": "string"
- },
- "modifiedTime": {
- "format": "date-time",
- "description": "Time when operation has been updated.",
- "type": "string"
- },
- "expirationTime": {
- "format": "date-time",
- "description": "Time when operation will expire.",
- "type": "string"
- },
- "geoMasterOperationId": {
- "format": "uuid",
- "description": "Applicable only for stamp operation ids.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- }
- }
- },
"PerfMonCounterCollection": {
"description": "Collection of performance monitor counters.",
"required": [
@@ -16902,7 +16309,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
],
"properties": {
@@ -16955,7 +16362,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -17171,7 +16578,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -17253,7 +16660,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -17341,37 +16748,12 @@
}
}
},
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
"PublicCertificate": {
"description": "Public certificate object",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -17426,35 +16808,38 @@
}
}
},
- "PushSettings": {
- "description": "Push settings for the App.",
+ "RelayServiceConnectionEntity": {
+ "description": "Hybrid Connection for an App Service app.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "description": "PushSettings resource specific properties",
- "required": [
- "isPushEnabled"
- ],
+ "description": "RelayServiceConnectionEntity resource specific properties",
"properties": {
- "isPushEnabled": {
- "description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
- "type": "boolean"
+ "entityName": {
+ "type": "string"
+ },
+ "entityConnectionString": {
+ "type": "string"
+ },
+ "resourceType": {
+ "type": "string"
},
- "tagWhitelistJson": {
- "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
+ "resourceConnectionString": {
"type": "string"
},
- "tagsRequiringAuth": {
- "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.",
+ "hostname": {
"type": "string"
},
- "dynamicTagsJson": {
- "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.",
+ "port": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "biztalkUri": {
"type": "string"
}
},
@@ -17462,81 +16847,80 @@
}
}
},
- "RampUpRule": {
- "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
- "type": "object",
- "properties": {
- "actionHostName": {
- "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
- "type": "string"
- },
- "reroutePercentage": {
- "format": "double",
- "description": "Percentage of the traffic which will be redirected to ActionHostName.",
- "type": "number"
- },
- "changeStep": {
- "format": "double",
- "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
- "type": "number"
- },
- "changeIntervalInMinutes": {
- "format": "int32",
- "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.",
- "type": "integer"
- },
- "minReroutePercentage": {
- "format": "double",
- "description": "Specifies lower boundary above which ReroutePercentage will stay.",
- "type": "number"
- },
- "maxReroutePercentage": {
- "format": "double",
- "description": "Specifies upper boundary below which ReroutePercentage will stay.",
- "type": "number"
- },
- "changeDecisionCallbackUrl": {
- "description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
- "type": "string"
- },
- "name": {
- "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.",
- "type": "string"
- }
- }
- },
- "RelayServiceConnectionEntity": {
- "description": "Hybrid Connection for an App Service app.",
+ "RestoreRequest": {
+ "description": "Description of a restore request.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "description": "RelayServiceConnectionEntity resource specific properties",
+ "description": "RestoreRequest resource specific properties",
+ "required": [
+ "storageAccountUrl",
+ "overwrite"
+ ],
"properties": {
- "entityName": {
+ "storageAccountUrl": {
+ "description": "SAS URL to the container.",
"type": "string"
},
- "entityConnectionString": {
+ "blobName": {
+ "description": "Name of a blob which contains the backup.",
"type": "string"
},
- "resourceType": {
- "type": "string"
+ "overwrite": {
+ "description": "true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.",
+ "type": "boolean"
},
- "resourceConnectionString": {
+ "siteName": {
+ "description": "Name of an app.",
"type": "string"
},
- "hostname": {
+ "databases": {
+ "description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatabaseBackupSetting"
+ }
+ },
+ "ignoreConflictingHostNames": {
+ "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,
+ "type": "boolean"
+ },
+ "ignoreDatabases": {
+ "description": "Ignore the databases and only restore the site content",
+ "default": false,
+ "type": "boolean"
+ },
+ "appServicePlan": {
+ "description": "Specify app service plan that will own restored site.",
"type": "string"
},
- "port": {
- "format": "int32",
- "type": "integer"
+ "operationType": {
+ "description": "Operation type.",
+ "default": "Default",
+ "enum": [
+ "Default",
+ "Clone",
+ "Relocation",
+ "Snapshot"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "BackupRestoreOperationType",
+ "modelAsString": false
+ }
},
- "biztalkUri": {
+ "adjustConnectionStrings": {
+ "description": "true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.",
+ "type": "boolean"
+ },
+ "hostingEnvironment": {
+ "description": "App Service Environment name, if needed (only when restoring an app to an App Service Environment).",
"type": "string"
}
},
@@ -17544,627 +16928,25 @@
}
}
},
- "RequestsBasedTrigger": {
- "description": "Trigger based on total requests.",
+ "RestoreResponse": {
+ "description": "Response for an app restore request.",
"type": "object",
- "properties": {
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
- },
- "ResourceMetric": {
- "description": "Object representing a metric for any resource .",
- "type": "object",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Metric unit.",
- "type": "string",
- "readOnly": true
- },
- "timeGrain": {
- "description": "Metric granularity. E.g PT1H, PT5M, P1D",
- "type": "string",
- "readOnly": true
- },
- "startTime": {
- "format": "date-time",
- "description": "Metric start time.",
- "type": "string",
- "readOnly": true
- },
- "endTime": {
- "format": "date-time",
- "description": "Metric end time.",
- "type": "string",
- "readOnly": true
- },
- "resourceId": {
- "description": "Metric resource Id.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "metricValues": {
- "description": "Metric values.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricValue"
- },
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
- },
- "ResourceMetricAvailability": {
- "description": "Metrics availability and retention.",
- "type": "object",
- "properties": {
- "timeGrain": {
- "description": "Time grain .",
- "type": "string",
- "readOnly": true
- },
- "retention": {
- "description": "Retention period for the current time grain.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ResourceMetricCollection": {
- "description": "Collection of metric responses.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetric"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetricDefinition": {
- "description": "Metadata for the metrics.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "ResourceMetricDefinition resource specific properties",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of the metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Unit of the metric.",
- "type": "string",
- "readOnly": true
- },
- "primaryAggregationType": {
- "description": "Primary aggregation type.",
- "type": "string",
- "readOnly": true
- },
- "metricAvailabilities": {
- "description": "List of time grains supported for the metric together with retention period.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricAvailability"
- },
- "readOnly": true
- },
- "resourceUri": {
- "description": "Resource URI.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource ID.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "ResourceMetricDefinitionCollection": {
- "description": "Collection of metric definitions.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricDefinition"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetricName": {
- "description": "Name of a metric for any resource .",
- "type": "object",
- "properties": {
- "value": {
- "description": "metric name value.",
- "type": "string",
- "readOnly": true
- },
- "localizedValue": {
- "description": "Localized metric name value.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ResourceMetricProperty": {
- "description": "Resource metric property.",
- "type": "object",
- "properties": {
- "key": {
- "description": "Key for resource metric property.",
- "type": "string"
- },
- "value": {
- "description": "Value of pair.",
- "type": "string"
- }
- }
- },
- "ResourceMetricValue": {
- "description": "Value of resource metric.",
- "type": "object",
- "properties": {
- "timestamp": {
- "description": "Value timestamp.",
- "type": "string",
- "readOnly": true
- },
- "average": {
- "format": "float",
- "description": "Value average.",
- "type": "number",
- "readOnly": true
- },
- "minimum": {
- "format": "float",
- "description": "Value minimum.",
- "type": "number",
- "readOnly": true
- },
- "maximum": {
- "format": "float",
- "description": "Value maximum.",
- "type": "number",
- "readOnly": true
- },
- "total": {
- "format": "float",
- "description": "Value total.",
- "type": "number",
- "readOnly": true
- },
- "count": {
- "format": "float",
- "description": "Value count.",
- "type": "number",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
- },
- "RestoreRequest": {
- "description": "Description of a restore request.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "RestoreRequest resource specific properties",
- "required": [
- "storageAccountUrl",
- "overwrite"
- ],
- "properties": {
- "storageAccountUrl": {
- "description": "SAS URL to the container.",
- "type": "string"
- },
- "blobName": {
- "description": "Name of a blob which contains the backup.",
- "type": "string"
- },
- "overwrite": {
- "description": "true if the restore operation can overwrite target app; otherwise, false. true is needed if trying to restore over an existing app.",
- "type": "boolean"
- },
- "siteName": {
- "description": "Name of an app.",
- "type": "string"
- },
- "databases": {
- "description": "Collection of databases which should be restored. This list has to match the list of databases included in the backup.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/DatabaseBackupSetting"
- }
- },
- "ignoreConflictingHostNames": {
- "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,
- "type": "boolean"
- },
- "ignoreDatabases": {
- "description": "Ignore the databases and only restore the site content",
- "default": false,
- "type": "boolean"
- },
- "appServicePlan": {
- "description": "Specify app service plan that will own restored site.",
- "type": "string"
- },
- "operationType": {
- "description": "Operation type.",
- "default": "Default",
- "enum": [
- "Default",
- "Clone",
- "Relocation",
- "Snapshot"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "BackupRestoreOperationType",
- "modelAsString": false
- }
- },
- "adjustConnectionStrings": {
- "description": "true if SiteConfig.ConnectionStrings should be set in new app; otherwise, false.",
- "type": "boolean"
- },
- "hostingEnvironment": {
- "description": "App Service Environment name, if needed (only when restoring an app to an App Service Environment).",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "RestoreResponse": {
- "description": "Response for an app restore request.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "RestoreResponse resource specific properties",
- "properties": {
- "operationId": {
- "description": "When server starts the restore process, it will return an operation ID identifying that particular restore operation.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "Site": {
- "description": "A web app, a mobile app backend, or an API app.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "description": "Site resource specific properties",
- "properties": {
- "state": {
- "description": "Current state of the app.",
- "type": "string",
- "readOnly": true
- },
- "hostNames": {
- "description": "Hostnames associated with the app.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "repositorySiteName": {
- "description": "Name of the repository site.",
- "type": "string",
- "readOnly": true
- },
- "usageState": {
- "description": "State indicating whether the app has exceeded its quota usage. Read-only.",
- "enum": [
- "Normal",
- "Exceeded"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "UsageState",
- "modelAsString": false
- }
- },
- "enabled": {
- "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
- "type": "boolean"
- },
- "enabledHostNames": {
- "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "availabilityState": {
- "description": "Management information availability state for the app.",
- "enum": [
- "Normal",
- "Limited",
- "DisasterRecoveryMode"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "SiteAvailabilityState",
- "modelAsString": false
- }
- },
- "hostNameSslStates": {
- "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HostNameSslState"
- }
- },
- "serverFarmId": {
- "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
- "type": "string"
- },
- "reserved": {
- "description": "true if reserved; otherwise, false.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "lastModifiedTimeUtc": {
- "format": "date-time",
- "description": "Last time the app was modified, in UTC. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "siteConfig": {
- "$ref": "#/definitions/SiteConfig",
- "description": "Configuration of the app."
- },
- "trafficManagerHostNames": {
- "description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "scmSiteAlsoStopped": {
- "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
- "default": false,
- "type": "boolean"
- },
- "targetSwapSlot": {
- "description": "Specifies which deployment slot this app will swap into. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "App Service Environment to use for the app.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "clientAffinityEnabled": {
- "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.",
- "type": "boolean"
- },
- "clientCertEnabled": {
- "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
- "type": "boolean"
- },
- "hostNamesDisabled": {
- "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
- "type": "boolean"
- },
- "outboundIpAddresses": {
- "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.",
- "type": "string",
- "readOnly": true
- },
- "possibleOutboundIpAddresses": {
- "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "containerSize": {
- "format": "int32",
- "description": "Size of the function container.",
- "type": "integer"
- },
- "dailyMemoryTimeQuota": {
- "format": "int32",
- "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
- "type": "integer"
- },
- "suspendedTill": {
- "format": "date-time",
- "description": "App suspended till in case memory-time quota is exceeded.",
- "type": "string",
- "readOnly": true
- },
- "maxNumberOfWorkers": {
- "format": "int32",
- "description": "Maximum number of workers.\nThis only applies to Functions container.",
- "type": "integer",
- "readOnly": true
- },
- "cloningInfo": {
- "$ref": "#/definitions/CloningInfo",
- "description": "If specified during app creation, the app is cloned from a source app.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "snapshotInfo": {
- "$ref": "#/definitions/SnapshotRecoveryRequest",
- "description": "If specified during app creation, the app is created from a previous snapshot.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "resourceGroup": {
- "description": "Name of the resource group the app belongs to. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "isDefaultContainer": {
- "description": "true if the app is a default container; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "defaultHostName": {
- "description": "Default hostname of the app. Read-only.",
+ "allOf": [
+ {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "RestoreResponse resource specific properties",
+ "properties": {
+ "operationId": {
+ "description": "When server starts the restore process, it will return an operation ID identifying that particular restore operation.",
"type": "string",
"readOnly": true
- },
- "slotSwapStatus": {
- "$ref": "#/definitions/SlotSwapStatus",
- "description": "Status of the last deployment slot swap operation.",
- "readOnly": true
- },
- "httpsOnly": {
- "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
- "type": "boolean"
}
},
"x-ms-client-flatten": true
- },
- "identity": {
- "$ref": "#/definitions/ManagedServiceIdentity"
}
}
},
@@ -18173,7 +16955,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -18369,261 +17151,17 @@
}
}
},
- "SiteConfig": {
- "description": "Configuration of an App Service app.",
- "type": "object",
- "properties": {
- "numberOfWorkers": {
- "format": "int32",
- "description": "Number of workers.",
- "type": "integer"
- },
- "defaultDocuments": {
- "description": "Default documents.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "netFrameworkVersion": {
- "description": ".NET Framework version.",
- "default": "v4.6",
- "type": "string"
- },
- "phpVersion": {
- "description": "Version of PHP.",
- "type": "string"
- },
- "pythonVersion": {
- "description": "Version of Python.",
- "type": "string"
- },
- "nodeVersion": {
- "description": "Version of Node.js.",
- "type": "string"
- },
- "linuxFxVersion": {
- "description": "Linux App Framework and version",
- "type": "string"
- },
- "requestTracingEnabled": {
- "description": "true if request tracing is enabled; otherwise, false.",
- "type": "boolean"
- },
- "requestTracingExpirationTime": {
- "format": "date-time",
- "description": "Request tracing expiration time.",
- "type": "string"
- },
- "remoteDebuggingEnabled": {
- "description": "true if remote debugging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "remoteDebuggingVersion": {
- "description": "Remote debugging version.",
- "type": "string"
- },
- "httpLoggingEnabled": {
- "description": "true if HTTP logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "logsDirectorySizeLimit": {
- "format": "int32",
- "description": "HTTP logs directory size limit.",
- "type": "integer"
- },
- "detailedErrorLoggingEnabled": {
- "description": "true if detailed error logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "publishingUsername": {
- "description": "Publishing user name.",
- "type": "string"
- },
- "appSettings": {
- "description": "Application settings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "connectionStrings": {
- "description": "Connection strings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ConnStringInfo"
- }
- },
- "machineKey": {
- "$ref": "#/definitions/SiteMachineKey",
- "description": "Site MachineKey.",
- "readOnly": true
- },
- "handlerMappings": {
- "description": "Handler mappings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HandlerMapping"
- }
- },
- "documentRoot": {
- "description": "Document root.",
- "type": "string"
- },
- "scmType": {
- "description": "SCM type.",
- "enum": [
- "None",
- "Dropbox",
- "Tfs",
- "LocalGit",
- "GitHub",
- "CodePlexGit",
- "CodePlexHg",
- "BitbucketGit",
- "BitbucketHg",
- "ExternalGit",
- "ExternalHg",
- "OneDrive",
- "VSO"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ScmType",
- "modelAsString": true
- }
- },
- "use32BitWorkerProcess": {
- "description": "true to use 32-bit worker process; otherwise, false.",
- "type": "boolean"
- },
- "webSocketsEnabled": {
- "description": "true if WebSocket is enabled; otherwise, false.",
- "type": "boolean"
- },
- "alwaysOn": {
- "description": "true if Always On is enabled; otherwise, false.",
- "type": "boolean"
- },
- "javaVersion": {
- "description": "Java version.",
- "type": "string"
- },
- "javaContainer": {
- "description": "Java container.",
- "type": "string"
- },
- "javaContainerVersion": {
- "description": "Java container version.",
- "type": "string"
- },
- "appCommandLine": {
- "description": "App command line to launch.",
- "type": "string"
- },
- "managedPipelineMode": {
- "description": "Managed pipeline mode.",
- "enum": [
- "Integrated",
- "Classic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ManagedPipelineMode",
- "modelAsString": false
- }
- },
- "virtualApplications": {
- "description": "Virtual applications.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualApplication"
- }
- },
- "loadBalancing": {
- "description": "Site load balancing.",
- "enum": [
- "WeightedRoundRobin",
- "LeastRequests",
- "LeastResponseTime",
- "WeightedTotalTraffic",
- "RequestHash"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SiteLoadBalancing",
- "modelAsString": false
- }
- },
- "experiments": {
- "$ref": "#/definitions/Experiments",
- "description": "This is work around for polymophic types."
- },
- "limits": {
- "$ref": "#/definitions/SiteLimits",
- "description": "Site limits."
- },
- "autoHealEnabled": {
- "description": "true if Auto Heal is enabled; otherwise, false.",
- "type": "boolean"
- },
- "autoHealRules": {
- "$ref": "#/definitions/AutoHealRules",
- "description": "Auto Heal rules."
- },
- "tracingOptions": {
- "description": "Tracing options.",
- "type": "string"
- },
- "vnetName": {
- "description": "Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "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."
- },
- "autoSwapSlotName": {
- "description": "Auto-swap slot name.",
- "type": "string"
- },
- "localMySqlEnabled": {
- "description": "true to enable local MySQL; otherwise, false.",
- "default": false,
- "type": "boolean"
- },
- "ipSecurityRestrictions": {
- "description": "IP security restrictions.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/IpSecurityRestriction"
- }
- }
- }
- },
"SiteConfigResource": {
"description": "Web app configuration ARM resource.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/SiteConfig",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SiteConfig",
"description": "Core resource properties",
"x-ms-client-flatten": true
}
@@ -18654,7 +17192,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -18703,7 +17241,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -18834,7 +17372,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -18851,33 +17389,12 @@
}
}
},
- "SiteLimits": {
- "description": "Metric limits set on an app.",
- "type": "object",
- "properties": {
- "maxPercentageCpu": {
- "format": "double",
- "description": "Maximum allowed CPU usage percentage.",
- "type": "number"
- },
- "maxMemoryInMb": {
- "format": "int64",
- "description": "Maximum allowed memory usage in MB.",
- "type": "integer"
- },
- "maxDiskSizeInMb": {
- "format": "int64",
- "description": "Maximum allowed disk size usage in MB.",
- "type": "integer"
- }
- }
- },
"SiteLogsConfig": {
"description": "Configuration of App Service site logs.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -18905,34 +17422,12 @@
}
}
},
- "SiteMachineKey": {
- "description": "MachineKey of an app.",
- "type": "object",
- "properties": {
- "validation": {
- "description": "MachineKey validation.",
- "type": "string"
- },
- "validationKey": {
- "description": "Validation key.",
- "type": "string"
- },
- "decryption": {
- "description": "Decryption.",
- "type": "string"
- },
- "decryptionKey": {
- "description": "Decryption key.",
- "type": "string"
- }
- }
- },
"SitePatchResource": {
"description": "ARM resource for a site.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19000,7 +17495,7 @@
"description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
"type": "array",
"items": {
- "$ref": "#/definitions/HostNameSslState"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HostNameSslState"
}
},
"serverFarmId": {
@@ -19023,7 +17518,7 @@
"readOnly": true
},
"siteConfig": {
- "$ref": "#/definitions/SiteConfig",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SiteConfig",
"description": "Configuration of the app."
},
"trafficManagerHostNames": {
@@ -19045,7 +17540,7 @@
"readOnly": true
},
"hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HostingEnvironmentProfile",
"description": "App Service Environment to use for the app.",
"x-ms-mutability": [
"create",
@@ -19097,14 +17592,14 @@
"readOnly": true
},
"cloningInfo": {
- "$ref": "#/definitions/CloningInfo",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/CloningInfo",
"description": "If specified during app creation, the app is cloned from a source app.",
"x-ms-mutability": [
"create"
]
},
"snapshotInfo": {
- "$ref": "#/definitions/SnapshotRecoveryRequest",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SnapshotRecoveryRequest",
"description": "If specified during app creation, the app is created from a previous snapshot.",
"x-ms-mutability": [
"create"
@@ -19126,7 +17621,7 @@
"readOnly": true
},
"slotSwapStatus": {
- "$ref": "#/definitions/SlotSwapStatus",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SlotSwapStatus",
"description": "Status of the last deployment slot swap operation.",
"readOnly": true
},
@@ -19144,7 +17639,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19177,7 +17672,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19254,7 +17749,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19270,7 +17765,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19337,53 +17832,12 @@
}
}
},
- "SlotSwapStatus": {
- "description": "The status of the last successfull slot swap operation.",
- "type": "object",
- "properties": {
- "timestampUtc": {
- "format": "date-time",
- "description": "The time the last successful slot swap completed.",
- "type": "string",
- "readOnly": true
- },
- "sourceSlotName": {
- "description": "The source slot of the last swap operation.",
- "type": "string",
- "readOnly": true
- },
- "destinationSlotName": {
- "description": "The destination slot of the last swap operation.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "SlowRequestsBasedTrigger": {
- "description": "Trigger based on request execution time.",
- "type": "object",
- "properties": {
- "timeTaken": {
- "description": "Time taken.",
- "type": "string"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
"Snapshot": {
"description": "A snapshot of an app.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19420,96 +17874,12 @@
}
}
},
- "SnapshotRecoveryRequest": {
- "description": "Details about app recovery operation.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "SnapshotRecoveryRequest resource specific properties",
- "required": [
- "overwrite"
- ],
- "properties": {
- "snapshotTime": {
- "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string.",
- "type": "string"
- },
- "recoveryTarget": {
- "$ref": "#/definitions/SnapshotRecoveryTarget",
- "description": "Specifies the web app that snapshot contents will be written to."
- },
- "overwrite": {
- "description": "If true the recovery operation can overwrite source app; otherwise, false.",
- "type": "boolean"
- },
- "recoverConfiguration": {
- "description": "If true, site configuration, in addition to content, will be reverted.",
- "type": "boolean"
- },
- "ignoreConflictingHostNames": {
- "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.",
- "type": "boolean"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "SnapshotRecoveryTarget": {
- "description": "Specifies the web app that snapshot contents will be written to.",
- "type": "object",
- "properties": {
- "location": {
- "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS",
- "type": "string"
- },
- "id": {
- "description": "ARM resource ID of the target 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.",
- "type": "string"
- }
- }
- },
- "StatusCodesBasedTrigger": {
- "description": "Trigger based on status code.",
- "type": "object",
- "properties": {
- "status": {
- "format": "int32",
- "description": "HTTP status code.",
- "type": "integer"
- },
- "subStatus": {
- "format": "int32",
- "description": "SubStatus.",
- "type": "integer"
- },
- "win32Status": {
- "format": "int32",
- "description": "Win32 error code.",
- "type": "integer"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
"StorageMigrationOptions": {
"description": "Options for app content migration.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19560,7 +17930,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19582,7 +17952,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19601,7 +17971,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19645,7 +18015,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19722,7 +18092,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -19810,240 +18180,6 @@
}
}
},
- "User": {
- "description": "User crendentials used for publishing activity.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "User resource specific properties",
- "required": [
- "publishingUserName"
- ],
- "properties": {
- "name": {
- "description": "Username",
- "type": "string",
- "x-ms-client-name": "UserName"
- },
- "publishingUserName": {
- "description": "Username used for publishing.",
- "type": "string"
- },
- "publishingPassword": {
- "format": "password",
- "description": "Password used for publishing.",
- "type": "string"
- },
- "publishingPasswordHash": {
- "format": "password",
- "description": "Password hash used for publishing.",
- "type": "string"
- },
- "publishingPasswordHashSalt": {
- "format": "password",
- "description": "Password hash salt used for publishing.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "VirtualApplication": {
- "description": "Virtual application in an app.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Virtual path.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- },
- "preloadEnabled": {
- "description": "true if preloading is enabled; otherwise, false.",
- "type": "boolean"
- },
- "virtualDirectories": {
- "description": "Virtual directories for virtual application.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualDirectory"
- }
- }
- }
- },
- "VirtualDirectory": {
- "description": "Directory for virtual application.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Path to virtual application.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- }
- }
- },
- "VnetGateway": {
- "description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetGateway resource specific properties",
- "required": [
- "vpnPackageUri"
- ],
- "properties": {
- "vnetName": {
- "description": "The Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "vpnPackageUri": {
- "description": "The URI where the VPN package can be downloaded.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ]
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "VnetInfo": {
- "description": "Virtual Network information contract.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetInfo resource specific properties",
- "properties": {
- "vnetResourceId": {
- "description": "The Virtual Network's resource ID.",
- "type": "string"
- },
- "certThumbprint": {
- "description": "The client certificate thumbprint.",
- "type": "string",
- "readOnly": true
- },
- "certBlob": {
- "format": "byte",
- "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
- "type": "string"
- },
- "routes": {
- "description": "The routes that this Virtual Network connection uses.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VnetRoute"
- },
- "readOnly": true
- },
- "resyncRequired": {
- "description": "true if a resync is required; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "dnsServers": {
- "description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "VnetRoute": {
- "description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetRoute resource specific properties",
- "properties": {
- "name": {
- "description": "The name of this route. This is only returned by the server and does not need to be set by the client.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ],
- "x-ms-client-name": "vnetRouteName"
- },
- "startAddress": {
- "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
- "type": "string"
- },
- "endAddress": {
- "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
- "type": "string"
- },
- "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.",
- "enum": [
- "DEFAULT",
- "INHERITED",
- "STATIC"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "RouteType",
- "modelAsString": true
- }
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "WebAppCollection": {
- "description": "Collection of App Service apps.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Site"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
"WebAppInstanceCollection": {
"description": "Collection of app instances.",
"required": [
@@ -20069,7 +18205,7 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
diff --git a/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServiceEnvironments.json b/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServiceEnvironments.json
index 4e0383acf992..0d736c7c474f 100644
--- a/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServiceEnvironments.json
+++ b/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServiceEnvironments.json
@@ -515,7 +515,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -753,7 +753,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -805,7 +805,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -844,7 +844,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -914,7 +914,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -1033,7 +1033,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/Operation"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Operation"
}
}
}
@@ -1112,13 +1112,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -1158,7 +1158,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/AppServicePlanCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlanCollection"
}
}
},
@@ -1203,7 +1203,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -1242,13 +1242,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -1295,7 +1295,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/CsmUsageQuotaCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
}
}
},
@@ -1561,7 +1561,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -1627,7 +1627,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -1673,7 +1673,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -1732,7 +1732,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -1858,244 +1858,7 @@
"description": "Additional virtual IPs.",
"type": "array",
"items": {
- "$ref": "#/definitions/VirtualIPMapping"
- }
- }
- }
- },
- "ApiDefinitionInfo": {
- "description": "Information about the formal API definition for the app.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL of the API definition.",
- "type": "string"
- }
- }
- },
- "AppServiceEnvironment": {
- "description": "Description of an App Service Environment.",
- "required": [
- "name",
- "location",
- "virtualNetwork",
- "workerPools"
- ],
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string"
- },
- "location": {
- "description": "Location of the App Service Environment, e.g. \"West US\".",
- "type": "string"
- },
- "provisioningState": {
- "description": "Provisioning state of the App Service Environment.",
- "enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": false
- }
- },
- "status": {
- "description": "Current status of the App Service Environment.",
- "enum": [
- "Preparing",
- "Ready",
- "Scaling",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "HostingEnvironmentStatus",
- "modelAsString": false
- }
- },
- "vnetName": {
- "description": "Name of the Virtual Network for the App Service Environment.",
- "type": "string"
- },
- "vnetResourceGroupName": {
- "description": "Resource group of the Virtual Network.",
- "type": "string"
- },
- "vnetSubnetName": {
- "description": "Subnet of the Virtual Network.",
- "type": "string"
- },
- "virtualNetwork": {
- "$ref": "#/definitions/VirtualNetworkProfile",
- "description": "Description of the Virtual Network."
- },
- "internalLoadBalancingMode": {
- "description": "Specifies which endpoints to serve internally in the Virtual Network for the App Service Environment.",
- "enum": [
- "None",
- "Web",
- "Publishing"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "InternalLoadBalancingMode",
- "modelAsString": false
- }
- },
- "multiSize": {
- "description": "Front-end VM size, e.g. \"Medium\", \"Large\".",
- "type": "string"
- },
- "multiRoleCount": {
- "format": "int32",
- "description": "Number of front-end instances.",
- "type": "integer"
- },
- "workerPools": {
- "description": "Description of worker pools with worker size IDs, VM sizes, and number of workers in each pool.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/WorkerPool"
- }
- },
- "ipsslAddressCount": {
- "format": "int32",
- "description": "Number of IP SSL addresses reserved for the App Service Environment.",
- "type": "integer"
- },
- "databaseEdition": {
- "description": "Edition of the metadata database for the App Service Environment, e.g. \"Standard\".",
- "type": "string",
- "readOnly": true
- },
- "databaseServiceObjective": {
- "description": "Service objective of the metadata database for the App Service Environment, e.g. \"S0\".",
- "type": "string",
- "readOnly": true
- },
- "upgradeDomains": {
- "format": "int32",
- "description": "Number of upgrade domains of the App Service Environment.",
- "type": "integer",
- "readOnly": true
- },
- "subscriptionId": {
- "description": "Subscription of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "dnsSuffix": {
- "description": "DNS suffix of the App Service Environment.",
- "type": "string"
- },
- "lastAction": {
- "description": "Last deployment action on the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "lastActionResult": {
- "description": "Result of the last deployment action on the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "allowedMultiSizes": {
- "description": "List of comma separated strings describing which VM sizes are allowed for front-ends.",
- "type": "string",
- "readOnly": true
- },
- "allowedWorkerSizes": {
- "description": "List of comma separated strings describing which VM sizes are allowed for workers.",
- "type": "string",
- "readOnly": true
- },
- "maximumNumberOfMachines": {
- "format": "int32",
- "description": "Maximum number of VMs in the App Service Environment.",
- "type": "integer",
- "readOnly": true
- },
- "vipMappings": {
- "description": "Description of IP SSL mapping for the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualIPMapping"
- },
- "readOnly": true
- },
- "environmentCapacities": {
- "description": "Current total, used, and available worker capacities.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StampCapacity"
- },
- "readOnly": true
- },
- "networkAccessControlList": {
- "description": "Access control list for controlling traffic to the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NetworkAccessControlEntry"
- }
- },
- "environmentIsHealthy": {
- "description": "True/false indicating whether the App Service Environment is healthy.",
- "type": "boolean",
- "readOnly": true
- },
- "environmentStatus": {
- "description": "Detailed message about with results of the last check of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "resourceGroup": {
- "description": "Resource group of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "frontEndScaleFactor": {
- "format": "int32",
- "description": "Scale factor for front-ends.",
- "type": "integer"
- },
- "defaultFrontEndScaleFactor": {
- "format": "int32",
- "description": "Default Scale Factor for FrontEnds.",
- "type": "integer",
- "readOnly": true
- },
- "apiManagementAccountId": {
- "description": "API Management Account associated with the App Service Environment.",
- "type": "string"
- },
- "suspended": {
- "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).",
- "type": "boolean"
- },
- "dynamicCacheEnabled": {
- "description": "True/false indicating whether the App Service Environment is suspended. The environment can be suspended e.g. when the management endpoint is no longer available\n(most likely because NSG blocked the incoming traffic).",
- "type": "boolean"
- },
- "clusterSettings": {
- "description": "Custom settings for changing the behavior of the App Service Environment.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "userWhitelistedIpRanges": {
- "description": "User added ip ranges to whitelist on ASE db",
- "type": "array",
- "items": {
- "type": "string"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VirtualIPMapping"
}
}
}
@@ -2105,2008 +1868,160 @@
"required": [
"value"
],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/AppServiceEnvironmentResource"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "AppServiceEnvironmentPatchResource": {
- "description": "ARM resource for a app service enviroment.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "$ref": "#/definitions/AppServiceEnvironment",
- "description": "Core resource properties",
- "x-ms-client-flatten": true
- }
- }
- },
- "AppServiceEnvironmentResource": {
- "description": "App Service Environment ARM resource.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "$ref": "#/definitions/AppServiceEnvironment",
- "description": "Core resource properties",
- "x-ms-client-flatten": true
- }
- }
- },
- "AppServicePlan": {
- "description": "App Service plan.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "description": "AppServicePlan resource specific properties",
- "required": [
- "name"
- ],
- "properties": {
- "name": {
- "description": "Name for the App Service plan.",
- "type": "string"
- },
- "workerTierName": {
- "description": "Target worker tier assigned to the App Service plan.",
- "type": "string"
- },
- "status": {
- "description": "App Service plan status.",
- "enum": [
- "Ready",
- "Pending",
- "Creating"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "StatusOptions",
- "modelAsString": false
- }
- },
- "subscription": {
- "description": "App Service plan subscription.",
- "type": "string",
- "readOnly": true
- },
- "adminSiteName": {
- "description": "App Service plan administration site.",
- "type": "string"
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "Specification for the App Service Environment to use for the App Service plan.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "maximumNumberOfWorkers": {
- "format": "int32",
- "description": "Maximum number of instances that can be assigned to this App Service plan.",
- "type": "integer",
- "readOnly": true
- },
- "geoRegion": {
- "description": "Geographical location for the App Service plan.",
- "type": "string",
- "readOnly": true
- },
- "perSiteScaling": {
- "description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.",
- "default": false,
- "type": "boolean"
- },
- "numberOfSites": {
- "format": "int32",
- "description": "Number of apps assigned to this App Service plan.",
- "type": "integer",
- "readOnly": true
- },
- "isSpot": {
- "description": "If true, this App Service Plan owns spot instances.",
- "type": "boolean"
- },
- "spotExpirationTime": {
- "format": "date-time",
- "description": "The time when the server farm expires. Valid only if it is a spot server farm.",
- "type": "string"
- },
- "resourceGroup": {
- "description": "Resource group of the App Service plan.",
- "type": "string",
- "readOnly": true
- },
- "reserved": {
- "description": "Reserved.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "targetWorkerCount": {
- "format": "int32",
- "description": "Scaling worker count.",
- "type": "integer"
- },
- "targetWorkerSizeId": {
- "format": "int32",
- "description": "Scaling worker size ID.",
- "type": "integer"
- },
- "provisioningState": {
- "description": "Provisioning state of the App Service Environment.",
- "enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": false
- }
- }
- },
- "x-ms-client-flatten": true
- },
- "sku": {
- "$ref": "#/definitions/SkuDescription"
- }
- }
- },
- "AppServicePlanCollection": {
- "description": "Collection of App Service plans.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/AppServicePlan"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "AutoHealActions": {
- "description": "Actions which to take by the auto-heal module when a rule is triggered.",
- "type": "object",
- "properties": {
- "actionType": {
- "description": "Predefined action to be taken.",
- "enum": [
- "Recycle",
- "LogEvent",
- "CustomAction"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AutoHealActionType",
- "modelAsString": false
- }
- },
- "customAction": {
- "$ref": "#/definitions/AutoHealCustomAction",
- "description": "Custom action to be taken."
- },
- "minProcessExecutionTime": {
- "description": "Minimum time the process must execute\nbefore taking the action",
- "type": "string"
- }
- }
- },
- "AutoHealCustomAction": {
- "description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
- "type": "object",
- "properties": {
- "exe": {
- "description": "Executable to be run.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the executable.",
- "type": "string"
- }
- }
- },
- "AutoHealRules": {
- "description": "Rules that can be defined for auto-heal.",
- "type": "object",
- "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": {
- "description": "Triggers for auto-heal.",
- "type": "object",
- "properties": {
- "requests": {
- "$ref": "#/definitions/RequestsBasedTrigger",
- "description": "A rule based on total requests."
- },
- "privateBytesInKB": {
- "format": "int32",
- "description": "A rule based on private bytes.",
- "type": "integer"
- },
- "statusCodes": {
- "description": "A rule based on status codes.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StatusCodesBasedTrigger"
- }
- },
- "slowRequests": {
- "$ref": "#/definitions/SlowRequestsBasedTrigger",
- "description": "A rule based on request execution time."
- }
- }
- },
- "Capability": {
- "description": "Describes the capabilities/features allowed for a specific SKU.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the SKU capability.",
- "type": "string"
- },
- "value": {
- "description": "Value of the SKU capability.",
- "type": "string"
- },
- "reason": {
- "description": "Reason of the SKU capability.",
- "type": "string"
- }
- }
- },
- "CloningInfo": {
- "description": "Information needed for cloning operation.",
- "required": [
- "sourceWebAppId"
- ],
- "type": "object",
- "properties": {
- "correlationId": {
- "format": "uuid",
- "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- },
- "overwrite": {
- "description": "true to overwrite destination app; otherwise, false.",
- "type": "boolean"
- },
- "cloneCustomHostNames": {
- "description": "true to clone custom hostnames from source app; otherwise, false.",
- "type": "boolean"
- },
- "cloneSourceControl": {
- "description": "true to clone source control from source app; otherwise, false.",
- "type": "boolean"
- },
- "sourceWebAppId": {
- "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.",
- "type": "string"
- },
- "hostingEnvironment": {
- "description": "App Service Environment.",
- "type": "string"
- },
- "appSettingsOverrides": {
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "configureLoadBalancing": {
- "description": "true to configure load balancing for source and destination app.",
- "type": "boolean"
- },
- "trafficManagerProfileId": {
- "description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
- "type": "string"
- },
- "trafficManagerProfileName": {
- "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
- "type": "string"
- },
- "ignoreQuotas": {
- "description": "true if quotas should be ignored; otherwise, false.",
- "type": "boolean"
- }
- }
- },
- "ConnStringInfo": {
- "description": "Database connection string information.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of connection string.",
- "type": "string"
- },
- "connectionString": {
- "description": "Connection string value.",
- "type": "string"
- },
- "type": {
- "description": "Type of database.",
- "enum": [
- "MySql",
- "SQLServer",
- "SQLAzure",
- "Custom",
- "NotificationHub",
- "ServiceBus",
- "EventHub",
- "ApiHub",
- "DocDb",
- "RedisCache",
- "PostgreSQL"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ConnectionStringType",
- "modelAsString": false
- }
- }
- }
- },
- "CorsSettings": {
- "description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
- "type": "object",
- "properties": {
- "allowedOrigins": {
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CsmUsageQuota": {
- "description": "Usage of the quota resource.",
- "type": "object",
- "properties": {
- "unit": {
- "description": "Units of measurement for the quota resourse.",
- "type": "string"
- },
- "nextResetTime": {
- "format": "date-time",
- "description": "Next reset time for the resource counter.",
- "type": "string"
- },
- "currentValue": {
- "format": "int64",
- "description": "The current value of the resource counter.",
- "type": "integer"
- },
- "limit": {
- "format": "int64",
- "description": "The resource limit.",
- "type": "integer"
- },
- "name": {
- "$ref": "#/definitions/LocalizableString",
- "description": "Quota name."
- }
- }
- },
- "CsmUsageQuotaCollection": {
- "description": "Collection of CSM usage quotas.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/CsmUsageQuota"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ErrorEntity": {
- "description": "Body of the error response returned from the API.",
- "type": "object",
- "properties": {
- "extendedCode": {
- "description": "Type of error.",
- "type": "string"
- },
- "messageTemplate": {
- "description": "Message template.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the template.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "innerErrors": {
- "description": "Inner errors.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ErrorEntity"
- }
- },
- "code": {
- "description": "Basic error code.",
- "type": "string"
- },
- "message": {
- "description": "Any details of the error.",
- "type": "string"
- }
- }
- },
- "Experiments": {
- "description": "Routing rules in production experiments.",
- "type": "object",
- "properties": {
- "rampUpRules": {
- "description": "List of ramp-up rules.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/RampUpRule"
- }
- }
- }
- },
- "HandlerMapping": {
- "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.",
- "type": "object",
- "properties": {
- "extension": {
- "description": "Requests with this extension will be handled using the specified FastCGI application.",
- "type": "string"
- },
- "scriptProcessor": {
- "description": "The absolute path to the FastCGI application.",
- "type": "string"
- },
- "arguments": {
- "description": "Command-line arguments to be passed to the script processor.",
- "type": "string"
- }
- }
- },
- "HostNameSslState": {
- "description": "SSL-enabled hostname.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Hostname.",
- "type": "string"
- },
- "sslState": {
- "description": "SSL type.",
- "enum": [
- "Disabled",
- "SniEnabled",
- "IpBasedEnabled"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SslState",
- "modelAsString": false
- }
- },
- "virtualIP": {
- "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
- "type": "string"
- },
- "thumbprint": {
- "description": "SSL certificate thumbprint.",
- "type": "string"
- },
- "toUpdate": {
- "description": "Set to true to update existing hostname.",
- "type": "boolean"
- },
- "hostType": {
- "description": "Indicates whether the hostname is a standard or repository hostname.",
- "enum": [
- "Standard",
- "Repository"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "HostType",
- "modelAsString": false
- }
- }
- }
- },
- "HostingEnvironmentDiagnostics": {
- "description": "Diagnostics for an App Service Environment.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name/identifier of the diagnostics.",
- "type": "string"
- },
- "diagnosicsOutput": {
- "description": "Diagnostics output.",
- "type": "string"
- }
- }
- },
- "HostingEnvironmentProfile": {
- "description": "Specification for an App Service Environment to use for this resource.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource ID of the App Service Environment.",
- "type": "string"
- },
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the App Service Environment.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "IpSecurityRestriction": {
- "description": "IP security restriction on an app.",
- "required": [
- "ipAddress"
- ],
- "type": "object",
- "properties": {
- "ipAddress": {
- "description": "IP address the security restriction is valid for.",
- "type": "string"
- },
- "subnetMask": {
- "description": "Subnet mask for the range of IP addresses the restriction is valid for.",
- "type": "string"
- }
- }
- },
- "LocalizableString": {
- "description": "Localizable string object containing the name and a localized value.",
- "type": "object",
- "properties": {
- "value": {
- "description": "Non-localized name.",
- "type": "string"
- },
- "localizedValue": {
- "description": "Localized name.",
- "type": "string"
- }
- }
- },
- "ManagedServiceIdentity": {
- "description": "Managed service identity.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of managed service identity.",
- "enum": [
- "SystemAssigned"
- ],
- "x-ms-enum": {
- "name": "ManagedServiceIdentityType",
- "modelAsString": true
- }
- },
- "tenantId": {
- "description": "Tenant of managed service identity.",
- "type": "string",
- "readOnly": true
- },
- "principalId": {
- "description": "Principal Id of managed service identity.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "MetricAvailabilily": {
- "description": "Metric availability and retention.",
- "type": "object",
- "properties": {
- "timeGrain": {
- "description": "Time grain.",
- "type": "string"
- },
- "retention": {
- "description": "Retention period for the current time grain.",
- "type": "string"
- }
- }
- },
- "MetricDefinition": {
- "description": "Metadata for a metric.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "MetricDefinition resource specific properties",
- "properties": {
- "name": {
- "description": "Name of the metric.",
- "type": "string",
- "readOnly": true
- },
- "unit": {
- "description": "Unit of the metric.",
- "type": "string",
- "readOnly": true
- },
- "primaryAggregationType": {
- "description": "Primary aggregation type.",
- "type": "string",
- "readOnly": true
- },
- "metricAvailabilities": {
- "description": "List of time grains supported for the metric together with retention period.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/MetricAvailabilily"
- },
- "readOnly": true
- },
- "displayName": {
- "description": "Friendly name shown in the UI.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "NameValuePair": {
- "description": "Name value pair.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Pair name.",
- "type": "string"
- },
- "value": {
- "description": "Pair value.",
- "type": "string"
- }
- }
- },
- "NetworkAccessControlEntry": {
- "description": "Network access control entry.",
- "type": "object",
- "properties": {
- "action": {
- "description": "Action object.",
- "enum": [
- "Permit",
- "Deny"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AccessControlEntryAction",
- "modelAsString": false
- }
- },
- "description": {
- "description": "Description.",
- "type": "string"
- },
- "order": {
- "format": "int32",
- "description": "Order of precedence.",
- "type": "integer"
- },
- "remoteSubnet": {
- "description": "Remote subnet.",
- "type": "string"
- }
- }
- },
- "Operation": {
- "description": "Operation.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Operation ID.",
- "type": "string"
- },
- "name": {
- "description": "Operation name.",
- "type": "string"
- },
- "status": {
- "description": "The current status of the operation.",
- "enum": [
- "InProgress",
- "Failed",
- "Succeeded",
- "TimedOut",
- "Created"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "OperationStatus",
- "modelAsString": false
- }
- },
- "errors": {
- "description": "Any errors associate with the operation.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ErrorEntity"
- }
- },
- "createdTime": {
- "format": "date-time",
- "description": "Time when operation has started.",
- "type": "string"
- },
- "modifiedTime": {
- "format": "date-time",
- "description": "Time when operation has been updated.",
- "type": "string"
- },
- "expirationTime": {
- "format": "date-time",
- "description": "Time when operation will expire.",
- "type": "string"
- },
- "geoMasterOperationId": {
- "format": "uuid",
- "description": "Applicable only for stamp operation ids.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- }
- }
- },
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
- "PushSettings": {
- "description": "Push settings for the App.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "PushSettings resource specific properties",
- "required": [
- "isPushEnabled"
- ],
- "properties": {
- "isPushEnabled": {
- "description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
- "type": "boolean"
- },
- "tagWhitelistJson": {
- "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
- "type": "string"
- },
- "tagsRequiringAuth": {
- "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.",
- "type": "string"
- },
- "dynamicTagsJson": {
- "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.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "RampUpRule": {
- "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
- "type": "object",
- "properties": {
- "actionHostName": {
- "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
- "type": "string"
- },
- "reroutePercentage": {
- "format": "double",
- "description": "Percentage of the traffic which will be redirected to ActionHostName.",
- "type": "number"
- },
- "changeStep": {
- "format": "double",
- "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
- "type": "number"
- },
- "changeIntervalInMinutes": {
- "format": "int32",
- "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.",
- "type": "integer"
- },
- "minReroutePercentage": {
- "format": "double",
- "description": "Specifies lower boundary above which ReroutePercentage will stay.",
- "type": "number"
- },
- "maxReroutePercentage": {
- "format": "double",
- "description": "Specifies upper boundary below which ReroutePercentage will stay.",
- "type": "number"
- },
- "changeDecisionCallbackUrl": {
- "description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
- "type": "string"
- },
- "name": {
- "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.",
- "type": "string"
- }
- }
- },
- "RequestsBasedTrigger": {
- "description": "Trigger based on total requests.",
- "type": "object",
- "properties": {
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
- },
- "ResourceMetric": {
- "description": "Object representing a metric for any resource .",
- "type": "object",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Metric unit.",
- "type": "string",
- "readOnly": true
- },
- "timeGrain": {
- "description": "Metric granularity. E.g PT1H, PT5M, P1D",
- "type": "string",
- "readOnly": true
- },
- "startTime": {
- "format": "date-time",
- "description": "Metric start time.",
- "type": "string",
- "readOnly": true
- },
- "endTime": {
- "format": "date-time",
- "description": "Metric end time.",
- "type": "string",
- "readOnly": true
- },
- "resourceId": {
- "description": "Metric resource Id.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "metricValues": {
- "description": "Metric values.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricValue"
- },
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
- },
- "ResourceMetricAvailability": {
- "description": "Metrics availability and retention.",
- "type": "object",
- "properties": {
- "timeGrain": {
- "description": "Time grain .",
- "type": "string",
- "readOnly": true
- },
- "retention": {
- "description": "Retention period for the current time grain.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ResourceMetricCollection": {
- "description": "Collection of metric responses.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetric"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetricDefinition": {
- "description": "Metadata for the metrics.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "ResourceMetricDefinition resource specific properties",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of the metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Unit of the metric.",
- "type": "string",
- "readOnly": true
- },
- "primaryAggregationType": {
- "description": "Primary aggregation type.",
- "type": "string",
- "readOnly": true
- },
- "metricAvailabilities": {
- "description": "List of time grains supported for the metric together with retention period.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricAvailability"
- },
- "readOnly": true
- },
- "resourceUri": {
- "description": "Resource URI.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource ID.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "ResourceMetricDefinitionCollection": {
- "description": "Collection of metric definitions.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricDefinition"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetricName": {
- "description": "Name of a metric for any resource .",
- "type": "object",
- "properties": {
- "value": {
- "description": "metric name value.",
- "type": "string",
- "readOnly": true
- },
- "localizedValue": {
- "description": "Localized metric name value.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ResourceMetricProperty": {
- "description": "Resource metric property.",
- "type": "object",
- "properties": {
- "key": {
- "description": "Key for resource metric property.",
- "type": "string"
- },
- "value": {
- "description": "Value of pair.",
- "type": "string"
- }
- }
- },
- "ResourceMetricValue": {
- "description": "Value of resource metric.",
- "type": "object",
- "properties": {
- "timestamp": {
- "description": "Value timestamp.",
- "type": "string",
- "readOnly": true
- },
- "average": {
- "format": "float",
- "description": "Value average.",
- "type": "number",
- "readOnly": true
- },
- "minimum": {
- "format": "float",
- "description": "Value minimum.",
- "type": "number",
- "readOnly": true
- },
- "maximum": {
- "format": "float",
- "description": "Value maximum.",
- "type": "number",
- "readOnly": true
- },
- "total": {
- "format": "float",
- "description": "Value total.",
- "type": "number",
- "readOnly": true
- },
- "count": {
- "format": "float",
- "description": "Value count.",
- "type": "number",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
- },
- "Site": {
- "description": "A web app, a mobile app backend, or an API app.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "description": "Site resource specific properties",
- "properties": {
- "state": {
- "description": "Current state of the app.",
- "type": "string",
- "readOnly": true
- },
- "hostNames": {
- "description": "Hostnames associated with the app.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "repositorySiteName": {
- "description": "Name of the repository site.",
- "type": "string",
- "readOnly": true
- },
- "usageState": {
- "description": "State indicating whether the app has exceeded its quota usage. Read-only.",
- "enum": [
- "Normal",
- "Exceeded"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "UsageState",
- "modelAsString": false
- }
- },
- "enabled": {
- "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
- "type": "boolean"
- },
- "enabledHostNames": {
- "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "availabilityState": {
- "description": "Management information availability state for the app.",
- "enum": [
- "Normal",
- "Limited",
- "DisasterRecoveryMode"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "SiteAvailabilityState",
- "modelAsString": false
- }
- },
- "hostNameSslStates": {
- "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HostNameSslState"
- }
- },
- "serverFarmId": {
- "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
- "type": "string"
- },
- "reserved": {
- "description": "true if reserved; otherwise, false.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "lastModifiedTimeUtc": {
- "format": "date-time",
- "description": "Last time the app was modified, in UTC. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "siteConfig": {
- "$ref": "#/definitions/SiteConfig",
- "description": "Configuration of the app."
- },
- "trafficManagerHostNames": {
- "description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "scmSiteAlsoStopped": {
- "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
- "default": false,
- "type": "boolean"
- },
- "targetSwapSlot": {
- "description": "Specifies which deployment slot this app will swap into. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "App Service Environment to use for the app.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "clientAffinityEnabled": {
- "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.",
- "type": "boolean"
- },
- "clientCertEnabled": {
- "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
- "type": "boolean"
- },
- "hostNamesDisabled": {
- "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
- "type": "boolean"
- },
- "outboundIpAddresses": {
- "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.",
- "type": "string",
- "readOnly": true
- },
- "possibleOutboundIpAddresses": {
- "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "containerSize": {
- "format": "int32",
- "description": "Size of the function container.",
- "type": "integer"
- },
- "dailyMemoryTimeQuota": {
- "format": "int32",
- "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
- "type": "integer"
- },
- "suspendedTill": {
- "format": "date-time",
- "description": "App suspended till in case memory-time quota is exceeded.",
- "type": "string",
- "readOnly": true
- },
- "maxNumberOfWorkers": {
- "format": "int32",
- "description": "Maximum number of workers.\nThis only applies to Functions container.",
- "type": "integer",
- "readOnly": true
- },
- "cloningInfo": {
- "$ref": "#/definitions/CloningInfo",
- "description": "If specified during app creation, the app is cloned from a source app.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "snapshotInfo": {
- "$ref": "#/definitions/SnapshotRecoveryRequest",
- "description": "If specified during app creation, the app is created from a previous snapshot.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "resourceGroup": {
- "description": "Name of the resource group the app belongs to. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "isDefaultContainer": {
- "description": "true if the app is a default container; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "defaultHostName": {
- "description": "Default hostname of the app. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "slotSwapStatus": {
- "$ref": "#/definitions/SlotSwapStatus",
- "description": "Status of the last deployment slot swap operation.",
- "readOnly": true
- },
- "httpsOnly": {
- "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
- "type": "boolean"
- }
- },
- "x-ms-client-flatten": true
- },
- "identity": {
- "$ref": "#/definitions/ManagedServiceIdentity"
- }
- }
- },
- "SiteConfig": {
- "description": "Configuration of an App Service app.",
- "type": "object",
- "properties": {
- "numberOfWorkers": {
- "format": "int32",
- "description": "Number of workers.",
- "type": "integer"
- },
- "defaultDocuments": {
- "description": "Default documents.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "netFrameworkVersion": {
- "description": ".NET Framework version.",
- "default": "v4.6",
- "type": "string"
- },
- "phpVersion": {
- "description": "Version of PHP.",
- "type": "string"
- },
- "pythonVersion": {
- "description": "Version of Python.",
- "type": "string"
- },
- "nodeVersion": {
- "description": "Version of Node.js.",
- "type": "string"
- },
- "linuxFxVersion": {
- "description": "Linux App Framework and version",
- "type": "string"
- },
- "requestTracingEnabled": {
- "description": "true if request tracing is enabled; otherwise, false.",
- "type": "boolean"
- },
- "requestTracingExpirationTime": {
- "format": "date-time",
- "description": "Request tracing expiration time.",
- "type": "string"
- },
- "remoteDebuggingEnabled": {
- "description": "true if remote debugging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "remoteDebuggingVersion": {
- "description": "Remote debugging version.",
- "type": "string"
- },
- "httpLoggingEnabled": {
- "description": "true if HTTP logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "logsDirectorySizeLimit": {
- "format": "int32",
- "description": "HTTP logs directory size limit.",
- "type": "integer"
- },
- "detailedErrorLoggingEnabled": {
- "description": "true if detailed error logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "publishingUsername": {
- "description": "Publishing user name.",
- "type": "string"
- },
- "appSettings": {
- "description": "Application settings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "connectionStrings": {
- "description": "Connection strings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ConnStringInfo"
- }
- },
- "machineKey": {
- "$ref": "#/definitions/SiteMachineKey",
- "description": "Site MachineKey.",
- "readOnly": true
- },
- "handlerMappings": {
- "description": "Handler mappings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HandlerMapping"
- }
- },
- "documentRoot": {
- "description": "Document root.",
- "type": "string"
- },
- "scmType": {
- "description": "SCM type.",
- "enum": [
- "None",
- "Dropbox",
- "Tfs",
- "LocalGit",
- "GitHub",
- "CodePlexGit",
- "CodePlexHg",
- "BitbucketGit",
- "BitbucketHg",
- "ExternalGit",
- "ExternalHg",
- "OneDrive",
- "VSO"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ScmType",
- "modelAsString": true
- }
- },
- "use32BitWorkerProcess": {
- "description": "true to use 32-bit worker process; otherwise, false.",
- "type": "boolean"
- },
- "webSocketsEnabled": {
- "description": "true if WebSocket is enabled; otherwise, false.",
- "type": "boolean"
- },
- "alwaysOn": {
- "description": "true if Always On is enabled; otherwise, false.",
- "type": "boolean"
- },
- "javaVersion": {
- "description": "Java version.",
- "type": "string"
- },
- "javaContainer": {
- "description": "Java container.",
- "type": "string"
- },
- "javaContainerVersion": {
- "description": "Java container version.",
- "type": "string"
- },
- "appCommandLine": {
- "description": "App command line to launch.",
- "type": "string"
- },
- "managedPipelineMode": {
- "description": "Managed pipeline mode.",
- "enum": [
- "Integrated",
- "Classic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ManagedPipelineMode",
- "modelAsString": false
- }
- },
- "virtualApplications": {
- "description": "Virtual applications.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualApplication"
- }
- },
- "loadBalancing": {
- "description": "Site load balancing.",
- "enum": [
- "WeightedRoundRobin",
- "LeastRequests",
- "LeastResponseTime",
- "WeightedTotalTraffic",
- "RequestHash"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SiteLoadBalancing",
- "modelAsString": false
- }
- },
- "experiments": {
- "$ref": "#/definitions/Experiments",
- "description": "This is work around for polymophic types."
- },
- "limits": {
- "$ref": "#/definitions/SiteLimits",
- "description": "Site limits."
- },
- "autoHealEnabled": {
- "description": "true if Auto Heal is enabled; otherwise, false.",
- "type": "boolean"
- },
- "autoHealRules": {
- "$ref": "#/definitions/AutoHealRules",
- "description": "Auto Heal rules."
- },
- "tracingOptions": {
- "description": "Tracing options.",
- "type": "string"
- },
- "vnetName": {
- "description": "Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "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."
- },
- "autoSwapSlotName": {
- "description": "Auto-swap slot name.",
- "type": "string"
- },
- "localMySqlEnabled": {
- "description": "true to enable local MySQL; otherwise, false.",
- "default": false,
- "type": "boolean"
- },
- "ipSecurityRestrictions": {
- "description": "IP security restrictions.",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
"type": "array",
"items": {
- "$ref": "#/definitions/IpSecurityRestriction"
+ "$ref": "#/definitions/AppServiceEnvironmentResource"
}
- }
- }
- },
- "SiteLimits": {
- "description": "Metric limits set on an app.",
- "type": "object",
- "properties": {
- "maxPercentageCpu": {
- "format": "double",
- "description": "Maximum allowed CPU usage percentage.",
- "type": "number"
- },
- "maxMemoryInMb": {
- "format": "int64",
- "description": "Maximum allowed memory usage in MB.",
- "type": "integer"
- },
- "maxDiskSizeInMb": {
- "format": "int64",
- "description": "Maximum allowed disk size usage in MB.",
- "type": "integer"
- }
- }
- },
- "SiteMachineKey": {
- "description": "MachineKey of an app.",
- "type": "object",
- "properties": {
- "validation": {
- "description": "MachineKey validation.",
- "type": "string"
- },
- "validationKey": {
- "description": "Validation key.",
- "type": "string"
},
- "decryption": {
- "description": "Decryption.",
- "type": "string"
- },
- "decryptionKey": {
- "description": "Decryption key.",
+ "nextLink": {
+ "description": "Link to next page of resources.",
"type": "string"
}
}
},
- "SkuCapacity": {
- "description": "Description of the App Service plan scale options.",
+ "AppServiceEnvironmentPatchResource": {
+ "description": "ARM resource for a app service enviroment.",
"type": "object",
- "properties": {
- "minimum": {
- "format": "int32",
- "description": "Minimum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "maximum": {
- "format": "int32",
- "description": "Maximum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "default": {
- "format": "int32",
- "description": "Default number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "scaleType": {
- "description": "Available scale configurations for an App Service plan.",
- "type": "string"
+ "allOf": [
+ {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
- }
- },
- "SkuDescription": {
- "description": "Description of a SKU for a scalable resource.",
- "type": "object",
+ ],
"properties": {
- "name": {
- "description": "Name of the resource SKU.",
- "type": "string"
- },
- "tier": {
- "description": "Service tier of the resource SKU.",
- "type": "string"
- },
- "size": {
- "description": "Size specifier of the resource SKU.",
- "type": "string"
- },
- "family": {
- "description": "Family code of the resource SKU.",
- "type": "string"
- },
- "capacity": {
- "format": "int32",
- "description": "Current number of instances assigned to the resource.",
- "type": "integer"
- },
- "skuCapacity": {
- "$ref": "#/definitions/SkuCapacity",
- "description": "Min, max, and default scale values of the SKU."
- },
- "locations": {
- "description": "Locations of the SKU.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "capabilities": {
- "description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Capability"
- }
+ "properties": {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServiceEnvironment",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
}
}
},
- "SkuInfo": {
- "description": "SKU discovery information.",
+ "AppServiceEnvironmentResource": {
+ "description": "App Service Environment ARM resource.",
"type": "object",
- "properties": {
- "resourceType": {
- "description": "Resource type that this SKU applies to.",
- "type": "string"
- },
- "sku": {
- "$ref": "#/definitions/SkuDescription",
- "description": "Name and tier of the SKU."
- },
- "capacity": {
- "$ref": "#/definitions/SkuCapacity",
- "description": "Min, max, and default scale values of the SKU."
+ "allOf": [
+ {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Resource"
}
- }
- },
- "SkuInfoCollection": {
- "description": "Collection of SKU information.",
- "required": [
- "value"
],
- "type": "object",
"properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/SkuInfo"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
+ "properties": {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServiceEnvironment",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
}
}
},
- "SlotSwapStatus": {
- "description": "The status of the last successfull slot swap operation.",
+ "HostingEnvironmentDiagnostics": {
+ "description": "Diagnostics for an App Service Environment.",
"type": "object",
"properties": {
- "timestampUtc": {
- "format": "date-time",
- "description": "The time the last successful slot swap completed.",
- "type": "string",
- "readOnly": true
- },
- "sourceSlotName": {
- "description": "The source slot of the last swap operation.",
- "type": "string",
- "readOnly": true
+ "name": {
+ "description": "Name/identifier of the diagnostics.",
+ "type": "string"
},
- "destinationSlotName": {
- "description": "The destination slot of the last swap operation.",
- "type": "string",
- "readOnly": true
+ "diagnosicsOutput": {
+ "description": "Diagnostics output.",
+ "type": "string"
}
}
},
- "SlowRequestsBasedTrigger": {
- "description": "Trigger based on request execution time.",
+ "MetricAvailabilily": {
+ "description": "Metric availability and retention.",
"type": "object",
"properties": {
- "timeTaken": {
- "description": "Time taken.",
+ "timeGrain": {
+ "description": "Time grain.",
"type": "string"
},
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
+ "retention": {
+ "description": "Retention period for the current time grain.",
"type": "string"
}
}
},
- "SnapshotRecoveryRequest": {
- "description": "Details about app recovery operation.",
+ "MetricDefinition": {
+ "description": "Metadata for a metric.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "description": "SnapshotRecoveryRequest resource specific properties",
- "required": [
- "overwrite"
- ],
+ "description": "MetricDefinition resource specific properties",
"properties": {
- "snapshotTime": {
- "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string.",
- "type": "string"
+ "name": {
+ "description": "Name of the metric.",
+ "type": "string",
+ "readOnly": true
},
- "recoveryTarget": {
- "$ref": "#/definitions/SnapshotRecoveryTarget",
- "description": "Specifies the web app that snapshot contents will be written to."
+ "unit": {
+ "description": "Unit of the metric.",
+ "type": "string",
+ "readOnly": true
},
- "overwrite": {
- "description": "If true the recovery operation can overwrite source app; otherwise, false.",
- "type": "boolean"
+ "primaryAggregationType": {
+ "description": "Primary aggregation type.",
+ "type": "string",
+ "readOnly": true
},
- "recoverConfiguration": {
- "description": "If true, site configuration, in addition to content, will be reverted.",
- "type": "boolean"
+ "metricAvailabilities": {
+ "description": "List of time grains supported for the metric together with retention period.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricAvailabilily"
+ },
+ "readOnly": true
},
- "ignoreConflictingHostNames": {
- "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.",
- "type": "boolean"
+ "displayName": {
+ "description": "Friendly name shown in the UI.",
+ "type": "string",
+ "readOnly": true
}
},
"x-ms-client-flatten": true
}
}
},
- "SnapshotRecoveryTarget": {
- "description": "Specifies the web app that snapshot contents will be written to.",
+ "SkuInfo": {
+ "description": "SKU discovery information.",
"type": "object",
"properties": {
- "location": {
- "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS",
+ "resourceType": {
+ "description": "Resource type that this SKU applies to.",
"type": "string"
},
- "id": {
- "description": "ARM resource ID of the target 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.",
- "type": "string"
+ "sku": {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SkuDescription",
+ "description": "Name and tier of the SKU."
+ },
+ "capacity": {
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SkuCapacity",
+ "description": "Min, max, and default scale values of the SKU."
}
}
},
- "StampCapacity": {
- "description": "Stamp capacity information.",
+ "SkuInfoCollection": {
+ "description": "Collection of SKU information.",
+ "required": [
+ "value"
+ ],
"type": "object",
"properties": {
- "name": {
- "description": "Name of the stamp.",
- "type": "string"
- },
- "availableCapacity": {
- "format": "int64",
- "description": "Available capacity (# of machines, bytes of storage etc...).",
- "type": "integer"
- },
- "totalCapacity": {
- "format": "int64",
- "description": "Total capacity (# of machines, bytes of storage etc...).",
- "type": "integer"
- },
- "unit": {
- "description": "Name of the unit.",
- "type": "string"
- },
- "computeMode": {
- "description": "Shared/dedicated workers.",
- "enum": [
- "Shared",
- "Dedicated",
- "Dynamic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ComputeModeOptions",
- "modelAsString": false
- }
- },
- "workerSize": {
- "description": "Size of the machines.",
- "enum": [
- "Default",
- "Small",
- "Medium",
- "Large",
- "D1",
- "D2",
- "D3"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "WorkerSizeOptions",
- "modelAsString": false
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SkuInfo"
}
},
- "workerSizeId": {
- "format": "int32",
- "description": "Size ID of machines: \n0 - Small\n1 - Medium\n2 - Large",
- "type": "integer"
- },
- "excludeFromCapacityAllocation": {
- "description": "If true, it includes basic apps.\nBasic apps are not used for capacity allocation.",
- "type": "boolean"
- },
- "isApplicableForAllComputeModes": {
- "description": "true if capacity is applicable for all apps; otherwise, false.",
- "type": "boolean"
- },
- "siteMode": {
- "description": "Shared or Dedicated.",
+ "nextLink": {
+ "description": "Link to next page of resources.",
"type": "string"
}
}
@@ -4122,7 +2037,7 @@
"description": "Collection of resources.",
"type": "array",
"items": {
- "$ref": "#/definitions/StampCapacity"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/StampCapacity"
}
},
"nextLink": {
@@ -4131,42 +2046,12 @@
}
}
},
- "StatusCodesBasedTrigger": {
- "description": "Trigger based on status code.",
- "type": "object",
- "properties": {
- "status": {
- "format": "int32",
- "description": "HTTP status code.",
- "type": "integer"
- },
- "subStatus": {
- "format": "int32",
- "description": "SubStatus.",
- "type": "integer"
- },
- "win32Status": {
- "format": "int32",
- "description": "Win32 error code.",
- "type": "integer"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
"Usage": {
"description": "Usage of the quota resource.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
@@ -4255,154 +2140,6 @@
}
}
},
- "VirtualApplication": {
- "description": "Virtual application in an app.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Virtual path.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- },
- "preloadEnabled": {
- "description": "true if preloading is enabled; otherwise, false.",
- "type": "boolean"
- },
- "virtualDirectories": {
- "description": "Virtual directories for virtual application.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualDirectory"
- }
- }
- }
- },
- "VirtualDirectory": {
- "description": "Directory for virtual application.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Path to virtual application.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- }
- }
- },
- "VirtualIPMapping": {
- "description": "Virtual IP mapping.",
- "type": "object",
- "properties": {
- "virtualIP": {
- "description": "Virtual IP address.",
- "type": "string"
- },
- "internalHttpPort": {
- "format": "int32",
- "description": "Internal HTTP port.",
- "type": "integer"
- },
- "internalHttpsPort": {
- "format": "int32",
- "description": "Internal HTTPS port.",
- "type": "integer"
- },
- "inUse": {
- "description": "Is virtual IP mapping in use.",
- "type": "boolean"
- }
- }
- },
- "VirtualNetworkProfile": {
- "description": "Specification for using a Virtual Network.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource id of the Virtual Network.",
- "type": "string"
- },
- "name": {
- "description": "Name of the Virtual Network (read-only).",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the Virtual Network (read-only).",
- "type": "string",
- "readOnly": true
- },
- "subnet": {
- "description": "Subnet within the Virtual Network.",
- "type": "string"
- }
- }
- },
- "WebAppCollection": {
- "description": "Collection of App Service apps.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Site"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "WorkerPool": {
- "description": "Worker pool of an App Service Environment.",
- "type": "object",
- "properties": {
- "workerSizeId": {
- "format": "int32",
- "description": "Worker size ID for referencing this worker pool.",
- "type": "integer"
- },
- "computeMode": {
- "description": "Shared or dedicated app hosting.",
- "enum": [
- "Shared",
- "Dedicated",
- "Dynamic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ComputeModeOptions",
- "modelAsString": false
- }
- },
- "workerSize": {
- "description": "VM size of the worker pool instances.",
- "type": "string"
- },
- "workerCount": {
- "format": "int32",
- "description": "Number of instances in the worker pool.",
- "type": "integer"
- },
- "instanceNames": {
- "description": "Names of all instances in the worker pool (read only).",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- }
- }
- },
"WorkerPoolCollection": {
"description": "Collection of worker pools.",
"required": [
@@ -4428,17 +2165,17 @@
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "$ref": "#/definitions/WorkerPool",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WorkerPool",
"description": "Core resource properties",
"x-ms-client-flatten": true
},
"sku": {
- "$ref": "#/definitions/SkuDescription"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/SkuDescription"
}
}
}
diff --git a/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServicePlans.json
index 82154e3834d2..58f2bfea9521 100644
--- a/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServicePlans.json
+++ b/specification/web/resource-manager/Microsoft.Web/2016-09-01/AppServicePlans.json
@@ -41,7 +41,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/AppServicePlanCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlanCollection"
}
}
},
@@ -73,7 +73,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/AppServicePlanCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlanCollection"
}
}
},
@@ -112,7 +112,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlan"
}
},
"404": {
@@ -144,7 +144,7 @@
"description": "Details of the App Service plan.",
"required": true,
"schema": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlan"
}
},
{
@@ -158,13 +158,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlan"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlan"
}
}
},
@@ -242,13 +242,13 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlan"
}
},
"202": {
"description": "Operation is in progress.",
"schema": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/AppServicePlan"
}
}
}
@@ -286,7 +286,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/Capability"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/Capability"
}
}
}
@@ -337,7 +337,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
}
}
@@ -435,7 +435,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/HybridConnectionKey"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnectionKey"
}
}
}
@@ -599,7 +599,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricDefinitionCollection"
}
}
},
@@ -651,7 +651,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/ResourceMetricCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ResourceMetricCollection"
}
}
},
@@ -748,7 +748,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/WebAppCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/WebAppCollection"
}
}
},
@@ -830,7 +830,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/CsmUsageQuotaCollection"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
}
}
},
@@ -871,7 +871,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
}
}
@@ -915,7 +915,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/VnetInfo"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetInfo"
}
},
"404": {
@@ -968,7 +968,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
}
}
@@ -1011,7 +1011,7 @@
"description": "Definition of the gateway.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
},
{
@@ -1025,7 +1025,7 @@
"200": {
"description": "OK",
"schema": {
- "$ref": "#/definitions/VnetGateway"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetGateway"
}
}
}
@@ -1070,7 +1070,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/VnetRoute"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetRoute"
}
}
}
@@ -1123,7 +1123,7 @@
"schema": {
"type": "array",
"items": {
- "$ref": "#/definitions/VnetRoute"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetRoute"
}
}
},
@@ -1170,7 +1170,7 @@
"description": "Definition of the Virtual Network route.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetRoute"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetRoute"
}
},
{
@@ -1184,7 +1184,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/VnetRoute"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetRoute"
}
},
"400": {
@@ -1281,7 +1281,7 @@
"description": "Definition of the Virtual Network route.",
"required": true,
"schema": {
- "$ref": "#/definitions/VnetRoute"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetRoute"
}
},
{
@@ -1295,7 +1295,7 @@
"200": {
"description": "OK.",
"schema": {
- "$ref": "#/definitions/VnetRoute"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/VnetRoute"
}
},
"400": {
@@ -1349,27 +1349,17 @@
}
},
"definitions": {
- "ApiDefinitionInfo": {
- "description": "Information about the formal API definition for the app.",
- "type": "object",
- "properties": {
- "url": {
- "description": "The URL of the API definition.",
- "type": "string"
- }
- }
- },
- "AppServicePlan": {
- "description": "App Service plan.",
+ "AppServicePlanPatchResource": {
+ "description": "ARM resource for a app service plan.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/Resource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "description": "AppServicePlan resource specific properties",
+ "description": "AppServicePlanPatchResource resource specific properties",
"required": [
"name"
],
@@ -1406,7 +1396,7 @@
"type": "string"
},
"hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HostingEnvironmentProfile",
"description": "Specification for the App Service Environment to use for the App Service plan.",
"x-ms-mutability": [
"create",
@@ -1486,14 +1476,11 @@
}
},
"x-ms-client-flatten": true
- },
- "sku": {
- "$ref": "#/definitions/SkuDescription"
}
}
},
- "AppServicePlanCollection": {
- "description": "Collection of App Service plans.",
+ "HybridConnectionCollection": {
+ "description": "Collection of hostname bindings.",
"required": [
"value"
],
@@ -1503,7 +1490,7 @@
"description": "Collection of resources.",
"type": "array",
"items": {
- "$ref": "#/definitions/AppServicePlan"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/HybridConnection"
}
},
"nextLink": {
@@ -1512,372 +1499,37 @@
}
}
},
- "AppServicePlanPatchResource": {
- "description": "ARM resource for a app service plan.",
+ "HybridConnectionLimits": {
+ "description": "Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.",
"type": "object",
"allOf": [
{
- "$ref": "#/definitions/ProxyOnlyResource"
+ "$ref": "../2016-03-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
}
],
"properties": {
"properties": {
- "description": "AppServicePlanPatchResource resource specific properties",
- "required": [
- "name"
- ],
+ "description": "HybridConnectionLimits resource specific properties",
"properties": {
- "name": {
- "description": "Name for the App Service plan.",
- "type": "string"
- },
- "workerTierName": {
- "description": "Target worker tier assigned to the App Service plan.",
- "type": "string"
- },
- "status": {
- "description": "App Service plan status.",
- "enum": [
- "Ready",
- "Pending",
- "Creating"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "StatusOptions",
- "modelAsString": false
- }
- },
- "subscription": {
- "description": "App Service plan subscription.",
- "type": "string",
- "readOnly": true
- },
- "adminSiteName": {
- "description": "App Service plan administration site.",
- "type": "string"
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "Specification for the App Service Environment to use for the App Service plan.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "maximumNumberOfWorkers": {
+ "current": {
"format": "int32",
- "description": "Maximum number of instances that can be assigned to this App Service plan.",
+ "description": "The current number of Hybrid Connections.",
"type": "integer",
"readOnly": true
},
- "geoRegion": {
- "description": "Geographical location for the App Service plan.",
- "type": "string",
- "readOnly": true
- },
- "perSiteScaling": {
- "description": "If true, apps assigned to this App Service plan can be scaled independently.\nIf false, apps assigned to this App Service plan will scale to all instances of the plan.",
- "default": false,
- "type": "boolean"
- },
- "numberOfSites": {
+ "maximum": {
"format": "int32",
- "description": "Number of apps assigned to this App Service plan.",
+ "description": "The maximum number of Hybrid Connections allowed.",
"type": "integer",
"readOnly": true
- },
- "isSpot": {
- "description": "If true, this App Service Plan owns spot instances.",
- "type": "boolean"
- },
- "spotExpirationTime": {
- "format": "date-time",
- "description": "The time when the server farm expires. Valid only if it is a spot server farm.",
- "type": "string"
- },
- "resourceGroup": {
- "description": "Resource group of the App Service plan.",
- "type": "string",
- "readOnly": true
- },
- "reserved": {
- "description": "Reserved.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "targetWorkerCount": {
- "format": "int32",
- "description": "Scaling worker count.",
- "type": "integer"
- },
- "targetWorkerSizeId": {
- "format": "int32",
- "description": "Scaling worker size ID.",
- "type": "integer"
- },
- "provisioningState": {
- "description": "Provisioning state of the App Service Environment.",
- "enum": [
- "Succeeded",
- "Failed",
- "Canceled",
- "InProgress",
- "Deleting"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "ProvisioningState",
- "modelAsString": false
- }
}
},
"x-ms-client-flatten": true
}
}
},
- "AutoHealActions": {
- "description": "Actions which to take by the auto-heal module when a rule is triggered.",
- "type": "object",
- "properties": {
- "actionType": {
- "description": "Predefined action to be taken.",
- "enum": [
- "Recycle",
- "LogEvent",
- "CustomAction"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "AutoHealActionType",
- "modelAsString": false
- }
- },
- "customAction": {
- "$ref": "#/definitions/AutoHealCustomAction",
- "description": "Custom action to be taken."
- },
- "minProcessExecutionTime": {
- "description": "Minimum time the process must execute\nbefore taking the action",
- "type": "string"
- }
- }
- },
- "AutoHealCustomAction": {
- "description": "Custom action to be executed\nwhen an auto heal rule is triggered.",
- "type": "object",
- "properties": {
- "exe": {
- "description": "Executable to be run.",
- "type": "string"
- },
- "parameters": {
- "description": "Parameters for the executable.",
- "type": "string"
- }
- }
- },
- "AutoHealRules": {
- "description": "Rules that can be defined for auto-heal.",
- "type": "object",
- "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": {
- "description": "Triggers for auto-heal.",
- "type": "object",
- "properties": {
- "requests": {
- "$ref": "#/definitions/RequestsBasedTrigger",
- "description": "A rule based on total requests."
- },
- "privateBytesInKB": {
- "format": "int32",
- "description": "A rule based on private bytes.",
- "type": "integer"
- },
- "statusCodes": {
- "description": "A rule based on status codes.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/StatusCodesBasedTrigger"
- }
- },
- "slowRequests": {
- "$ref": "#/definitions/SlowRequestsBasedTrigger",
- "description": "A rule based on request execution time."
- }
- }
- },
- "Capability": {
- "description": "Describes the capabilities/features allowed for a specific SKU.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the SKU capability.",
- "type": "string"
- },
- "value": {
- "description": "Value of the SKU capability.",
- "type": "string"
- },
- "reason": {
- "description": "Reason of the SKU capability.",
- "type": "string"
- }
- }
- },
- "CloningInfo": {
- "description": "Information needed for cloning operation.",
- "required": [
- "sourceWebAppId"
- ],
- "type": "object",
- "properties": {
- "correlationId": {
- "format": "uuid",
- "description": "Correlation ID of cloning operation. This ID ties multiple cloning operations\ntogether to use the same snapshot.",
- "type": "string",
- "example": "00000000-0000-0000-0000-000000000000"
- },
- "overwrite": {
- "description": "true to overwrite destination app; otherwise, false.",
- "type": "boolean"
- },
- "cloneCustomHostNames": {
- "description": "true to clone custom hostnames from source app; otherwise, false.",
- "type": "boolean"
- },
- "cloneSourceControl": {
- "description": "true to clone source control from source app; otherwise, false.",
- "type": "boolean"
- },
- "sourceWebAppId": {
- "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.",
- "type": "string"
- },
- "hostingEnvironment": {
- "description": "App Service Environment.",
- "type": "string"
- },
- "appSettingsOverrides": {
- "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.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- },
- "configureLoadBalancing": {
- "description": "true to configure load balancing for source and destination app.",
- "type": "boolean"
- },
- "trafficManagerProfileId": {
- "description": "ARM resource ID of the Traffic Manager profile to use, if it exists. Traffic Manager resource ID is of the form \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{profileName}.",
- "type": "string"
- },
- "trafficManagerProfileName": {
- "description": "Name of Traffic Manager profile to create. This is only needed if Traffic Manager profile does not already exist.",
- "type": "string"
- },
- "ignoreQuotas": {
- "description": "true if quotas should be ignored; otherwise, false.",
- "type": "boolean"
- }
- }
- },
- "ConnStringInfo": {
- "description": "Database connection string information.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of connection string.",
- "type": "string"
- },
- "connectionString": {
- "description": "Connection string value.",
- "type": "string"
- },
- "type": {
- "description": "Type of database.",
- "enum": [
- "MySql",
- "SQLServer",
- "SQLAzure",
- "Custom",
- "NotificationHub",
- "ServiceBus",
- "EventHub",
- "ApiHub",
- "DocDb",
- "RedisCache",
- "PostgreSQL"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ConnectionStringType",
- "modelAsString": false
- }
- }
- }
- },
- "CorsSettings": {
- "description": "Cross-Origin Resource Sharing (CORS) settings for the app.",
- "type": "object",
- "properties": {
- "allowedOrigins": {
- "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.",
- "type": "array",
- "items": {
- "type": "string"
- }
- }
- }
- },
- "CsmUsageQuota": {
- "description": "Usage of the quota resource.",
- "type": "object",
- "properties": {
- "unit": {
- "description": "Units of measurement for the quota resourse.",
- "type": "string"
- },
- "nextResetTime": {
- "format": "date-time",
- "description": "Next reset time for the resource counter.",
- "type": "string"
- },
- "currentValue": {
- "format": "int64",
- "description": "The current value of the resource counter.",
- "type": "integer"
- },
- "limit": {
- "format": "int64",
- "description": "The resource limit.",
- "type": "integer"
- },
- "name": {
- "$ref": "#/definitions/LocalizableString",
- "description": "Quota name."
- }
- }
- },
- "CsmUsageQuotaCollection": {
- "description": "Collection of CSM usage quotas.",
+ "ResourceCollection": {
+ "description": "Collection of resources.",
"required": [
"value"
],
@@ -1886,1630 +1538,10 @@
"value": {
"description": "Collection of resources.",
"type": "array",
- "items": {
- "$ref": "#/definitions/CsmUsageQuota"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "Experiments": {
- "description": "Routing rules in production experiments.",
- "type": "object",
- "properties": {
- "rampUpRules": {
- "description": "List of ramp-up rules.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/RampUpRule"
- }
- }
- }
- },
- "HandlerMapping": {
- "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.",
- "type": "object",
- "properties": {
- "extension": {
- "description": "Requests with this extension will be handled using the specified FastCGI application.",
- "type": "string"
- },
- "scriptProcessor": {
- "description": "The absolute path to the FastCGI application.",
- "type": "string"
- },
- "arguments": {
- "description": "Command-line arguments to be passed to the script processor.",
- "type": "string"
- }
- }
- },
- "HostNameSslState": {
- "description": "SSL-enabled hostname.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Hostname.",
- "type": "string"
- },
- "sslState": {
- "description": "SSL type.",
- "enum": [
- "Disabled",
- "SniEnabled",
- "IpBasedEnabled"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SslState",
- "modelAsString": false
- }
- },
- "virtualIP": {
- "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
- "type": "string"
- },
- "thumbprint": {
- "description": "SSL certificate thumbprint.",
- "type": "string"
- },
- "toUpdate": {
- "description": "Set to true to update existing hostname.",
- "type": "boolean"
- },
- "hostType": {
- "description": "Indicates whether the hostname is a standard or repository hostname.",
- "enum": [
- "Standard",
- "Repository"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "HostType",
- "modelAsString": false
- }
- }
- }
- },
- "HostingEnvironmentProfile": {
- "description": "Specification for an App Service Environment to use for this resource.",
- "type": "object",
- "properties": {
- "id": {
- "description": "Resource ID of the App Service Environment.",
- "type": "string"
- },
- "name": {
- "description": "Name of the App Service Environment.",
- "type": "string",
- "readOnly": true
- },
- "type": {
- "description": "Resource type of the App Service Environment.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "HybridConnection": {
- "description": "Hybrid Connection contract. This is used to configure a Hybrid Connection.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "HybridConnection resource specific properties",
- "properties": {
- "serviceBusNamespace": {
- "description": "The name of the Service Bus namespace.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "relayName": {
- "description": "The name of the Service Bus relay.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "relayArmUri": {
- "description": "The ARM URI to the Service Bus relay.",
- "type": "string"
- },
- "hostname": {
- "description": "The hostname of the endpoint.",
- "type": "string"
- },
- "port": {
- "format": "int32",
- "description": "The port of the endpoint.",
- "type": "integer"
- },
- "sendKeyName": {
- "description": "The name of the Service Bus key which has Send permissions. This is used to authenticate to Service Bus.",
- "type": "string"
- },
- "sendKeyValue": {
- "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.",
- "type": "string"
- },
- "serviceBusSuffix": {
- "description": "The suffix for the service bus endpoint. By default this is .servicebus.windows.net",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "HybridConnectionCollection": {
- "description": "Collection of hostname bindings.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HybridConnection"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "HybridConnectionKey": {
- "description": "Hybrid Connection key contract. This has the send key name and value for a Hybrid Connection.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "HybridConnectionKey resource specific properties",
- "properties": {
- "sendKeyName": {
- "description": "The name of the send key.",
- "type": "string",
- "readOnly": true
- },
- "sendKeyValue": {
- "description": "The value of the send key.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "HybridConnectionLimits": {
- "description": "Hybrid Connection limits contract. This is used to return the plan limits of Hybrid Connections.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "HybridConnectionLimits resource specific properties",
- "properties": {
- "current": {
- "format": "int32",
- "description": "The current number of Hybrid Connections.",
- "type": "integer",
- "readOnly": true
- },
- "maximum": {
- "format": "int32",
- "description": "The maximum number of Hybrid Connections allowed.",
- "type": "integer",
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "IpSecurityRestriction": {
- "description": "IP security restriction on an app.",
- "required": [
- "ipAddress"
- ],
- "type": "object",
- "properties": {
- "ipAddress": {
- "description": "IP address the security restriction is valid for.",
- "type": "string"
- },
- "subnetMask": {
- "description": "Subnet mask for the range of IP addresses the restriction is valid for.",
- "type": "string"
- }
- }
- },
- "LocalizableString": {
- "description": "Localizable string object containing the name and a localized value.",
- "type": "object",
- "properties": {
- "value": {
- "description": "Non-localized name.",
- "type": "string"
- },
- "localizedValue": {
- "description": "Localized name.",
- "type": "string"
- }
- }
- },
- "ManagedServiceIdentity": {
- "description": "Managed service identity.",
- "type": "object",
- "properties": {
- "type": {
- "description": "Type of managed service identity.",
- "enum": [
- "SystemAssigned"
- ],
- "x-ms-enum": {
- "name": "ManagedServiceIdentityType",
- "modelAsString": true
- }
- },
- "tenantId": {
- "description": "Tenant of managed service identity.",
- "type": "string",
- "readOnly": true
- },
- "principalId": {
- "description": "Principal Id of managed service identity.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "NameValuePair": {
- "description": "Name value pair.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Pair name.",
- "type": "string"
- },
- "value": {
- "description": "Pair value.",
- "type": "string"
- }
- }
- },
- "ProxyOnlyResource": {
- "description": "Azure proxy only resource. This resource is not tracked by Azure Resource Manager.",
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- }
- },
- "x-ms-azure-resource": true
- },
- "PushSettings": {
- "description": "Push settings for the App.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "PushSettings resource specific properties",
- "required": [
- "isPushEnabled"
- ],
- "properties": {
- "isPushEnabled": {
- "description": "Gets or sets a flag indicating whether the Push endpoint is enabled.",
- "type": "boolean"
- },
- "tagWhitelistJson": {
- "description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
- "type": "string"
- },
- "tagsRequiringAuth": {
- "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.",
- "type": "string"
- },
- "dynamicTagsJson": {
- "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.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "RampUpRule": {
- "description": "Routing rules for ramp up testing. This rule allows to redirect static traffic % to a slot or to gradually change routing % based on performance.",
- "type": "object",
- "properties": {
- "actionHostName": {
- "description": "Hostname of a slot to which the traffic will be redirected if decided to. E.g. myapp-stage.azurewebsites.net.",
- "type": "string"
- },
- "reroutePercentage": {
- "format": "double",
- "description": "Percentage of the traffic which will be redirected to ActionHostName.",
- "type": "number"
- },
- "changeStep": {
- "format": "double",
- "description": "In auto ramp up scenario this is the step to to add/remove from ReroutePercentage until it reaches \nMinReroutePercentage or MaxReroutePercentage. Site metrics are checked every N minutes specificed in ChangeIntervalInMinutes.\nCustom decision algorithm can be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
- "type": "number"
- },
- "changeIntervalInMinutes": {
- "format": "int32",
- "description": "Specifies interval in mimuntes to reevaluate ReroutePercentage.",
- "type": "integer"
- },
- "minReroutePercentage": {
- "format": "double",
- "description": "Specifies lower boundary above which ReroutePercentage will stay.",
- "type": "number"
- },
- "maxReroutePercentage": {
- "format": "double",
- "description": "Specifies upper boundary below which ReroutePercentage will stay.",
- "type": "number"
- },
- "changeDecisionCallbackUrl": {
- "description": "Custom decision algorithm can be provided in TiPCallback site extension which URL can be specified. See TiPCallback site extension for the scaffold and contracts.\nhttps://www.siteextensions.net/packages/TiPCallback/",
- "type": "string"
- },
- "name": {
- "description": "Name of the routing rule. The recommended name would be to point to the slot which will receive the traffic in the experiment.",
- "type": "string"
- }
- }
- },
- "RequestsBasedTrigger": {
- "description": "Trigger based on total requests.",
- "type": "object",
- "properties": {
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
- "Resource": {
- "description": "Azure resource. This resource is tracked in Azure Resource Manager",
- "required": [
- "location"
- ],
- "properties": {
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "name": {
- "description": "Resource Name.",
- "type": "string",
- "readOnly": true
- },
- "kind": {
- "description": "Kind of resource.",
- "type": "string"
- },
- "location": {
- "description": "Resource Location.",
- "type": "string"
- },
- "type": {
- "description": "Resource type.",
- "type": "string",
- "readOnly": true
- },
- "tags": {
- "description": "Resource tags.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- }
- }
- },
- "x-ms-azure-resource": true
- },
- "ResourceCollection": {
- "description": "Collection of resources.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetric": {
- "description": "Object representing a metric for any resource .",
- "type": "object",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Metric unit.",
- "type": "string",
- "readOnly": true
- },
- "timeGrain": {
- "description": "Metric granularity. E.g PT1H, PT5M, P1D",
- "type": "string",
- "readOnly": true
- },
- "startTime": {
- "format": "date-time",
- "description": "Metric start time.",
- "type": "string",
- "readOnly": true
- },
- "endTime": {
- "format": "date-time",
- "description": "Metric end time.",
- "type": "string",
- "readOnly": true
- },
- "resourceId": {
- "description": "Metric resource Id.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource Id.",
- "type": "string",
- "readOnly": true
- },
- "metricValues": {
- "description": "Metric values.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricValue"
- },
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
- },
- "ResourceMetricAvailability": {
- "description": "Metrics availability and retention.",
- "type": "object",
- "properties": {
- "timeGrain": {
- "description": "Time grain .",
- "type": "string",
- "readOnly": true
- },
- "retention": {
- "description": "Retention period for the current time grain.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ResourceMetricCollection": {
- "description": "Collection of metric responses.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetric"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetricDefinition": {
- "description": "Metadata for the metrics.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "ResourceMetricDefinition resource specific properties",
- "properties": {
- "name": {
- "$ref": "#/definitions/ResourceMetricName",
- "description": "Name of the metric.",
- "readOnly": true
- },
- "unit": {
- "description": "Unit of the metric.",
- "type": "string",
- "readOnly": true
- },
- "primaryAggregationType": {
- "description": "Primary aggregation type.",
- "type": "string",
- "readOnly": true
- },
- "metricAvailabilities": {
- "description": "List of time grains supported for the metric together with retention period.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricAvailability"
- },
- "readOnly": true
- },
- "resourceUri": {
- "description": "Resource URI.",
- "type": "string",
- "readOnly": true
- },
- "id": {
- "description": "Resource ID.",
- "type": "string",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "object",
- "additionalProperties": {
- "type": "string"
- },
- "readOnly": true
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "ResourceMetricDefinitionCollection": {
- "description": "Collection of metric definitions.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricDefinition"
- }
- },
- "nextLink": {
- "description": "Link to next page of resources.",
- "type": "string"
- }
- }
- },
- "ResourceMetricName": {
- "description": "Name of a metric for any resource .",
- "type": "object",
- "properties": {
- "value": {
- "description": "metric name value.",
- "type": "string",
- "readOnly": true
- },
- "localizedValue": {
- "description": "Localized metric name value.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "ResourceMetricProperty": {
- "description": "Resource metric property.",
- "type": "object",
- "properties": {
- "key": {
- "description": "Key for resource metric property.",
- "type": "string"
- },
- "value": {
- "description": "Value of pair.",
- "type": "string"
- }
- }
- },
- "ResourceMetricValue": {
- "description": "Value of resource metric.",
- "type": "object",
- "properties": {
- "timestamp": {
- "description": "Value timestamp.",
- "type": "string",
- "readOnly": true
- },
- "average": {
- "format": "float",
- "description": "Value average.",
- "type": "number",
- "readOnly": true
- },
- "minimum": {
- "format": "float",
- "description": "Value minimum.",
- "type": "number",
- "readOnly": true
- },
- "maximum": {
- "format": "float",
- "description": "Value maximum.",
- "type": "number",
- "readOnly": true
- },
- "total": {
- "format": "float",
- "description": "Value total.",
- "type": "number",
- "readOnly": true
- },
- "count": {
- "format": "float",
- "description": "Value count.",
- "type": "number",
- "readOnly": true
- },
- "properties": {
- "description": "Properties.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ResourceMetricProperty"
- },
- "readOnly": true
- }
- }
- },
- "Site": {
- "description": "A web app, a mobile app backend, or an API app.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/Resource"
- }
- ],
- "properties": {
- "properties": {
- "description": "Site resource specific properties",
- "properties": {
- "state": {
- "description": "Current state of the app.",
- "type": "string",
- "readOnly": true
- },
- "hostNames": {
- "description": "Hostnames associated with the app.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "repositorySiteName": {
- "description": "Name of the repository site.",
- "type": "string",
- "readOnly": true
- },
- "usageState": {
- "description": "State indicating whether the app has exceeded its quota usage. Read-only.",
- "enum": [
- "Normal",
- "Exceeded"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "UsageState",
- "modelAsString": false
- }
- },
- "enabled": {
- "description": "true if the app is enabled; otherwise, false. Setting this value to false disables the app (takes the app offline).",
- "type": "boolean"
- },
- "enabledHostNames": {
- "description": "Enabled hostnames for the app.Hostnames need to be assigned (see HostNames) AND enabled. Otherwise,\nthe app is not served on those hostnames.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "availabilityState": {
- "description": "Management information availability state for the app.",
- "enum": [
- "Normal",
- "Limited",
- "DisasterRecoveryMode"
- ],
- "type": "string",
- "readOnly": true,
- "x-ms-enum": {
- "name": "SiteAvailabilityState",
- "modelAsString": false
- }
- },
- "hostNameSslStates": {
- "description": "Hostname SSL states are used to manage the SSL bindings for app's hostnames.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HostNameSslState"
- }
- },
- "serverFarmId": {
- "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
- "type": "string"
- },
- "reserved": {
- "description": "true if reserved; otherwise, false.",
- "default": false,
- "type": "boolean",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "lastModifiedTimeUtc": {
- "format": "date-time",
- "description": "Last time the app was modified, in UTC. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "siteConfig": {
- "$ref": "#/definitions/SiteConfig",
- "description": "Configuration of the app."
- },
- "trafficManagerHostNames": {
- "description": "Azure Traffic Manager hostnames associated with the app. Read-only.",
- "type": "array",
- "items": {
- "type": "string"
- },
- "readOnly": true
- },
- "scmSiteAlsoStopped": {
- "description": "true to stop SCM (KUDU) site when the app is stopped; otherwise, false. The default is false.",
- "default": false,
- "type": "boolean"
- },
- "targetSwapSlot": {
- "description": "Specifies which deployment slot this app will swap into. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "hostingEnvironmentProfile": {
- "$ref": "#/definitions/HostingEnvironmentProfile",
- "description": "App Service Environment to use for the app.",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "clientAffinityEnabled": {
- "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.",
- "type": "boolean"
- },
- "clientCertEnabled": {
- "description": "true to enable client certificate authentication (TLS mutual authentication); otherwise, false. Default is false.",
- "type": "boolean"
- },
- "hostNamesDisabled": {
- "description": "true to disable the public hostnames of the app; otherwise, false.\n If true, the app is only accessible via API management process.",
- "type": "boolean"
- },
- "outboundIpAddresses": {
- "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.",
- "type": "string",
- "readOnly": true
- },
- "possibleOutboundIpAddresses": {
- "description": "List of IP addresses that the app uses for outbound connections (e.g. database access). Includes VIPs from all tenants. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "containerSize": {
- "format": "int32",
- "description": "Size of the function container.",
- "type": "integer"
- },
- "dailyMemoryTimeQuota": {
- "format": "int32",
- "description": "Maximum allowed daily memory-time quota (applicable on dynamic apps only).",
- "type": "integer"
- },
- "suspendedTill": {
- "format": "date-time",
- "description": "App suspended till in case memory-time quota is exceeded.",
- "type": "string",
- "readOnly": true
- },
- "maxNumberOfWorkers": {
- "format": "int32",
- "description": "Maximum number of workers.\nThis only applies to Functions container.",
- "type": "integer",
- "readOnly": true
- },
- "cloningInfo": {
- "$ref": "#/definitions/CloningInfo",
- "description": "If specified during app creation, the app is cloned from a source app.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "snapshotInfo": {
- "$ref": "#/definitions/SnapshotRecoveryRequest",
- "description": "If specified during app creation, the app is created from a previous snapshot.",
- "x-ms-mutability": [
- "create"
- ]
- },
- "resourceGroup": {
- "description": "Name of the resource group the app belongs to. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "isDefaultContainer": {
- "description": "true if the app is a default container; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "defaultHostName": {
- "description": "Default hostname of the app. Read-only.",
- "type": "string",
- "readOnly": true
- },
- "slotSwapStatus": {
- "$ref": "#/definitions/SlotSwapStatus",
- "description": "Status of the last deployment slot swap operation.",
- "readOnly": true
- },
- "httpsOnly": {
- "description": "HttpsOnly: configures a web site to accept only https requests. Issues redirect for\nhttp requests",
- "type": "boolean"
- }
- },
- "x-ms-client-flatten": true
- },
- "identity": {
- "$ref": "#/definitions/ManagedServiceIdentity"
- }
- }
- },
- "SiteConfig": {
- "description": "Configuration of an App Service app.",
- "type": "object",
- "properties": {
- "numberOfWorkers": {
- "format": "int32",
- "description": "Number of workers.",
- "type": "integer"
- },
- "defaultDocuments": {
- "description": "Default documents.",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "netFrameworkVersion": {
- "description": ".NET Framework version.",
- "default": "v4.6",
- "type": "string"
- },
- "phpVersion": {
- "description": "Version of PHP.",
- "type": "string"
- },
- "pythonVersion": {
- "description": "Version of Python.",
- "type": "string"
- },
- "nodeVersion": {
- "description": "Version of Node.js.",
- "type": "string"
- },
- "linuxFxVersion": {
- "description": "Linux App Framework and version",
- "type": "string"
- },
- "requestTracingEnabled": {
- "description": "true if request tracing is enabled; otherwise, false.",
- "type": "boolean"
- },
- "requestTracingExpirationTime": {
- "format": "date-time",
- "description": "Request tracing expiration time.",
- "type": "string"
- },
- "remoteDebuggingEnabled": {
- "description": "true if remote debugging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "remoteDebuggingVersion": {
- "description": "Remote debugging version.",
- "type": "string"
- },
- "httpLoggingEnabled": {
- "description": "true if HTTP logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "logsDirectorySizeLimit": {
- "format": "int32",
- "description": "HTTP logs directory size limit.",
- "type": "integer"
- },
- "detailedErrorLoggingEnabled": {
- "description": "true if detailed error logging is enabled; otherwise, false.",
- "type": "boolean"
- },
- "publishingUsername": {
- "description": "Publishing user name.",
- "type": "string"
- },
- "appSettings": {
- "description": "Application settings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/NameValuePair"
- }
- },
- "connectionStrings": {
- "description": "Connection strings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/ConnStringInfo"
- }
- },
- "machineKey": {
- "$ref": "#/definitions/SiteMachineKey",
- "description": "Site MachineKey.",
- "readOnly": true
- },
- "handlerMappings": {
- "description": "Handler mappings.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/HandlerMapping"
- }
- },
- "documentRoot": {
- "description": "Document root.",
- "type": "string"
- },
- "scmType": {
- "description": "SCM type.",
- "enum": [
- "None",
- "Dropbox",
- "Tfs",
- "LocalGit",
- "GitHub",
- "CodePlexGit",
- "CodePlexHg",
- "BitbucketGit",
- "BitbucketHg",
- "ExternalGit",
- "ExternalHg",
- "OneDrive",
- "VSO"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ScmType",
- "modelAsString": true
- }
- },
- "use32BitWorkerProcess": {
- "description": "true to use 32-bit worker process; otherwise, false.",
- "type": "boolean"
- },
- "webSocketsEnabled": {
- "description": "true if WebSocket is enabled; otherwise, false.",
- "type": "boolean"
- },
- "alwaysOn": {
- "description": "true if Always On is enabled; otherwise, false.",
- "type": "boolean"
- },
- "javaVersion": {
- "description": "Java version.",
- "type": "string"
- },
- "javaContainer": {
- "description": "Java container.",
- "type": "string"
- },
- "javaContainerVersion": {
- "description": "Java container version.",
- "type": "string"
- },
- "appCommandLine": {
- "description": "App command line to launch.",
- "type": "string"
- },
- "managedPipelineMode": {
- "description": "Managed pipeline mode.",
- "enum": [
- "Integrated",
- "Classic"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "ManagedPipelineMode",
- "modelAsString": false
- }
- },
- "virtualApplications": {
- "description": "Virtual applications.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualApplication"
- }
- },
- "loadBalancing": {
- "description": "Site load balancing.",
- "enum": [
- "WeightedRoundRobin",
- "LeastRequests",
- "LeastResponseTime",
- "WeightedTotalTraffic",
- "RequestHash"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "SiteLoadBalancing",
- "modelAsString": false
- }
- },
- "experiments": {
- "$ref": "#/definitions/Experiments",
- "description": "This is work around for polymophic types."
- },
- "limits": {
- "$ref": "#/definitions/SiteLimits",
- "description": "Site limits."
- },
- "autoHealEnabled": {
- "description": "true if Auto Heal is enabled; otherwise, false.",
- "type": "boolean"
- },
- "autoHealRules": {
- "$ref": "#/definitions/AutoHealRules",
- "description": "Auto Heal rules."
- },
- "tracingOptions": {
- "description": "Tracing options.",
- "type": "string"
- },
- "vnetName": {
- "description": "Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "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."
- },
- "autoSwapSlotName": {
- "description": "Auto-swap slot name.",
- "type": "string"
- },
- "localMySqlEnabled": {
- "description": "true to enable local MySQL; otherwise, false.",
- "default": false,
- "type": "boolean"
- },
- "ipSecurityRestrictions": {
- "description": "IP security restrictions.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/IpSecurityRestriction"
- }
- }
- }
- },
- "SiteLimits": {
- "description": "Metric limits set on an app.",
- "type": "object",
- "properties": {
- "maxPercentageCpu": {
- "format": "double",
- "description": "Maximum allowed CPU usage percentage.",
- "type": "number"
- },
- "maxMemoryInMb": {
- "format": "int64",
- "description": "Maximum allowed memory usage in MB.",
- "type": "integer"
- },
- "maxDiskSizeInMb": {
- "format": "int64",
- "description": "Maximum allowed disk size usage in MB.",
- "type": "integer"
- }
- }
- },
- "SiteMachineKey": {
- "description": "MachineKey of an app.",
- "type": "object",
- "properties": {
- "validation": {
- "description": "MachineKey validation.",
- "type": "string"
- },
- "validationKey": {
- "description": "Validation key.",
- "type": "string"
- },
- "decryption": {
- "description": "Decryption.",
- "type": "string"
- },
- "decryptionKey": {
- "description": "Decryption key.",
- "type": "string"
- }
- }
- },
- "SkuCapacity": {
- "description": "Description of the App Service plan scale options.",
- "type": "object",
- "properties": {
- "minimum": {
- "format": "int32",
- "description": "Minimum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "maximum": {
- "format": "int32",
- "description": "Maximum number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "default": {
- "format": "int32",
- "description": "Default number of workers for this App Service plan SKU.",
- "type": "integer"
- },
- "scaleType": {
- "description": "Available scale configurations for an App Service plan.",
- "type": "string"
- }
- }
- },
- "SkuDescription": {
- "description": "Description of a SKU for a scalable resource.",
- "type": "object",
- "properties": {
- "name": {
- "description": "Name of the resource SKU.",
- "type": "string"
- },
- "tier": {
- "description": "Service tier of the resource SKU.",
- "type": "string"
- },
- "size": {
- "description": "Size specifier of the resource SKU.",
- "type": "string"
- },
- "family": {
- "description": "Family code of the resource SKU.",
- "type": "string"
- },
- "capacity": {
- "format": "int32",
- "description": "Current number of instances assigned to the resource.",
- "type": "integer"
- },
- "skuCapacity": {
- "$ref": "#/definitions/SkuCapacity",
- "description": "Min, max, and default scale values of the SKU."
- },
- "locations": {
- "description": "Locations of the SKU.",
- "type": "array",
"items": {
"type": "string"
}
},
- "capabilities": {
- "description": "Capabilities of the SKU, e.g., is traffic manager enabled?",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Capability"
- }
- }
- }
- },
- "SlotSwapStatus": {
- "description": "The status of the last successfull slot swap operation.",
- "type": "object",
- "properties": {
- "timestampUtc": {
- "format": "date-time",
- "description": "The time the last successful slot swap completed.",
- "type": "string",
- "readOnly": true
- },
- "sourceSlotName": {
- "description": "The source slot of the last swap operation.",
- "type": "string",
- "readOnly": true
- },
- "destinationSlotName": {
- "description": "The destination slot of the last swap operation.",
- "type": "string",
- "readOnly": true
- }
- }
- },
- "SlowRequestsBasedTrigger": {
- "description": "Trigger based on request execution time.",
- "type": "object",
- "properties": {
- "timeTaken": {
- "description": "Time taken.",
- "type": "string"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
- "SnapshotRecoveryRequest": {
- "description": "Details about app recovery operation.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "SnapshotRecoveryRequest resource specific properties",
- "required": [
- "overwrite"
- ],
- "properties": {
- "snapshotTime": {
- "description": "Point in time in which the app recovery should be attempted, formatted as a DateTime string.",
- "type": "string"
- },
- "recoveryTarget": {
- "$ref": "#/definitions/SnapshotRecoveryTarget",
- "description": "Specifies the web app that snapshot contents will be written to."
- },
- "overwrite": {
- "description": "If true the recovery operation can overwrite source app; otherwise, false.",
- "type": "boolean"
- },
- "recoverConfiguration": {
- "description": "If true, site configuration, in addition to content, will be reverted.",
- "type": "boolean"
- },
- "ignoreConflictingHostNames": {
- "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.",
- "type": "boolean"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "SnapshotRecoveryTarget": {
- "description": "Specifies the web app that snapshot contents will be written to.",
- "type": "object",
- "properties": {
- "location": {
- "description": "Geographical location of the target web app, e.g. SouthEastAsia, SouthCentralUS",
- "type": "string"
- },
- "id": {
- "description": "ARM resource ID of the target 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.",
- "type": "string"
- }
- }
- },
- "StatusCodesBasedTrigger": {
- "description": "Trigger based on status code.",
- "type": "object",
- "properties": {
- "status": {
- "format": "int32",
- "description": "HTTP status code.",
- "type": "integer"
- },
- "subStatus": {
- "format": "int32",
- "description": "SubStatus.",
- "type": "integer"
- },
- "win32Status": {
- "format": "int32",
- "description": "Win32 error code.",
- "type": "integer"
- },
- "count": {
- "format": "int32",
- "description": "Count.",
- "type": "integer"
- },
- "timeInterval": {
- "description": "Time interval.",
- "type": "string"
- }
- }
- },
- "VirtualApplication": {
- "description": "Virtual application in an app.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Virtual path.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- },
- "preloadEnabled": {
- "description": "true if preloading is enabled; otherwise, false.",
- "type": "boolean"
- },
- "virtualDirectories": {
- "description": "Virtual directories for virtual application.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VirtualDirectory"
- }
- }
- }
- },
- "VirtualDirectory": {
- "description": "Directory for virtual application.",
- "type": "object",
- "properties": {
- "virtualPath": {
- "description": "Path to virtual application.",
- "type": "string"
- },
- "physicalPath": {
- "description": "Physical path.",
- "type": "string"
- }
- }
- },
- "VnetGateway": {
- "description": "The Virtual Network gateway contract. This is used to give the Virtual Network gateway access to the VPN package.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetGateway resource specific properties",
- "required": [
- "vpnPackageUri"
- ],
- "properties": {
- "vnetName": {
- "description": "The Virtual Network name.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ]
- },
- "vpnPackageUri": {
- "description": "The URI where the VPN package can be downloaded.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "update"
- ]
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "VnetInfo": {
- "description": "Virtual Network information contract.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetInfo resource specific properties",
- "properties": {
- "vnetResourceId": {
- "description": "The Virtual Network's resource ID.",
- "type": "string"
- },
- "certThumbprint": {
- "description": "The client certificate thumbprint.",
- "type": "string",
- "readOnly": true
- },
- "certBlob": {
- "format": "byte",
- "description": "A certificate file (.cer) blob containing the public key of the private key used to authenticate a \nPoint-To-Site VPN connection.",
- "type": "string"
- },
- "routes": {
- "description": "The routes that this Virtual Network connection uses.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/VnetRoute"
- },
- "readOnly": true
- },
- "resyncRequired": {
- "description": "true if a resync is required; otherwise, false.",
- "type": "boolean",
- "readOnly": true
- },
- "dnsServers": {
- "description": "DNS servers to be used by this Virtual Network. This should be a comma-separated list of IP addresses.",
- "type": "string"
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "VnetRoute": {
- "description": "Virtual Network route contract used to pass routing information for a Virtual Network.",
- "type": "object",
- "allOf": [
- {
- "$ref": "#/definitions/ProxyOnlyResource"
- }
- ],
- "properties": {
- "properties": {
- "description": "VnetRoute resource specific properties",
- "properties": {
- "name": {
- "description": "The name of this route. This is only returned by the server and does not need to be set by the client.",
- "type": "string",
- "x-ms-mutability": [
- "create",
- "read"
- ],
- "x-ms-client-name": "vnetRouteName"
- },
- "startAddress": {
- "description": "The starting address for this route. This may also include a CIDR notation, in which case the end address must not be specified.",
- "type": "string"
- },
- "endAddress": {
- "description": "The ending address for this route. If the start address is specified in CIDR notation, this must be omitted.",
- "type": "string"
- },
- "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.",
- "enum": [
- "DEFAULT",
- "INHERITED",
- "STATIC"
- ],
- "type": "string",
- "x-ms-enum": {
- "name": "RouteType",
- "modelAsString": true
- }
- }
- },
- "x-ms-client-flatten": true
- }
- }
- },
- "WebAppCollection": {
- "description": "Collection of App Service apps.",
- "required": [
- "value"
- ],
- "type": "object",
- "properties": {
- "value": {
- "description": "Collection of resources.",
- "type": "array",
- "items": {
- "$ref": "#/definitions/Site"
- }
- },
"nextLink": {
"description": "Link to next page of resources.",
"type": "string"
diff --git a/specification/web/resource-manager/readme.md b/specification/web/resource-manager/readme.md
index fd7c6f050e0f..fdb92218c912 100644
--- a/specification/web/resource-manager/readme.md
+++ b/specification/web/resource-manager/readme.md
@@ -48,6 +48,7 @@ input-file:
- Microsoft.DomainRegistration/2015-04-01/Domains.json
- Microsoft.DomainRegistration/2015-04-01/TopLevelDomains.json
- Microsoft.Web/2016-03-01/Certificates.json
+- Microsoft.Web/2016-03-01/CommonDefinitions.json
- Microsoft.Web/2016-03-01/DeletedWebApps.json
- Microsoft.Web/2016-03-01/Provider.json
- Microsoft.Web/2016-03-01/Recommendations.json