true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.",
+ "enum": [
+ "Invalid",
+ "AlreadyExists"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InAvailabilityReasonType",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceNameAvailabilityRequest": {
+ "description": "Resource name availability request content.",
+ "required": [
+ "name",
+ "type",
+ "resourceGroup"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Resource name to verify.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type used for verification.",
+ "enum": [
+ "Microsoft.NetApp/netAppAccounts",
+ "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CheckNameResourceTypes",
+ "modelAsString": true
+ }
+ },
+ "resourceGroup": {
+ "description": "Resource group name.",
+ "type": "string"
+ }
+ }
+ },
+ "QuotaAvailabilityRequest": {
+ "description": "Quota availability request content.",
+ "required": [
+ "name",
+ "type",
+ "resourceGroup"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the resource to verify.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type used for verification.",
+ "enum": [
+ "Microsoft.NetApp/netAppAccounts",
+ "Microsoft.NetApp/netAppAccounts/capacityPools",
+ "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
+ "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CheckQuotaNameResourceTypes",
+ "modelAsString": true
+ }
+ },
+ "resourceGroup": {
+ "description": "Resource group name.",
+ "type": "string"
+ }
+ }
+ },
+ "netAppAccountList": {
+ "description": "List of NetApp account resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "description": "Multiple NetApp accounts",
+ "items": {
+ "$ref": "#/definitions/netAppAccount"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of results."
+ }
+ }
+ },
+ "netAppAccount": {
+ "description": "NetApp account resource",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "NetApp Account properties",
+ "$ref": "#/definitions/accountProperties",
+ "x-ms-client-flatten": true
+ },
+ "systemData": {
+ "readOnly": true,
+ "description": "The system meta data relating to this resource.",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ }
+ },
+ "netAppAccountPatch": {
+ "description": "NetApp account patch resource",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "NetApp Account properties",
+ "$ref": "#/definitions/accountProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "accountProperties": {
+ "description": "NetApp account properties",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "activeDirectories": {
+ "description": "Active Directories",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/activeDirectory"
+ }
+ },
+ "encryption": {
+ "description": "Encryption settings",
+ "$ref": "#/definitions/accountEncryption"
+ }
+ }
+ },
+ "activeDirectory": {
+ "description": "Active Directory",
+ "type": "object",
+ "properties": {
+ "activeDirectoryId": {
+ "type": "string",
+ "x-nullable": true,
+ "description": "Id of the Active Directory"
+ },
+ "username": {
+ "type": "string",
+ "description": "Username of Active Directory domain administrator"
+ },
+ "password": {
+ "type": "string",
+ "x-ms-secret": true,
+ "description": "Plain text password of Active Directory domain administrator, value is masked in the response"
+ },
+ "domain": {
+ "type": "string",
+ "description": "Name of the Active Directory domain"
+ },
+ "dns": {
+ "type": "string",
+ "description": "Comma separated list of DNS server IP addresses (IPv4 only) for the Active Directory domain",
+ "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$",
+ "example": "101.102.103.104,101.102.103.105"
+ },
+ "status": {
+ "type": "string",
+ "description": "Status of the Active Directory",
+ "readOnly": true,
+ "enum": [
+ "Created",
+ "Updating",
+ "InUse",
+ "Deleted",
+ "Error"
+ ],
+ "x-ms-enum": {
+ "name": "ActiveDirectoryStatus",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Created",
+ "description": "Active Directory created but not in use"
+ },
+ {
+ "value": "InUse",
+ "description": "Active Directory in use by SMB Volume"
+ },
+ {
+ "value": "Deleted",
+ "description": "Active Directory Deleted"
+ },
+ {
+ "value": "Error",
+ "description": "Error with the Active Directory"
+ },
+ {
+ "value": "Updating",
+ "description": "Active Directory Updating"
+ }
+ ]
+ }
+ },
+ "statusDetails": {
+ "type": "string",
+ "description": "Any details in regards to the Status of the Active Directory",
+ "readOnly": true
+ },
+ "smbServerName": {
+ "type": "string",
+ "description": "NetBIOS name of the SMB server. This name will be registered as a computer account in the AD and used to mount volumes"
+ },
+ "organizationalUnit": {
+ "type": "string",
+ "default": "CN=Computers",
+ "description": "The Organizational Unit (OU) within the Windows Active Directory"
+ },
+ "site": {
+ "type": "string",
+ "description": "The Active Directory site the service will limit Domain Controller discovery to"
+ },
+ "backupOperators": {
+ "description": "Users to be added to the Built-in Backup Operator active directory group. A list of unique usernames without domain specifier",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "maxLength": 255,
+ "minLength": 1,
+ "example": [
+ "user1",
+ "user2"
+ ]
+ }
+ },
+ "kdcIP": {
+ "type": "string",
+ "pattern": "^(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)((, ?)(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))*$",
+ "description": "kdc server IP addresses for the active directory machine. This optional parameter is used only while creating kerberos volume.",
+ "example": "101.102.103.104"
+ },
+ "adName": {
+ "type": "string",
+ "maxLength": 64,
+ "minLength": 1,
+ "description": "Name of the active directory machine. This optional parameter is used only while creating kerberos volume",
+ "example": "ADServerName"
+ },
+ "serverRootCACertificate": {
+ "type": "string",
+ "maxLength": 10240,
+ "minLength": 1,
+ "description": "When LDAP over SSL/TLS is enabled, the LDAP client is required to have base64 encoded Active Directory Certificate Service's self-signed root CA certificate, this optional parameter is used only for dual protocol with LDAP user-mapping volumes.",
+ "x-ms-secret": true,
+ "example": "LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURuVENDQW9XZ0F3SUJBZ0lRR3FXdnRxeHBvSTFJV3Z4VGdJbElWREFOQmdrcWhraUc5dzBCQVFzRkFEQlYKTVJNd0VRWUtDWkltaVpQeUxHUUJHUllEWTI5dE1SY3dGUVlLQ1pJbWlaUHlMR1FCR1JZSGFHRnlhV3R5WWpFbApNQ01HQTFVRUF4TWNhR0Z5YVd0eVlpMVhTVTR0TWtKUFZrRkZTMEkwTkVJdFEwRXRNakFlRncweU1EQTFNRFV3Ck56TTVORGxhRncweU1EQTFNRFl3TnpRNU5EaGFNRlV4RXpBUkJnb0praWFKay9Jc1pBRVpGZ05qYjIweEZ6QVYKQmdvSmtpYUprL0lzWkFFWkZnZG9ZWEpwYTNKaU1TVXdJd1lEVlFRREV4eG9ZWEpwYTNKaUxWZEpUaTB5UWs5VwpRVVZMUWpRMFFpMURRUzB5TUlJQklqQU5CZ2txaGtpRzl3MEJBUUVGQUFPQ0FROEFNSUlCQ2dLQ0FRRUFqMHByCnhaaXpNaDBqYnRwN1ZOc0JrRVJ2MVpZT0MzMEtqaGRWdEExRm1MeFM2cXlycmpMZUdXOXRSd2ZnUkR0eVBodTIKZVJTcVpTUjF6Z1hZR0s0Nys3Y3F0YnB2UElOektCb0dOWERIVTNxVWlleXJWSjFDVzRKNjJodUdrbUV1VVVkMApKMXBxNTVxbjk1SmRUbWh1dmZlTUxxeHB5c01nbGVnY281ZFhoN0hsQkhwaTNKMFN4ZnhVWmxKMVZiOFJZVEZhCkJiMGFlTVZaRzRKeVREaktiMlR1TmFXOG1aUE5vOFBMRDRocjdndFNZUEQvQ1dVVGV5QlpoZC9LTzNPczlWVEIKYmpLUGtWd0J2WEs2SlFMSGprNFBHS3VYZDhaWVFyajBtOWNIZDNmcWNYTXlQUnQ2TlJ4ak0yMTUxckFzSkVhNgpWZC9ta056akpXalBrT2VZUVFJREFRQUJvMmt3WnpBVEJna3JCZ0VFQVlJM0ZBSUVCaDRFQUVNQVFUQU9CZ05WCkhROEJBZjhFQkFNQ0FZWXdEd1lEVlIwVEFRSC9CQVV3QXdFQi96QWRCZ05WSFE0RUZnUVVDVEc2ODJSay9kMysKWGtHa0VMakRFMjI4ZjNnd0VBWUpLd1lCQkFHQ054VUJCQU1DQVFBd0RRWUpLb1pJaHZjTkFRRUxCUUFEZ2dFQgpBR1RjTTNnWExIU05wS014RHEvUFpZbWZCMmNlN3VhMmxxbXpzZSt4QmthSTE0WXdzZE5ZQjZBVTNFWDM3QWpZCjd3bm9xQzY1N0U2RVhTODVDckoyNXJNTHo4OEtONGI3cUg5RUowSS9XVHg5YTdUT0ZENENWQThuL0xwNGh1Ym4KNlBFalY5NFlZWXBXTG1hTkkvbGFReWsxSHVJbDFSTCttVDFnSWQ4ZWZXZ1UvNmlVVEw3eGMrdjkyNHBuTHhISwpOSnNTV3c0NFk5a0R5SU9KOXFjWUlBN1lhTkxPZTRjSysvQlRvdDh0dVVKT1hHLzdBRmtxR2EyQVA4MmFZOStKCnkwSmU2OG5nTHJ1dVU4VHpneVpqdkFHcTRrVEVOdWFoaFdHVC9KWkEzOXhSNUV4MmNMUUplcE5NdnlZbUZ3Z1UKME8zYlA0OWNBVFVCMXoyQ3Y5aTRQbVk9Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K"
+ },
+ "aesEncryption": {
+ "type": "boolean",
+ "description": "If enabled, AES encryption will be enabled for SMB communication."
+ },
+ "ldapSigning": {
+ "type": "boolean",
+ "description": "Specifies whether or not the LDAP traffic needs to be signed."
+ },
+ "securityOperators": {
+ "type": "array",
+ "description": "Domain Users in the Active directory to be given SeSecurityPrivilege privilege (Needed for SMB Continuously available shares for SQL). A list of unique usernames without domain specifier",
+ "items": {
+ "type": "string",
+ "maxLength": 255,
+ "minLength": 1,
+ "example": [
+ "user1",
+ "user2"
+ ]
+ }
+ },
+ "ldapOverTLS": {
+ "type": "boolean",
+ "description": "Specifies whether or not the LDAP traffic needs to be secured via TLS."
+ }
+ }
+ },
+ "accountEncryption": {
+ "type": "object",
+ "description": "Encryption settings",
+ "properties": {
+ "keySource": {
+ "type": "string",
+ "description": "Encryption Key Source. Possible values are: 'Microsoft.NetApp'.",
+ "enum": [
+ "Microsoft.NetApp"
+ ],
+ "x-ms-enum": {
+ "name": "keySource",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Microsoft.NetApp",
+ "description": "The service manages the keys."
+ }
+ ]
+ }
+ }
+ }
+ },
+ "capacityPoolList": {
+ "description": "List of capacity pool resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of Capacity pools",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/capacityPool"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of results."
+ }
+ }
+ },
+ "capacityPool": {
+ "description": "Capacity pool resource",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Capacity pool properties",
+ "$ref": "#/definitions/poolProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "poolProperties": {
+ "description": "Pool properties",
+ "type": "object",
+ "required": [
+ "size",
+ "serviceLevel"
+ ],
+ "properties": {
+ "poolId": {
+ "title": "poolId",
+ "type": "string",
+ "readOnly": true,
+ "description": "UUID v4 used to identify the Pool",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca7778"
+ },
+ "size": {
+ "title": "size",
+ "type": "integer",
+ "format": "int64",
+ "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).",
+ "minimum": 4398046511104,
+ "maximum": 549755813888000
+ },
+ "serviceLevel": {
+ "title": "serviceLevel",
+ "type": "string",
+ "description": "The service level of the file system",
+ "enum": [
+ "Standard",
+ "Premium",
+ "Ultra"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceLevel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Standard",
+ "description": "Standard service level"
+ },
+ {
+ "value": "Premium",
+ "description": "Premium service level"
+ },
+ {
+ "value": "Ultra",
+ "description": "Ultra service level"
+ }
+ ]
+ },
+ "example": "Ultra",
+ "default": "Premium"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "totalThroughputMibps": {
+ "type": "number",
+ "description": "Total throughput of pool in Mibps",
+ "example": 164.221,
+ "readOnly": true
+ },
+ "utilizedThroughputMibps": {
+ "type": "number",
+ "description": "Utilized throughput of pool in Mibps",
+ "example": 164.221,
+ "readOnly": true
+ },
+ "qosType": {
+ "title": "qosType",
+ "type": "string",
+ "description": "The qos type of the pool",
+ "enum": [
+ "Auto",
+ "Manual"
+ ],
+ "x-ms-enum": {
+ "name": "qosType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Auto",
+ "description": "qos type Auto"
+ },
+ {
+ "value": "Manual",
+ "description": "qos type Manual"
+ }
+ ]
+ },
+ "example": "Manual",
+ "default": "Auto"
+ }
+ }
+ },
+ "capacityPoolPatch": {
+ "description": "Capacity pool patch resource",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Capacity pool properties",
+ "$ref": "#/definitions/poolPatchProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "poolPatchProperties": {
+ "description": "Patchable pool properties",
+ "type": "object",
+ "properties": {
+ "size": {
+ "title": "size",
+ "type": "integer",
+ "format": "int64",
+ "description": "Provisioned size of the pool (in bytes). Allowed values are in 4TiB chunks (value must be multiply of 4398046511104).",
+ "minimum": 4398046511104,
+ "maximum": 549755813888000,
+ "default": 4398046511104
+ },
+ "qosType": {
+ "title": "qosType",
+ "type": "string",
+ "description": "The qos type of the pool",
+ "enum": [
+ "Auto",
+ "Manual"
+ ],
+ "x-ms-enum": {
+ "name": "qosType",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Auto",
+ "description": "qos type Auto"
+ },
+ {
+ "value": "Manual",
+ "description": "qos type Manual"
+ }
+ ]
+ },
+ "example": "Manual",
+ "default": "Auto"
+ }
+ }
+ },
+ "volumeList": {
+ "description": "List of volume resources",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of volumes",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/volume"
+ }
+ },
+ "nextLink": {
+ "type": "string",
+ "description": "URL to get the next set of results."
+ }
+ }
+ },
+ "volume": {
+ "description": "Volume resource",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Volume properties",
+ "$ref": "#/definitions/volumeProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "resourceTags": {
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Tags are a list of key-value pairs that describe the resource"
+ },
+ "volumeProperties": {
+ "description": "Volume properties",
+ "type": "object",
+ "required": [
+ "creationToken",
+ "usageThreshold",
+ "subnetId"
+ ],
+ "properties": {
+ "fileSystemId": {
+ "title": "FileSystem ID",
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique FileSystem Identifier.",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca7778"
+ },
+ "creationToken": {
+ "title": "Creation Token or File Path",
+ "type": "string",
+ "description": "A unique file path for the volume. Used when creating mount targets",
+ "pattern": "^[a-zA-Z][a-zA-Z0-9\\-]{0,79}$",
+ "minLength": 1,
+ "maxLength": 80,
+ "example": "some-amazing-filepath"
+ },
+ "serviceLevel": {
+ "title": "serviceLevel",
+ "type": "string",
+ "description": "The service level of the file system",
+ "enum": [
+ "Standard",
+ "Premium",
+ "Ultra"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceLevel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Standard",
+ "description": "Standard service level"
+ },
+ {
+ "value": "Premium",
+ "description": "Premium service level"
+ },
+ {
+ "value": "Ultra",
+ "description": "Ultra service level"
+ }
+ ]
+ },
+ "example": "Ultra",
+ "default": "Premium"
+ },
+ "usageThreshold": {
+ "title": "usageThreshold",
+ "type": "integer",
+ "format": "int64",
+ "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes.",
+ "minimum": 107374182400,
+ "maximum": 109951162777600,
+ "default": 107374182400,
+ "example": 107374182400
+ },
+ "exportPolicy": {
+ "title": "exportPolicy",
+ "description": "Set of export policy rules",
+ "properties": {
+ "rules": {
+ "title": "Export policy rule",
+ "description": "Export policy rule",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/exportPolicyRule"
+ }
+ }
+ }
+ },
+ "protocolTypes": {
+ "title": "protocolTypes",
+ "description": "Set of protocol types, default NFSv3, CIFS fro SMB protocol",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "example": [
+ [
+ "NFSv4.1"
+ ]
+ ]
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "snapshotId": {
+ "title": "Snapshot ID",
+ "type": "string",
+ "x-nullable": true,
+ "description": "UUID v4 or resource identifier used to identify the Snapshot.",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|(\\\\?([^\\/]*[\\/])*)([^\\/]+)$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca3333"
+ },
+ "backupId": {
+ "title": "Backup ID",
+ "type": "string",
+ "description": "UUID v4 or resource identifier used to identify the Backup.",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}|(\\\\?([^\\/]*[\\/])*)([^\\/]+)$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca3333"
+ },
+ "baremetalTenantId": {
+ "title": "Baremetal Tenant ID",
+ "type": "string",
+ "readOnly": true,
+ "description": "Unique Baremetal Tenant Identifier.",
+ "example": "9560acf5-4e3a-12e7-9bdb-02007cca7779"
+ },
+ "subnetId": {
+ "type": "string",
+ "description": "The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes"
+ },
+ "mountTargets": {
+ "title": "mountTargets",
+ "type": "array",
+ "readOnly": true,
+ "description": "List of mount targets",
+ "items": {
+ "$ref": "#/definitions/mountTargetProperties"
+ }
+ },
+ "volumeType": {
+ "type": "string",
+ "description": "What type of volume is this",
+ "example": "DataProtection"
+ },
+ "dataProtection": {
+ "title": "DataProtection",
+ "description": "DataProtection type volumes include an object containing details of the replication",
+ "properties": {
+ "backup": {
+ "title": "Backup",
+ "description": "Backup Properties",
+ "type": "object",
+ "$ref": "#/definitions/volumeBackupProperties"
+ },
+ "replication": {
+ "title": "Replication",
+ "description": "Replication properties",
+ "type": "object",
+ "$ref": "#/definitions/replicationObject"
+ },
+ "snapshot": {
+ "title": "Snapshot",
+ "description": "Snapshot properties.",
+ "$ref": "#/definitions/volumeSnapshotProperties"
+ }
+ }
+ },
+ "isRestoring": {
+ "type": "boolean",
+ "description": "Restoring"
+ },
+ "snapshotDirectoryVisible": {
+ "type": "boolean",
+ "default": true,
+ "description": "If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (default to true)."
+ },
+ "kerberosEnabled": {
+ "type": "boolean",
+ "description": "Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later",
+ "example": false,
+ "default": false
+ },
+ "securityStyle": {
+ "type": "string",
+ "description": "The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol",
+ "default": "unix",
+ "enum": [
+ "ntfs",
+ "unix"
+ ],
+ "x-ms-enum": {
+ "name": "SecurityStyle",
+ "modelAsString": true
+ }
+ },
+ "smbEncryption": {
+ "type": "boolean",
+ "description": "Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later",
+ "example": false,
+ "default": false
+ },
+ "smbContinuouslyAvailable": {
+ "type": "boolean",
+ "description": "Enables continuously available share property for smb volume. Only applicable for SMB volume",
+ "example": false,
+ "default": false
+ },
+ "throughputMibps": {
+ "title": "Maximum throughput in Mibps that can be achieved by this volume",
+ "type": "number",
+ "default": 0.0,
+ "example": 128.22,
+ "maximum": 4500,
+ "minimum": 0,
+ "multipleOf": 0.001
+ },
+ "encryptionKeySource": {
+ "description": "Encryption Key Source. Possible values are: 'Microsoft.NetApp'",
+ "type": "string"
+ }
+ }
+ },
+ "exportPolicyRule": {
+ "description": "Volume Export Policy Rule",
+ "type": "object",
+ "properties": {
+ "ruleIndex": {
+ "type": "integer",
+ "description": "Order index",
+ "format": "int32"
+ },
+ "unixReadOnly": {
+ "type": "boolean",
+ "description": "Read only access"
+ },
+ "unixReadWrite": {
+ "type": "boolean",
+ "description": "Read and write access"
+ },
+ "kerberos5ReadOnly": {
+ "type": "boolean",
+ "description": "Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later",
+ "example": false,
+ "default": false
+ },
+ "kerberos5ReadWrite": {
+ "type": "boolean",
+ "description": "Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later",
+ "example": true,
+ "default": false
+ },
+ "kerberos5iReadOnly": {
+ "type": "boolean",
+ "description": "Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later",
+ "example": false,
+ "default": false
+ },
+ "kerberos5iReadWrite": {
+ "type": "boolean",
+ "description": "Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later",
+ "example": true,
+ "default": false
+ },
+ "kerberos5pReadOnly": {
+ "type": "boolean",
+ "description": "Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later",
+ "example": false,
+ "default": false
+ },
+ "kerberos5pReadWrite": {
+ "type": "boolean",
+ "description": "Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later",
+ "example": true,
+ "default": false
+ },
+ "cifs": {
+ "type": "boolean",
+ "description": "Allows CIFS protocol"
+ },
+ "nfsv3": {
+ "type": "boolean",
+ "description": "Allows NFSv3 protocol. Enable only for NFSv3 type volumes"
+ },
+ "nfsv41": {
+ "type": "boolean",
+ "description": "Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes"
+ },
+ "allowedClients": {
+ "type": "string",
+ "description": "Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names"
+ },
+ "hasRootAccess": {
+ "type": "boolean",
+ "description": "Has root access to volume",
+ "example": true,
+ "default": true
+ }
+ }
+ },
+ "volumeBackupProperties": {
+ "description": "Volume Backup Properties",
+ "type": "object",
+ "properties": {
+ "backupPolicyId": {
+ "type": "string",
+ "description": "Backup Policy Resource ID"
+ },
+ "policyEnforced": {
+ "type": "boolean",
+ "description": "Policy Enforced"
+ },
+ "vaultId": {
+ "type": "string",
+ "description": "Vault Resource ID"
+ },
+ "backupEnabled": {
+ "type": "boolean",
+ "description": "Backup Enabled"
+ }
+ }
+ },
+ "replicationObject": {
+ "description": "Replication properties",
+ "type": "object",
+ "required": [
+ "replicationSchedule",
+ "remoteVolumeResourceId"
+ ],
+ "properties": {
+ "replicationId": {
+ "type": "string",
+ "description": "Id"
+ },
+ "endpointType": {
+ "type": "string",
+ "description": "Indicates whether the local volume is the source or destination for the Volume Replication",
+ "enum": [
+ "src",
+ "dst"
+ ],
+ "x-ms-enum": {
+ "name": "EndpointType",
+ "modelAsString": true
+ }
+ },
+ "replicationSchedule": {
+ "type": "string",
+ "description": "Schedule",
+ "enum": [
+ "_10minutely",
+ "hourly",
+ "daily"
+ ],
+ "x-ms-enum": {
+ "name": "ReplicationSchedule",
+ "modelAsString": true
+ }
+ },
+ "remoteVolumeResourceId": {
+ "type": "string",
+ "description": "The resource ID of the remote volume."
+ },
+ "remoteVolumeRegion": {
+ "type": "string",
+ "description": "The remote region for the other end of the Volume Replication."
+ }
+ }
+ },
+ "volumeSnapshotProperties": {
+ "description": "Volume Snapshot Properties",
+ "type": "object",
+ "properties": {
+ "snapshotPolicyId": {
+ "type": "string",
+ "description": "Snapshot Policy ResourceId"
+ }
+ }
+ },
+ "replicationStatus": {
+ "description": "Replication status",
+ "type": "object",
+ "properties": {
+ "healthy": {
+ "type": "boolean",
+ "description": "Replication health check"
+ },
+ "relationshipStatus": {
+ "type": "string",
+ "description": "Status of the mirror relationship",
+ "enum": [
+ "Idle",
+ "Transferring"
+ ],
+ "x-ms-enum": {
+ "name": "RelationshipStatus",
+ "modelAsString": true
+ }
+ },
+ "mirrorState": {
+ "type": "string",
+ "description": "The status of the replication",
+ "enum": [
+ "Uninitialized",
+ "Mirrored",
+ "Broken"
+ ],
+ "x-ms-enum": {
+ "name": "MirrorState",
+ "modelAsString": true
+ }
+ },
+ "totalProgress": {
+ "type": "string",
+ "description": "The progress of the replication"
+ },
+ "errorMessage": {
+ "type": "string",
+ "description": "Displays error message if the replication is in an error state"
+ }
+ }
+ },
+ "volumePatch": {
+ "description": "Volume patch resource",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Patchable volume properties",
+ "$ref": "#/definitions/volumePatchProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "volumePatchProperties": {
+ "description": "Patchable volume properties",
+ "type": "object",
+ "properties": {
+ "serviceLevel": {
+ "title": "serviceLevel",
+ "type": "string",
+ "description": "The service level of the file system",
+ "enum": [
+ "Standard",
+ "Premium",
+ "Ultra"
+ ],
+ "x-ms-enum": {
+ "name": "ServiceLevel",
+ "modelAsString": true,
+ "values": [
+ {
+ "value": "Standard",
+ "description": "Standard service level"
+ },
+ {
+ "value": "Premium",
+ "description": "Premium service level"
+ },
+ {
+ "value": "Ultra",
+ "description": "Ultra service level"
+ }
+ ]
+ },
+ "example": "Ultra",
+ "default": "Premium"
+ },
+ "usageThreshold": {
+ "title": "usageThreshold",
+ "type": "integer",
+ "format": "int64",
+ "description": "Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. Minimum size is 100 GiB. Upper limit is 100TiB. Specified in bytes.",
+ "minimum": 107374182400,
+ "maximum": 109951162777600,
+ "default": 107374182400,
+ "example": 107374182400
+ },
+ "exportPolicy": {
+ "title": "exportPolicy",
+ "description": "Set of export policy rules",
+ "properties": {
+ "rules": {
+ "title": "Export policy rule",
+ "description": "Export policy rule",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/exportPolicyRule"
+ }
+ }
+ }
+ },
+ "throughputMibps": {
+ "title": "Maximum throughput in Mibps that can be achieved by this volume",
+ "type": "number",
+ "example": "128.22",
+ "maximum": 4500,
+ "minimum": 1,
+ "multipleOf": 0.001
+ },
+ "dataProtection": {
+ "title": "DataProtection",
+ "description": "DataProtection type volumes include an object containing details of the replication",
+ "properties": {
+ "backup": {
+ "title": "Backup",
+ "description": "Backup Properties",
+ "type": "object",
+ "$ref": "#/definitions/volumeBackupProperties"
+ }
+ }
+ }
+ }
+ },
+ "mountTarget": {
+ "description": "Mount Target",
+ "type": "object",
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags",
+ "x-ms-client-flatten": true
+ },
+ "properties": {
+ "description": "Mount Target Properties",
+ "$ref": "#/definitions/mountTargetProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "mountTargetProperties": {
+ "description": "Mount target properties",
+ "type": "object",
+ "required": [
+ "fileSystemId"
+ ],
+ "properties": {
+ "mountTargetId": {
+ "title": "mountTargetId",
+ "type": "string",
+ "readOnly": true,
+ "description": "UUID v4 used to identify the MountTarget",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca3333"
+ },
+ "fileSystemId": {
+ "title": "fileSystemId",
+ "type": "string",
+ "description": "UUID v4 used to identify the MountTarget",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca3333"
+ },
+ "ipAddress": {
+ "title": "ipAddress",
+ "description": "The mount target's IPv4 address",
+ "type": "string",
+ "readOnly": true,
+ "example": "1.2.3.4"
+ },
+ "smbServerFqdn": {
+ "title": "smbServerFQDN",
+ "description": "The SMB server's Fully Qualified Domain Name, FQDN",
+ "type": "string",
+ "example": "fullyqualified.domainname.com"
+ }
+ }
+ },
+ "snapshotsList": {
+ "description": "List of Snapshots",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A list of Snapshots",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/snapshot"
+ }
+ }
+ }
+ },
+ "snapshot": {
+ "description": "Snapshot of a Volume",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "properties": {
+ "description": "Snapshot Properties",
+ "$ref": "#/definitions/snapshotProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "snapshotPatch": {
+ "description": "Snapshot patch",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {}
+ },
+ "snapshotProperties": {
+ "description": "Snapshot properties",
+ "type": "object",
+ "properties": {
+ "snapshotId": {
+ "title": "snapshotId",
+ "type": "string",
+ "readOnly": true,
+ "description": "UUID v4 used to identify the Snapshot",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca3333"
+ },
+ "created": {
+ "title": "name",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The creation date of the snapshot",
+ "example": "2017-08-15 13:23:33"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ }
+ }
+ },
+ "snapshotPolicyProperties": {
+ "description": "Snapshot policy properties",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Snapshot policy name"
+ },
+ "hourlySchedule": {
+ "title": "hourlySchedule",
+ "description": "Schedule for hourly snapshots",
+ "type": "object",
+ "$ref": "#/definitions/hourlySchedule"
+ },
+ "dailySchedule": {
+ "title": "dailySchedule",
+ "description": "Schedule for daily snapshots",
+ "type": "object",
+ "$ref": "#/definitions/dailySchedule"
+ },
+ "weeklySchedule": {
+ "title": "weeklySchedule",
+ "description": "Schedule for weekly snapshots",
+ "type": "object",
+ "$ref": "#/definitions/weeklySchedule"
+ },
+ "monthlySchedule": {
+ "title": "monthlySchedule",
+ "description": "Schedule for monthly snapshots",
+ "type": "object",
+ "$ref": "#/definitions/monthlySchedule"
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "The property to decide policy is enabled or not"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ }
+ }
+ },
+ "snapshotPolicy": {
+ "description": "Snapshot policy information",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Snapshot policy Properties",
+ "$ref": "#/definitions/snapshotPolicyProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "snapshotPoliciesList": {
+ "description": "List of Snapshot Policies",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A list of snapshot policies",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/snapshotPolicy"
+ }
+ }
+ }
+ },
+ "snapshotPolicyDetails": {
+ "description": "Snapshot policy properties",
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Snapshot policy Properties",
+ "$ref": "#/definitions/snapshotPolicyProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "snapshotPolicyPatch": {
+ "description": "Snapshot policy Details for create and update",
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location"
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Snapshot Policy properties",
+ "$ref": "#/definitions/snapshotPolicyProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "snapshotPolicyVolumeList": {
+ "description": "Volumes associated with snapshot policy",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "List of volumes",
+ "type": "array",
+ "items": {
+ "type": "object",
+ "readOnly": true,
+ "description": "Associated volume resource Id"
+ }
+ }
+ }
+ },
+ "hourlySchedule": {
+ "description": "Hourly Schedule properties",
+ "type": "object",
+ "properties": {
+ "snapshotsToKeep": {
+ "type": "integer",
+ "description": "Hourly snapshot count to keep",
+ "format": "int32"
+ },
+ "minute": {
+ "type": "integer",
+ "description": "Indicates which minute snapshot should be taken",
+ "example": 30,
+ "format": "int32"
+ },
+ "usedBytes": {
+ "type": "integer",
+ "description": "Resource size in bytes, current storage usage for the volume in bytes",
+ "format": "int64"
+ }
+ }
+ },
+ "dailySchedule": {
+ "description": "Daily Schedule properties",
+ "type": "object",
+ "properties": {
+ "snapshotsToKeep": {
+ "type": "integer",
+ "description": "Daily snapshot count to keep",
+ "format": "int32"
+ },
+ "hour": {
+ "type": "integer",
+ "description": "Indicates which hour in UTC timezone a snapshot should be taken",
+ "example": 11,
+ "format": "int32"
+ },
+ "minute": {
+ "type": "integer",
+ "description": "Indicates which minute snapshot should be taken",
+ "example": 30,
+ "format": "int32"
+ },
+ "usedBytes": {
+ "type": "integer",
+ "description": "Resource size in bytes, current storage usage for the volume in bytes",
+ "format": "int64"
+ }
+ }
+ },
+ "weeklySchedule": {
+ "description": "Weekly Schedule properties, make a snapshot every week at a specific day or days",
+ "type": "object",
+ "properties": {
+ "snapshotsToKeep": {
+ "type": "integer",
+ "description": "Weekly snapshot count to keep",
+ "format": "int32"
+ },
+ "day": {
+ "type": "string",
+ "description": "Indicates which weekdays snapshot should be taken, accepts a comma separated list of week day names in english",
+ "example": "Sunday,Monday"
+ },
+ "hour": {
+ "type": "integer",
+ "description": "Indicates which hour in UTC timezone a snapshot should be taken",
+ "example": 11,
+ "format": "int32"
+ },
+ "minute": {
+ "type": "integer",
+ "description": "Indicates which minute snapshot should be taken",
+ "example": 30,
+ "format": "int32"
+ },
+ "usedBytes": {
+ "type": "integer",
+ "description": "Resource size in bytes, current storage usage for the volume in bytes",
+ "format": "int64"
+ }
+ }
+ },
+ "monthlySchedule": {
+ "description": "Monthly Schedule properties",
+ "type": "object",
+ "properties": {
+ "snapshotsToKeep": {
+ "type": "integer",
+ "description": "Monthly snapshot count to keep",
+ "format": "int32"
+ },
+ "daysOfMonth": {
+ "type": "string",
+ "description": "Indicates which days of the month snapshot should be taken. A comma delimited string.",
+ "example": "1,11,21"
+ },
+ "hour": {
+ "type": "integer",
+ "description": "Indicates which hour in UTC timezone a snapshot should be taken",
+ "example": 11,
+ "format": "int32"
+ },
+ "minute": {
+ "type": "integer",
+ "description": "Indicates which minute snapshot should be taken",
+ "example": 30,
+ "format": "int32"
+ },
+ "usedBytes": {
+ "type": "integer",
+ "description": "Resource size in bytes, current storage usage for the volume in bytes",
+ "format": "int64"
+ }
+ }
+ },
+ "volumeRevert": {
+ "description": "revert a volume to the snapshot",
+ "type": "object",
+ "properties": {
+ "snapshotId": {
+ "type": "string",
+ "description": "Resource id of the snapshot"
+ }
+ }
+ },
+ "authorizeRequest": {
+ "description": "Authorize request",
+ "type": "object",
+ "properties": {
+ "remoteVolumeResourceId": {
+ "type": "string",
+ "description": "Resource id of the remote volume"
+ }
+ }
+ },
+ "breakReplicationRequest": {
+ "description": "Break replication request",
+ "type": "object",
+ "properties": {
+ "forceBreakReplication": {
+ "type": "boolean",
+ "description": "If replication is in status transferring and you want to force break the replication, set to true"
+ }
+ }
+ },
+ "poolChangeRequest": {
+ "description": "Pool change request",
+ "type": "object",
+ "required": [
+ "newPoolResourceId"
+ ],
+ "properties": {
+ "newPoolResourceId": {
+ "type": "string",
+ "description": "Resource id of the pool to move volume to"
+ }
+ }
+ },
+ "backupsList": {
+ "description": "List of Backups",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A list of Backups",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/backup"
+ }
+ }
+ }
+ },
+ "backup": {
+ "description": "Backup of a Volume",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "properties": {
+ "description": "Backup Properties",
+ "$ref": "#/definitions/backupProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "backupPatch": {
+ "description": "Backup patch",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Backup Properties",
+ "$ref": "#/definitions/backupProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "backupProperties": {
+ "description": "Backup properties",
+ "type": "object",
+ "properties": {
+ "backupId": {
+ "title": "backupId",
+ "type": "string",
+ "readOnly": true,
+ "description": "UUID v4 used to identify the Backup",
+ "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$",
+ "maxLength": 36,
+ "minLength": 36,
+ "example": "9760acf5-4638-11e7-9bdb-020073ca3333"
+ },
+ "creationDate": {
+ "title": "name",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true,
+ "description": "The creation date of the backup",
+ "example": "2017-08-15 13:23:33"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "size": {
+ "type": "integer",
+ "readOnly": true,
+ "description": "Size of backup",
+ "format": "int64"
+ },
+ "label": {
+ "type": "string",
+ "description": "Label for backup"
+ },
+ "backupType": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Type of backup adhoc or scheduled"
+ },
+ "failureReason": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Failure reason"
+ }
+ }
+ },
+ "backupPolicyProperties": {
+ "description": "Backup policy properties",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Name of backup policy"
+ },
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Azure lifecycle management"
+ },
+ "dailyBackupsToKeep": {
+ "type": "integer",
+ "description": "Daily backups count to keep",
+ "format": "int32"
+ },
+ "weeklyBackupsToKeep": {
+ "type": "integer",
+ "description": "Weekly backups count to keep",
+ "format": "int32"
+ },
+ "monthlyBackupsToKeep": {
+ "type": "integer",
+ "description": "Monthly backups count to keep",
+ "format": "int32"
+ },
+ "yearlyBackupsToKeep": {
+ "type": "integer",
+ "description": "Yearly backups count to keep",
+ "format": "int32"
+ },
+ "volumesAssigned": {
+ "type": "integer",
+ "description": "Volumes using current backup policy",
+ "format": "int32"
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "The property to decide policy is enabled or not"
+ },
+ "volumeBackups": {
+ "description": "A list of volumes assigned to this policy",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/volumeBackups"
+ }
+ }
+ }
+ },
+ "backupPolicy": {
+ "description": "Backup policy information",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Backup policy Properties",
+ "$ref": "#/definitions/backupPolicyProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "backupPoliciesList": {
+ "description": "List of Backup Policies",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A list of backup policies",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/backupPolicy"
+ }
+ }
+ }
+ },
+ "backupPolicyDetails": {
+ "description": "Backup policy properties",
+ "x-ms-azure-resource": true,
+ "type": "object",
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Backup policy Properties",
+ "$ref": "#/definitions/backupPolicyProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "backupPolicyPatch": {
+ "description": "Backup policy Details for create and update",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "tags": {
+ "description": "Resource tags",
+ "$ref": "#/definitions/resourceTags"
+ },
+ "properties": {
+ "description": "Backup policy Properties",
+ "$ref": "#/definitions/backupPolicyProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "volumeBackups": {
+ "description": "Volume details using the backup policy",
+ "type": "object",
+ "readOnly": true,
+ "properties": {
+ "volumeName": {
+ "type": "string",
+ "description": "Volume name"
+ },
+ "backupsCount": {
+ "type": "integer",
+ "description": "Total count of backups for volume",
+ "format": "int32"
+ },
+ "policyEnabled": {
+ "type": "boolean",
+ "description": "Policy enabled"
+ }
+ }
+ },
+ "vaultList": {
+ "description": "List of Vaults",
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "A list of vaults",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/vault"
+ }
+ }
+ }
+ },
+ "vault": {
+ "description": "Vault information",
+ "type": "object",
+ "x-ms-azure-resource": true,
+ "required": [
+ "location",
+ "properties"
+ ],
+ "properties": {
+ "location": {
+ "type": "string",
+ "description": "Resource location",
+ "x-ms-mutability": [
+ "read",
+ "create"
+ ]
+ },
+ "id": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource Id"
+ },
+ "name": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource name"
+ },
+ "type": {
+ "type": "string",
+ "readOnly": true,
+ "description": "Resource type"
+ },
+ "properties": {
+ "description": "Vault Properties",
+ "$ref": "#/definitions/vaultProperties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "vaultProperties": {
+ "description": "Vault properties",
+ "type": "object",
+ "properties": {
+ "vaultName": {
+ "type": "string",
+ "readOnly": false,
+ "description": "Vault Name"
+ }
+ }
+ },
+ "cloudError": {
+ "x-ms-external": true,
+ "properties": {
+ "error": {
+ "$ref": "#/definitions/cloudErrorBody",
+ "description": "Cloud error body."
+ }
+ },
+ "description": "An error response from the service."
+ },
+ "cloudErrorBody": {
+ "x-ms-external": true,
+ "properties": {
+ "code": {
+ "type": "string",
+ "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
+ },
+ "message": {
+ "type": "string",
+ "description": "A message describing the error, intended to be suitable for display in a user interface."
+ }
+ },
+ "description": "An error response from the service."
+ }
+ },
+ "parameters": {
+ "SubscriptionId": {
+ "name": "subscriptionId",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
+ },
+ "location": {
+ "name": "location",
+ "description": "The location",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "x-ms-parameter-location": "method"
+ },
+ "ResourceGroup": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "The name of the resource group.",
+ "pattern": "^[-\\w\\._\\(\\)]+$",
+ "minLength": 1,
+ "maxLength": 90,
+ "x-ms-parameter-location": "method"
+ },
+ "AccountName": {
+ "name": "accountName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "description": "The name of the NetApp account",
+ "x-ms-parameter-location": "method"
+ },
+ "PoolName": {
+ "name": "poolName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "pattern": "^[a-zA-Z0-9][a-zA-Z0-9\\-_]{0,63}$",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The name of the capacity pool",
+ "x-ms-parameter-location": "method"
+ },
+ "VolumeName": {
+ "name": "volumeName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "pattern": "^[a-zA-Z][a-zA-Z0-9\\-_]{0,63}$",
+ "minLength": 1,
+ "maxLength": 64,
+ "description": "The name of the volume",
+ "x-ms-parameter-location": "method"
+ },
+ "MountTargetName": {
+ "name": "mountTargetName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "description": "The name of the mount target",
+ "x-ms-parameter-location": "method"
+ },
+ "SnapshotName": {
+ "name": "snapshotName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "description": "The name of the mount target",
+ "x-ms-parameter-location": "method"
+ },
+ "SnapshotPolicyName": {
+ "name": "snapshotPolicyName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "description": "The name of the snapshot policy target",
+ "x-ms-parameter-location": "method"
+ },
+ "BackupName": {
+ "name": "backupName",
+ "type": "string",
+ "in": "path",
+ "required": true,
+ "description": "The name of the backup",
+ "x-ms-parameter-location": "method"
+ },
+ "BackupPolicyName": {
+ "name": "backupPolicyName",
+ "in": "path",
+ "required": true,
+ "type": "string",
+ "description": "Backup policy Name which uniquely identify backup policy.",
+ "x-ms-parameter-location": "method"
+ },
+ "ApiVersionParameter": {
+ "name": "api-version",
+ "description": "Version of the API to be used with the client request.",
+ "in": "query",
+ "type": "string",
+ "required": true,
+ "default": "2020-11-01"
+ }
+ }
+}
diff --git a/specification/netapp/resource-manager/readme.azureresourceschema.md b/specification/netapp/resource-manager/readme.azureresourceschema.md
index ffd7b58e2af3..2db1251b5577 100644
--- a/specification/netapp/resource-manager/readme.azureresourceschema.md
+++ b/specification/netapp/resource-manager/readme.azureresourceschema.md
@@ -6,10 +6,13 @@ These settings apply only when `--azureresourceschema` is specified on the comma
``` yaml $(azureresourceschema) && $(multiapi)
batch:
+ - tag: schema-netapp-2020-11-01
- tag: schema-netapp-2020-09-01
- tag: schema-netapp-2020-08-01
- - tag: schema-netapp-2020-07-01
+ - tag: schema-netapp-2020-07-01
- tag: schema-netapp-2020-06-01
+ - tag: schema-netapp-2020-05-01
+ - tag: schema-netapp-2020-03-01
- tag: schema-netapp-2020-02-01
- tag: schema-netapp-2019-11-01
- tag: schema-netapp-2019-10-01
@@ -23,6 +26,17 @@ batch:
Please also specify `--azureresourceschema-folder=true if the certificate should be automatically renewed when it expires; otherwise, false.",
+ "default": true,
+ "type": "boolean"
+ },
+ "provisioningState": {
+ "description": "Status of certificate order.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false
+ }
+ },
+ "status": {
+ "description": "Current order status.",
+ "enum": [
+ "Pendingissuance",
+ "Issued",
+ "Revoked",
+ "Canceled",
+ "Denied",
+ "Pendingrevocation",
+ "PendingRekey",
+ "Unused",
+ "Expired",
+ "NotSubmitted"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CertificateOrderStatus",
+ "modelAsString": false
+ }
+ },
+ "signedCertificate": {
+ "$ref": "#/definitions/CertificateDetails",
+ "description": "Signed certificate.",
+ "readOnly": true
+ },
+ "csr": {
+ "description": "Last CSR that was created for this order.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "intermediate": {
+ "$ref": "#/definitions/CertificateDetails",
+ "description": "Intermediate certificate.",
+ "readOnly": true
+ },
+ "root": {
+ "$ref": "#/definitions/CertificateDetails",
+ "description": "Root certificate.",
+ "readOnly": true
+ },
+ "serialNumber": {
+ "description": "Current serial number of the certificate.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastCertificateIssuanceTime": {
+ "format": "date-time",
+ "description": "Certificate last issuance time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "expirationTime": {
+ "format": "date-time",
+ "description": "Certificate expiration time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isPrivateKeyExternal": {
+ "description": "true if private key is external; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "appServiceCertificateNotRenewableReasons": {
+ "description": "Reasons why App Service Certificate is not renewable at the current moment.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "RegistrationStatusNotSupportedForRenewal",
+ "ExpirationNotInRenewalTimeRange",
+ "SubscriptionNotActive"
+ ],
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "nextAutoRenewalTimeStamp": {
+ "format": "date-time",
+ "description": "Time stamp when the certificate would be auto renewed next",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AppServiceCertificateOrderCollection": {
+ "description": "Collection of certificate orders.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AppServiceCertificateOrder"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "AppServiceCertificateOrderPatchResource": {
+ "description": "ARM resource for a certificate order that is purchased through Azure.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AppServiceCertificateOrderPatchResource resource specific properties",
+ "required": [
+ "productType"
+ ],
+ "properties": {
+ "certificates": {
+ "description": "State of the Key Vault secret.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/AppServiceCertificate"
+ }
+ },
+ "distinguishedName": {
+ "description": "Certificate distinguished name.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "domainVerificationToken": {
+ "description": "Domain verification token.",
+ "type": "string",
+ "readOnly": true
+ },
+ "validityInYears": {
+ "format": "int32",
+ "description": "Duration in years (must be between 1 and 3).",
+ "default": 1,
+ "maximum": 3,
+ "minimum": 1,
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "keySize": {
+ "format": "int32",
+ "description": "Certificate key size.",
+ "default": 2048,
+ "type": "integer",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "productType": {
+ "description": "Certificate product type.",
+ "enum": [
+ "StandardDomainValidatedSsl",
+ "StandardDomainValidatedWildCardSsl"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CertificateProductType",
+ "modelAsString": false
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "autoRenew": {
+ "description": "true if the certificate should be automatically renewed when it expires; otherwise, false.",
+ "default": true,
+ "type": "boolean"
+ },
+ "provisioningState": {
+ "description": "Status of certificate order.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false
+ }
+ },
+ "status": {
+ "description": "Current order status.",
+ "enum": [
+ "Pendingissuance",
+ "Issued",
+ "Revoked",
+ "Canceled",
+ "Denied",
+ "Pendingrevocation",
+ "PendingRekey",
+ "Unused",
+ "Expired",
+ "NotSubmitted"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CertificateOrderStatus",
+ "modelAsString": false
+ }
+ },
+ "signedCertificate": {
+ "$ref": "#/definitions/CertificateDetails",
+ "description": "Signed certificate.",
+ "readOnly": true
+ },
+ "csr": {
+ "description": "Last CSR that was created for this order.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "intermediate": {
+ "$ref": "#/definitions/CertificateDetails",
+ "description": "Intermediate certificate.",
+ "readOnly": true
+ },
+ "root": {
+ "$ref": "#/definitions/CertificateDetails",
+ "description": "Root certificate.",
+ "readOnly": true
+ },
+ "serialNumber": {
+ "description": "Current serial number of the certificate.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastCertificateIssuanceTime": {
+ "format": "date-time",
+ "description": "Certificate last issuance time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "expirationTime": {
+ "format": "date-time",
+ "description": "Certificate expiration time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "isPrivateKeyExternal": {
+ "description": "true if private key is external; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "appServiceCertificateNotRenewableReasons": {
+ "description": "Reasons why App Service Certificate is not renewable at the current moment.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "RegistrationStatusNotSupportedForRenewal",
+ "ExpirationNotInRenewalTimeRange",
+ "SubscriptionNotActive"
+ ],
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "nextAutoRenewalTimeStamp": {
+ "format": "date-time",
+ "description": "Time stamp when the certificate would be auto renewed next",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AppServiceCertificatePatchResource": {
+ "description": "Key Vault container ARM resource for a certificate that is purchased through Azure.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AppServiceCertificate",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AppServiceCertificateResource": {
+ "description": "Key Vault container ARM resource for a certificate that is purchased through Azure.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/AppServiceCertificate",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CertificateDetails": {
+ "description": "SSL certificate details.",
+ "type": "object",
+ "properties": {
+ "version": {
+ "format": "int32",
+ "description": "Certificate Version.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "serialNumber": {
+ "description": "Certificate Serial Number.",
+ "type": "string",
+ "readOnly": true
+ },
+ "thumbprint": {
+ "description": "Certificate Thumbprint.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subject": {
+ "description": "Certificate Subject.",
+ "type": "string",
+ "readOnly": true
+ },
+ "notBefore": {
+ "format": "date-time",
+ "description": "Date Certificate is valid from.",
+ "type": "string",
+ "readOnly": true
+ },
+ "notAfter": {
+ "format": "date-time",
+ "description": "Date Certificate is valid to.",
+ "type": "string",
+ "readOnly": true
+ },
+ "signatureAlgorithm": {
+ "description": "Certificate Signature algorithm.",
+ "type": "string",
+ "readOnly": true
+ },
+ "issuer": {
+ "description": "Certificate Issuer.",
+ "type": "string",
+ "readOnly": true
+ },
+ "rawData": {
+ "description": "Raw certificate data.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CertificateEmail": {
+ "description": "SSL certificate email.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CertificateEmail resource specific properties",
+ "properties": {
+ "emailId": {
+ "description": "Email id.",
+ "type": "string"
+ },
+ "timeStamp": {
+ "format": "date-time",
+ "description": "Time stamp.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CertificateOrderAction": {
+ "description": "Certificate order action.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CertificateOrderAction resource specific properties",
+ "properties": {
+ "actionType": {
+ "description": "Action type.",
+ "enum": [
+ "CertificateIssued",
+ "CertificateOrderCanceled",
+ "CertificateOrderCreated",
+ "CertificateRevoked",
+ "DomainValidationComplete",
+ "FraudDetected",
+ "OrgNameChange",
+ "OrgValidationComplete",
+ "SanDrop",
+ "FraudCleared",
+ "CertificateExpired",
+ "CertificateExpirationWarning",
+ "FraudDocumentationRequired",
+ "Unknown"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "CertificateOrderActionType",
+ "modelAsString": false
+ }
+ },
+ "createdAt": {
+ "format": "date-time",
+ "description": "Time at which the certificate action was performed.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ReissueCertificateOrderRequest": {
+ "description": "Class representing certificate reissue request.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ReissueCertificateOrderRequest resource specific properties",
+ "properties": {
+ "keySize": {
+ "format": "int32",
+ "description": "Certificate Key Size.",
+ "type": "integer"
+ },
+ "delayExistingRevokeInHours": {
+ "format": "int32",
+ "description": "Delay in hours to revoke existing certificate after the new certificate is issued.",
+ "type": "integer"
+ },
+ "csr": {
+ "description": "Csr to be used for re-key operation.",
+ "type": "string"
+ },
+ "isPrivateKeyExternal": {
+ "description": "Should we change the ASC type (from managed private key to external private key and vice versa).",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "RenewCertificateOrderRequest": {
+ "description": "Class representing certificate renew request.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "RenewCertificateOrderRequest resource specific properties",
+ "properties": {
+ "keySize": {
+ "format": "int32",
+ "description": "Certificate Key Size.",
+ "type": "integer"
+ },
+ "csr": {
+ "description": "Csr to be used for re-key operation.",
+ "type": "string"
+ },
+ "isPrivateKeyExternal": {
+ "description": "Should we change the ASC type (from managed private key to external private key and vice versa).",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteSeal": {
+ "description": "Site seal",
+ "required": [
+ "html"
+ ],
+ "type": "object",
+ "properties": {
+ "html": {
+ "description": "HTML snippet",
+ "type": "string",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteSealRequest": {
+ "description": "Site seal request.",
+ "type": "object",
+ "properties": {
+ "lightTheme": {
+ "description": "If true use the light color theme for site seal; otherwise, use the default color theme.",
+ "type": "boolean"
+ },
+ "locale": {
+ "description": "Locale of site seal.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/CertificateRegistrationProvider.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/CertificateRegistrationProvider.json
new file mode 100644
index 000000000000..4db793e2e521
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/CertificateRegistrationProvider.json
@@ -0,0 +1,91 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "CertificateRegistrationProvider API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.CertificateRegistration/operations": {
+ "get": {
+ "tags": [
+ "CertificateRegistrationProvider"
+ ],
+ "summary": "Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider",
+ "description": "Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider",
+ "operationId": "CertificateRegistrationProvider_ListOperations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/CsmOperationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List operations": {
+ "$ref": "./examples/ListOperations.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {},
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/examples/ListOperations.json
new file mode 100644
index 000000000000..b62431c22ac5
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.CertificateRegistration/stable/2020-10-01/examples/ListOperations.json
@@ -0,0 +1,184 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/certificates/Write",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "Certificate",
+ "operation": "Add or Update Certificate",
+ "description": "Add a new certificate or update an existing one"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/Write",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Add or Update AppServiceCertificate",
+ "description": "Add a new certificateOrder or update an existing one"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/certificates/Delete",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "Certificate",
+ "operation": "Delete Certificate",
+ "description": "Delete an existing certificate"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/Delete",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Delete AppServiceCertificate",
+ "description": "Delete an existing AppServiceCertificate"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/Read",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Get CertificateOrders",
+ "description": "Get the list of CertificateOrders"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/certificates/Read",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "Certificate",
+ "operation": "Get Certificates",
+ "description": "Get the list of certificates"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/reissue/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Reissue certificateorder",
+ "description": "Reissue an existing certificateorder"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/renew/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Renew certificateorder",
+ "description": "Renew an existing certificateorder"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/retrieveCertificateActions/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Certificateorder actions",
+ "description": "Retrieve the list of certificate actions"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/retrieveEmailHistory/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Certificateorder email history",
+ "description": "Retrieve certificate email history"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/resendEmail/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Resend Certificateorder email",
+ "description": "Resend certificate email"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/verifyDomainOwnership/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Verify domain ownership",
+ "description": "Verify domain ownership"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/resendRequestEmails/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Resend request emails to another email address",
+ "description": "Resend request emails to another email address"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/certificateOrders/resendRequestEmails/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Retrieve site seal for an issued App Service Certificate",
+ "description": "Retrieve site seal for an issued App Service Certificate"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/provisionGlobalAppServicePrincipalInUserTenant/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Provision service principal",
+ "description": "Provision service principal for service app principal"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/validateCertificateRegistrationInformation/Action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "AppServiceCertificate",
+ "operation": "Certificate Purchase Info Validation",
+ "description": "Validate certificate purchase object without submitting it"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.CertificateRegistration/register/action",
+ "display": {
+ "provider": "Microsoft Certificates",
+ "resource": "Microsoft Certificates resource provider",
+ "operation": "Register Microsoft Certificates resource provider",
+ "description": "Register the Microsoft Certificates resource provider for the subscription"
+ },
+ "origin": "user,system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/DomainRegistrationProvider.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/DomainRegistrationProvider.json
new file mode 100644
index 000000000000..5cca4077139a
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/DomainRegistrationProvider.json
@@ -0,0 +1,91 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "DomainRegistrationProvider API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.DomainRegistration/operations": {
+ "get": {
+ "tags": [
+ "DomainRegistrationProvider"
+ ],
+ "summary": "Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider",
+ "description": "Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider",
+ "operationId": "DomainRegistrationProvider_ListOperations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/CsmOperationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List operations": {
+ "$ref": "./examples/ListOperations.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {},
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/Domains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/Domains.json
new file mode 100644
index 000000000000..c19c44f25853
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/Domains.json
@@ -0,0 +1,1476 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "Domains API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability": {
+ "post": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Check if a domain is available for registration.",
+ "description": "Description for Check if a domain is available for registration.",
+ "operationId": "Domains_CheckAvailability",
+ "parameters": [
+ {
+ "name": "identifier",
+ "in": "body",
+ "description": "Name of the domain.",
+ "required": true,
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/NameIdentifier"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainAvailabilityCheckResult"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains": {
+ "get": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Get all domains in a subscription.",
+ "description": "Description for Get all domains in a subscription.",
+ "operationId": "Domains_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest": {
+ "post": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Generate a single sign-on request for the domain management portal.",
+ "description": "Description for Generate a single sign-on request for the domain management portal.",
+ "operationId": "Domains_GetControlCenterSsoRequest",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainControlCenterSsoRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations": {
+ "post": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Get domain name recommendations based on keywords.",
+ "description": "Description for Get domain name recommendations based on keywords.",
+ "operationId": "Domains_ListRecommendations",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "Search parameters for domain name recommendations.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DomainRecommendationSearchParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/NameIdentifierCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains": {
+ "get": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Get all domains in a resource group.",
+ "description": "Description for Get all domains in a resource group.",
+ "operationId": "Domains_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}": {
+ "get": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Get a domain.",
+ "description": "Description for Get a domain.",
+ "operationId": "Domains_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Creates or updates a domain.",
+ "description": "Description for Creates or updates a domain.",
+ "operationId": "Domains_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-zA-Z0-9][a-zA-Z0-9\\.-]+"
+ },
+ {
+ "name": "domain",
+ "in": "body",
+ "description": "Domain registration information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Domain purchase is in progress.",
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "200": {
+ "description": "Domain purchase was successful.",
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Delete a domain.",
+ "description": "Description for Delete a domain.",
+ "operationId": "Domains_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "forceHardDeleteDomain",
+ "in": "query",
+ "description": "Specify true to delete the domain immediately. The default is false which deletes the domain after 24 hours.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted domain."
+ },
+ "204": {
+ "description": "Domain does not exist in Azure database probably because it has already been deleted"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Creates or updates a domain.",
+ "description": "Description for Creates or updates a domain.",
+ "operationId": "Domains_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string",
+ "pattern": "[a-zA-Z0-9][a-zA-Z0-9\\.-]+"
+ },
+ {
+ "name": "domain",
+ "in": "body",
+ "description": "Domain registration information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DomainPatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Domain purchase is in progress.",
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "200": {
+ "description": "Domain purchase was successful.",
+ "schema": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers": {
+ "get": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Lists domain ownership identifiers.",
+ "description": "Description for Lists domain ownership identifiers.",
+ "operationId": "Domains_ListOwnershipIdentifiers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainOwnershipIdentifierCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}": {
+ "get": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Get ownership identifier for domain",
+ "description": "Description for Get ownership identifier for domain",
+ "operationId": "Domains_GetOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainOwnershipIdentifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Creates an ownership identifier for a domain or updates identifier details for an existing identifier",
+ "description": "Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier",
+ "operationId": "Domains_CreateOrUpdateOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifier",
+ "in": "body",
+ "description": "A JSON representation of the domain ownership properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DomainOwnershipIdentifier"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainOwnershipIdentifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Delete ownership identifier for domain",
+ "description": "Description for Delete ownership identifier for domain",
+ "operationId": "Domains_DeleteOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted domain ownership identifier."
+ },
+ "204": {
+ "description": "Domain ownership identifier does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Creates an ownership identifier for a domain or updates identifier details for an existing identifier",
+ "description": "Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier",
+ "operationId": "Domains_UpdateOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifier",
+ "in": "body",
+ "description": "A JSON representation of the domain ownership properties.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DomainOwnershipIdentifier"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DomainOwnershipIdentifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/renew": {
+ "post": {
+ "tags": [
+ "Domains"
+ ],
+ "summary": "Renew a domain.",
+ "description": "Description for Renew a domain.",
+ "operationId": "Domains_Renew",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "Name of the domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Domain renewal was successful."
+ },
+ "202": {
+ "description": "Domain renewal in progress."
+ },
+ "204": {
+ "description": "Domain does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Renew an existing domain": {
+ "$ref": "./examples/RenewDomain.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Address": {
+ "description": "Address information for domain registration.",
+ "required": [
+ "address1",
+ "city",
+ "country",
+ "postalCode",
+ "state"
+ ],
+ "type": "object",
+ "properties": {
+ "address1": {
+ "description": "First line of an Address.",
+ "type": "string"
+ },
+ "address2": {
+ "description": "The second line of the Address. Optional.",
+ "type": "string"
+ },
+ "city": {
+ "description": "The city for the address.",
+ "type": "string"
+ },
+ "country": {
+ "description": "The country for the address.",
+ "type": "string"
+ },
+ "postalCode": {
+ "description": "The postal code for the address.",
+ "type": "string"
+ },
+ "state": {
+ "description": "The state or province for the address.",
+ "type": "string"
+ }
+ }
+ },
+ "Contact": {
+ "description": "Contact information for domain registration. If 'Domain Privacy' option is not selected then the contact information is made publicly available through the Whois \ndirectories as per ICANN requirements.",
+ "required": [
+ "email",
+ "nameFirst",
+ "nameLast",
+ "phone"
+ ],
+ "type": "object",
+ "properties": {
+ "addressMailing": {
+ "$ref": "#/definitions/Address",
+ "description": "Mailing address."
+ },
+ "email": {
+ "description": "Email address.",
+ "type": "string"
+ },
+ "fax": {
+ "description": "Fax number.",
+ "type": "string"
+ },
+ "jobTitle": {
+ "description": "Job title.",
+ "type": "string"
+ },
+ "nameFirst": {
+ "description": "First name.",
+ "type": "string"
+ },
+ "nameLast": {
+ "description": "Last name.",
+ "type": "string"
+ },
+ "nameMiddle": {
+ "description": "Middle name.",
+ "type": "string"
+ },
+ "organization": {
+ "description": "Organization contact belongs to.",
+ "type": "string"
+ },
+ "phone": {
+ "description": "Phone number.",
+ "type": "string"
+ }
+ }
+ },
+ "Domain": {
+ "description": "Information about a domain.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Domain resource specific properties",
+ "required": [
+ "contactAdmin",
+ "contactBilling",
+ "contactRegistrant",
+ "contactTech",
+ "consent"
+ ],
+ "properties": {
+ "contactAdmin": {
+ "$ref": "#/definitions/Contact",
+ "description": "Administrative contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "contactBilling": {
+ "$ref": "#/definitions/Contact",
+ "description": "Billing contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "contactRegistrant": {
+ "$ref": "#/definitions/Contact",
+ "description": "Registrant contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "contactTech": {
+ "$ref": "#/definitions/Contact",
+ "description": "Technical contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "registrationStatus": {
+ "description": "Domain registration status.",
+ "enum": [
+ "Active",
+ "Awaiting",
+ "Cancelled",
+ "Confiscated",
+ "Disabled",
+ "Excluded",
+ "Expired",
+ "Failed",
+ "Held",
+ "Locked",
+ "Parked",
+ "Pending",
+ "Reserved",
+ "Reverted",
+ "Suspended",
+ "Transferred",
+ "Unknown",
+ "Unlocked",
+ "Unparked",
+ "Updated",
+ "JsonConverterFailed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DomainStatus",
+ "modelAsString": false
+ }
+ },
+ "provisioningState": {
+ "description": "Domain provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false
+ }
+ },
+ "nameServers": {
+ "description": "Name servers.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "privacy": {
+ "description": "true if domain privacy is enabled for this domain; otherwise, false.",
+ "type": "boolean"
+ },
+ "createdTime": {
+ "format": "date-time",
+ "description": "Domain creation timestamp.",
+ "type": "string",
+ "readOnly": true
+ },
+ "expirationTime": {
+ "format": "date-time",
+ "description": "Domain expiration timestamp.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastRenewedTime": {
+ "format": "date-time",
+ "description": "Timestamp when the domain was renewed last time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "autoRenew": {
+ "description": "true if the domain should be automatically renewed; otherwise, false.",
+ "default": true,
+ "type": "boolean"
+ },
+ "readyForDnsRecordManagement": {
+ "description": "true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "managedHostNames": {
+ "description": "All hostnames derived from the domain and assigned to Azure resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HostName"
+ },
+ "readOnly": true
+ },
+ "consent": {
+ "$ref": "#/definitions/DomainPurchaseConsent",
+ "description": "Legal agreement consent.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "domainNotRenewableReasons": {
+ "description": "Reasons why domain is not renewable.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "RegistrationStatusNotSupportedForRenewal",
+ "ExpirationNotInRenewalTimeRange",
+ "SubscriptionNotActive"
+ ],
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "dnsType": {
+ "description": "Current DNS type",
+ "enum": [
+ "AzureDns",
+ "DefaultDomainRegistrarDns"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DnsType",
+ "modelAsString": false
+ }
+ },
+ "dnsZoneId": {
+ "description": "Azure DNS Zone to use",
+ "type": "string"
+ },
+ "targetDnsType": {
+ "description": "Target DNS type (would be used for migration)",
+ "enum": [
+ "AzureDns",
+ "DefaultDomainRegistrarDns"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DnsType",
+ "modelAsString": false
+ }
+ },
+ "authCode": {
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DomainAvailabilityCheckResult": {
+ "description": "Domain availability check result.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the domain.",
+ "type": "string"
+ },
+ "available": {
+ "description": "true if domain can be purchased using CreateDomain API; otherwise, false.",
+ "type": "boolean"
+ },
+ "domainType": {
+ "description": "Valid values are Regular domain: Azure will charge the full price of domain registration, SoftDeleted: Purchasing this domain will simply restore it and this operation will not cost anything.",
+ "enum": [
+ "Regular",
+ "SoftDeleted"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DomainType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "DomainCollection": {
+ "description": "Collection of domains.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Domain"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DomainControlCenterSsoRequest": {
+ "description": "Single sign-on request information for domain management.",
+ "type": "object",
+ "properties": {
+ "url": {
+ "description": "URL where the single sign-on request is to be made.",
+ "type": "string",
+ "readOnly": true
+ },
+ "postParameterKey": {
+ "description": "Post parameter key.",
+ "type": "string",
+ "readOnly": true
+ },
+ "postParameterValue": {
+ "description": "Post parameter value. Client should use 'application/x-www-form-urlencoded' encoding for this value.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DomainOwnershipIdentifier": {
+ "description": "Domain ownership Identifier.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DomainOwnershipIdentifier resource specific properties",
+ "properties": {
+ "ownershipId": {
+ "description": "Ownership Id.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DomainOwnershipIdentifierCollection": {
+ "description": "Collection of domain ownership identifiers.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DomainOwnershipIdentifier"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DomainPatchResource": {
+ "description": "ARM resource for a domain.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DomainPatchResource resource specific properties",
+ "required": [
+ "contactAdmin",
+ "contactBilling",
+ "contactRegistrant",
+ "contactTech",
+ "consent"
+ ],
+ "properties": {
+ "contactAdmin": {
+ "$ref": "#/definitions/Contact",
+ "description": "Administrative contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "contactBilling": {
+ "$ref": "#/definitions/Contact",
+ "description": "Billing contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "contactRegistrant": {
+ "$ref": "#/definitions/Contact",
+ "description": "Registrant contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "contactTech": {
+ "$ref": "#/definitions/Contact",
+ "description": "Technical contact.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "registrationStatus": {
+ "description": "Domain registration status.",
+ "enum": [
+ "Active",
+ "Awaiting",
+ "Cancelled",
+ "Confiscated",
+ "Disabled",
+ "Excluded",
+ "Expired",
+ "Failed",
+ "Held",
+ "Locked",
+ "Parked",
+ "Pending",
+ "Reserved",
+ "Reverted",
+ "Suspended",
+ "Transferred",
+ "Unknown",
+ "Unlocked",
+ "Unparked",
+ "Updated",
+ "JsonConverterFailed"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DomainStatus",
+ "modelAsString": false
+ }
+ },
+ "provisioningState": {
+ "description": "Domain provisioning state.",
+ "enum": [
+ "Succeeded",
+ "Failed",
+ "Canceled",
+ "InProgress",
+ "Deleting"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ProvisioningState",
+ "modelAsString": false
+ }
+ },
+ "nameServers": {
+ "description": "Name servers.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "privacy": {
+ "description": "true if domain privacy is enabled for this domain; otherwise, false.",
+ "type": "boolean"
+ },
+ "createdTime": {
+ "format": "date-time",
+ "description": "Domain creation timestamp.",
+ "type": "string",
+ "readOnly": true
+ },
+ "expirationTime": {
+ "format": "date-time",
+ "description": "Domain expiration timestamp.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastRenewedTime": {
+ "format": "date-time",
+ "description": "Timestamp when the domain was renewed last time.",
+ "type": "string",
+ "readOnly": true
+ },
+ "autoRenew": {
+ "description": "true if the domain should be automatically renewed; otherwise, false.",
+ "default": true,
+ "type": "boolean"
+ },
+ "readyForDnsRecordManagement": {
+ "description": "true if Azure can assign this domain to App Service apps; otherwise, false. This value will be true if domain registration status is active and \n it is hosted on name servers Azure has programmatic access to.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "managedHostNames": {
+ "description": "All hostnames derived from the domain and assigned to Azure resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HostName"
+ },
+ "readOnly": true
+ },
+ "consent": {
+ "$ref": "#/definitions/DomainPurchaseConsent",
+ "description": "Legal agreement consent.",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "domainNotRenewableReasons": {
+ "description": "Reasons why domain is not renewable.",
+ "type": "array",
+ "items": {
+ "enum": [
+ "RegistrationStatusNotSupportedForRenewal",
+ "ExpirationNotInRenewalTimeRange",
+ "SubscriptionNotActive"
+ ],
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "dnsType": {
+ "description": "Current DNS type",
+ "enum": [
+ "AzureDns",
+ "DefaultDomainRegistrarDns"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DnsType",
+ "modelAsString": false
+ }
+ },
+ "dnsZoneId": {
+ "description": "Azure DNS Zone to use",
+ "type": "string"
+ },
+ "targetDnsType": {
+ "description": "Target DNS type (would be used for migration)",
+ "enum": [
+ "AzureDns",
+ "DefaultDomainRegistrarDns"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DnsType",
+ "modelAsString": false
+ }
+ },
+ "authCode": {
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DomainPurchaseConsent": {
+ "description": "Domain purchase consent object, representing acceptance of applicable legal agreements.",
+ "type": "object",
+ "properties": {
+ "agreementKeys": {
+ "description": "List of applicable legal agreement keys. This list can be retrieved using ListLegalAgreements API under TopLevelDomain resource.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "agreedBy": {
+ "description": "Client IP address.",
+ "type": "string"
+ },
+ "agreedAt": {
+ "format": "date-time",
+ "description": "Timestamp when the agreements were accepted.",
+ "type": "string"
+ }
+ }
+ },
+ "DomainRecommendationSearchParameters": {
+ "description": "Domain recommendation search parameters.",
+ "type": "object",
+ "properties": {
+ "keywords": {
+ "description": "Keywords to be used for generating domain recommendations.",
+ "type": "string"
+ },
+ "maxDomainRecommendations": {
+ "format": "int32",
+ "description": "Maximum number of recommendations.",
+ "type": "integer"
+ }
+ }
+ },
+ "HostName": {
+ "description": "Details of a hostname derived from a domain.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the hostname.",
+ "type": "string"
+ },
+ "siteNames": {
+ "description": "List of apps the hostname is assigned to. This list will have more than one app only if the hostname is pointing to a Traffic Manager.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "azureResourceName": {
+ "description": "Name of the Azure resource the hostname is assigned to. If it is assigned to a Traffic Manager then it will be the Traffic Manager name otherwise it will be the app name.",
+ "type": "string"
+ },
+ "azureResourceType": {
+ "description": "Type of the Azure resource the hostname is assigned to.",
+ "enum": [
+ "Website",
+ "TrafficManager"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureResourceType",
+ "modelAsString": false
+ }
+ },
+ "customHostNameDnsRecordType": {
+ "description": "Type of the DNS record.",
+ "enum": [
+ "CName",
+ "A"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomHostNameDnsRecordType",
+ "modelAsString": false
+ }
+ },
+ "hostNameType": {
+ "description": "Type of the hostname.",
+ "enum": [
+ "Verified",
+ "Managed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "HostNameType",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "NameIdentifierCollection": {
+ "description": "Collection of domain name identifiers.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/NameIdentifier"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/TopLevelDomains.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/TopLevelDomains.json
new file mode 100644
index 000000000000..99ee8dec2e38
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/TopLevelDomains.json
@@ -0,0 +1,299 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "TopLevelDomains API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains": {
+ "get": {
+ "tags": [
+ "TopLevelDomains"
+ ],
+ "summary": "Get all top-level domains supported for registration.",
+ "description": "Description for Get all top-level domains supported for registration.",
+ "operationId": "TopLevelDomains_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TopLevelDomainCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Top Level Domains": {
+ "$ref": "./examples/ListTopLevelDomains.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}": {
+ "get": {
+ "tags": [
+ "TopLevelDomains"
+ ],
+ "summary": "Get details of a top-level domain.",
+ "description": "Description for Get details of a top-level domain.",
+ "operationId": "TopLevelDomains_Get",
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the top-level domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TopLevelDomain"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Top Level Domain": {
+ "$ref": "./examples/GetTopLevelDomain.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/topLevelDomains/{name}/listAgreements": {
+ "post": {
+ "tags": [
+ "TopLevelDomains"
+ ],
+ "summary": "Gets all legal agreements that user needs to accept before purchasing a domain.",
+ "description": "Description for Gets all legal agreements that user needs to accept before purchasing a domain.",
+ "operationId": "TopLevelDomains_ListAgreements",
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the top-level domain.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "agreementOption",
+ "in": "body",
+ "description": "Domain agreement options.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/TopLevelDomainAgreementOption"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TldLegalAgreementCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Top Level Domain Agreements": {
+ "$ref": "./examples/ListTopLevelDomainAgreements.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "TldLegalAgreement": {
+ "description": "Legal agreement for a top level domain.",
+ "required": [
+ "agreementKey",
+ "title",
+ "content"
+ ],
+ "type": "object",
+ "properties": {
+ "agreementKey": {
+ "description": "Unique identifier for the agreement.",
+ "type": "string"
+ },
+ "title": {
+ "description": "Agreement title.",
+ "type": "string"
+ },
+ "content": {
+ "description": "Agreement details.",
+ "type": "string"
+ },
+ "url": {
+ "description": "URL where a copy of the agreement details is hosted.",
+ "type": "string"
+ }
+ }
+ },
+ "TldLegalAgreementCollection": {
+ "description": "Collection of top-level domain legal agreements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TldLegalAgreement"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TopLevelDomain": {
+ "description": "A top level domain object.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "../../../Microsoft.Web/stable/2020-10-01/CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "TopLevelDomain resource specific properties",
+ "properties": {
+ "privacy": {
+ "description": "If true, then the top level domain supports domain privacy; otherwise, false.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TopLevelDomainAgreementOption": {
+ "description": "Options for retrieving the list of top level domain legal agreements.",
+ "type": "object",
+ "properties": {
+ "includePrivacy": {
+ "description": "If true, then the list of agreements will include agreements for domain privacy as well; otherwise, false.",
+ "type": "boolean"
+ },
+ "forTransfer": {
+ "description": "If true, then the list of agreements will include agreements for domain transfer as well; otherwise, false.",
+ "type": "boolean"
+ }
+ }
+ },
+ "TopLevelDomainCollection": {
+ "description": "Collection of Top-level domains.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TopLevelDomain"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/GetTopLevelDomain.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/GetTopLevelDomain.json
new file mode 100644
index 000000000000..426c26f9b5da
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/GetTopLevelDomain.json
@@ -0,0 +1,20 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "api-version": "2020-10-01",
+ "name": "com"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.DomainRegistration/topLevelDomains/com",
+ "name": "com",
+ "type": "Microsoft.DomainRegistration/topLevelDomains",
+ "properties": {
+ "privacy": true
+ }
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/ListOperations.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/ListOperations.json
new file mode 100644
index 000000000000..3253043f43bb
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/ListOperations.json
@@ -0,0 +1,104 @@
+{
+ "parameters": {
+ "api-version": "2020-10-01"
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "value": [
+ {
+ "name": "Microsoft.DomainRegistration/domains/Read",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain",
+ "operation": "Get Domains",
+ "description": "Get the list of domains"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/domains/Write",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain",
+ "operation": "Add or Update Domain",
+ "description": "Add a new Domain or update an existing one"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/domains/Delete",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain",
+ "operation": "Delete Domain",
+ "description": "Delete an existing domain."
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/domains/operationresults/Read",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain operation",
+ "operation": "Get Domain Operation",
+ "description": "Get a domain operation"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/generateSsoRequest/Action",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain Control Center Single Sign On Request",
+ "operation": "Generate Domain Control Center Single Sign On Request",
+ "description": "Generate a request for signing into domain control center."
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/validateDomainRegistrationInformation/Action",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain Validation",
+ "operation": "Domain Purchase Info Validation",
+ "description": "Validate domain purchase object without submitting it"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/checkDomainAvailability/Action",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain Availability Result",
+ "operation": "Check Domain Availability",
+ "description": "Check if a domain is available for purchase"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/listDomainRecommendations/Action",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Domain Recommendations",
+ "operation": "Retrieve Domain Recommendations",
+ "description": "Retrieve the list domain recommendations based on keywords"
+ },
+ "origin": "user,system"
+ },
+ {
+ "name": "Microsoft.DomainRegistration/register/action",
+ "display": {
+ "provider": "Microsoft Domains",
+ "resource": "Microsoft Domains resource provider",
+ "operation": "Register Microsoft Domains resource provider",
+ "description": "Register the Microsoft Domains resource provider for the subscription"
+ },
+ "origin": "user,system"
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/ListTopLevelDomainAgreements.json b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/ListTopLevelDomainAgreements.json
new file mode 100644
index 000000000000..e7e0da3fff9d
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2020-10-01/examples/ListTopLevelDomainAgreements.json
@@ -0,0 +1,32 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "name": "in",
+ "api-version": "2020-10-01",
+ "agreementOption": {
+ "includePrivacy": true,
+ "forTransfer": false
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "value": [
+ {
+ "agreementKey": "DNRA",
+ "title": "Domain Name Registration Agreement",
+ "content": "\n
|
\n
|
true to force the deletion even if the App Service Environment contains resources. The default is false.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Operation is in progress."
+ },
+ "204": {
+ "description": "App Service Environment does not exist"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Create or update an App Service Environment.",
+ "description": "Description for Create or update an App Service Environment.",
+ "operationId": "AppServiceEnvironments_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostingEnvironmentEnvelope",
+ "in": "body",
+ "description": "Configuration details of the App Service Environment.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AppServiceEnvironmentPatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AppServiceEnvironmentResource"
+ }
+ },
+ "201": {
+ "description": "Created",
+ "schema": {
+ "$ref": "#/definitions/AppServiceEnvironmentResource"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "#/definitions/AppServiceEnvironmentResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/compute": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get the used, available, and total worker capacity an App Service Environment.",
+ "description": "Description for Get the used, available, and total worker capacity an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListCapacities",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/StampCapacityCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/capacities/virtualip": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get IP addresses assigned to an App Service Environment.",
+ "description": "Description for Get IP addresses assigned to an App Service Environment.",
+ "operationId": "AppServiceEnvironments_GetVipInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AddressResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/changeVirtualNetwork": {
+ "post": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Move an App Service Environment to a different VNET.",
+ "description": "Description for Move an App Service Environment to a different VNET.",
+ "operationId": "AppServiceEnvironments_ChangeVnet",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetInfo",
+ "in": "body",
+ "description": "Details for the new virtual network.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VirtualNetworkProfile"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get diagnostic information for an App Service Environment.",
+ "description": "Description for Get diagnostic information for an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListDiagnostics",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HostingEnvironmentDiagnostics"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/diagnostics/{diagnosticsName}": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get a diagnostics item for an App Service Environment.",
+ "description": "Description for Get a diagnostics item for an App Service Environment.",
+ "operationId": "AppServiceEnvironments_GetDiagnosticsItem",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticsName",
+ "in": "path",
+ "description": "Name of the diagnostics item.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostingEnvironmentDiagnostics"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/inboundNetworkDependenciesEndpoints": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get the network endpoints of all inbound dependencies of an App Service Environment.",
+ "description": "Description for Get the network endpoints of all inbound dependencies of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_GetInboundNetworkDependenciesEndpoints",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/InboundEnvironmentEndpointCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Inbound Network Dependencies Endpoints": {
+ "$ref": "./examples/GetInboundNetworkDependenciesEndpoints.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get all multi-role pools.",
+ "description": "Description for Get all multi-role pools.",
+ "operationId": "AppServiceEnvironments_ListMultiRolePools",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get properties of a multi-role pool.",
+ "description": "Description for Get properties of a multi-role pool.",
+ "operationId": "AppServiceEnvironments_GetMultiRolePool",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Create or update a multi-role pool.",
+ "description": "Description for Create or update a multi-role pool.",
+ "operationId": "AppServiceEnvironments_CreateOrUpdateMultiRolePool",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "multiRolePoolEnvelope",
+ "in": "body",
+ "description": "Properties of the multi-role pool.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Create or update a multi-role pool.",
+ "description": "Description for Create or update a multi-role pool.",
+ "operationId": "AppServiceEnvironments_UpdateMultiRolePool",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "multiRolePoolEnvelope",
+ "in": "body",
+ "description": "Properties of the multi-role pool.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/instances/{instance}/metricdefinitions": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.",
+ "description": "Description for Get metric definitions for a specific instance of a multi-role pool of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListMultiRolePoolInstanceMetricDefinitions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instance",
+ "in": "path",
+ "description": "Name of the instance in the multi-role pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/metricdefinitions": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get metric definitions for a multi-role pool of an App Service Environment.",
+ "description": "Description for Get metric definitions for a multi-role pool of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListMultiRoleMetricDefinitions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/skus": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get available SKUs for scaling a multi-role pool.",
+ "description": "Description for Get available SKUs for scaling a multi-role pool.",
+ "operationId": "AppServiceEnvironments_ListMultiRolePoolSkus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SkuInfoCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/multiRolePools/default/usages": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get usage metrics for a multi-role pool of an App Service Environment.",
+ "description": "Description for Get usage metrics for a multi-role pool of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListMultiRoleUsages",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UsageCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/operations": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "List all currently running operations on the App Service Environment.",
+ "description": "Description for List all currently running operations on the App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListOperations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/Operation"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/outboundNetworkDependenciesEndpoints": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get the network endpoints of all outbound dependencies of an App Service Environment.",
+ "description": "Description for Get the network endpoints of all outbound dependencies of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_GetOutboundNetworkDependenciesEndpoints",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpointCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Outbound Network Dependencies Endpoints": {
+ "$ref": "./examples/GetOutboundNetworkDependenciesEndpoints.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/reboot": {
+ "post": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Reboot all machines in an App Service Environment.",
+ "description": "Description for Reboot all machines in an App Service Environment.",
+ "operationId": "AppServiceEnvironments_Reboot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Asynchronous operation in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/resume": {
+ "post": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Resume an App Service Environment.",
+ "description": "Description for Resume an App Service Environment.",
+ "operationId": "AppServiceEnvironments_Resume",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/serverfarms": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get all App Service plans in an App Service Environment.",
+ "description": "Description for Get all App Service plans in an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListAppServicePlans",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlanCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/sites": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get all apps in an App Service Environment.",
+ "description": "Description for Get all apps in an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListWebApps",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "propertiesToInclude",
+ "in": "query",
+ "description": "Comma separated list of app properties to include.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/suspend": {
+ "post": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Suspend an App Service Environment.",
+ "description": "Description for Suspend an App Service Environment.",
+ "operationId": "AppServiceEnvironments_Suspend",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true,
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/usages": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get global usage metrics of an App Service Environment.",
+ "description": "Description for Get global usage metrics of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListUsages",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get all worker pools of an App Service Environment.",
+ "description": "Description for Get all worker pools of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListWorkerPools",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get properties of a worker pool.",
+ "description": "Description for Get properties of a worker pool.",
+ "operationId": "AppServiceEnvironments_GetWorkerPool",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Create or update a worker pool.",
+ "description": "Description for Create or update a worker pool.",
+ "operationId": "AppServiceEnvironments_CreateOrUpdateWorkerPool",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolEnvelope",
+ "in": "body",
+ "description": "Properties of the worker pool.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "patch": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Create or update a worker pool.",
+ "description": "Description for Create or update a worker pool.",
+ "operationId": "AppServiceEnvironments_UpdateWorkerPool",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolEnvelope",
+ "in": "body",
+ "description": "Properties of the worker pool.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/instances/{instance}/metricdefinitions": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get metric definitions for a specific instance of a worker pool of an App Service Environment.",
+ "description": "Description for Get metric definitions for a specific instance of a worker pool of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListWorkerPoolInstanceMetricDefinitions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instance",
+ "in": "path",
+ "description": "Name of the instance in the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/metricdefinitions": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get metric definitions for a worker pool of an App Service Environment.",
+ "description": "Description for Get metric definitions for a worker pool of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListWebWorkerMetricDefinitions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceMetricDefinitionCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/skus": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get available SKUs for scaling a worker pool.",
+ "description": "Description for Get available SKUs for scaling a worker pool.",
+ "operationId": "AppServiceEnvironments_ListWorkerPoolSkus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SkuInfoCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/workerPools/{workerPoolName}/usages": {
+ "get": {
+ "tags": [
+ "AppServiceEnvironments"
+ ],
+ "summary": "Get usage metrics for a worker pool of an App Service Environment.",
+ "description": "Description for Get usage metrics for a worker pool of an App Service Environment.",
+ "operationId": "AppServiceEnvironments_ListWebWorkerUsages",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service Environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerPoolName",
+ "in": "path",
+ "description": "Name of the worker pool.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/UsageCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AddressResponse": {
+ "description": "Describes main public IP address and any extra virtual IPs.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AddressResponse resource specific properties",
+ "properties": {
+ "serviceIpAddress": {
+ "description": "Main public virtual IP.",
+ "type": "string"
+ },
+ "internalIpAddress": {
+ "description": "Virtual Network internal IP address of the App Service Environment if it is in internal load-balancing mode.",
+ "type": "string"
+ },
+ "outboundIpAddresses": {
+ "description": "IP addresses appearing on outbound connections.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "vipMappings": {
+ "description": "Additional virtual IPs.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/VirtualIPMapping"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AppServiceEnvironmentCollection": {
+ "description": "Collection of App Service Environments.",
+ "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",
+ "readOnly": true
+ }
+ }
+ },
+ "AppServiceEnvironmentPatchResource": {
+ "description": "ARM resource for a app service environment.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AppServiceEnvironmentResource": {
+ "description": "App Service Environment ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "EndpointDependency": {
+ "description": "A domain name that a service is reached at, including details of the current connection status.",
+ "type": "object",
+ "properties": {
+ "domainName": {
+ "description": "The domain name of the dependency.",
+ "type": "string"
+ },
+ "endpointDetails": {
+ "description": "The IP Addresses and Ports used when connecting to DomainName.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointDetail"
+ }
+ }
+ }
+ },
+ "EndpointDetail": {
+ "description": "Current TCP connectivity information from the App Service Environment to a single endpoint.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "An IP Address that Domain Name currently resolves to.",
+ "type": "string"
+ },
+ "port": {
+ "format": "int32",
+ "description": "The port an endpoint is connected to.",
+ "type": "integer"
+ },
+ "latency": {
+ "format": "double",
+ "description": "The time in milliseconds it takes for a TCP connection to be created from the App Service Environment to this IpAddress at this Port.",
+ "type": "number"
+ },
+ "isAccessible": {
+ "description": "Whether it is possible to create a TCP connection from the App Service Environment to this IpAddress at this Port.",
+ "type": "boolean"
+ }
+ }
+ },
+ "HostingEnvironmentDiagnostics": {
+ "description": "Diagnostics for an App Service Environment.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name/identifier of the diagnostics.",
+ "type": "string"
+ },
+ "diagnosticsOutput": {
+ "description": "Diagnostics output.",
+ "type": "string"
+ }
+ }
+ },
+ "InboundEnvironmentEndpoint": {
+ "description": "The IP Addresses and Ports that require inbound network access to and within the subnet of the App Service Environment.",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Short text describing the purpose of the network traffic.",
+ "type": "string"
+ },
+ "endpoints": {
+ "description": "The IP addresses that network traffic will originate from in cidr notation.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "ports": {
+ "description": "The ports that network traffic will arrive to the App Service Environment at.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "InboundEnvironmentEndpointCollection": {
+ "description": "Collection of Inbound Environment Endpoints",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/InboundEnvironmentEndpoint"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "OutboundEnvironmentEndpoint": {
+ "description": "Endpoints accessed for a common purpose that the App Service Environment requires outbound network access to.",
+ "type": "object",
+ "properties": {
+ "category": {
+ "description": "The type of service accessed by the App Service Environment, e.g., Azure Storage, Azure SQL Database, and Azure Active Directory.",
+ "type": "string"
+ },
+ "endpoints": {
+ "description": "The endpoints that the App Service Environment reaches the service at.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/EndpointDependency"
+ }
+ }
+ }
+ },
+ "OutboundEnvironmentEndpointCollection": {
+ "description": "Collection of Outbound Environment Endpoints",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/OutboundEnvironmentEndpoint"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "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
+ }
+ }
+ },
+ "ResourceMetricDefinition": {
+ "description": "Metadata for the metrics.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ResourceMetricDefinition resource specific properties",
+ "properties": {
+ "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
+ },
+ "properties": {
+ "description": "Resource metric definition 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",
+ "readOnly": true
+ }
+ }
+ },
+ "SkuInfo": {
+ "description": "SKU discovery information.",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "description": "Resource type that this SKU applies to.",
+ "type": "string"
+ },
+ "sku": {
+ "$ref": "./CommonDefinitions.json#/definitions/SkuDescription",
+ "description": "Name and tier of the SKU."
+ },
+ "capacity": {
+ "$ref": "./CommonDefinitions.json#/definitions/SkuCapacity",
+ "description": "Min, max, and default scale values of the SKU."
+ }
+ }
+ },
+ "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",
+ "readOnly": true
+ }
+ }
+ },
+ "StampCapacityCollection": {
+ "description": "Collection of stamp capacities.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/StampCapacity"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Usage": {
+ "description": "Usage of the quota resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Usage resource specific properties",
+ "properties": {
+ "displayName": {
+ "description": "Friendly name shown in the UI.",
+ "type": "string",
+ "readOnly": true
+ },
+ "resourceName": {
+ "description": "Name of the quota resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "unit": {
+ "description": "Units of measurement for the quota resource.",
+ "type": "string",
+ "readOnly": true
+ },
+ "currentValue": {
+ "format": "int64",
+ "description": "The current value of the resource counter.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "limit": {
+ "format": "int64",
+ "description": "The resource limit.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "nextResetTime": {
+ "format": "date-time",
+ "description": "Next reset time for the resource counter.",
+ "type": "string",
+ "readOnly": true
+ },
+ "computeMode": {
+ "description": "Compute mode used for this usage.",
+ "enum": [
+ "Shared",
+ "Dedicated",
+ "Dynamic"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "ComputeModeOptions",
+ "modelAsString": false
+ }
+ },
+ "siteMode": {
+ "description": "Site mode used for this usage.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "UsageCollection": {
+ "description": "Collection of usages.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Usage"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "WorkerPoolCollection": {
+ "description": "Collection of worker pools.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WorkerPoolResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "WorkerPoolResource": {
+ "description": "Worker pool of an App Service Environment ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "./CommonDefinitions.json#/definitions/WorkerPool",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ },
+ "sku": {
+ "$ref": "./CommonDefinitions.json#/definitions/SkuDescription"
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/AppServicePlans.json
new file mode 100644
index 000000000000..4ef0c7bc5917
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/AppServicePlans.json
@@ -0,0 +1,1744 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "AppServicePlans API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/serverfarms": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get all App Service plans for a subscription.",
+ "description": "Description for Get all App Service plans for a subscription.",
+ "operationId": "AppServicePlans_List",
+ "parameters": [
+ {
+ "name": "detailed",
+ "in": "query",
+ "description": "Specify true to return all App Service plan properties. The default is false, which returns a subset of the properties.\n Retrieval of all properties may increase the API latency.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlanCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Service plans": {
+ "$ref": "./examples/ListAppServicePlans.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get all App Service plans in a resource group.",
+ "description": "Description for Get all App Service plans in a resource group.",
+ "operationId": "AppServicePlans_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlanCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Service plans by resource group": {
+ "$ref": "./examples/ListAppServicePlansByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get an App Service plan.",
+ "description": "Description for Get an App Service plan.",
+ "operationId": "AppServicePlans_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan"
+ }
+ },
+ "404": {
+ "description": "Not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Service plan": {
+ "$ref": "./examples/GetAppServicePlan.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Creates or updates an App Service Plan.",
+ "description": "Description for Creates or updates an App Service Plan.",
+ "operationId": "AppServicePlans_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "appServicePlan",
+ "in": "body",
+ "description": "Details of the App Service plan.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create Or Update App Service plan": {
+ "$ref": "./examples/CreateOrUpdateAppServicePlan.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Delete an App Service plan.",
+ "description": "Description for Delete an App Service plan.",
+ "operationId": "AppServicePlans_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "204": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete App Service plan": {
+ "$ref": "./examples/DeleteAppServicePlan.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Creates or updates an App Service Plan.",
+ "description": "Description for Creates or updates an App Service Plan.",
+ "operationId": "AppServicePlans_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "appServicePlan",
+ "in": "body",
+ "description": "Details of the App Service plan.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AppServicePlanPatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan"
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServicePlan"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch Service plan": {
+ "$ref": "./examples/PatchAppServicePlan.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/capabilities": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "List all capabilities of an App Service plan.",
+ "description": "Description for List all capabilities of an App Service plan.",
+ "operationId": "AppServicePlans_ListCapabilities",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/Capability"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Retrieve a Hybrid Connection in use in an App Service plan.",
+ "description": "Description for Retrieve a Hybrid Connection in use in an App Service plan.",
+ "operationId": "AppServicePlans_GetHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "Name of the Service Bus namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "Name of the Service Bus relay.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Delete a Hybrid Connection in use in an App Service plan.",
+ "description": "Description for Delete a Hybrid Connection in use in an App Service plan.",
+ "operationId": "AppServicePlans_DeleteHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "Name of the Service Bus namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "Name of the Service Bus relay.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hybrid connection"
+ },
+ "204": {
+ "description": "Hybrid connection does not exist"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/listKeys": {
+ "post": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get the send key name and value of a Hybrid Connection.",
+ "description": "Description for Get the send key name and value of a Hybrid Connection.",
+ "operationId": "AppServicePlans_ListHybridConnectionKeys",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The name of the Service Bus namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The name of the Service Bus relay.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HybridConnectionKey"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}/sites": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get all apps that use a Hybrid Connection in an App Service Plan.",
+ "description": "Description for Get all apps that use a Hybrid Connection in an App Service Plan.",
+ "operationId": "AppServicePlans_ListWebAppsByHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "Name of the Hybrid Connection namespace.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "Name of the Hybrid Connection relay.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionPlanLimits/limit": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get the maximum number of Hybrid Connections allowed in an App Service plan.",
+ "description": "Description for Get the maximum number of Hybrid Connections allowed in an App Service plan.",
+ "operationId": "AppServicePlans_GetHybridConnectionPlanLimit",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HybridConnectionLimits"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/hybridConnectionRelays": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Retrieve all Hybrid Connections in use in an App Service plan.",
+ "description": "Description for Retrieve all Hybrid Connections in use in an App Service plan.",
+ "operationId": "AppServicePlans_ListHybridConnections",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HybridConnectionCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/restartSites": {
+ "post": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Restart all apps in an App Service plan.",
+ "description": "Description for Restart all apps in an App Service plan.",
+ "operationId": "AppServicePlans_RestartWebApps",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "softRestart",
+ "in": "query",
+ "description": "Specify true to perform a soft restart, applies the configuration settings and restarts the apps if necessary. The default is false, which always restarts and reprovisions the apps",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/sites": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get all apps associated with an App Service plan.",
+ "description": "Description for Get all apps associated with an App Service plan.",
+ "operationId": "AppServicePlans_ListWebApps",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$skipToken",
+ "in": "query",
+ "description": "Skip to a web app in the list of webapps associated with app service plan. If specified, the resulting list will contain web apps starting from (including) the skipToken. Otherwise, the resulting list contains web apps from the start of the list",
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Supported filter: $filter=state eq running. Returns only web apps that are currently running",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "description": "List page size. If specified, results are paged.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/skus": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Gets all selectable SKUs for a given App Service Plan",
+ "description": "Description for Gets all selectable SKUs for a given App Service Plan",
+ "operationId": "AppServicePlans_GetServerFarmSkus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of App Service Plan",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "object"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/usages": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Gets server farm usage information",
+ "description": "Description for Gets server farm usage information",
+ "operationId": "AppServicePlans_ListUsages",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of App Service Plan",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2').",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get all Virtual Networks associated with an App Service plan.",
+ "description": "Description for Get all Virtual Networks associated with an App Service plan.",
+ "operationId": "AppServicePlans_ListVnets",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get a Virtual Network associated with an App Service plan.",
+ "description": "Description for Get a Virtual Network associated with an App Service plan.",
+ "operationId": "AppServicePlans_GetVnetFromServerFarm",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "404": {
+ "description": "Virtual network could not be found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get a Virtual Network gateway.",
+ "description": "Description for Get a Virtual Network gateway.",
+ "operationId": "AppServicePlans_GetVnetGateway",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Only the 'primary' gateway is supported.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Update a Virtual Network gateway.",
+ "description": "Description for Update a Virtual Network gateway.",
+ "operationId": "AppServicePlans_UpdateVnetGateway",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Only the 'primary' gateway is supported.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Definition of the gateway.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get all routes that are associated with a Virtual Network in an App Service plan.",
+ "description": "Description for Get all routes that are associated with a Virtual Network in an App Service plan.",
+ "operationId": "AppServicePlans_ListRoutesForVnet",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetRoute"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/virtualNetworkConnections/{vnetName}/routes/{routeName}": {
+ "get": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Get a Virtual Network route in an App Service plan.",
+ "description": "Description for Get a Virtual Network route in an App Service plan.",
+ "operationId": "AppServicePlans_GetRouteForVnet",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "routeName",
+ "in": "path",
+ "description": "Name of the Virtual Network route.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetRoute"
+ }
+ }
+ },
+ "404": {
+ "description": "Specified route does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Create or update a Virtual Network route in an App Service plan.",
+ "description": "Description for Create or update a Virtual Network route in an App Service plan.",
+ "operationId": "AppServicePlans_CreateOrUpdateVnetRoute",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "routeName",
+ "in": "path",
+ "description": "Name of the Virtual Network route.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "route",
+ "in": "body",
+ "description": "Definition of the Virtual Network route.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetRoute"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetRoute"
+ }
+ },
+ "400": {
+ "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid."
+ },
+ "404": {
+ "description": "Route not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Delete a Virtual Network route in an App Service plan.",
+ "description": "Description for Delete a Virtual Network route in an App Service plan.",
+ "operationId": "AppServicePlans_DeleteVnetRoute",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "routeName",
+ "in": "path",
+ "description": "Name of the Virtual Network route.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted Virtual Network route."
+ },
+ "404": {
+ "description": "Specified Virtual Network route does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Create or update a Virtual Network route in an App Service plan.",
+ "description": "Description for Create or update a Virtual Network route in an App Service plan.",
+ "operationId": "AppServicePlans_UpdateVnetRoute",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "routeName",
+ "in": "path",
+ "description": "Name of the Virtual Network route.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "route",
+ "in": "body",
+ "description": "Definition of the Virtual Network route.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetRoute"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetRoute"
+ }
+ },
+ "400": {
+ "description": "Invalid request. Ensure that required parameters are given, and that addresses and address spaces are valid."
+ },
+ "404": {
+ "description": "Route not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/serverfarms/{name}/workers/{workerName}/reboot": {
+ "post": {
+ "tags": [
+ "AppServicePlans"
+ ],
+ "summary": "Reboot a worker machine in an App Service plan.",
+ "description": "Description for Reboot a worker machine in an App Service plan.",
+ "operationId": "AppServicePlans_RebootWorker",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the App Service plan.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "workerName",
+ "in": "path",
+ "description": "Name of worker machine, which typically starts with RD.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AppServicePlanPatchResource": {
+ "description": "ARM resource for a app service plan.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AppServicePlanPatchResource resource specific properties",
+ "properties": {
+ "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
+ },
+ "hostingEnvironmentProfile": {
+ "$ref": "./CommonDefinitions.json#/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"
+ },
+ "maximumElasticWorkerCount": {
+ "format": "int32",
+ "description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan",
+ "type": "integer"
+ },
+ "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"
+ },
+ "freeOfferExpirationTime": {
+ "format": "date-time",
+ "description": "The time when the server farm free offer expires.",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "description": "Resource group of the App Service plan.",
+ "type": "string",
+ "readOnly": true
+ },
+ "reserved": {
+ "description": "This needs to set to true when creating a Linux App Service Plan, along with kind set to Linux. It should be false otherwise.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "isXenon": {
+ "description": "Obsolete: If Hyper-V container app service plan true, false otherwise.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "hyperV": {
+ "description": "If Hyper-V container app service plan true, false otherwise.",
+ "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
+ }
+ }
+ },
+ "HybridConnectionCollection": {
+ "description": "Collection of hostname bindings.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "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": "./CommonDefinitions.json#/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": "./CommonDefinitions.json#/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
+ }
+ }
+ },
+ "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",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Certificates.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Certificates.json
new file mode 100644
index 000000000000..b012bbb01937
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Certificates.json
@@ -0,0 +1,650 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "Certificates API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/certificates": {
+ "get": {
+ "tags": [
+ "Certificates"
+ ],
+ "summary": "Get all certificates for a subscription.",
+ "description": "Description for Get all certificates for a subscription.",
+ "operationId": "Certificates_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CertificateCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Certificates for subscription": {
+ "$ref": "./examples/ListCertificates.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates": {
+ "get": {
+ "tags": [
+ "Certificates"
+ ],
+ "summary": "Get all certificates in a resource group.",
+ "description": "Description for Get all certificates in a resource group.",
+ "operationId": "Certificates_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/CertificateCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Certificates by resource group": {
+ "$ref": "./examples/ListCertificatesByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/certificates/{name}": {
+ "get": {
+ "tags": [
+ "Certificates"
+ ],
+ "summary": "Get a certificate.",
+ "description": "Description for Get a certificate.",
+ "operationId": "Certificates_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the certificate.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Certificate": {
+ "$ref": "./examples/GetCertificate.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "Certificates"
+ ],
+ "summary": "Create or update a certificate.",
+ "description": "Description for Create or update a certificate.",
+ "operationId": "Certificates_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the certificate.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "certificateEnvelope",
+ "in": "body",
+ "description": "Details of certificate, if it exists already.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create Or Update Certificate": {
+ "$ref": "./examples/CreateOrUpdateCertificate.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "Certificates"
+ ],
+ "summary": "Delete a certificate.",
+ "description": "Description for Delete a certificate.",
+ "operationId": "Certificates_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the certificate.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted certificate."
+ },
+ "204": {
+ "description": "Certificate does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete Certificate": {
+ "$ref": "./examples/DeleteCertificate.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "Certificates"
+ ],
+ "summary": "Create or update a certificate.",
+ "description": "Description for Create or update a certificate.",
+ "operationId": "Certificates_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the certificate.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "certificateEnvelope",
+ "in": "body",
+ "description": "Details of certificate, if it exists already.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CertificatePatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/Certificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch Certificate": {
+ "$ref": "./examples/PatchCertificate.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Certificate": {
+ "description": "SSL certificate for an app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Certificate resource specific properties",
+ "required": [
+ "password"
+ ],
+ "properties": {
+ "friendlyName": {
+ "description": "Friendly name of the certificate.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subjectName": {
+ "description": "Subject name of the certificate.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostNames": {
+ "description": "Host names the certificate applies to.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pfxBlob": {
+ "format": "byte",
+ "description": "Pfx blob.",
+ "type": "string"
+ },
+ "siteName": {
+ "description": "App name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "selfLink": {
+ "description": "Self link.",
+ "type": "string",
+ "readOnly": true
+ },
+ "issuer": {
+ "description": "Certificate issuer.",
+ "type": "string",
+ "readOnly": true
+ },
+ "issueDate": {
+ "format": "date-time",
+ "description": "Certificate issue Date.",
+ "type": "string",
+ "readOnly": true
+ },
+ "expirationDate": {
+ "format": "date-time",
+ "description": "Certificate expiration date.",
+ "type": "string",
+ "readOnly": true
+ },
+ "password": {
+ "description": "Certificate password.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "thumbprint": {
+ "description": "Certificate thumbprint.",
+ "type": "string",
+ "readOnly": true
+ },
+ "valid": {
+ "description": "Is the certificate valid?.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "cerBlob": {
+ "format": "byte",
+ "description": "Raw bytes of .cer file",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicKeyHash": {
+ "description": "Public key hash.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostingEnvironmentProfile": {
+ "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile",
+ "description": "Specification for the App Service Environment to use for the certificate.",
+ "readOnly": true
+ },
+ "keyVaultId": {
+ "description": "Key Vault Csm resource Id.",
+ "type": "string"
+ },
+ "keyVaultSecretName": {
+ "description": "Key Vault secret name.",
+ "type": "string"
+ },
+ "keyVaultSecretStatus": {
+ "description": "Status of the Key Vault secret.",
+ "enum": [
+ "Initialized",
+ "WaitingOnCertificateOrder",
+ "Succeeded",
+ "CertificateOrderFailed",
+ "OperationNotPermittedOnKeyVault",
+ "AzureServiceUnauthorizedToAccessKeyVault",
+ "KeyVaultDoesNotExist",
+ "KeyVaultSecretDoesNotExist",
+ "UnknownError",
+ "ExternalPrivateKey",
+ "Unknown"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KeyVaultSecretStatus",
+ "modelAsString": false
+ }
+ },
+ "serverFarmId": {
+ "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
+ "type": "string"
+ },
+ "canonicalName": {
+ "description": "CNAME of the certificate to be issued via free certificate",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CertificateCollection": {
+ "description": "Collection of certificates.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Certificate"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CertificatePatchResource": {
+ "description": "ARM resource for a certificate.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CertificatePatchResource resource specific properties",
+ "required": [
+ "password"
+ ],
+ "properties": {
+ "friendlyName": {
+ "description": "Friendly name of the certificate.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subjectName": {
+ "description": "Subject name of the certificate.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostNames": {
+ "description": "Host names the certificate applies to.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "pfxBlob": {
+ "format": "byte",
+ "description": "Pfx blob.",
+ "type": "string"
+ },
+ "siteName": {
+ "description": "App name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "selfLink": {
+ "description": "Self link.",
+ "type": "string",
+ "readOnly": true
+ },
+ "issuer": {
+ "description": "Certificate issuer.",
+ "type": "string",
+ "readOnly": true
+ },
+ "issueDate": {
+ "format": "date-time",
+ "description": "Certificate issue Date.",
+ "type": "string",
+ "readOnly": true
+ },
+ "expirationDate": {
+ "format": "date-time",
+ "description": "Certificate expiration date.",
+ "type": "string",
+ "readOnly": true
+ },
+ "password": {
+ "description": "Certificate password.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "thumbprint": {
+ "description": "Certificate thumbprint.",
+ "type": "string",
+ "readOnly": true
+ },
+ "valid": {
+ "description": "Is the certificate valid?.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "cerBlob": {
+ "format": "byte",
+ "description": "Raw bytes of .cer file",
+ "type": "string",
+ "readOnly": true
+ },
+ "publicKeyHash": {
+ "description": "Public key hash.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostingEnvironmentProfile": {
+ "$ref": "./CommonDefinitions.json#/definitions/HostingEnvironmentProfile",
+ "description": "Specification for the App Service Environment to use for the certificate.",
+ "readOnly": true
+ },
+ "keyVaultId": {
+ "description": "Key Vault Csm resource Id.",
+ "type": "string"
+ },
+ "keyVaultSecretName": {
+ "description": "Key Vault secret name.",
+ "type": "string"
+ },
+ "keyVaultSecretStatus": {
+ "description": "Status of the Key Vault secret.",
+ "enum": [
+ "Initialized",
+ "WaitingOnCertificateOrder",
+ "Succeeded",
+ "CertificateOrderFailed",
+ "OperationNotPermittedOnKeyVault",
+ "AzureServiceUnauthorizedToAccessKeyVault",
+ "KeyVaultDoesNotExist",
+ "KeyVaultSecretDoesNotExist",
+ "UnknownError",
+ "ExternalPrivateKey",
+ "Unknown"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "KeyVaultSecretStatus",
+ "modelAsString": false
+ }
+ },
+ "serverFarmId": {
+ "description": "Resource ID of the associated App Service plan, formatted as: \"/subscriptions/{subscriptionID}/resourceGroups/{groupName}/providers/Microsoft.Web/serverfarms/{appServicePlanName}\".",
+ "type": "string"
+ },
+ "canonicalName": {
+ "description": "CNAME of the certificate to be issued via free certificate",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/CommonDefinitions.json
new file mode 100644
index 000000000000..5ddb30dc2489
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/CommonDefinitions.json
@@ -0,0 +1,2924 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "Common Definitions"
+ },
+ "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"
+ }
+ }
+ },
+ "ApiManagementConfig": {
+ "description": "Azure API management (APIM) configuration linked to the app.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "description": "APIM-Api Identifier.",
+ "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",
+ "Web,Publishing"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LoadBalancingMode",
+ "modelAsString": true
+ }
+ },
+ "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"
+ }
+ },
+ "hasLinuxWorkers": {
+ "description": "Flag that displays whether an ASE has linux workers or not",
+ "type": "boolean"
+ },
+ "sslCertKeyVaultId": {
+ "description": "Key Vault ID for ILB App Service Environment default SSL certificate",
+ "type": "string"
+ },
+ "sslCertKeyVaultSecretName": {
+ "description": "Key Vault Secret Name for ILB App Service Environment default SSL certificate",
+ "type": "string"
+ }
+ }
+ },
+ "AppServicePlan": {
+ "description": "App Service plan.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AppServicePlan resource specific properties",
+ "properties": {
+ "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
+ },
+ "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"
+ },
+ "maximumElasticWorkerCount": {
+ "format": "int32",
+ "description": "Maximum number of total workers allowed for this ElasticScaleEnabled App Service Plan",
+ "type": "integer"
+ },
+ "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"
+ },
+ "freeOfferExpirationTime": {
+ "format": "date-time",
+ "description": "The time when the server farm free offer expires.",
+ "type": "string"
+ },
+ "resourceGroup": {
+ "description": "Resource group of the App Service plan.",
+ "type": "string",
+ "readOnly": true
+ },
+ "reserved": {
+ "description": "If Linux app service plan true, false otherwise.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "isXenon": {
+ "description": "Obsolete: If Hyper-V container app service plan true, false otherwise.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "hyperV": {
+ "description": "If Hyper-V container app service plan true, false otherwise.",
+ "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",
+ "readOnly": 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"
+ },
+ "sourceWebAppLocation": {
+ "description": "Location of source app ex: West US or North Europe",
+ "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"
+ }
+ }
+ },
+ "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"
+ }
+ },
+ "supportCredentials": {
+ "description": "Gets or sets whether CORS requests with credentials are allowed. See \nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#Requests_with_credentials\nfor more details.",
+ "type": "boolean"
+ }
+ }
+ },
+ "CsmOperationCollection": {
+ "description": "Collection of Azure resource manager operation metadata.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/CsmOperationDescription"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CsmOperationDescription": {
+ "description": "Description of an operation available for Microsoft.Web resource provider.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "display": {
+ "$ref": "#/definitions/CsmOperationDisplay"
+ },
+ "origin": {
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/CsmOperationDescriptionProperties"
+ }
+ }
+ },
+ "CsmOperationDescriptionProperties": {
+ "description": "Properties available for a Microsoft.Web resource provider operation.",
+ "type": "object",
+ "properties": {
+ "serviceSpecification": {
+ "$ref": "#/definitions/ServiceSpecification"
+ }
+ }
+ },
+ "CsmOperationDisplay": {
+ "description": "Meta data about operation used for display in portal.",
+ "type": "object",
+ "properties": {
+ "provider": {
+ "type": "string"
+ },
+ "resource": {
+ "type": "string"
+ },
+ "operation": {
+ "type": "string"
+ },
+ "description": {
+ "type": "string"
+ }
+ }
+ },
+ "CsmUsageQuota": {
+ "description": "Usage of the quota resource.",
+ "type": "object",
+ "properties": {
+ "unit": {
+ "description": "Units of measurement for the quota resource.",
+ "type": "string"
+ },
+ "nextResetTime": {
+ "format": "date-time",
+ "description": "Next reset time for the resource counter.",
+ "type": "string"
+ },
+ "currentValue": {
+ "format": "int64",
+ "description": "The current value of the resource counter.",
+ "type": "integer"
+ },
+ "limit": {
+ "format": "int64",
+ "description": "The resource limit.",
+ "type": "integer"
+ },
+ "name": {
+ "$ref": "#/definitions/LocalizableString",
+ "description": "Quota name."
+ }
+ }
+ },
+ "CsmUsageQuotaCollection": {
+ "description": "Collection of CSM usage quotas.",
+ "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",
+ "readOnly": true
+ }
+ }
+ },
+ "DefaultErrorResponse": {
+ "description": "App Service error response.",
+ "type": "object",
+ "properties": {
+ "error": {
+ "description": "Error model.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Standardized string to programmatically identify the error.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "Detailed error description and debugging information.",
+ "type": "string",
+ "readOnly": true
+ },
+ "target": {
+ "description": "Detailed error description and debugging information.",
+ "type": "string",
+ "readOnly": true
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "description": "Detailed errors.",
+ "properties": {
+ "code": {
+ "description": "Standardized string to programmatically identify the error.",
+ "type": "string",
+ "readOnly": true
+ },
+ "message": {
+ "description": "Detailed error description and debugging information.",
+ "type": "string",
+ "readOnly": true
+ },
+ "target": {
+ "description": "Detailed error description and debugging information.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "readOnly": true
+ }
+ },
+ "innererror": {
+ "description": "More information to debug error.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "DeletedSite": {
+ "description": "A deleted app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DeletedSite resource specific properties",
+ "properties": {
+ "deletedSiteId": {
+ "format": "int32",
+ "description": "Numeric id for the deleted site",
+ "type": "integer",
+ "readOnly": true
+ },
+ "deletedTimestamp": {
+ "description": "Time in UTC when the app was deleted.",
+ "type": "string",
+ "readOnly": true
+ },
+ "subscription": {
+ "description": "Subscription containing the deleted site",
+ "type": "string",
+ "readOnly": true
+ },
+ "resourceGroup": {
+ "description": "ResourceGroup that contained the deleted site",
+ "type": "string",
+ "readOnly": true
+ },
+ "deletedSiteName": {
+ "description": "Name of the deleted site",
+ "type": "string",
+ "readOnly": true
+ },
+ "slot": {
+ "description": "Slot of the deleted site",
+ "type": "string",
+ "readOnly": true
+ },
+ "kind": {
+ "description": "Kind of site that was deleted",
+ "type": "string",
+ "readOnly": true
+ },
+ "geoRegionName": {
+ "description": "Geo Region of the deleted site",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "Dimension": {
+ "description": "Dimension of a resource metric. For e.g. instance specific HTTP requests for a web app, \nwhere instance name is dimension of the metric HTTP request",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string"
+ },
+ "internalName": {
+ "type": "string"
+ },
+ "toBeExportedForShoebox": {
+ "type": "boolean"
+ }
+ }
+ },
+ "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
+ }
+ }
+ },
+ "Identifier": {
+ "description": "A domain specific resource identifier.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Identifier resource specific properties",
+ "properties": {
+ "id": {
+ "description": "String representation of the identity.",
+ "type": "string",
+ "x-ms-client-name": "value"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "IdentifierCollection": {
+ "description": "Collection of identifiers.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Identifier"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "IpSecurityRestriction": {
+ "description": "IP security restriction on an app.",
+ "type": "object",
+ "properties": {
+ "ipAddress": {
+ "description": "IP address the security restriction is valid for.\nIt can be in form of pure ipv4 address (required SubnetMask property) or\nCIDR notation such as ipv4/mask (leading bit match). For CIDR,\nSubnetMask property must not be specified.",
+ "type": "string"
+ },
+ "subnetMask": {
+ "description": "Subnet mask for the range of IP addresses the restriction is valid for.",
+ "type": "string"
+ },
+ "vnetSubnetResourceId": {
+ "description": "Virtual network resource id",
+ "type": "string"
+ },
+ "vnetTrafficTag": {
+ "format": "int32",
+ "description": "(internal) Vnet traffic tag",
+ "type": "integer"
+ },
+ "subnetTrafficTag": {
+ "format": "int32",
+ "description": "(internal) Subnet traffic tag",
+ "type": "integer"
+ },
+ "action": {
+ "description": "Allow or Deny access for this IP range.",
+ "type": "string"
+ },
+ "tag": {
+ "description": "Defines what this IP filter will be used for. This is to support IP filtering on proxies.",
+ "enum": [
+ "Default",
+ "XffProxy",
+ "ServiceTag"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "IpFilterTag",
+ "modelAsString": true
+ }
+ },
+ "priority": {
+ "format": "int32",
+ "description": "Priority of IP restriction rule.",
+ "type": "integer"
+ },
+ "name": {
+ "description": "IP restriction rule name.",
+ "type": "string"
+ },
+ "description": {
+ "description": "IP restriction rule description.",
+ "type": "string"
+ },
+ "headers": {
+ "description": "IP restriction rule headers.\nX-Forwarded-Host (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Host#Examples). \nThe matching logic is ..\n- If the property is null or empty (default), all hosts(or lack of) are allowed.\n- A value is compared using ordinal-ignore-case (excluding port number).\n- Subdomain wildcards are permitted but don't match the root domain. For example, *.contoso.com matches the subdomain foo.contoso.com\n but not the root domain contoso.com or multi-level foo.bar.contoso.com\n- Unicode host names are allowed but are converted to Punycode for matching.\n\nX-Forwarded-For (https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-For#Examples).\nThe matching logic is ..\n- If the property is null or empty (default), any forwarded-for chains (or lack of) are allowed.\n- If any address (excluding port number) in the chain (comma separated) matches the CIDR defined by the property.\n\nX-Azure-FDID and X-FD-HealthProbe.\nThe matching logic is exact match.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "array",
+ "items": {
+ "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"
+ }
+ }
+ },
+ "LogSpecification": {
+ "description": "Log Definition of a single resource metric.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string"
+ },
+ "blobDuration": {
+ "type": "string"
+ },
+ "logFilterPattern": {
+ "type": "string"
+ }
+ }
+ },
+ "ManagedServiceIdentity": {
+ "description": "Managed service identity.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Type of managed service identity.",
+ "enum": [
+ "SystemAssigned",
+ "UserAssigned",
+ "SystemAssigned, UserAssigned",
+ "None"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ManagedServiceIdentityType",
+ "modelAsString": false
+ }
+ },
+ "tenantId": {
+ "description": "Tenant of managed service identity.",
+ "type": "string",
+ "readOnly": true
+ },
+ "principalId": {
+ "description": "Principal Id of managed service identity.",
+ "type": "string",
+ "readOnly": true
+ },
+ "userAssignedIdentities": {
+ "description": "The list of user assigned identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object",
+ "properties": {
+ "principalId": {
+ "description": "Principal Id of user assigned identity",
+ "type": "string",
+ "readOnly": true
+ },
+ "clientId": {
+ "description": "Client Id of user assigned identity",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ }
+ }
+ },
+ "MetricAvailability": {
+ "description": "Retention policy of a resource metric.",
+ "type": "object",
+ "properties": {
+ "timeGrain": {
+ "type": "string"
+ },
+ "blobDuration": {
+ "type": "string"
+ }
+ }
+ },
+ "MetricSpecification": {
+ "description": "Definition of a single resource metric.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string"
+ },
+ "displayName": {
+ "type": "string"
+ },
+ "displayDescription": {
+ "type": "string"
+ },
+ "unit": {
+ "type": "string"
+ },
+ "aggregationType": {
+ "type": "string"
+ },
+ "supportsInstanceLevelAggregation": {
+ "type": "boolean"
+ },
+ "enableRegionalMdmAccount": {
+ "type": "boolean"
+ },
+ "sourceMdmAccount": {
+ "type": "string"
+ },
+ "sourceMdmNamespace": {
+ "type": "string"
+ },
+ "metricFilterPattern": {
+ "type": "string"
+ },
+ "fillGapWithZero": {
+ "type": "boolean"
+ },
+ "isInternal": {
+ "type": "boolean"
+ },
+ "dimensions": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Dimension"
+ }
+ },
+ "category": {
+ "type": "string"
+ },
+ "availabilities": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricAvailability"
+ }
+ },
+ "supportedTimeGrainTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "supportedAggregationTypes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "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 of network access control entry.",
+ "type": "string"
+ },
+ "order": {
+ "format": "int32",
+ "description": "Order of precedence.",
+ "type": "integer"
+ },
+ "remoteSubnet": {
+ "description": "Remote subnet.",
+ "type": "string"
+ }
+ }
+ },
+ "Operation": {
+ "description": "An operation on a resource.",
+ "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
+ },
+ "systemData": {
+ "description": "The system metadata relating to this resource.",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ },
+ "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 add/remove from ReroutePercentage until it reaches \\nMinReroutePercentage or \nMaxReroutePercentage. Site metrics are checked every N minutes specified in ChangeIntervalInMinutes.\\nCustom decision algorithm \ncan be provided in TiPCallback site extension which URL can be specified in ChangeDecisionCallbackUrl.",
+ "type": "number"
+ },
+ "changeIntervalInMinutes": {
+ "format": "int32",
+ "description": "Specifies interval in minutes 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": "Request 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"
+ }
+ },
+ "systemData": {
+ "description": "The system metadata relating to this resource.",
+ "$ref": "../../../../../common-types/resource-management/v2/types.json#/definitions/systemData"
+ }
+ },
+ "x-ms-azure-resource": true
+ },
+ "ServiceSpecification": {
+ "description": "Resource metrics service provided by Microsoft.Insights resource provider.",
+ "type": "object",
+ "properties": {
+ "metricSpecifications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MetricSpecification"
+ }
+ },
+ "logSpecifications": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/LogSpecification"
+ }
+ }
+ }
+ },
+ "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"
+ ]
+ },
+ "isXenon": {
+ "description": "Obsolete: Hyper-V sandbox.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "hyperV": {
+ "description": "Hyper-V sandbox.",
+ "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"
+ },
+ "clientCertMode": {
+ "description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.",
+ "enum": [
+ "Required",
+ "Optional"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClientCertMode",
+ "modelAsString": false
+ }
+ },
+ "clientCertExclusionPaths": {
+ "description": "client certificate authentication comma-separated exclusion paths",
+ "type": "string"
+ },
+ "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"
+ },
+ "customDomainVerificationId": {
+ "description": "Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.",
+ "type": "string"
+ },
+ "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 except dataComponent. 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"
+ ]
+ },
+ "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"
+ },
+ "redundancyMode": {
+ "description": "Site redundancy mode",
+ "enum": [
+ "None",
+ "Manual",
+ "Failover",
+ "ActiveActive",
+ "GeoRedundant"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RedundancyMode",
+ "modelAsString": false
+ }
+ },
+ "inProgressOperationId": {
+ "format": "uuid",
+ "description": "Specifies an operation id if this site has a pending operation.",
+ "type": "string",
+ "readOnly": true,
+ "example": "00000000-0000-0000-0000-000000000000"
+ },
+ "storageAccountRequired": {
+ "description": "Checks if Customer provided storage account is required",
+ "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"
+ },
+ "powerShellVersion": {
+ "description": "Version of PowerShell.",
+ "type": "string"
+ },
+ "linuxFxVersion": {
+ "description": "Linux App Framework and version",
+ "type": "string"
+ },
+ "windowsFxVersion": {
+ "description": "Xenon 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",
+ "VSTSRM"
+ ],
+ "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 polymorphic 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"
+ ]
+ },
+ "vnetRouteAllEnabled": {
+ "description": "Virtual Network Route All enabled. This causes all outbound traffic to have Virtual Network Security Groups and User Defined Routes applied.",
+ "type": "boolean"
+ },
+ "vnetPrivatePortsCount": {
+ "format": "int32",
+ "description": "The number of private ports assigned to this app. These will be assigned dynamically on runtime.",
+ "type": "integer"
+ },
+ "cors": {
+ "$ref": "#/definitions/CorsSettings",
+ "description": "Cross-Origin Resource Sharing (CORS) settings."
+ },
+ "push": {
+ "$ref": "#/definitions/PushSettings",
+ "description": "Push endpoint settings."
+ },
+ "apiDefinition": {
+ "$ref": "#/definitions/ApiDefinitionInfo",
+ "description": "Information about the formal API definition for the app."
+ },
+ "apiManagementConfig": {
+ "$ref": "#/definitions/ApiManagementConfig",
+ "description": "Azure API management settings linked to the app."
+ },
+ "autoSwapSlotName": {
+ "description": "Auto-swap slot name.",
+ "type": "string"
+ },
+ "localMySqlEnabled": {
+ "description": "true to enable local MySQL; otherwise, false.",
+ "default": false,
+ "type": "boolean"
+ },
+ "managedServiceIdentityId": {
+ "format": "int32",
+ "description": "Managed Service Identity Id",
+ "type": "integer"
+ },
+ "xManagedServiceIdentityId": {
+ "format": "int32",
+ "description": "Explicit Managed Service Identity Id",
+ "type": "integer"
+ },
+ "ipSecurityRestrictions": {
+ "description": "IP security restrictions for main.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IpSecurityRestriction"
+ }
+ },
+ "scmIpSecurityRestrictions": {
+ "description": "IP security restrictions for scm.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IpSecurityRestriction"
+ }
+ },
+ "scmIpSecurityRestrictionsUseMain": {
+ "description": "IP security restrictions for scm to use main.",
+ "type": "boolean"
+ },
+ "http20Enabled": {
+ "description": "Http20Enabled: configures a web site to allow clients to connect over http2.0",
+ "default": true,
+ "type": "boolean"
+ },
+ "minTlsVersion": {
+ "description": "MinTlsVersion: configures the minimum version of TLS required for SSL requests",
+ "enum": [
+ "1.0",
+ "1.1",
+ "1.2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SupportedTlsVersions",
+ "modelAsString": true
+ }
+ },
+ "scmMinTlsVersion": {
+ "description": "ScmMinTlsVersion: configures the minimum version of TLS required for SSL requests for SCM site",
+ "enum": [
+ "1.0",
+ "1.1",
+ "1.2"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SupportedTlsVersions",
+ "modelAsString": true
+ }
+ },
+ "ftpsState": {
+ "description": "State of FTP / FTPS service",
+ "enum": [
+ "AllAllowed",
+ "FtpsOnly",
+ "Disabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FtpsState",
+ "modelAsString": true
+ }
+ },
+ "preWarmedInstanceCount": {
+ "format": "int32",
+ "description": "Number of preWarmed instances.\nThis setting only applies to the Consumption and Elastic Plans",
+ "maximum": 10,
+ "minimum": 0,
+ "type": "integer"
+ },
+ "healthCheckPath": {
+ "description": "Health check path",
+ "type": "string"
+ }
+ }
+ },
+ "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": "Algorithm used for 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 successful 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": "Request Count.",
+ "type": "integer"
+ },
+ "timeInterval": {
+ "description": "Time interval.",
+ "type": "string"
+ }
+ }
+ },
+ "Snapshot": {
+ "description": "A snapshot of an app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Snapshot resource specific properties",
+ "properties": {
+ "time": {
+ "description": "The time the snapshot was taken.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "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": [
+ "Small",
+ "Medium",
+ "Large",
+ "D1",
+ "D2",
+ "D3",
+ "NestedSmall",
+ "Default"
+ ],
+ "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"
+ },
+ "isLinux": {
+ "description": "Is this a linux stamp capacity",
+ "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": "Request Sub Status.",
+ "type": "integer"
+ },
+ "win32Status": {
+ "format": "int32",
+ "description": "Win32 error code.",
+ "type": "integer"
+ },
+ "count": {
+ "format": "int32",
+ "description": "Request Count.",
+ "type": "integer"
+ },
+ "timeInterval": {
+ "description": "Time interval.",
+ "type": "string"
+ }
+ }
+ },
+ "StringDictionary": {
+ "description": "String dictionary resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Settings.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "User": {
+ "description": "User credentials used for publishing activity.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "User resource specific properties",
+ "required": [
+ "publishingUserName"
+ ],
+ "properties": {
+ "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"
+ },
+ "scmUri": {
+ "description": "Url of SCM site.",
+ "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"
+ }
+ }
+ },
+ "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"
+ },
+ "serviceName": {
+ "description": "name of the service that virtual IP is assigned to",
+ "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"
+ }
+ }
+ },
+ "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": {
+ "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"
+ },
+ "isSwift": {
+ "description": "Flag that is used to denote if this is VNET injection",
+ "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": {
+ "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",
+ "readOnly": 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
+ }
+ }
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/DeletedWebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/DeletedWebApps.json
new file mode 100644
index 000000000000..ee6629092a3a
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/DeletedWebApps.json
@@ -0,0 +1,207 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "DeletedWebApps API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deletedSites": {
+ "get": {
+ "tags": [
+ "DeletedWebApps"
+ ],
+ "summary": "Get all deleted apps for a subscription.",
+ "description": "Description for Get all deleted apps for a subscription.",
+ "operationId": "DeletedWebApps_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedWebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites": {
+ "get": {
+ "tags": [
+ "DeletedWebApps"
+ ],
+ "summary": "Get all deleted apps for a subscription at location",
+ "description": "Description for Get all deleted apps for a subscription at location",
+ "operationId": "DeletedWebApps_ListByLocation",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeletedWebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Deleted Web App by Location": {
+ "$ref": "./examples/ListDeletedWebAppsByLocation.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/deletedSites/{deletedSiteId}": {
+ "get": {
+ "tags": [
+ "DeletedWebApps"
+ ],
+ "summary": "Get deleted app for a subscription at location.",
+ "description": "Description for Get deleted app for a subscription at location.",
+ "operationId": "DeletedWebApps_GetDeletedWebAppByLocation",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deletedSiteId",
+ "in": "path",
+ "description": "The numeric ID of the deleted app, e.g. 12345",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DeletedSite"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Deleted Web App by Location": {
+ "$ref": "./examples/GetDeletedWebAppByLocation.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "DeletedWebAppCollection": {
+ "description": "Collection of deleted apps.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/DeletedSite"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Diagnostics.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Diagnostics.json
new file mode 100644
index 000000000000..ef073f3809bd
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Diagnostics.json
@@ -0,0 +1,2281 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "Diagnostics API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "List Hosting Environment Detector Responses",
+ "description": "Description for List Hosting Environment Detector Responses",
+ "operationId": "Diagnostics_ListHostingEnvironmentDetectorResponses",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorResponseCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Service Environment Detector Responses": {
+ "$ref": "./examples/Diagnostics_ListHostingEnvironmentDetectorResponses.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{name}/detectors/{detectorName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Hosting Environment Detector Response",
+ "description": "Description for Get Hosting Environment Detector Response",
+ "operationId": "Diagnostics_GetHostingEnvironmentDetectorResponse",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "App Service Environment Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Service Environment Detector Responses": {
+ "$ref": "./examples/Diagnostics_GetHostingEnvironmentDetectorResponse.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "List Site Detector Responses",
+ "description": "Description for List Site Detector Responses",
+ "operationId": "Diagnostics_ListSiteDetectorResponses",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorResponseCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Detector Responses": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json"
+ },
+ "Get App Slot Detector Responses": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/detectors/{detectorName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get site detector response",
+ "description": "Description for Get site detector response",
+ "operationId": "Diagnostics_GetSiteDetectorResponse",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Detector Response": {
+ "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json"
+ },
+ "Get App Slot Detector Response": {
+ "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Diagnostics Categories",
+ "description": "Description for Get Diagnostics Categories",
+ "operationId": "Diagnostics_ListSiteDiagnosticCategories",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticCategoryCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Diagnostic Categories": {
+ "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategories.json"
+ },
+ "List App Slot Diagnostic Categories": {
+ "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Diagnostics Category",
+ "description": "Description for Get Diagnostics Category",
+ "operationId": "Diagnostics_GetSiteDiagnosticCategory",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticCategory"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Diagnostic Category": {
+ "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategory.json"
+ },
+ "Get App Slot Diagnostic Category": {
+ "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategorySlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Site Analyses",
+ "description": "Description for Get Site Analyses",
+ "operationId": "Diagnostics_ListSiteAnalyses",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticAnalysisCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Analyses": {
+ "$ref": "./examples/Diagnostics_ListSiteAnalyses.json"
+ },
+ "List App Slot Analyses": {
+ "$ref": "./examples/Diagnostics_ListSiteAnalysesSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Site Analysis",
+ "description": "Description for Get Site Analysis",
+ "operationId": "Diagnostics_GetSiteAnalysis",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "analysisName",
+ "in": "path",
+ "description": "Analysis Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AnalysisDefinition"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Analysis": {
+ "$ref": "./examples/Diagnostics_GetSiteAnalysis.json"
+ },
+ "Get App Slot Analysis": {
+ "$ref": "./examples/Diagnostics_GetSiteAnalysisSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute": {
+ "post": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Execute Analysis",
+ "description": "Description for Execute Analysis",
+ "operationId": "Diagnostics_ExecuteSiteAnalysis",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Category Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "analysisName",
+ "in": "path",
+ "description": "Analysis Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticAnalysis"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Execute site slot analysis": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteAnalysisSlot.json"
+ },
+ "Execute site analysis": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteAnalysis.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Detectors",
+ "description": "Description for Get Detectors",
+ "operationId": "Diagnostics_ListSiteDetectors",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticDetectorCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Detectors": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectors.json"
+ },
+ "List App Slot Detectors": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectorsSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Detector",
+ "description": "Description for Get Detector",
+ "operationId": "Diagnostics_GetSiteDetector",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorDefinition"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Detector": {
+ "$ref": "./examples/Diagnostics_GetSiteDetector.json"
+ },
+ "Get App Slot Detector": {
+ "$ref": "./examples/Diagnostics_GetSiteDetectorSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute": {
+ "post": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Execute Detector",
+ "description": "Description for Execute Detector",
+ "operationId": "Diagnostics_ExecuteSiteDetector",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Category Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticDetectorResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Execute site detector": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteDetector.json"
+ },
+ "Execute site slot detector": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteDetectorSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "List Site Detector Responses",
+ "description": "Description for List Site Detector Responses",
+ "operationId": "Diagnostics_ListSiteDetectorResponsesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorResponseCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Detector Responses": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectorResponses.json"
+ },
+ "Get App Slot Detector Responses": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectorResponsesSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/detectors/{detectorName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get site detector response",
+ "description": "Description for Get site detector response",
+ "operationId": "Diagnostics_GetSiteDetectorResponseSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Detector Response": {
+ "$ref": "./examples/Diagnostics_GetSiteDetectorResponse.json"
+ },
+ "Get App Slot Detector Response": {
+ "$ref": "./examples/Diagnostics_GetSiteDetectorResponseSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Diagnostics Categories",
+ "description": "Description for Get Diagnostics Categories",
+ "operationId": "Diagnostics_ListSiteDiagnosticCategoriesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticCategoryCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Diagnostic Categories": {
+ "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategories.json"
+ },
+ "List App Slot Diagnostic Categories": {
+ "$ref": "./examples/Diagnostics_ListSiteDiagnosticCategoriesSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Diagnostics Category",
+ "description": "Description for Get Diagnostics Category",
+ "operationId": "Diagnostics_GetSiteDiagnosticCategorySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticCategory"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Diagnostic Category": {
+ "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategory.json"
+ },
+ "Get App Slot Diagnostic Category": {
+ "$ref": "./examples/Diagnostics_GetSiteDiagnosticCategorySlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Site Analyses",
+ "description": "Description for Get Site Analyses",
+ "operationId": "Diagnostics_ListSiteAnalysesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticAnalysisCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Analyses": {
+ "$ref": "./examples/Diagnostics_ListSiteAnalyses.json"
+ },
+ "List App Slot Analyses": {
+ "$ref": "./examples/Diagnostics_ListSiteAnalysesSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Site Analysis",
+ "description": "Description for Get Site Analysis",
+ "operationId": "Diagnostics_GetSiteAnalysisSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "analysisName",
+ "in": "path",
+ "description": "Analysis Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot - optional",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AnalysisDefinition"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Analysis": {
+ "$ref": "./examples/Diagnostics_GetSiteAnalysis.json"
+ },
+ "Get App Slot Analysis": {
+ "$ref": "./examples/Diagnostics_GetSiteAnalysisSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/analyses/{analysisName}/execute": {
+ "post": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Execute Analysis",
+ "description": "Description for Execute Analysis",
+ "operationId": "Diagnostics_ExecuteSiteAnalysisSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Category Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "analysisName",
+ "in": "path",
+ "description": "Analysis Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticAnalysis"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Execute site slot analysis": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteAnalysisSlot.json"
+ },
+ "Execute site analysis": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteAnalysis.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Detectors",
+ "description": "Description for Get Detectors",
+ "operationId": "Diagnostics_ListSiteDetectorsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticDetectorCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List App Detectors": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectors.json"
+ },
+ "List App Slot Detectors": {
+ "$ref": "./examples/Diagnostics_ListSiteDetectorsSlot.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}": {
+ "get": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Get Detector",
+ "description": "Description for Get Detector",
+ "operationId": "Diagnostics_GetSiteDetectorSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Diagnostic Category",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DetectorDefinition"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get App Detector": {
+ "$ref": "./examples/Diagnostics_GetSiteDetector.json"
+ },
+ "Get App Slot Detector": {
+ "$ref": "./examples/Diagnostics_GetSiteDetectorSlot.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slot}/diagnostics/{diagnosticCategory}/detectors/{detectorName}/execute": {
+ "post": {
+ "tags": [
+ "Diagnostics"
+ ],
+ "summary": "Execute Detector",
+ "description": "Description for Execute Detector",
+ "operationId": "Diagnostics_ExecuteSiteDetectorSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "detectorName",
+ "in": "path",
+ "description": "Detector Resource Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "diagnosticCategory",
+ "in": "path",
+ "description": "Category Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Slot Name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "startTime",
+ "in": "query",
+ "description": "Start Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "endTime",
+ "in": "query",
+ "description": "End Time",
+ "type": "string",
+ "format": "date-time"
+ },
+ {
+ "name": "timeGrain",
+ "in": "query",
+ "description": "Time Grain",
+ "type": "string",
+ "pattern": "PT[1-9][0-9]+[SMH]"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DiagnosticDetectorResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Execute site detector": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteDetector.json"
+ },
+ "Execute site slot detector": {
+ "$ref": "./examples/Diagnostics_ExecuteSiteDetectorSlot.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AbnormalTimePeriod": {
+ "description": "Class representing Abnormal Time Period identified in diagnosis",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of the downtime",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of the downtime",
+ "type": "string"
+ },
+ "events": {
+ "description": "List of Possible Cause of downtime",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectorAbnormalTimePeriod"
+ }
+ },
+ "solutions": {
+ "description": "List of proposed solutions",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Solution"
+ }
+ }
+ }
+ },
+ "AnalysisData": {
+ "description": "Class Representing Detector Evidence used for analysis",
+ "type": "object",
+ "properties": {
+ "source": {
+ "description": "Name of the Detector",
+ "type": "string"
+ },
+ "detectorDefinition": {
+ "$ref": "#/definitions/DetectorDefinition",
+ "description": "Detector Definition"
+ },
+ "metrics": {
+ "description": "Source Metrics",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiagnosticMetricSet"
+ }
+ },
+ "data": {
+ "description": "Additional Source Data",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameValuePair"
+ }
+ }
+ },
+ "detectorMetaData": {
+ "$ref": "#/definitions/ResponseMetaData",
+ "description": "Detector Meta Data"
+ }
+ }
+ },
+ "AnalysisDefinition": {
+ "description": "Definition of Analysis",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AnalysisDefinition resource specific properties",
+ "properties": {
+ "description": {
+ "description": "Description of the Analysis",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DataSource": {
+ "description": "Class representing data source used by the detectors",
+ "type": "object",
+ "properties": {
+ "instructions": {
+ "description": "Instructions if any for the data source",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "dataSourceUri": {
+ "description": "Datasource Uri Links",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameValuePair"
+ }
+ }
+ }
+ },
+ "DataTableResponseColumn": {
+ "description": "Column definition",
+ "type": "object",
+ "properties": {
+ "columnName": {
+ "description": "Name of the column",
+ "type": "string"
+ },
+ "dataType": {
+ "description": "Data type which looks like 'String' or 'Int32'.",
+ "type": "string"
+ },
+ "columnType": {
+ "description": "Column Type",
+ "type": "string"
+ }
+ }
+ },
+ "DataTableResponseObject": {
+ "description": "Data Table which defines columns and raw row values",
+ "type": "object",
+ "properties": {
+ "tableName": {
+ "description": "Name of the table",
+ "type": "string"
+ },
+ "columns": {
+ "description": "List of columns with data types",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DataTableResponseColumn"
+ }
+ },
+ "rows": {
+ "description": "Raw row values",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ },
+ "DetectorAbnormalTimePeriod": {
+ "description": "Class representing Abnormal Time Period detected.",
+ "type": "object",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of the correlated event",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of the correlated event",
+ "type": "string"
+ },
+ "message": {
+ "description": "Message describing the event",
+ "type": "string"
+ },
+ "source": {
+ "description": "Represents the name of the Detector",
+ "type": "string"
+ },
+ "priority": {
+ "format": "double",
+ "description": "Represents the rank of the Detector",
+ "type": "number"
+ },
+ "metaData": {
+ "description": "Downtime metadata",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameValuePair"
+ }
+ }
+ },
+ "type": {
+ "description": "Represents the type of the Detector",
+ "enum": [
+ "ServiceIncident",
+ "AppDeployment",
+ "AppCrash",
+ "RuntimeIssueDetected",
+ "AseDeployment",
+ "UserIssue",
+ "PlatformIssue",
+ "Other"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "IssueType",
+ "modelAsString": false
+ }
+ },
+ "solutions": {
+ "description": "List of proposed solutions",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Solution"
+ }
+ }
+ }
+ },
+ "DetectorDefinition": {
+ "description": "Class representing detector definition",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DetectorDefinition resource specific properties",
+ "properties": {
+ "displayName": {
+ "description": "Display name of the detector",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "Description of the detector",
+ "type": "string",
+ "readOnly": true
+ },
+ "rank": {
+ "format": "double",
+ "description": "Detector Rank",
+ "type": "number",
+ "readOnly": true
+ },
+ "isEnabled": {
+ "description": "Flag representing whether detector is enabled or not.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DetectorInfo": {
+ "description": "Definition of Detector",
+ "type": "object",
+ "properties": {
+ "description": {
+ "description": "Short description of the detector and its purpose",
+ "type": "string",
+ "readOnly": true
+ },
+ "category": {
+ "description": "Support Category",
+ "type": "string",
+ "readOnly": true
+ },
+ "subCategory": {
+ "description": "Support Sub Category",
+ "type": "string",
+ "readOnly": true
+ },
+ "supportTopicId": {
+ "description": "Support Topic Id",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DetectorResponse": {
+ "description": "Class representing Response from Detector",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DetectorResponse resource specific properties",
+ "properties": {
+ "metadata": {
+ "$ref": "#/definitions/DetectorInfo",
+ "description": "metadata for the detector"
+ },
+ "dataset": {
+ "description": "Data Set",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiagnosticData"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DetectorResponseCollection": {
+ "description": "Collection of detector responses",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectorResponse"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticAnalysis": {
+ "description": "Class representing a diagnostic analysis done on an application",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DiagnosticAnalysis resource specific properties",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of the period",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of the period",
+ "type": "string"
+ },
+ "abnormalTimePeriods": {
+ "description": "List of time periods.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AbnormalTimePeriod"
+ }
+ },
+ "payload": {
+ "description": "Data by each detector",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AnalysisData"
+ }
+ },
+ "nonCorrelatedDetectors": {
+ "description": "Data by each detector for detectors that did not corelate",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectorDefinition"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DiagnosticAnalysisCollection": {
+ "description": "Collection of Diagnostic Analyses",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/AnalysisDefinition"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticCategory": {
+ "description": "Class representing detector definition",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DiagnosticCategory resource specific properties",
+ "properties": {
+ "description": {
+ "description": "Description of the diagnostic category",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DiagnosticCategoryCollection": {
+ "description": "Collection of Diagnostic Categories",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiagnosticCategory"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticData": {
+ "description": "Set of data with rendering instructions",
+ "type": "object",
+ "properties": {
+ "table": {
+ "$ref": "#/definitions/DataTableResponseObject",
+ "description": "Data in table form"
+ },
+ "renderingProperties": {
+ "$ref": "#/definitions/Rendering",
+ "description": "Properties that describe how the table should be rendered"
+ }
+ }
+ },
+ "DiagnosticDetectorCollection": {
+ "description": "Collection of Diagnostic Detectors",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectorDefinition"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "DiagnosticDetectorResponse": {
+ "description": "Class representing Response from Diagnostic Detectors",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DiagnosticDetectorResponse resource specific properties",
+ "properties": {
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of the period",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of the period",
+ "type": "string"
+ },
+ "issueDetected": {
+ "description": "Flag representing Issue was detected.",
+ "type": "boolean"
+ },
+ "detectorDefinition": {
+ "$ref": "#/definitions/DetectorDefinition",
+ "description": "Detector's definition"
+ },
+ "metrics": {
+ "description": "Metrics provided by the detector",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiagnosticMetricSet"
+ }
+ },
+ "abnormalTimePeriods": {
+ "description": "List of Correlated events found by the detector",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DetectorAbnormalTimePeriod"
+ }
+ },
+ "data": {
+ "description": "Additional Data that detector wants to send.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameValuePair"
+ }
+ }
+ },
+ "responseMetaData": {
+ "$ref": "#/definitions/ResponseMetaData",
+ "description": "Meta Data"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DiagnosticMetricSample": {
+ "description": "Class representing Diagnostic Metric",
+ "type": "object",
+ "properties": {
+ "timestamp": {
+ "format": "date-time",
+ "description": "Time at which metric is measured",
+ "type": "string"
+ },
+ "roleInstance": {
+ "description": "Role Instance. Null if this counter is not per instance \nThis is returned and should be whichever instance name we desire to be returned\ni.e. CPU and Memory return RDWORKERNAME (LargeDed..._IN_0) \nwhere RDWORKERNAME is Machine name below and RoleInstance name in parenthesis",
+ "type": "string"
+ },
+ "total": {
+ "format": "double",
+ "description": "Total value of the metric. If multiple measurements are made this will have sum of all.",
+ "type": "number"
+ },
+ "maximum": {
+ "format": "double",
+ "description": "Maximum of the metric sampled during the time period",
+ "type": "number"
+ },
+ "minimum": {
+ "format": "double",
+ "description": "Minimum of the metric sampled during the time period",
+ "type": "number"
+ },
+ "isAggregated": {
+ "description": "Whether the values are aggregates across all workers or not",
+ "type": "boolean"
+ }
+ }
+ },
+ "DiagnosticMetricSet": {
+ "description": "Class representing Diagnostic Metric information",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the metric",
+ "type": "string"
+ },
+ "unit": {
+ "description": "Metric's unit",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of the period",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of the period",
+ "type": "string"
+ },
+ "timeGrain": {
+ "description": "Presented time grain. Supported grains at the moment are PT1M, PT1H, P1D",
+ "type": "string"
+ },
+ "values": {
+ "description": "Collection of metric values for the selected period based on the {Microsoft.Web.Hosting.Administration.DiagnosticMetricSet.TimeGrain}",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DiagnosticMetricSample"
+ }
+ }
+ }
+ },
+ "Rendering": {
+ "description": "Instructions for rendering the data",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Rendering Type",
+ "enum": [
+ "NoGraph",
+ "Table",
+ "TimeSeries",
+ "TimeSeriesPerInstance"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RenderingType",
+ "modelAsString": false
+ }
+ },
+ "title": {
+ "description": "Title of data",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of the data that will help it be interpreted",
+ "type": "string"
+ }
+ }
+ },
+ "ResponseMetaData": {
+ "type": "object",
+ "properties": {
+ "dataSource": {
+ "$ref": "#/definitions/DataSource",
+ "description": "Source of the Data"
+ }
+ }
+ },
+ "Solution": {
+ "description": "Class Representing Solution for problems detected.",
+ "type": "object",
+ "properties": {
+ "id": {
+ "format": "double",
+ "description": "Solution Id.",
+ "type": "number"
+ },
+ "displayName": {
+ "description": "Display Name of the solution",
+ "type": "string"
+ },
+ "order": {
+ "format": "double",
+ "description": "Order of the solution.",
+ "type": "number"
+ },
+ "description": {
+ "description": "Description of the solution",
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of Solution",
+ "enum": [
+ "QuickSolution",
+ "DeepInvestigation",
+ "BestPractices"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SolutionType",
+ "modelAsString": false
+ }
+ },
+ "data": {
+ "description": "Solution Data.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameValuePair"
+ }
+ }
+ },
+ "metadata": {
+ "description": "Solution Metadata.",
+ "type": "array",
+ "items": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameValuePair"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Provider.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Provider.json
new file mode 100644
index 000000000000..baa5d24dfd3c
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Provider.json
@@ -0,0 +1,1085 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "Provider API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.Web/availableStacks": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Get available application frameworks and their versions",
+ "description": "Description for Get available application frameworks and their versions",
+ "operationId": "Provider_GetAvailableStacks",
+ "parameters": [
+ {
+ "name": "osTypeSelected",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "Windows",
+ "Linux",
+ "WindowsFunctions",
+ "LinuxFunctions"
+ ]
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ApplicationStackCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Web/functionAppStacks": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Get available Function app frameworks and their versions",
+ "description": "Description for Get available Function app frameworks and their versions",
+ "operationId": "Provider_GetFunctionAppStacks",
+ "parameters": [
+ {
+ "name": "stackOsType",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "Windows",
+ "Linux",
+ "All"
+ ]
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FunctionAppStackCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Function App Stacks": {
+ "$ref": "./examples/GetFunctionAppStacks.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Web/locations/{location}/functionAppStacks": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Get available Function app frameworks and their versions for location",
+ "description": "Description for Get available Function app frameworks and their versions for location",
+ "operationId": "Provider_GetFunctionAppStacksForLocation",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "stackOsType",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "Windows",
+ "Linux",
+ "All"
+ ]
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FunctionAppStackCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Locations Function App Stacks": {
+ "$ref": "./examples/GetFunctionAppStacksForLocation.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Web/locations/{location}/webAppStacks": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Get available Web app frameworks and their versions for location",
+ "description": "Description for Get available Web app frameworks and their versions for location",
+ "operationId": "Provider_GetWebAppStacksForLocation",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "stackOsType",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "Windows",
+ "Linux",
+ "All"
+ ]
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebAppStackCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Locations Web App Stacks": {
+ "$ref": "./examples/GetWebAppStacksForLocation.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Web/operations": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions",
+ "description": "Description for Gets all available operations for the Microsoft.Web resource provider. Also exposes resource metric definitions",
+ "operationId": "Provider_ListOperations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/CsmOperationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List operations": {
+ "$ref": "./examples/ListOperations.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Web/webAppStacks": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Get available Web app frameworks and their versions",
+ "description": "Description for Get available Web app frameworks and their versions",
+ "operationId": "Provider_GetWebAppStacks",
+ "parameters": [
+ {
+ "name": "stackOsType",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "Windows",
+ "Linux",
+ "All"
+ ]
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebAppStackCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get Web App Stacks": {
+ "$ref": "./examples/GetWebAppStacks.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/availableStacks": {
+ "get": {
+ "tags": [
+ "Provider"
+ ],
+ "summary": "Get available application frameworks and their versions",
+ "description": "Description for Get available application frameworks and their versions",
+ "operationId": "Provider_GetAvailableStacksOnPrem",
+ "parameters": [
+ {
+ "name": "osTypeSelected",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "Windows",
+ "Linux",
+ "WindowsFunctions",
+ "LinuxFunctions"
+ ]
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ApplicationStackCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AppInsightsWebAppStackSettings": {
+ "description": "App Insights Web App stack settings.",
+ "type": "object",
+ "properties": {
+ "isSupported": {
+ "description": "true if remote Application Insights is supported for the stack; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDefaultOff": {
+ "description": "true if Application Insights is disabled by default for the stack; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "ApplicationStack": {
+ "description": "Application stack.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Application stack name.",
+ "type": "string"
+ },
+ "display": {
+ "description": "Application stack display name.",
+ "type": "string"
+ },
+ "dependency": {
+ "description": "Application stack dependency.",
+ "type": "string"
+ },
+ "majorVersions": {
+ "description": "List of major versions available.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StackMajorVersion"
+ }
+ },
+ "frameworks": {
+ "description": "List of frameworks associated with application stack.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationStack"
+ }
+ }
+ }
+ },
+ "ApplicationStackCollection": {
+ "description": "Collection of Application Stacks",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ApplicationStackResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ApplicationStackResource": {
+ "description": "ARM resource for a ApplicationStack.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/ApplicationStack",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "FunctionAppMajorVersion": {
+ "description": "Function App stack major version.",
+ "type": "object",
+ "properties": {
+ "displayText": {
+ "description": "Function App stack major version (display only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Function App stack major version name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "minorVersions": {
+ "description": "Minor versions associated with the major version.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/FunctionAppMinorVersion"
+ }
+ }
+ }
+ },
+ "FunctionAppMinorVersion": {
+ "description": "Function App stack minor version.",
+ "type": "object",
+ "properties": {
+ "displayText": {
+ "description": "Function App stack (display only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Function App stack name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "stackSettings": {
+ "$ref": "#/definitions/FunctionAppRuntimes",
+ "description": "Settings associated with the minor version.",
+ "readOnly": true
+ }
+ }
+ },
+ "FunctionAppRuntimeSettings": {
+ "description": "Function App runtime settings.",
+ "type": "object",
+ "properties": {
+ "runtimeVersion": {
+ "description": "Function App stack minor version (runtime only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "remoteDebuggingSupported": {
+ "description": "true if remote debugging is supported for the stack; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "appInsightsSettings": {
+ "$ref": "#/definitions/AppInsightsWebAppStackSettings",
+ "description": "Application Insights settings associated with the minor version.",
+ "readOnly": true
+ },
+ "gitHubActionSettings": {
+ "$ref": "#/definitions/GitHubActionWebAppStackSettings",
+ "description": "GitHub Actions settings associated with the minor version.",
+ "readOnly": true
+ },
+ "appSettingsDictionary": {
+ "description": "Application settings associated with the minor version.",
+ "type": "object",
+ "readOnly": true,
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "siteConfigPropertiesDictionary": {
+ "$ref": "#/definitions/SiteConfigPropertiesDictionary",
+ "description": "Configuration settings associated with the minor version.",
+ "readOnly": true
+ },
+ "supportedFunctionsExtensionVersions": {
+ "description": "List of supported Functions extension versions.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "type": "string"
+ }
+ },
+ "isPreview": {
+ "description": "true if the stack is in preview; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDeprecated": {
+ "description": "true if the stack is deprecated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isHidden": {
+ "description": "true if the stack should be hidden; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "endOfLifeDate": {
+ "description": "End-of-life date for the minor version.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "isAutoUpdate": {
+ "description": "true if the stack version is auto-updated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isEarlyAccess": {
+ "description": "true if the minor version is early-access; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDefault": {
+ "description": "true if the minor version the default; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "FunctionAppRuntimes": {
+ "description": "Function App stack runtimes.",
+ "type": "object",
+ "properties": {
+ "linuxRuntimeSettings": {
+ "$ref": "#/definitions/FunctionAppRuntimeSettings",
+ "description": "Linux-specific settings associated with the minor version.",
+ "readOnly": true
+ },
+ "windowsRuntimeSettings": {
+ "$ref": "#/definitions/FunctionAppRuntimeSettings",
+ "description": "Windows-specific settings associated with the minor version.",
+ "readOnly": true
+ }
+ }
+ },
+ "FunctionAppStack": {
+ "description": "Function App Stack.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "Function App stack location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "properties": {
+ "description": "FunctionAppStack resource specific properties",
+ "properties": {
+ "displayText": {
+ "description": "Function App stack (display only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Function App stack name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "majorVersions": {
+ "description": "List of major versions available.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/FunctionAppMajorVersion"
+ }
+ },
+ "preferredOs": {
+ "description": "Function App stack preferred OS.",
+ "enum": [
+ "windows",
+ "linux"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StackOsTypes",
+ "modelAsString": false
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "FunctionAppStackCollection": {
+ "description": "Collection of Function app Stacks",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FunctionAppStack"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "GitHubActionWebAppStackSettings": {
+ "description": "GitHub Actions Web App stack settings.",
+ "type": "object",
+ "properties": {
+ "isSupported": {
+ "description": "true if GitHub Actions is supported for the stack; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "supportedVersion": {
+ "description": "The minor version that is supported for GitHub Actions.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "LinuxJavaContainerSettings": {
+ "description": "Linux Java Container settings.",
+ "type": "object",
+ "properties": {
+ "java11Runtime": {
+ "description": "Java 11 version (runtime only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "java8Runtime": {
+ "description": "Java 8 version (runtime only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "isPreview": {
+ "description": "true if the stack is in preview; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDeprecated": {
+ "description": "true if the stack is deprecated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isHidden": {
+ "description": "true if the stack should be hidden; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "endOfLifeDate": {
+ "description": "End-of-life date for the minor version.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "isAutoUpdate": {
+ "description": "true if the stack version is auto-updated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isEarlyAccess": {
+ "description": "true if the minor version is early-access; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "SiteConfigPropertiesDictionary": {
+ "description": "Site config properties dictionary.",
+ "type": "object",
+ "properties": {
+ "use32BitWorkerProcess": {
+ "description": "true if use32BitWorkerProcess should be set to true for the stack; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "linuxFxVersion": {
+ "description": "LinuxFxVersion configuration setting.",
+ "type": "string",
+ "readOnly": true
+ },
+ "javaVersion": {
+ "description": "JavaVersion configuration setting.",
+ "type": "string",
+ "readOnly": true
+ },
+ "powerShellVersion": {
+ "description": "PowerShellVersion configuration setting.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StackMajorVersion": {
+ "description": "Application stack major version.",
+ "type": "object",
+ "properties": {
+ "displayVersion": {
+ "description": "Application stack major version (display only).",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Application stack major version (runtime only).",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "true if this is the default major version; otherwise, false.",
+ "type": "boolean"
+ },
+ "minorVersions": {
+ "description": "Minor versions associated with the major version.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StackMinorVersion"
+ }
+ },
+ "applicationInsights": {
+ "description": "true if this supports Application Insights; otherwise, false.",
+ "type": "boolean"
+ },
+ "isPreview": {
+ "description": "true if this stack is in Preview, otherwise false.",
+ "type": "boolean"
+ },
+ "isDeprecated": {
+ "description": "true if this stack has been deprecated, otherwise false.",
+ "type": "boolean"
+ },
+ "isHidden": {
+ "description": "true if this stack should be hidden for new customers on portal, otherwise false.",
+ "type": "boolean"
+ }
+ }
+ },
+ "StackMinorVersion": {
+ "description": "Application stack minor version.",
+ "type": "object",
+ "properties": {
+ "displayVersion": {
+ "description": "Application stack minor version (display only).",
+ "type": "string"
+ },
+ "runtimeVersion": {
+ "description": "Application stack minor version (runtime only).",
+ "type": "string"
+ },
+ "isDefault": {
+ "description": "true if this is the default minor version; otherwise, false.",
+ "type": "boolean"
+ },
+ "isRemoteDebuggingEnabled": {
+ "description": "true if this supports Remote Debugging, otherwise false.",
+ "type": "boolean"
+ }
+ }
+ },
+ "WebAppMajorVersion": {
+ "description": "Web App stack major version.",
+ "type": "object",
+ "properties": {
+ "displayText": {
+ "description": "Web App stack major version (display only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Web App stack major version name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "minorVersions": {
+ "description": "Minor versions associated with the major version.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/WebAppMinorVersion"
+ }
+ }
+ }
+ },
+ "WebAppMinorVersion": {
+ "description": "Web App stack minor version.",
+ "type": "object",
+ "properties": {
+ "displayText": {
+ "description": "Web App stack minor version (display only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Web App stack major version name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "stackSettings": {
+ "$ref": "#/definitions/WebAppRuntimes",
+ "description": "Settings associated with the minor version.",
+ "readOnly": true
+ }
+ }
+ },
+ "WebAppRuntimeSettings": {
+ "description": "Web App runtime settings.",
+ "type": "object",
+ "properties": {
+ "runtimeVersion": {
+ "description": "Web App stack minor version (runtime only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "remoteDebuggingSupported": {
+ "description": "true if remote debugging is supported for the stack; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "appInsightsSettings": {
+ "$ref": "#/definitions/AppInsightsWebAppStackSettings",
+ "description": "Application Insights settings associated with the minor version.",
+ "readOnly": true
+ },
+ "gitHubActionSettings": {
+ "$ref": "#/definitions/GitHubActionWebAppStackSettings",
+ "description": "GitHub Actions settings associated with the minor version.",
+ "readOnly": true
+ },
+ "isPreview": {
+ "description": "true if the stack is in preview; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDeprecated": {
+ "description": "true if the stack is deprecated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isHidden": {
+ "description": "true if the stack should be hidden; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "endOfLifeDate": {
+ "description": "End-of-life date for the minor version.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "isAutoUpdate": {
+ "description": "true if the stack version is auto-updated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isEarlyAccess": {
+ "description": "true if the minor version is early-access; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ },
+ "WebAppRuntimes": {
+ "description": "Web App stack runtimes.",
+ "type": "object",
+ "properties": {
+ "linuxRuntimeSettings": {
+ "$ref": "#/definitions/WebAppRuntimeSettings",
+ "description": "Linux-specific settings associated with the minor version.",
+ "readOnly": true
+ },
+ "windowsRuntimeSettings": {
+ "$ref": "#/definitions/WebAppRuntimeSettings",
+ "description": "Windows-specific settings associated with the minor version.",
+ "readOnly": true
+ },
+ "linuxContainerSettings": {
+ "$ref": "#/definitions/LinuxJavaContainerSettings",
+ "description": "Linux-specific settings associated with the Java container minor version.",
+ "readOnly": true
+ },
+ "windowsContainerSettings": {
+ "$ref": "#/definitions/WindowsJavaContainerSettings",
+ "description": "Windows-specific settings associated with the Java container minor version.",
+ "readOnly": true
+ }
+ }
+ },
+ "WebAppStack": {
+ "description": "Web App stack.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "location": {
+ "description": "Web App stack location.",
+ "type": "string",
+ "readOnly": true
+ },
+ "properties": {
+ "description": "WebAppStack resource specific properties",
+ "properties": {
+ "displayText": {
+ "description": "Web App stack (display only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "value": {
+ "description": "Web App stack name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "majorVersions": {
+ "description": "List of major versions available.",
+ "type": "array",
+ "readOnly": true,
+ "items": {
+ "$ref": "#/definitions/WebAppMajorVersion"
+ }
+ },
+ "preferredOs": {
+ "description": "Web App stack preferred OS.",
+ "enum": [
+ "windows",
+ "linux"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "StackOsTypes",
+ "modelAsString": false
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebAppStackCollection": {
+ "description": "Collection of Web app Stacks",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WebAppStack"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "WindowsJavaContainerSettings": {
+ "description": "Windows Java Container settings.",
+ "type": "object",
+ "properties": {
+ "javaContainer": {
+ "description": "Java container (runtime only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "javaContainerVersion": {
+ "description": "Java container version (runtime only).",
+ "type": "string",
+ "readOnly": true
+ },
+ "isPreview": {
+ "description": "true if the stack is in preview; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isDeprecated": {
+ "description": "true if the stack is deprecated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isHidden": {
+ "description": "true if the stack should be hidden; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "endOfLifeDate": {
+ "description": "End-of-life date for the minor version.",
+ "type": "string",
+ "format": "date-time",
+ "readOnly": true
+ },
+ "isAutoUpdate": {
+ "description": "true if the stack version is auto-updated; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "isEarlyAccess": {
+ "description": "true if the minor version is early-access; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Recommendations.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Recommendations.json
new file mode 100644
index 000000000000..6eb5d037463e
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/Recommendations.json
@@ -0,0 +1,1072 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "Recommendations API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "List all recommendations for a subscription.",
+ "description": "Description for List all recommendations for a subscription.",
+ "operationId": "Recommendations_List",
+ "parameters": [
+ {
+ "name": "featured",
+ "in": "query",
+ "description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.",
+ "type": "boolean"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/reset": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Reset all recommendation opt-out settings for a subscription.",
+ "description": "Description for Reset all recommendation opt-out settings for a subscription.",
+ "operationId": "Recommendations_ResetAllFilters",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/recommendations/{name}/disable": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Disables the specified rule so it will not apply to a subscription in the future.",
+ "description": "Description for Disables the specified rule so it will not apply to a subscription in the future.",
+ "operationId": "Recommendations_DisableRecommendationForSubscription",
+ "parameters": [
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Rule name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully disabled recommendations."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendationHistory": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Get past recommendations for an app, optionally specified by the time range.",
+ "description": "Description for Get past recommendations for an app, optionally specified by the time range.",
+ "operationId": "Recommendations_ListHistoryForHostingEnvironment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "hostingEnvironmentName",
+ "in": "path",
+ "description": "Name of the hosting environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "expiredOnly",
+ "in": "query",
+ "description": "Specify false to return all recommendations. The default is true, which returns only expired recommendations.",
+ "type": "boolean"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Get all recommendations for a hosting environment.",
+ "description": "Description for Get all recommendations for a hosting environment.",
+ "operationId": "Recommendations_ListRecommendedRulesForHostingEnvironment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "hostingEnvironmentName",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "featured",
+ "in": "query",
+ "description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.",
+ "type": "boolean"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/disable": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Disable all recommendations for an app.",
+ "description": "Description for Disable all recommendations for an app.",
+ "operationId": "Recommendations_DisableAllForHostingEnvironment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "environmentName",
+ "in": "query",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostingEnvironmentName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/reset": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Reset all recommendation opt-out settings for an app.",
+ "description": "Description for Reset all recommendation opt-out settings for an app.",
+ "operationId": "Recommendations_ResetAllFiltersForHostingEnvironment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "environmentName",
+ "in": "query",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostingEnvironmentName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Get a recommendation rule for an app.",
+ "description": "Description for Get a recommendation rule for an app.",
+ "operationId": "Recommendations_GetRuleDetailsByHostingEnvironment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "hostingEnvironmentName",
+ "in": "path",
+ "description": "Name of the hosting environment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the recommendation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "updateSeen",
+ "in": "query",
+ "description": "Specify true to update the last-seen timestamp of the recommendation object.",
+ "type": "boolean"
+ },
+ {
+ "name": "recommendationId",
+ "in": "query",
+ "description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationRule"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/hostingEnvironments/{hostingEnvironmentName}/recommendations/{name}/disable": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Disables the specific rule for a web site permanently.",
+ "description": "Description for Disables the specific rule for a web site permanently.",
+ "operationId": "Recommendations_DisableRecommendationForHostingEnvironment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "environmentName",
+ "in": "query",
+ "description": "Site name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Rule name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostingEnvironmentName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully disabled recommendations."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendationHistory": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Get past recommendations for an app, optionally specified by the time range.",
+ "description": "Description for Get past recommendations for an app, optionally specified by the time range.",
+ "operationId": "Recommendations_ListHistoryForWebApp",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "expiredOnly",
+ "in": "query",
+ "description": "Specify false to return all recommendations. The default is true, which returns only expired recommendations.",
+ "type": "boolean"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification' and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[PT1H|PT1M|P1D]",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Get all recommendations for an app.",
+ "description": "Description for Get all recommendations for an app.",
+ "operationId": "Recommendations_ListRecommendedRulesForWebApp",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "featured",
+ "in": "query",
+ "description": "Specify true to return only the most critical recommendations. The default is false, which returns all recommendations.",
+ "type": "boolean"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only channels specified in the filter. Filter is specified by using OData syntax. Example: $filter=channel eq 'Api' or channel eq 'Notification'",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/disable": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Disable all recommendations for an app.",
+ "description": "Description for Disable all recommendations for an app.",
+ "operationId": "Recommendations_DisableAllForWebApp",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/reset": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Reset all recommendation opt-out settings for an app.",
+ "description": "Description for Reset all recommendation opt-out settings for an app.",
+ "operationId": "Recommendations_ResetAllFiltersForWebApp",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}": {
+ "get": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Get a recommendation rule for an app.",
+ "description": "Description for Get a recommendation rule for an app.",
+ "operationId": "Recommendations_GetRuleDetailsByWebApp",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the recommendation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "updateSeen",
+ "in": "query",
+ "description": "Specify true to update the last-seen timestamp of the recommendation object.",
+ "type": "boolean"
+ },
+ {
+ "name": "recommendationId",
+ "in": "query",
+ "description": "The GUID of the recommendation object if you query an expired one. You don't need to specify it to query an active entry.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RecommendationRule"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/recommendations/{name}/disable": {
+ "post": {
+ "tags": [
+ "Recommendations"
+ ],
+ "summary": "Disables the specific rule for a web site permanently.",
+ "description": "Description for Disables the specific rule for a web site permanently.",
+ "operationId": "Recommendations_DisableRecommendationForSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "siteName",
+ "in": "path",
+ "description": "Site name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Rule name",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully disabled recommendations."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "Recommendation": {
+ "description": "Represents a recommendation result generated by the recommendation engine.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Recommendation resource specific properties",
+ "properties": {
+ "creationTime": {
+ "format": "date-time",
+ "description": "Timestamp when this instance was created.",
+ "type": "string"
+ },
+ "recommendationId": {
+ "format": "uuid",
+ "description": "A GUID value that each recommendation object is associated with.",
+ "type": "string",
+ "example": "00000000-0000-0000-0000-000000000000"
+ },
+ "resourceId": {
+ "description": "Full ARM resource ID string that this recommendation object is associated with.",
+ "type": "string"
+ },
+ "resourceScope": {
+ "description": "Name of a resource type this recommendation applies, e.g. Subscription, ServerFarm, Site.",
+ "enum": [
+ "ServerFarm",
+ "Subscription",
+ "WebSite"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ResourceScopeType",
+ "modelAsString": true
+ }
+ },
+ "ruleName": {
+ "description": "Unique name of the rule.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "UI friendly name of the rule (may not be unique).",
+ "type": "string"
+ },
+ "message": {
+ "description": "Recommendation text.",
+ "type": "string"
+ },
+ "level": {
+ "description": "Level indicating how critical this recommendation can impact.",
+ "enum": [
+ "Critical",
+ "Warning",
+ "Information",
+ "NonUrgentSuggestion"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NotificationLevel",
+ "modelAsString": false
+ }
+ },
+ "channels": {
+ "description": "List of channels that this recommendation can apply.",
+ "enum": [
+ "Notification",
+ "Api",
+ "Email",
+ "Webhook",
+ "All"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Channels",
+ "modelAsString": false
+ }
+ },
+ "categoryTags": {
+ "description": "The list of category tags that this recommendation belongs to.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "actionName": {
+ "description": "Name of action recommended by this object.",
+ "type": "string"
+ },
+ "enabled": {
+ "format": "int32",
+ "description": "True if this recommendation is still valid (i.e. \"actionable\"). False if it is invalid.",
+ "type": "integer"
+ },
+ "states": {
+ "description": "The list of states of this recommendation. If it's null then it should be considered \"Active\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "The beginning time in UTC of a range that the recommendation refers to.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "The end time in UTC of a range that the recommendation refers to.",
+ "type": "string"
+ },
+ "nextNotificationTime": {
+ "format": "date-time",
+ "description": "When to notify this recommendation next in UTC. Null means that this will never be notified anymore.",
+ "type": "string"
+ },
+ "notificationExpirationTime": {
+ "format": "date-time",
+ "description": "Date and time in UTC when this notification expires.",
+ "type": "string"
+ },
+ "notifiedTime": {
+ "format": "date-time",
+ "description": "Last timestamp in UTC this instance was actually notified. Null means that this recommendation hasn't been notified yet.",
+ "type": "string"
+ },
+ "score": {
+ "format": "double",
+ "description": "A metric value measured by the rule.",
+ "type": "number"
+ },
+ "isDynamic": {
+ "description": "True if this is associated with a dynamically added rule",
+ "type": "boolean"
+ },
+ "extensionName": {
+ "description": "Extension name of the portal if exists.",
+ "type": "string"
+ },
+ "bladeName": {
+ "description": "Deep link to a blade on the portal.",
+ "type": "string"
+ },
+ "forwardLink": {
+ "description": "Forward link to an external document associated with the rule.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "RecommendationCollection": {
+ "description": "Collection of recommendations.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Recommendation"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "RecommendationRule": {
+ "description": "Represents a recommendation rule that the recommendation engine can perform.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "RecommendationRule resource specific properties",
+ "properties": {
+ "recommendationName": {
+ "description": "Unique name of the rule.",
+ "type": "string"
+ },
+ "displayName": {
+ "description": "UI friendly name of the rule.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Localized name of the rule (Good for UI).",
+ "type": "string"
+ },
+ "recommendationId": {
+ "format": "uuid",
+ "description": "Recommendation ID of an associated recommendation object tied to the rule, if exists.\nIf such an object doesn't exist, it is set to null.",
+ "type": "string",
+ "example": "00000000-0000-0000-0000-000000000000"
+ },
+ "description": {
+ "description": "Localized detailed description of the rule.",
+ "type": "string"
+ },
+ "actionName": {
+ "description": "Name of action that is recommended by this rule in string.",
+ "type": "string"
+ },
+ "level": {
+ "description": "Level of impact indicating how critical this rule is.",
+ "enum": [
+ "Critical",
+ "Warning",
+ "Information",
+ "NonUrgentSuggestion"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "NotificationLevel",
+ "modelAsString": false
+ }
+ },
+ "channels": {
+ "description": "List of available channels that this rule applies.",
+ "enum": [
+ "Notification",
+ "Api",
+ "Email",
+ "Webhook",
+ "All"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "Channels",
+ "modelAsString": false
+ }
+ },
+ "categoryTags": {
+ "description": "The list of category tags that this recommendation rule belongs to.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "isDynamic": {
+ "description": "True if this is associated with a dynamically added rule",
+ "type": "boolean"
+ },
+ "extensionName": {
+ "description": "Extension name of the portal if exists. Applicable to dynamic rule only.",
+ "type": "string"
+ },
+ "bladeName": {
+ "description": "Deep link to a blade on the portal. Applicable to dynamic rule only.",
+ "type": "string"
+ },
+ "forwardLink": {
+ "description": "Forward link to an external document associated with the rule. Applicable to dynamic rule only.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceHealthMetadata.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceHealthMetadata.json
new file mode 100644
index 000000000000..cb3a0cc52255
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceHealthMetadata.json
@@ -0,0 +1,403 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "ResourceHealthMetadata API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata": {
+ "get": {
+ "tags": [
+ "ResourceHealthMetadata"
+ ],
+ "summary": "List all ResourceHealthMetadata for all sites in the subscription.",
+ "description": "Description for List all ResourceHealthMetadata for all sites in the subscription.",
+ "operationId": "ResourceHealthMetadata_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceHealthMetadataCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List ResourceHealthMetadata for a subscription": {
+ "$ref": "./examples/ListResourceHealthMetadataBySubscription.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata": {
+ "get": {
+ "tags": [
+ "ResourceHealthMetadata"
+ ],
+ "summary": "List all ResourceHealthMetadata for all sites in the resource group in the subscription.",
+ "description": "Description for List all ResourceHealthMetadata for all sites in the resource group in the subscription.",
+ "operationId": "ResourceHealthMetadata_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceHealthMetadataCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List ResourceHealthMetadata for a resource group": {
+ "$ref": "./examples/ListResourceHealthMetadataByResourceGroup.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata": {
+ "get": {
+ "tags": [
+ "ResourceHealthMetadata"
+ ],
+ "summary": "Gets the category of ResourceHealthMetadata to use for the given site as a collection",
+ "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection",
+ "operationId": "ResourceHealthMetadata_ListBySite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceHealthMetadataCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List ResourceHealthMetadata for a site": {
+ "$ref": "./examples/ListResourceHealthMetadataBySite.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata/default": {
+ "get": {
+ "tags": [
+ "ResourceHealthMetadata"
+ ],
+ "summary": "Gets the category of ResourceHealthMetadata to use for the given site",
+ "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site",
+ "operationId": "ResourceHealthMetadata_GetBySite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceHealthMetadata"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ResourceHealthMetadata": {
+ "$ref": "./examples/GetResourceHealthMetadataBySite.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata": {
+ "get": {
+ "tags": [
+ "ResourceHealthMetadata"
+ ],
+ "summary": "Gets the category of ResourceHealthMetadata to use for the given site as a collection",
+ "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site as a collection",
+ "operationId": "ResourceHealthMetadata_ListBySiteSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceHealthMetadataCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List ResourceHealthMetadata for a site": {
+ "$ref": "./examples/ListResourceHealthMetadataBySite.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata/default": {
+ "get": {
+ "tags": [
+ "ResourceHealthMetadata"
+ ],
+ "summary": "Gets the category of ResourceHealthMetadata to use for the given site",
+ "description": "Description for Gets the category of ResourceHealthMetadata to use for the given site",
+ "operationId": "ResourceHealthMetadata_GetBySiteSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceHealthMetadata"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get ResourceHealthMetadata": {
+ "$ref": "./examples/GetResourceHealthMetadataBySite.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "ResourceHealthMetadata": {
+ "description": "Used for getting ResourceHealthCheck settings.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ResourceHealthMetadata resource specific properties",
+ "properties": {
+ "category": {
+ "description": "The category that the resource matches in the RHC Policy File",
+ "type": "string"
+ },
+ "signalAvailability": {
+ "description": "Is there a health signal for the resource",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ResourceHealthMetadataCollection": {
+ "description": "Collection of resource health metadata.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ResourceHealthMetadata"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceProvider.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceProvider.json
new file mode 100644
index 000000000000..2e724a3a2c1e
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/ResourceProvider.json
@@ -0,0 +1,1404 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": " API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/providers/Microsoft.Web/generateGithubAccessTokenForAppserviceCLI": {
+ "post": {
+ "summary": "Exchange code for GitHub access token for AppService CLI",
+ "description": "Description for Exchange code for GitHub access token for AppService CLI",
+ "operationId": "GenerateGithubAccessTokenForAppserviceCLIAsync",
+ "parameters": [
+ {
+ "name": "request",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AppserviceGithubTokenRequest"
+ },
+ "x-ms-client-flatten": true
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AppserviceGithubToken"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Generate Github Access Token For AppService CLI": {
+ "$ref": "./examples/GenerateGithubAccessTokenForAppserviceCLIAsync.json"
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Web/publishingUsers/web": {
+ "get": {
+ "summary": "Gets publishing user",
+ "description": "Description for Gets publishing user",
+ "operationId": "GetPublishingUser",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/User"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "summary": "Updates publishing user",
+ "description": "Description for Updates publishing user",
+ "operationId": "UpdatePublishingUser",
+ "parameters": [
+ {
+ "name": "userDetails",
+ "in": "body",
+ "description": "Details of publishing user",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/User"
+ }
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/User"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/providers/Microsoft.Web/sourcecontrols": {
+ "get": {
+ "summary": "Gets the source controls available for Azure websites.",
+ "description": "Description for Gets the source controls available for Azure websites.",
+ "operationId": "ListSourceControls",
+ "parameters": [
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SourceControlCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/providers/Microsoft.Web/sourcecontrols/{sourceControlType}": {
+ "get": {
+ "summary": "Gets source control token",
+ "description": "Description for Gets source control token",
+ "operationId": "GetSourceControl",
+ "parameters": [
+ {
+ "name": "sourceControlType",
+ "in": "path",
+ "description": "Type of source control",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "summary": "Updates source control token",
+ "description": "Description for Updates source control token",
+ "operationId": "UpdateSourceControl",
+ "parameters": [
+ {
+ "name": "sourceControlType",
+ "in": "path",
+ "description": "Type of source control",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "requestMessage",
+ "in": "body",
+ "description": "Source control token information",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SourceControl"
+ }
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/billingMeters": {
+ "get": {
+ "summary": "Gets a list of meters for a given location.",
+ "description": "Description for Gets a list of meters for a given location.",
+ "operationId": "ListBillingMeters",
+ "parameters": [
+ {
+ "name": "billingLocation",
+ "in": "query",
+ "description": "Azure Location of billable resource",
+ "type": "string"
+ },
+ {
+ "name": "osType",
+ "in": "query",
+ "description": "App Service OS type meters used for",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BillingMeterCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/checknameavailability": {
+ "post": {
+ "summary": "Check if a resource name is available.",
+ "description": "Description for Check if a resource name is available.",
+ "operationId": "CheckNameAvailability",
+ "parameters": [
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Name availability request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ResourceNameAvailabilityRequest"
+ },
+ "x-ms-client-flatten": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ResourceNameAvailability"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/deploymentLocations": {
+ "get": {
+ "summary": "Gets list of available geo regions plus ministamps",
+ "description": "Description for Gets list of available geo regions plus ministamps",
+ "operationId": "GetSubscriptionDeploymentLocations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeploymentLocations"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/geoRegions": {
+ "get": {
+ "summary": "Get a list of available geographical regions.",
+ "description": "Description for Get a list of available geographical regions.",
+ "operationId": "ListGeoRegions",
+ "parameters": [
+ {
+ "name": "sku",
+ "in": "query",
+ "description": "Name of SKU used to filter the regions.",
+ "type": "string",
+ "enum": [
+ "Free",
+ "Shared",
+ "Basic",
+ "Standard",
+ "Premium",
+ "Dynamic",
+ "Isolated",
+ "PremiumV2",
+ "ElasticPremium",
+ "ElasticIsolated"
+ ],
+ "x-ms-enum": {
+ "name": "SkuName",
+ "modelAsString": true
+ }
+ },
+ {
+ "name": "linuxWorkersEnabled",
+ "in": "query",
+ "description": "Specify true if you want to filter to only regions that support Linux workers.",
+ "type": "boolean"
+ },
+ {
+ "name": "xenonWorkersEnabled",
+ "in": "query",
+ "description": "Specify true if you want to filter to only regions that support Xenon workers.",
+ "type": "boolean"
+ },
+ {
+ "name": "linuxDynamicWorkersEnabled",
+ "in": "query",
+ "description": "Specify true if you want to filter to only regions that support Linux Consumption Workers.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/GeoRegionCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/listSitesAssignedToHostName": {
+ "post": {
+ "summary": "List all apps that are assigned to a hostname.",
+ "description": "Description for List all apps that are assigned to a hostname.",
+ "operationId": "ListSiteIdentifiersAssignedToHostName",
+ "parameters": [
+ {
+ "name": "nameIdentifier",
+ "in": "body",
+ "description": "Hostname information.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/NameIdentifier"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/premieraddonoffers": {
+ "get": {
+ "summary": "List all premier add-on offers.",
+ "description": "Description for List all premier add-on offers.",
+ "operationId": "ListPremierAddOnOffers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOnOfferCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/skus": {
+ "get": {
+ "summary": "List all SKUs.",
+ "description": "Description for List all SKUs.",
+ "operationId": "ListSkus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SkuInfos"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/verifyHostingEnvironmentVnet": {
+ "post": {
+ "summary": "Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.",
+ "description": "Description for Verifies if this VNET is compatible with an App Service Environment by analyzing the Network Security Group rules.",
+ "operationId": "VerifyHostingEnvironmentVnet",
+ "parameters": [
+ {
+ "name": "parameters",
+ "in": "body",
+ "description": "VNET information",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/VnetParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/VnetValidationFailureDetails"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "VerifyHostingEnvironmentVnet": {
+ "$ref": "./examples/VerifyHostingEnvironmentVnet.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/moveResources": {
+ "post": {
+ "summary": "Move resources between resource groups.",
+ "description": "Description for Move resources between resource groups.",
+ "operationId": "Move",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "moveResourceEnvelope",
+ "in": "body",
+ "description": "Object that represents the resource to move.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmMoveResourceEnvelope"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/validate": {
+ "post": {
+ "summary": "Validate if a resource can be created.",
+ "description": "Description for Validate if a resource can be created.",
+ "operationId": "Validate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "validateRequest",
+ "in": "body",
+ "description": "Request with the resources to validate.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ValidateRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ValidateResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/validateMoveResources": {
+ "post": {
+ "summary": "Validate whether a resource can be moved.",
+ "description": "Description for Validate whether a resource can be moved.",
+ "operationId": "ValidateMove",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "moveResourceEnvelope",
+ "in": "body",
+ "description": "Object that represents the resource to move.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmMoveResourceEnvelope"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AppserviceGithubToken": {
+ "description": "Github access token for Appservice CLI github integration.",
+ "type": "object",
+ "properties": {
+ "accessToken": {
+ "description": "Github access token for Appservice CLI github integration",
+ "type": "string"
+ },
+ "scope": {
+ "description": "Scope of the github access token",
+ "type": "string"
+ },
+ "tokenType": {
+ "description": "token type",
+ "type": "string"
+ },
+ "gotToken": {
+ "description": "True if valid github token received, False otherwise",
+ "type": "boolean"
+ },
+ "errorMessage": {
+ "description": "Error message if unable to get token",
+ "type": "string"
+ }
+ }
+ },
+ "AppserviceGithubTokenRequest": {
+ "description": "Appservice Github token request content.",
+ "required": [
+ "code",
+ "state"
+ ],
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Code string to exchange for Github Access token",
+ "type": "string",
+ "x-ms-secret": true
+ },
+ "state": {
+ "description": "State string used for verification.",
+ "type": "string"
+ }
+ }
+ },
+ "BillingMeter": {
+ "description": "App Service billing entity that contains information about meter which the Azure billing system utilizes to charge users for services.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "BillingMeter resource specific properties",
+ "properties": {
+ "meterId": {
+ "description": "Meter GUID onboarded in Commerce",
+ "type": "string"
+ },
+ "billingLocation": {
+ "description": "Azure Location of billable resource",
+ "type": "string"
+ },
+ "shortName": {
+ "description": "Short Name from App Service Azure pricing Page",
+ "type": "string"
+ },
+ "friendlyName": {
+ "description": "Friendly name of the meter",
+ "type": "string"
+ },
+ "resourceType": {
+ "description": "App Service ResourceType meter used for",
+ "type": "string"
+ },
+ "osType": {
+ "description": "App Service OS type meter used for",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "BillingMeterCollection": {
+ "description": "Collection of Billing Meters",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BillingMeter"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "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",
+ "properties": {
+ "targetResourceGroup": {
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": " ^[-\\w\\._\\(\\)]+[^\\.]$",
+ "type": "string"
+ },
+ "resources": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "DeploymentLocations": {
+ "description": "List of available locations (regions or App Service Environments) for\ndeployment of App Service resources.",
+ "type": "object",
+ "properties": {
+ "locations": {
+ "description": "Available regions.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GeoRegion"
+ }
+ },
+ "hostingEnvironments": {
+ "description": "Available App Service Environments with full descriptions of the environments.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/AppServiceEnvironment"
+ }
+ },
+ "hostingEnvironmentDeploymentInfos": {
+ "description": "Available App Service Environments with basic information.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HostingEnvironmentDeploymentInfo"
+ }
+ }
+ }
+ },
+ "GeoRegion": {
+ "description": "Geographical region.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "GeoRegion resource specific properties",
+ "properties": {
+ "description": {
+ "description": "Region description.",
+ "type": "string",
+ "readOnly": true
+ },
+ "displayName": {
+ "description": "Display name for region.",
+ "type": "string",
+ "readOnly": true
+ },
+ "orgDomain": {
+ "description": "Display name for region.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "GeoRegionCollection": {
+ "description": "Collection of geographical regions.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GeoRegion"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "GlobalCsmSkuDescription": {
+ "description": "A Global SKU Description.",
+ "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": {
+ "$ref": "./CommonDefinitions.json#/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": "./CommonDefinitions.json#/definitions/Capability"
+ }
+ }
+ }
+ },
+ "HostingEnvironmentDeploymentInfo": {
+ "description": "Information needed to create resources on an App Service Environment.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of the App Service Environment.",
+ "type": "string"
+ },
+ "location": {
+ "description": "Location of the App Service Environment.",
+ "type": "string"
+ }
+ }
+ },
+ "PremierAddOnOffer": {
+ "description": "Premier add-on offer.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "PremierAddOnOffer resource specific properties",
+ "properties": {
+ "sku": {
+ "description": "Premier add on SKU.",
+ "type": "string"
+ },
+ "product": {
+ "description": "Premier add on offer Product.",
+ "type": "string"
+ },
+ "vendor": {
+ "description": "Premier add on offer Vendor.",
+ "type": "string"
+ },
+ "promoCodeRequired": {
+ "description": "true if promotion code is required; otherwise, false.",
+ "type": "boolean"
+ },
+ "quota": {
+ "format": "int32",
+ "description": "Premier add on offer Quota.",
+ "type": "integer"
+ },
+ "webHostingPlanRestrictions": {
+ "description": "App Service plans this offer is restricted to.",
+ "enum": [
+ "None",
+ "Free",
+ "Shared",
+ "Basic",
+ "Standard",
+ "Premium"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AppServicePlanRestrictions",
+ "modelAsString": false
+ }
+ },
+ "privacyPolicyUrl": {
+ "description": "Privacy policy URL.",
+ "type": "string"
+ },
+ "legalTermsUrl": {
+ "description": "Legal terms URL.",
+ "type": "string"
+ },
+ "marketplacePublisher": {
+ "description": "Marketplace publisher.",
+ "type": "string"
+ },
+ "marketplaceOffer": {
+ "description": "Marketplace offer.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PremierAddOnOfferCollection": {
+ "description": "Collection of premier add-on offers.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PremierAddOnOffer"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ResourceNameAvailability": {
+ "description": "Information regarding availability of a resource name.",
+ "type": "object",
+ "properties": {
+ "nameAvailable": {
+ "description": "true indicates name is valid and available. false indicates the name is invalid, unavailable, or both.",
+ "type": "boolean"
+ },
+ "reason": {
+ "description": "Invalid indicates the name provided does not match Azure App Service naming requirements. AlreadyExists indicates that the name is already in use and is therefore unavailable.",
+ "enum": [
+ "Invalid",
+ "AlreadyExists"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "InAvailabilityReasonType",
+ "modelAsString": true
+ }
+ },
+ "message": {
+ "description": "If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that resource name is already in use, and direct them to select a different name.",
+ "type": "string"
+ }
+ }
+ },
+ "ResourceNameAvailabilityRequest": {
+ "description": "Resource name availability request content.",
+ "required": [
+ "name",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Resource name to verify.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type used for verification.",
+ "enum": [
+ "Site",
+ "Slot",
+ "HostingEnvironment",
+ "PublishingUser",
+ "Microsoft.Web/sites",
+ "Microsoft.Web/sites/slots",
+ "Microsoft.Web/hostingEnvironments",
+ "Microsoft.Web/publishingUsers"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CheckNameResourceTypes",
+ "modelAsString": true
+ }
+ },
+ "isFqdn": {
+ "description": "Is fully qualified domain name.",
+ "type": "boolean"
+ }
+ }
+ },
+ "SkuInfos": {
+ "description": "Collection of SKU information.",
+ "type": "object",
+ "properties": {
+ "resourceType": {
+ "description": "Resource type that this SKU applies to.",
+ "type": "string"
+ },
+ "skus": {
+ "description": "List of SKUs the subscription is able to use.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/GlobalCsmSkuDescription"
+ }
+ }
+ }
+ },
+ "SourceControl": {
+ "description": "The source control OAuth token.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SourceControl resource specific properties",
+ "properties": {
+ "token": {
+ "description": "OAuth access token.",
+ "type": "string"
+ },
+ "tokenSecret": {
+ "description": "OAuth access token secret.",
+ "type": "string"
+ },
+ "refreshToken": {
+ "description": "OAuth refresh token.",
+ "type": "string"
+ },
+ "expirationTime": {
+ "format": "date-time",
+ "description": "OAuth token expiration.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SourceControlCollection": {
+ "description": "Collection of source controls.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SourceControl"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ValidateProperties": {
+ "description": "App properties used for validation.",
+ "type": "object",
+ "properties": {
+ "serverFarmId": {
+ "description": "ARM resource ID of an App Service plan that would host the app.",
+ "type": "string"
+ },
+ "skuName": {
+ "description": "Name of the target SKU for the App Service plan.",
+ "type": "string"
+ },
+ "needLinuxWorkers": {
+ "description": "true if App Service plan is for Linux workers; otherwise, false.",
+ "type": "boolean"
+ },
+ "isSpot": {
+ "description": "true if App Service plan is for Spot instances; otherwise, false.",
+ "type": "boolean"
+ },
+ "capacity": {
+ "format": "int32",
+ "description": "Target capacity of the App Service plan (number of VMs).",
+ "minimum": 1,
+ "type": "integer"
+ },
+ "hostingEnvironment": {
+ "description": "Name of App Service Environment where app or App Service plan should be created.",
+ "type": "string"
+ },
+ "isXenon": {
+ "description": "true if App Service plan is running as a windows container",
+ "type": "boolean"
+ },
+ "containerRegistryBaseUrl": {
+ "description": "Base URL of the container registry",
+ "type": "string"
+ },
+ "containerRegistryUsername": {
+ "description": "Username for to access the container registry",
+ "type": "string"
+ },
+ "containerRegistryPassword": {
+ "description": "Password for to access the container registry",
+ "type": "string"
+ },
+ "containerImageRepository": {
+ "description": "Repository name (image name)",
+ "type": "string"
+ },
+ "containerImageTag": {
+ "description": "Image tag",
+ "type": "string"
+ },
+ "containerImagePlatform": {
+ "description": "Platform (windows or linux)",
+ "type": "string"
+ }
+ }
+ },
+ "ValidateRequest": {
+ "description": "Resource validation request content.",
+ "required": [
+ "name",
+ "type",
+ "location",
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Resource name to verify.",
+ "type": "string"
+ },
+ "type": {
+ "description": "Resource type used for verification.",
+ "enum": [
+ "ServerFarm",
+ "Site"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ValidateResourceTypes",
+ "modelAsString": true
+ }
+ },
+ "location": {
+ "description": "Expected location of the resource.",
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/ValidateProperties",
+ "description": "Properties of the resource to validate.",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ValidateResponse": {
+ "description": "Describes the result of resource validation.",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Result of validation.",
+ "type": "string"
+ },
+ "error": {
+ "$ref": "#/definitions/ValidateResponseError",
+ "description": "Error details for the case when validation fails."
+ }
+ }
+ },
+ "ValidateResponseError": {
+ "description": "Error details for when validation fails.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "Validation error code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "Validation error message.",
+ "type": "string"
+ }
+ }
+ },
+ "VnetParameters": {
+ "description": "The required set of inputs to validate a VNET",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "VnetParameters resource specific properties",
+ "properties": {
+ "vnetResourceGroup": {
+ "description": "The Resource Group of the VNET to be validated",
+ "type": "string"
+ },
+ "vnetName": {
+ "description": "The name of the VNET to be validated",
+ "type": "string"
+ },
+ "vnetSubnetName": {
+ "description": "The subnet name to be validated",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "VnetValidationFailureDetails": {
+ "description": "A class that describes the reason for a validation failure.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "VnetValidationFailureDetails resource specific properties",
+ "properties": {
+ "failed": {
+ "description": "A flag describing whether or not validation failed.",
+ "type": "boolean"
+ },
+ "failedTests": {
+ "description": "A list of tests that failed in the validation.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/VnetValidationTestFailure"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "VnetValidationTestFailure": {
+ "description": "A class that describes a test that failed during NSG and UDR validation.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "VnetValidationTestFailure resource specific properties",
+ "properties": {
+ "testName": {
+ "description": "The name of the test that failed.",
+ "type": "string"
+ },
+ "details": {
+ "description": "The details of what caused the failure, e.g. the blocking rule name, etc.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/StaticSites.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/StaticSites.json
new file mode 100644
index 000000000000..853254146067
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/StaticSites.json
@@ -0,0 +1,2025 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "StaticSites API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/locations/{location}/previewStaticSiteWorkflowFile": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Generates a preview workflow file for the static site",
+ "description": "Description for Generates a preview workflow file for the static site",
+ "operationId": "StaticSites_PreviewWorkflow",
+ "parameters": [
+ {
+ "name": "location",
+ "in": "path",
+ "description": "Location where you plan to create the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "staticSitesWorkflowPreviewRequest",
+ "in": "body",
+ "description": "A JSON representation of the StaticSitesWorkflowPreviewRequest properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StaticSitesWorkflowPreviewRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/StaticSitesWorkflowPreview"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Generates a preview workflow file for the static site": {
+ "$ref": "./examples/GenerateStaticSiteWorkflowPreview.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/staticSites": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Get all Static Sites for a subscription.",
+ "description": "Description for Get all Static Sites for a subscription.",
+ "operationId": "StaticSites_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get all static sites in a subscription": {
+ "$ref": "./examples/GetAllStaticSites.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets all static sites in the specified resource group.",
+ "description": "Description for Gets all static sites in the specified resource group.",
+ "operationId": "StaticSites_GetStaticSitesByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get static sites for a resource group": {
+ "$ref": "./examples/GetStaticSites.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the details of a static site.",
+ "description": "Description for Gets the details of a static site.",
+ "operationId": "StaticSites_GetStaticSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get details for a static site": {
+ "$ref": "./examples/GetStaticSite.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Creates a new static site in an existing resource group, or updates an existing static site.",
+ "description": "Description for Creates a new static site in an existing resource group, or updates an existing static site.",
+ "operationId": "StaticSites_CreateOrUpdateStaticSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site to create or update.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "staticSiteEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the staticsite properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a static site": {
+ "$ref": "./examples/CreateOrUpdateStaticSite.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Deletes a static site.",
+ "description": "Description for Deletes a static site.",
+ "operationId": "StaticSites_DeleteStaticSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site to delete.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Asynchronous operation in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete a static site": {
+ "$ref": "./examples/DeleteStaticSite.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Creates a new static site in an existing resource group, or updates an existing static site.",
+ "description": "Description for Creates a new static site in an existing resource group, or updates an existing static site.",
+ "operationId": "StaticSites_UpdateStaticSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site to create or update.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "staticSiteEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the staticsite properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StaticSitePatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Patch a static site": {
+ "$ref": "./examples/PatchStaticSite.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/listUsers": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the list of users of a static site.",
+ "description": "Description for Gets the list of users of a static site.",
+ "operationId": "StaticSites_ListStaticSiteUsers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "authprovider",
+ "in": "path",
+ "description": "The auth provider for the users.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteUserCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List users for a static site": {
+ "$ref": "./examples/ListStaticSiteUsers.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/authproviders/{authprovider}/users/{userid}": {
+ "delete": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Deletes the user entry from the static site.",
+ "description": "Description for Deletes the user entry from the static site.",
+ "operationId": "StaticSites_DeleteStaticSiteUser",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the staticsite.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "authprovider",
+ "in": "path",
+ "description": "The auth provider for this user.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "userid",
+ "in": "path",
+ "description": "The user id of the user.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete a user for a static site": {
+ "$ref": "./examples/DeleteStaticSiteUser.json"
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Updates a user entry with the listed roles",
+ "description": "Description for Updates a user entry with the listed roles",
+ "operationId": "StaticSites_UpdateStaticSiteUser",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "authprovider",
+ "in": "path",
+ "description": "The auth provider for this user.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "userid",
+ "in": "path",
+ "description": "The user id of the user.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "staticSiteUserEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the StaticSiteUser properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StaticSiteUserARMResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteUserARMResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a user for a static site": {
+ "$ref": "./examples/UpdateStaticSiteUser.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets all static site builds for a particular static site.",
+ "description": "Description for Gets all static site builds for a particular static site.",
+ "operationId": "StaticSites_GetStaticSiteBuilds",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteBuildCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get all builds for a static site": {
+ "$ref": "./examples/GetStaticSiteBuilds.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{prId}": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the details of a static site build.",
+ "description": "Description for Gets the details of a static site build.",
+ "operationId": "StaticSites_GetStaticSiteBuild",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "prId",
+ "in": "path",
+ "description": "The stage site identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteBuildARMResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a static site build": {
+ "$ref": "./examples/GetStaticSiteBuild.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Deletes a static site build.",
+ "description": "Description for Deletes a static site build.",
+ "operationId": "StaticSites_DeleteStaticSiteBuild",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "prId",
+ "in": "path",
+ "description": "The stage site identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Asynchronous operation in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete a static site build": {
+ "$ref": "./examples/DeleteStaticSiteBuild.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{prId}/config/functionappsettings": {
+ "put": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Creates or updates the function app settings of a static site build.",
+ "description": "Description for Creates or updates the function app settings of a static site build.",
+ "operationId": "StaticSites_CreateOrUpdateStaticSiteBuildFunctionAppSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "prId",
+ "in": "path",
+ "description": "The stage site identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "appSettings",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Creates or updates the function app settings of a static site build.": {
+ "$ref": "./examples/CreateOrUpdateStaticSiteBuildFunctionAppSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{prId}/functions": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the functions of a particular static site build.",
+ "description": "Description for Gets the functions of a particular static site build.",
+ "operationId": "StaticSites_ListStaticSiteBuildFunctions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "prId",
+ "in": "path",
+ "description": "The stage site identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteFunctionOverviewCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets the functions of a particular static site build": {
+ "$ref": "./examples/ListStaticSiteBuildFunctions.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/builds/{prId}/listFunctionAppSettings": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the application settings of a static site.",
+ "description": "Description for Gets the application settings of a static site.",
+ "operationId": "StaticSites_ListStaticSiteBuildFunctionAppSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "prId",
+ "in": "path",
+ "description": "The stage site identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get function app settings of a static site build": {
+ "$ref": "./examples/ListStaticSiteBuildFunctionAppSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/config/functionappsettings": {
+ "put": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Creates or updates the function app settings of a static site.",
+ "description": "Description for Creates or updates the function app settings of a static site.",
+ "operationId": "StaticSites_CreateOrUpdateStaticSiteFunctionAppSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "appSettings",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Creates or updates the function app settings of a static site.": {
+ "$ref": "./examples/CreateOrUpdateStaticSiteFunctionAppSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/createUserInvitation": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Creates an invitation link for a user with the role",
+ "description": "Description for Creates an invitation link for a user with the role",
+ "operationId": "StaticSites_CreateUserRolesInvitationLink",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "staticSiteUserRolesInvitationEnvelope",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StaticSiteUserInvitationRequestResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteUserInvitationResponseResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create an invitation link for a user for a static site": {
+ "$ref": "./examples/CreateUserRolesInvitationLink.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets all static site custom domains for a particular static site.",
+ "description": "Description for Gets all static site custom domains for a particular static site.",
+ "operationId": "StaticSites_ListStaticSiteCustomDomains",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site resource to search in.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteCustomDomainOverviewCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List custom domains for a static site": {
+ "$ref": "./examples/GetStaticSiteCustomDomains.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}": {
+ "put": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Creates a new static site custom domain in an existing resource group and static site.",
+ "description": "Description for Creates a new static site custom domain in an existing resource group and static site.",
+ "operationId": "StaticSites_CreateOrUpdateStaticSiteCustomDomain",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "The custom domain to create.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Create or update a custom domain for a static site": {
+ "$ref": "./examples/CreateOrUpdateStaticSiteCustomDomain.json"
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Deletes a custom domain.",
+ "description": "Description for Deletes a custom domain.",
+ "operationId": "StaticSites_DeleteStaticSiteCustomDomain",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "The custom domain to delete.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Asynchronous operation in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete a custom domain for a static site": {
+ "$ref": "./examples/DeleteStaticSiteCustomDomain.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/customDomains/{domainName}/validate": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Validates a particular custom domain can be added to a static site.",
+ "description": "Description for Validates a particular custom domain can be added to a static site.",
+ "operationId": "StaticSites_ValidateCustomDomainCanBeAddedToStaticSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainName",
+ "in": "path",
+ "description": "The custom domain to validate.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Asynchronous operation in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Validate a custom domain for a static site": {
+ "$ref": "./examples/ValidateStaticSiteCustomDomain.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/detach": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Detaches a static site.",
+ "description": "Description for Detaches a static site.",
+ "operationId": "StaticSites_DetachStaticSite",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site to detach.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Asynchronous operation in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Detach a static site": {
+ "$ref": "./examples/DetachStaticSite.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/functions": {
+ "get": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the functions of a static site.",
+ "description": "Description for Gets the functions of a static site.",
+ "operationId": "StaticSites_ListStaticSiteFunctions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/StaticSiteFunctionOverviewCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Gets the functions of a static site": {
+ "$ref": "./examples/ListStaticSiteFunctions.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listFunctionAppSettings": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Gets the application settings of a static site.",
+ "description": "Description for Gets the application settings of a static site.",
+ "operationId": "StaticSites_ListStaticSiteFunctionAppSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get function app settings of a static site": {
+ "$ref": "./examples/ListStaticSiteFunctionAppSettings.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/listSecrets": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Lists the secrets for an existing static site.",
+ "description": "Description for Lists the secrets for an existing static site.",
+ "operationId": "StaticSites_ListStaticSiteSecrets",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List secrets for a static site": {
+ "$ref": "./examples/ListStaticSiteSecrets.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/staticSites/{name}/resetapikey": {
+ "post": {
+ "tags": [
+ "StaticSites"
+ ],
+ "summary": "Resets the api key for an existing static site.",
+ "description": "Description for Resets the api key for an existing static site.",
+ "operationId": "StaticSites_ResetStaticSiteApiKey",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the static site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "resetPropertiesEnvelope",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StaticSiteResetPropertiesARMResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Reset the api key for a static site": {
+ "$ref": "./examples/ResetStaticSiteApiKey.json"
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "StaticSite": {
+ "description": "A static site.",
+ "type": "object",
+ "properties": {
+ "defaultHostname": {
+ "description": "The default autogenerated hostname for the static site.",
+ "type": "string",
+ "readOnly": true
+ },
+ "repositoryUrl": {
+ "description": "URL for the repository of the static site.",
+ "type": "string"
+ },
+ "branch": {
+ "description": "The target branch in the repository.",
+ "type": "string"
+ },
+ "customDomains": {
+ "description": "The custom domains associated with this static site.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "repositoryToken": {
+ "description": "A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.",
+ "type": "string"
+ },
+ "buildProperties": {
+ "$ref": "#/definitions/StaticSiteBuildProperties",
+ "description": "Build properties to configure on the repository."
+ }
+ }
+ },
+ "StaticSiteARMResource": {
+ "description": "Static Site ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StaticSite",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ },
+ "sku": {
+ "$ref": "./CommonDefinitions.json#/definitions/SkuDescription"
+ }
+ }
+ },
+ "StaticSiteBuildARMResource": {
+ "description": "Static Site Build ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteBuildARMResource resource specific properties",
+ "properties": {
+ "buildId": {
+ "description": "An identifier for the static site build.",
+ "type": "string",
+ "readOnly": true
+ },
+ "sourceBranch": {
+ "description": "The source branch.",
+ "type": "string",
+ "readOnly": true
+ },
+ "pullRequestTitle": {
+ "description": "The title of a pull request that a static site build is related to.",
+ "type": "string",
+ "readOnly": true
+ },
+ "hostname": {
+ "description": "The hostname for a static site build.",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdTimeUtc": {
+ "format": "date-time",
+ "description": "When this build was created.",
+ "type": "string",
+ "readOnly": true
+ },
+ "lastUpdatedOn": {
+ "format": "date-time",
+ "description": "When this build was updated.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "The status of the static site build.",
+ "enum": [
+ "WaitingForDeployment",
+ "Uploading",
+ "Deploying",
+ "Ready",
+ "Failed",
+ "Deleting",
+ "Detached"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BuildStatus",
+ "modelAsString": true
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteBuildCollection": {
+ "description": "Collection of static site builds.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StaticSiteBuildARMResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StaticSiteBuildProperties": {
+ "description": "Build properties for the static site.",
+ "type": "object",
+ "properties": {
+ "appLocation": {
+ "description": "The path to the app code within the repository.",
+ "type": "string"
+ },
+ "apiLocation": {
+ "description": "The path to the api code within the repository.",
+ "type": "string"
+ },
+ "appArtifactLocation": {
+ "description": "The path of the app artifacts after building.",
+ "type": "string"
+ }
+ }
+ },
+ "StaticSiteCollection": {
+ "description": "Collection of static sites.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StaticSiteARMResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StaticSiteCustomDomainOverviewARMResource": {
+ "description": "Static Site Custom Domain Overview ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteCustomDomainOverviewARMResource resource specific properties",
+ "properties": {
+ "domainName": {
+ "description": "The domain name for the static site custom domain.",
+ "type": "string",
+ "readOnly": true
+ },
+ "createdOn": {
+ "format": "date-time",
+ "description": "The date and time on which the custom domain was created for the static site.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteCustomDomainOverviewCollection": {
+ "description": "Collection of static site custom domains.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StaticSiteCustomDomainOverviewARMResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StaticSiteFunctionOverviewARMResource": {
+ "description": "Static Site Function Overview ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteFunctionOverviewARMResource resource specific properties",
+ "properties": {
+ "functionName": {
+ "description": "The name for the function",
+ "type": "string",
+ "readOnly": true
+ },
+ "triggerType": {
+ "description": "The trigger type of the function",
+ "enum": [
+ "HttpTrigger",
+ "Unknown"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "TriggerTypes",
+ "modelAsString": true
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteFunctionOverviewCollection": {
+ "description": "Collection of static site functions.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StaticSiteFunctionOverviewARMResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StaticSitePatchResource": {
+ "description": "ARM resource for a static site when patching",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/StaticSite",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteResetPropertiesARMResource": {
+ "description": "Static Site Reset Properties ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteResetPropertiesARMResource resource specific properties",
+ "properties": {
+ "repositoryToken": {
+ "description": "The token which proves admin privileges to the repository.",
+ "type": "string"
+ },
+ "shouldUpdateRepository": {
+ "description": "Determines whether the repository should be updated with the new properties.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteUserARMResource": {
+ "description": "Static Site User ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteUserARMResource resource specific properties",
+ "properties": {
+ "provider": {
+ "description": "The identity provider for the static site user.",
+ "type": "string",
+ "readOnly": true
+ },
+ "userId": {
+ "description": "The user id for the static site user.",
+ "type": "string",
+ "readOnly": true
+ },
+ "displayName": {
+ "description": "The display name for the static site user.",
+ "type": "string",
+ "readOnly": true
+ },
+ "roles": {
+ "description": "The roles for the static site user, in free-form string format",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteUserCollection": {
+ "description": "Collection of static site custom users.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/StaticSiteUserARMResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "StaticSiteUserInvitationRequestResource": {
+ "description": "Static sites user roles invitation resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteUserInvitationRequestResource resource specific properties",
+ "properties": {
+ "domain": {
+ "description": "The domain name for the static site custom domain.",
+ "type": "string"
+ },
+ "provider": {
+ "description": "The identity provider for the static site user.",
+ "type": "string"
+ },
+ "userDetails": {
+ "description": "The user id for the static site user.",
+ "type": "string"
+ },
+ "roles": {
+ "description": "The roles for the static site user, in free-form string format",
+ "type": "string"
+ },
+ "numHoursToExpiration": {
+ "format": "int32",
+ "description": "The number of hours the sas token stays valid",
+ "type": "integer"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSiteUserInvitationResponseResource": {
+ "description": "Static sites user roles invitation link resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSiteUserInvitationResponseResource resource specific properties",
+ "properties": {
+ "expiresOn": {
+ "format": "date-time",
+ "description": "The expiration time of the invitation",
+ "type": "string",
+ "readOnly": true
+ },
+ "invitationUrl": {
+ "description": "The url for the invitation link",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSitesWorkflowPreview": {
+ "description": "Preview for the Static Site Workflow to be generated",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSitesWorkflowPreview resource specific properties",
+ "properties": {
+ "path": {
+ "description": "The path for the workflow file to be generated",
+ "type": "string",
+ "readOnly": true
+ },
+ "contents": {
+ "description": "The contents for the workflow file to be generated",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StaticSitesWorkflowPreviewRequest": {
+ "description": "Request entity for previewing the Static Site workflow",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StaticSitesWorkflowPreviewRequest resource specific properties",
+ "properties": {
+ "repositoryUrl": {
+ "description": "URL for the repository of the static site.",
+ "type": "string"
+ },
+ "branch": {
+ "description": "The target branch in the repository.",
+ "type": "string"
+ },
+ "buildProperties": {
+ "$ref": "#/definitions/StaticSiteBuildProperties",
+ "description": "Build properties to configure on the repository."
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/WebApps.json
new file mode 100644
index 000000000000..5d9d57ef9345
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/WebApps.json
@@ -0,0 +1,25245 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "version": "2020-10-01",
+ "title": "WebApps API Client"
+ },
+ "host": "management.azure.com",
+ "schemes": [
+ "https"
+ ],
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/subscriptions/{subscriptionId}/providers/Microsoft.Web/sites": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get all apps for a subscription.",
+ "description": "Description for Get all apps for a subscription.",
+ "operationId": "WebApps_List",
+ "parameters": [
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all web, mobile, and API apps in the specified resource group.",
+ "description": "Description for Gets all web, mobile, and API apps in the specified resource group.",
+ "operationId": "WebApps_ListByResourceGroup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "includeSlots",
+ "in": "query",
+ "description": "Specify true to include deployment slots in results. The default is false, which only gives you the production slot of all apps.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the details of a web, mobile, or API app.",
+ "description": "Description for Gets the details of a web, mobile, or API app.",
+ "operationId": "WebApps_Get",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "404": {
+ "description": "Not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "operationId": "WebApps_CreateOrUpdate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the app properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a web, mobile, or API app, or one of the deployment slots.",
+ "description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.",
+ "operationId": "WebApps_Delete",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app to delete.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deleteMetrics",
+ "in": "query",
+ "description": "If true, web app metrics are also deleted.",
+ "type": "boolean"
+ },
+ {
+ "name": "deleteEmptyServerFarm",
+ "in": "query",
+ "description": "Specify false if you want to keep empty App Service plan. By default, empty App Service plan is deleted.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted web app."
+ },
+ "204": {
+ "description": "Successfully deleted web app."
+ },
+ "404": {
+ "description": "Web app not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "operationId": "WebApps_Update",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the app properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SitePatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/analyzeCustomHostname": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Analyze a custom hostname.",
+ "description": "Description for Analyze a custom hostname.",
+ "operationId": "WebApps_AnalyzeCustomHostname",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "query",
+ "description": "Custom hostname.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CustomHostnameAnalysisResult"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/applySlotConfig": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Applies the configuration settings from the target slot onto the current slot.",
+ "description": "Description for Applies the configuration settings from the target slot onto the current slot.",
+ "operationId": "WebApps_ApplySlotConfigToProduction",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotSwapEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmSlotEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backup": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a backup of an app.",
+ "description": "Description for Creates a backup of an app.",
+ "operationId": "WebApps_Backup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Backup configuration. You can use the JSON response from the POST action as input here.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets existing backups of an app.",
+ "description": "Description for Gets existing backups of an app.",
+ "operationId": "WebApps_ListBackups",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItemCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a backup of an app by its ID.",
+ "description": "Description for Gets a backup of an app by its ID.",
+ "operationId": "WebApps_GetBackupStatus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of the backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a backup of an app by its ID.",
+ "description": "Description for Deletes a backup of an app by its ID.",
+ "operationId": "WebApps_DeleteBackup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of the backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted web app backup item."
+ },
+ "404": {
+ "description": "Web app backup item does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
+ "description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
+ "operationId": "WebApps_ListBackupStatusSecrets",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Information on backup request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/backups/{backupId}/restore": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a specific backup to another app (or deployment slot, if specified).",
+ "description": "Description for Restores a specific backup to another app (or deployment slot, if specified).",
+ "operationId": "WebApps_Restore",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of the backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Information on restore request .",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
+ "description": "Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.",
+ "operationId": "WebApps_GetBasicPublishingCredentialsPolicies",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List Publishing Credentials Policies": {
+ "$ref": "./examples/ListPublishingCredentialsPolicies.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns whether FTP is allowed on the site or not.",
+ "description": "Description for Returns whether FTP is allowed on the site or not.",
+ "operationId": "WebApps_GetFtpAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get FTP Allowed": {
+ "$ref": "./examples/GetPublishingCredentialsPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates whether FTP is allowed on the site or not.",
+ "description": "Description for Updates whether FTP is allowed on the site or not.",
+ "operationId": "WebApps_UpdateFtpAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "csmPublishingAccessPoliciesEntity",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update FTP Allowed": {
+ "$ref": "./examples/UpdatePublishingCredentialsPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns whether Scm basic auth is allowed on the site or not.",
+ "description": "Description for Returns whether Scm basic auth is allowed on the site or not.",
+ "operationId": "WebApps_GetScmAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get SCM Allowed": {
+ "$ref": "./examples/GetPublishingCredentialsPolicy.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates whether user publishing credentials are allowed on the site or not.",
+ "description": "Description for Updates whether user publishing credentials are allowed on the site or not.",
+ "operationId": "WebApps_UpdateScmAllowed",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "csmPublishingAccessPoliciesEntity",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Update SCM Allowed": {
+ "$ref": "./examples/UpdatePublishingCredentialsPolicy.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the configurations of an app",
+ "description": "Description for List the configurations of an app",
+ "operationId": "WebApps_ListConfigurations",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResourceCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Replaces the application settings of an app.",
+ "description": "Description for Replaces the application settings of an app.",
+ "operationId": "WebApps_UpdateApplicationSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "appSettings",
+ "in": "body",
+ "description": "Application settings of the app.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/appsettings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the application settings of an app.",
+ "description": "Description for Gets the application settings of an app.",
+ "operationId": "WebApps_ListApplicationSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the Authentication / Authorization settings associated with web app.",
+ "description": "Description for Updates the Authentication / Authorization settings associated with web app.",
+ "operationId": "WebApps_UpdateAuthSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteAuthSettings",
+ "in": "body",
+ "description": "Auth settings associated with web app.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Authentication/Authorization settings of an app.",
+ "description": "Description for Gets the Authentication/Authorization settings of an app.",
+ "operationId": "WebApps_GetAuthSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates site's Authentication / Authorization settings for apps via the V2 format",
+ "description": "Description for Updates site's Authentication / Authorization settings for apps via the V2 format",
+ "operationId": "WebApps_UpdateAuthSettingsV2",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteAuthSettingsV2",
+ "in": "body",
+ "description": "Auth settings associated with web app.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettingsV2"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettingsV2"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/authsettingsV2/list": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets site's Authentication / Authorization settings for apps via the V2 format",
+ "description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format",
+ "operationId": "WebApps_GetAuthSettingsV2",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettingsV2"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the Azure storage account configurations of an app.",
+ "description": "Description for Updates the Azure storage account configurations of an app.",
+ "operationId": "WebApps_UpdateAzureStorageAccounts",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "azureStorageAccounts",
+ "in": "body",
+ "description": "Azure storage accounts of the app.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/azurestorageaccounts/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Azure storage account configurations of an app.",
+ "description": "Description for Gets the Azure storage account configurations of an app.",
+ "operationId": "WebApps_ListAzureStorageAccounts",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the backup configuration of an app.",
+ "description": "Description for Updates the backup configuration of an app.",
+ "operationId": "WebApps_UpdateBackupConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Edited backup configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes the backup configuration of an app.",
+ "description": "Description for Deletes the backup configuration of an app.",
+ "operationId": "WebApps_DeleteBackupConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted backup configuration."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/backup/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the backup configuration of an app.",
+ "description": "Description for Gets the backup configuration of an app.",
+ "operationId": "WebApps_GetBackupConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Replaces the connection strings of an app.",
+ "description": "Description for Replaces the connection strings of an app.",
+ "operationId": "WebApps_UpdateConnectionStrings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionStrings",
+ "in": "body",
+ "description": "Connection strings of the app or deployment slot. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectionStringDictionary"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ConnectionStringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/connectionstrings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the connection strings of an app.",
+ "description": "Description for Gets the connection strings of an app.",
+ "operationId": "WebApps_ListConnectionStrings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ConnectionStringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/logs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the logging configuration of an app.",
+ "description": "Description for Gets the logging configuration of an app.",
+ "operationId": "WebApps_GetDiagnosticLogsConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteLogsConfig"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the logging configuration of an app.",
+ "description": "Description for Updates the logging configuration of an app.",
+ "operationId": "WebApps_UpdateDiagnosticLogsConfig",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteLogsConfig",
+ "in": "body",
+ "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteLogsConfig"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteLogsConfig"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Replaces the metadata of an app.",
+ "description": "Description for Replaces the metadata of an app.",
+ "operationId": "WebApps_UpdateMetadata",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "metadata",
+ "in": "body",
+ "description": "Edited metadata of the app or deployment slot. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/metadata/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the metadata of an app.",
+ "description": "Description for Gets the metadata of an app.",
+ "operationId": "WebApps_ListMetadata",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/publishingcredentials/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Git/FTP publishing credentials of an app.",
+ "description": "Description for Gets the Git/FTP publishing credentials of an app.",
+ "operationId": "WebApps_ListPublishingCredentials",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/User"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the Push settings associated with web app.",
+ "description": "Description for Updates the Push settings associated with web app.",
+ "operationId": "WebApps_UpdateSitePushSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "pushSettings",
+ "in": "body",
+ "description": "Push settings associated with web app.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/PushSettings"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/PushSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/pushsettings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Push settings associated with web app.",
+ "description": "Description for Gets the Push settings associated with web app.",
+ "operationId": "WebApps_ListSitePushSettings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/PushSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/slotConfigNames": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the names of app settings and connection strings that stick to the slot (not swapped).",
+ "description": "Description for Gets the names of app settings and connection strings that stick to the slot (not swapped).",
+ "operationId": "WebApps_ListSlotConfigurationNames",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SlotConfigNamesResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the names of application settings and connection string that remain with the slot during swap operation.",
+ "description": "Description for Updates the names of application settings and connection string that remain with the slot during swap operation.",
+ "operationId": "WebApps_UpdateSlotConfigurationNames",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotConfigNames",
+ "in": "body",
+ "description": "Names of application settings and connection strings. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SlotConfigNamesResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SlotConfigNamesResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
+ "description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
+ "operationId": "WebApps_GetConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the configuration of an app.",
+ "description": "Description for Updates the configuration of an app.",
+ "operationId": "WebApps_CreateOrUpdateConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteConfig",
+ "in": "body",
+ "description": "JSON representation of a SiteConfig object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the configuration of an app.",
+ "description": "Description for Updates the configuration of an app.",
+ "operationId": "WebApps_UpdateConfiguration",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteConfig",
+ "in": "body",
+ "description": "JSON representation of a SiteConfig object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
+ "description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
+ "operationId": "WebApps_ListConfigurationSnapshotInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a snapshot of the configuration of an app at a previous point in time.",
+ "description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.",
+ "operationId": "WebApps_GetConfigurationSnapshot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "snapshotId",
+ "in": "path",
+ "description": "The ID of the snapshot to read.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config/web/snapshots/{snapshotId}/recover": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Reverts the configuration of an app to a previous snapshot.",
+ "description": "Description for Reverts the configuration of an app to a previous snapshot.",
+ "operationId": "WebApps_RecoverSiteConfigurationSnapshot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "snapshotId",
+ "in": "path",
+ "description": "The ID of the snapshot to read.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the last lines of docker logs for the given site",
+ "description": "Description for Gets the last lines of docker logs for the given site",
+ "operationId": "WebApps_GetWebSiteContainerLogs",
+ "produces": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/containerlogs/zip/download": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the ZIP archived docker log files for the given site",
+ "description": "Description for Gets the ZIP archived docker log files for the given site",
+ "operationId": "WebApps_GetContainerLogsZip",
+ "produces": [
+ "application/zip"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List continuous web jobs for an app, or a deployment slot.",
+ "description": "Description for List continuous web jobs for an app, or a deployment slot.",
+ "operationId": "WebApps_ListContinuousWebJobs",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ContinuousWebJobCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_GetContinuousWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/ContinuousWebJob"
+ }
+ },
+ "404": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a continuous web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_DeleteContinuousWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted continuous web job."
+ },
+ "204": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/start": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start a continuous web job for an app, or a deployment slot.",
+ "description": "Description for Start a continuous web job for an app, or a deployment slot.",
+ "operationId": "WebApps_StartContinuousWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job."
+ },
+ "404": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/continuouswebjobs/{webJobName}/stop": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stop a continuous web job for an app, or a deployment slot.",
+ "description": "Description for Stop a continuous web job for an app, or a deployment slot.",
+ "operationId": "WebApps_StopContinuousWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job."
+ },
+ "404": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List deployments for an app, or a deployment slot.",
+ "description": "Description for List deployments for an app, or a deployment slot.",
+ "operationId": "WebApps_ListDeployments",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeploymentCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get a deployment by its ID for an app, or a deployment slot.",
+ "description": "Description for Get a deployment by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_GetDeployment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Deployment ID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Create a deployment for an app, or a deployment slot.",
+ "description": "Description for Create a deployment for an app, or a deployment slot.",
+ "operationId": "WebApps_CreateDeployment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "ID of an existing deployment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deployment",
+ "in": "body",
+ "description": "Deployment details.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a deployment by its ID for an app, or a deployment slot.",
+ "description": "Description for Delete a deployment by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_DeleteDeployment",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Deployment ID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted deployment."
+ },
+ "204": {
+ "description": "Deployment does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/deployments/{id}/log": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List deployment log for specific deployment for an app, or a deployment slot.",
+ "description": "Description for List deployment log for specific deployment for an app, or a deployment slot.",
+ "operationId": "WebApps_ListDeploymentLog",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/discoverbackup": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
+ "description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
+ "operationId": "WebApps_DiscoverBackup",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Lists ownership identifiers for domain associated with web app.",
+ "description": "Description for Lists ownership identifiers for domain associated with web app.",
+ "operationId": "WebApps_ListDomainOwnershipIdentifiers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get domain ownership identifier for web app.",
+ "description": "Description for Get domain ownership identifier for web app.",
+ "operationId": "WebApps_GetDomainOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifier",
+ "in": "body",
+ "description": "A JSON representation of the domain ownership properties.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a domain ownership identifier for a web app.",
+ "description": "Description for Deletes a domain ownership identifier for a web app.",
+ "operationId": "WebApps_DeleteDomainOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted domain ownership identifier."
+ },
+ "204": {
+ "description": "Domain ownership identifier does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "operationId": "WebApps_UpdateDomainOwnershipIdentifier",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifier",
+ "in": "body",
+ "description": "A JSON representation of the domain ownership properties.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the status of the last MSDeploy operation.",
+ "description": "Description for Get the status of the last MSDeploy operation.",
+ "operationId": "WebApps_GetMSDeployStatus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Invoke the MSDeploy web app extension.",
+ "description": "Description for Invoke the MSDeploy web app extension.",
+ "operationId": "WebApps_CreateMSDeployOperation",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "MSDeploy",
+ "in": "body",
+ "description": "Details of MSDeploy operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MSDeploy"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Deployment is scheduled.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "409": {
+ "description": "Another deployment is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/extensions/MSDeploy/log": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the MSDeploy Log for the last MSDeploy operation.",
+ "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
+ "operationId": "WebApps_GetMSDeployLog",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "MSDeploy log returned.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployLog"
+ }
+ },
+ "404": {
+ "description": "MSDeploy log not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the functions for a web site, or a deployment slot.",
+ "description": "Description for List the functions for a web site, or a deployment slot.",
+ "operationId": "WebApps_ListFunctions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function information returned.",
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelopeCollection"
+ }
+ },
+ "404": {
+ "description": "Function with an ID of {functionName} is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/admin/token": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Fetch a short lived token that can be exchanged for a master key.",
+ "description": "Description for Fetch a short lived token that can be exchanged for a master key.",
+ "operationId": "WebApps_GetFunctionsAdminToken",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get function information by its ID for web site, or a deployment slot.",
+ "description": "Description for Get function information by its ID for web site, or a deployment slot.",
+ "operationId": "WebApps_GetFunction",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function information returned.",
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ "404": {
+ "description": "Function with a name of {functionName} does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Create function for web site, or a deployment slot.",
+ "description": "Description for Create function for web site, or a deployment slot.",
+ "operationId": "WebApps_CreateFunction",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "function_envelope",
+ "in": "body",
+ "description": "Function details.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Function created.",
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a function for web site, or a deployment slot.",
+ "description": "Description for Delete a function for web site, or a deployment slot.",
+ "operationId": "WebApps_DeleteFunction",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Function deleted."
+ },
+ "404": {
+ "description": "Function does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/keys/{keyName}": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Add or update a function secret.",
+ "description": "Description for Add or update a function secret.",
+ "operationId": "WebApps_CreateOrUpdateFunctionSecret",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "The name of the function.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "key",
+ "in": "body",
+ "description": "The key to create or update",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Key was created.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "200": {
+ "description": "Key was updated.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a function secret.",
+ "description": "Description for Delete a function secret.",
+ "operationId": "WebApps_DeleteFunctionSecret",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "The name of the function.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "404": {
+ "description": "Key was not found."
+ },
+ "204": {
+ "description": "Key was deleted."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listkeys": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get function keys for a function in a web site, or a deployment slot.",
+ "description": "Description for Get function keys for a function in a web site, or a deployment slot.",
+ "operationId": "WebApps_ListFunctionKeys",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function keys returned.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/functions/{functionName}/listsecrets": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get function secrets for a function in a web site, or a deployment slot.",
+ "description": "Description for Get function secrets for a function in a web site, or a deployment slot.",
+ "operationId": "WebApps_ListFunctionSecrets",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function secrets returned.",
+ "schema": {
+ "$ref": "#/definitions/FunctionSecrets"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listkeys": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get host secrets for a function app.",
+ "description": "Description for Get host secrets for a function app.",
+ "operationId": "WebApps_ListHostKeys",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Host secrets returned.",
+ "schema": {
+ "$ref": "#/definitions/HostKeys"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/listsyncstatus": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "This is to allow calling via powershell and ARM template.",
+ "description": "Description for This is to allow calling via powershell and ARM template.",
+ "operationId": "WebApps_ListSyncStatus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/sync": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Syncs function trigger metadata to the management database",
+ "description": "Description for Syncs function trigger metadata to the management database",
+ "operationId": "WebApps_SyncFunctions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/host/default/{keyType}/{keyName}": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Add or update a host level secret.",
+ "description": "Description for Add or update a host level secret.",
+ "operationId": "WebApps_CreateOrUpdateHostSecret",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyType",
+ "in": "path",
+ "description": "The type of host key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "key",
+ "in": "body",
+ "description": "The key to create or update",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Key was created.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "200": {
+ "description": "Key was updated.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a host level secret.",
+ "description": "Description for Delete a host level secret.",
+ "operationId": "WebApps_DeleteHostSecret",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyType",
+ "in": "path",
+ "description": "The type of host key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "404": {
+ "description": "Key was not found."
+ },
+ "204": {
+ "description": "Key was deleted."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get hostname bindings for an app or a deployment slot.",
+ "description": "Description for Get hostname bindings for an app or a deployment slot.",
+ "operationId": "WebApps_ListHostNameBindings",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostNameBindingCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hostNameBindings/{hostName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the named hostname binding for an app (or deployment slot, if specified).",
+ "description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_GetHostNameBinding",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "description": "Hostname in the hostname binding.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a hostname binding for an app.",
+ "description": "Description for Creates a hostname binding for an app.",
+ "operationId": "WebApps_CreateOrUpdateHostNameBinding",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "description": "Hostname in the hostname binding.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostNameBinding",
+ "in": "body",
+ "description": "Binding details. This is the JSON representation of a HostNameBinding object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a hostname binding for an app.",
+ "description": "Description for Deletes a hostname binding for an app.",
+ "operationId": "WebApps_DeleteHostNameBinding",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "description": "Hostname in the hostname binding.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hostname binding."
+ },
+ "204": {
+ "description": "Hostname binding does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
+ "description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
+ "operationId": "WebApps_GetHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new Hybrid Connection using a Service Bus relay.",
+ "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
+ "operationId": "WebApps_CreateOrUpdateHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The details of the hybrid connection.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Removes a Hybrid Connection from this site.",
+ "description": "Description for Removes a Hybrid Connection from this site.",
+ "operationId": "WebApps_DeleteHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hybrid connection."
+ },
+ "404": {
+ "description": "Hybrid connection does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new Hybrid Connection using a Service Bus relay.",
+ "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
+ "operationId": "WebApps_UpdateHybridConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The details of the hybrid connection.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridConnectionRelays": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.",
+ "description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.",
+ "operationId": "WebApps_ListHybridConnections",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).",
+ "description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListRelayServiceConnections",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/hybridconnection/{entityName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a hybrid connection configuration by its name.",
+ "description": "Description for Gets a hybrid connection configuration by its name.",
+ "operationId": "WebApps_GetRelayServiceConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "operationId": "WebApps_CreateOrUpdateRelayServiceConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection configuration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Details of the hybrid connection configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a relay service connection by its name.",
+ "description": "Description for Deletes a relay service connection by its name.",
+ "operationId": "WebApps_DeleteRelayServiceConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection configuration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted relay service connection."
+ },
+ "404": {
+ "description": "Relay service connection does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "operationId": "WebApps_UpdateRelayServiceConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection configuration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Details of the hybrid connection configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all scale-out instances of an app.",
+ "description": "Description for Gets all scale-out instances of an app.",
+ "operationId": "WebApps_ListInstanceIdentifiers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebAppInstanceStatusCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all scale-out instances of an app.",
+ "description": "Description for Gets all scale-out instances of an app.",
+ "operationId": "WebApps_GetInstanceInfo",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebSiteInstanceStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get site instance info": {
+ "$ref": "./examples/GetSiteInstanceInfo.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the status of the last MSDeploy operation.",
+ "description": "Description for Get the status of the last MSDeploy operation.",
+ "operationId": "WebApps_GetInstanceMsDeployStatus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of web app instance.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Invoke the MSDeploy web app extension.",
+ "description": "Description for Invoke the MSDeploy web app extension.",
+ "operationId": "WebApps_CreateInstanceMSDeployOperation",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of web app instance.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "MSDeploy",
+ "in": "body",
+ "description": "Details of MSDeploy operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MSDeploy"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Deployment is scheduled.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "409": {
+ "description": "Another deployment is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/extensions/MSDeploy/log": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the MSDeploy Log for the last MSDeploy operation.",
+ "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
+ "operationId": "WebApps_GetInstanceMSDeployLog",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of web app instance.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "MSDeploy log returned.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployLog"
+ }
+ },
+ "404": {
+ "description": "MSDeploy log not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListInstanceProcesses",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process terminated.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetInstanceProcess",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "operationId": "WebApps_DeleteInstanceProcess",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Process terminated."
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/dump": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetInstanceProcessDump",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListInstanceProcessModules",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetInstanceProcessModule",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "baseAddress",
+ "in": "path",
+ "description": "Module base address.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/instances/{instanceId}/processes/{processId}/threads": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListInstanceProcessThreads",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Thread information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessThreadInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/iscloneable": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Shows whether an app can be cloned to another resource group or subscription.",
+ "description": "Description for Shows whether an app can be cloned to another resource group or subscription.",
+ "operationId": "WebApps_IsCloneable",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/SiteCloneability"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listbackups": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets existing backups of an app.",
+ "description": "Description for Gets existing backups of an app.",
+ "operationId": "WebApps_ListSiteBackups",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItemCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List backups": {
+ "$ref": "./examples/ListSlotBackups.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/listsyncfunctiontriggerstatus": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "This is to allow calling via powershell and ARM template.",
+ "description": "Description for This is to allow calling via powershell and ARM template.",
+ "operationId": "WebApps_ListSyncFunctionTriggers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FunctionSecrets"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migrate": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a web app.",
+ "description": "Description for Restores a web app.",
+ "operationId": "WebApps_MigrateStorage",
+ "parameters": [
+ {
+ "name": "subscriptionName",
+ "in": "query",
+ "description": "Azure subscription.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "migrationOptions",
+ "in": "body",
+ "description": "Migration migrationOptions.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/StorageMigrationOptions"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/StorageMigrationResponse"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Migrates a local (in-app) MySql database to a remote MySql database.",
+ "description": "Description for Migrates a local (in-app) MySql database to a remote MySql database.",
+ "operationId": "WebApps_MigrateMySql",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "migrationRequestEnvelope",
+ "in": "body",
+ "description": "MySql migration options.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MigrateMySqlRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Operation"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/migratemysql/status": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
+ "description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
+ "operationId": "WebApps_GetMigrateMySqlStatus",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MigrateMySqlStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkConfig/virtualNetwork": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a Swift Virtual Network connection.",
+ "description": "Description for Gets a Swift Virtual Network connection.",
+ "operationId": "WebApps_GetSwiftVirtualNetworkConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
+ "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
+ "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).",
+ "description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).",
+ "operationId": "WebApps_DeleteSwiftVirtualNetwork",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted virtual network."
+ },
+ "404": {
+ "description": "Virtual network does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
+ "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
+ "operationId": "WebApps_UpdateSwiftVirtualNetworkConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkFeatures/{view}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all network features used by the app (or deployment slot, if specified).",
+ "description": "Description for Gets all network features used by the app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListNetworkFeatures",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "view",
+ "in": "path",
+ "description": "The type of view. This can either be \"summary\" or \"detailed\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/NetworkFeatures"
+ }
+ },
+ "404": {
+ "description": "The requested view does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/operationresults/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTraceOperation",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get the current status of a network trace operation for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraceOperation.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/start": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start capturing network packets for the site (To be deprecated).",
+ "description": "Description for Start capturing network packets for the site (To be deprecated).",
+ "operationId": "WebApps_StartWebSiteNetworkTrace",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "durationInSeconds",
+ "in": "query",
+ "description": "The duration to keep capturing in seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "maxFrameLength",
+ "in": "query",
+ "description": "The maximum frame length in bytes (Optional).",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "sasUrl",
+ "in": "query",
+ "description": "The Blob URL to store capture file.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/startOperation": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start capturing network packets for the site.",
+ "description": "Description for Start capturing network packets for the site.",
+ "operationId": "WebApps_StartWebSiteNetworkTraceOperation",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "durationInSeconds",
+ "in": "query",
+ "description": "The duration to keep capturing in seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "maxFrameLength",
+ "in": "query",
+ "description": "The maximum frame length in bytes (Optional).",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "sasUrl",
+ "in": "query",
+ "description": "The Blob URL to store capture file.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Start a new network trace operation for a site": {
+ "$ref": "./examples/StartWebSiteNetworkTraceOperation.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/stop": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stop ongoing capturing network packets for the site.",
+ "description": "Description for Stop ongoing capturing network packets for the site.",
+ "operationId": "WebApps_StopWebSiteNetworkTrace",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Stopped."
+ },
+ "204": {
+ "description": "Stopped."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Stop a currently running network trace operation for a site": {
+ "$ref": "./examples/StopWebSiteNetworkTrace.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTrace/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTraces",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get NetworkTraces for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraces.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/current/operationresults/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTraceOperationV2",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get the current status of a network trace operation for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraceOperation.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/networkTraces/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTracesV2",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get NetworkTraces for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraces.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/newpassword": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Generates a new publishing password for an app (or deployment slot, if specified).",
+ "description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_GenerateNewSitePublishingPassword",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully generate new password."
+ },
+ "204": {
+ "description": "Successfully generate new password."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/perfcounters": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets perfmon counters for web app.",
+ "description": "Description for Gets perfmon counters for web app.",
+ "operationId": "WebApps_ListPerfMonCounters",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PerfMonCounterCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/phplogging": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets web app's event logs.",
+ "description": "Description for Gets web app's event logs.",
+ "operationId": "WebApps_GetSitePhpErrorLogFlag",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SitePhpErrorLogFlag"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the premier add-ons of an app.",
+ "description": "Description for Gets the premier add-ons of an app.",
+ "operationId": "WebApps_ListPremierAddOns",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/premieraddons/{premierAddOnName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named add-on of an app.",
+ "description": "Description for Gets a named add-on of an app.",
+ "operationId": "WebApps_GetPremierAddOn",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates a named add-on of an app.",
+ "description": "Description for Updates a named add-on of an app.",
+ "operationId": "WebApps_AddPremierAddOn",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOn",
+ "in": "body",
+ "description": "A JSON representation of the edited premier add-on.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a premier add-on from an app.",
+ "description": "Description for Delete a premier add-on from an app.",
+ "operationId": "WebApps_DeletePremierAddOn",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted premier add-on."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates a named add-on of an app.",
+ "description": "Description for Updates a named add-on of an app.",
+ "operationId": "WebApps_UpdatePremierAddOn",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOn",
+ "in": "body",
+ "description": "A JSON representation of the edited premier add-on.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PremierAddOnPatchResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateAccess/virtualNetworks": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "operationId": "WebApps_GetPrivateAccess",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateAccess"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "operationId": "WebApps_PutPrivateAccessVnet",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "access",
+ "in": "body",
+ "description": "The information for the private access",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateAccess"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateAccess"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListProcesses",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process terminated.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetProcess",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "operationId": "WebApps_DeleteProcess",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Process terminated."
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/dump": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetProcessDump",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListProcessModules",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/modules/{baseAddress}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetProcessModule",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "baseAddress",
+ "in": "path",
+ "description": "Module base address.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/processes/{processId}/threads": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListProcessThreads",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Thread information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessThreadInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get public certificates for an app or a deployment slot.",
+ "description": "Description for Get public certificates for an app or a deployment slot.",
+ "operationId": "WebApps_ListPublicCertificates",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublicCertificateCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publicCertificates/{publicCertificateName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the named public certificate for an app (or deployment slot, if specified).",
+ "description": "Description for Get the named public certificate for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_GetPublicCertificate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificateName",
+ "in": "path",
+ "description": "Public certificate name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a hostname binding for an app.",
+ "description": "Description for Creates a hostname binding for an app.",
+ "operationId": "WebApps_CreateOrUpdatePublicCertificate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificateName",
+ "in": "path",
+ "description": "Public certificate name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificate",
+ "in": "body",
+ "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a hostname binding for an app.",
+ "description": "Description for Deletes a hostname binding for an app.",
+ "operationId": "WebApps_DeletePublicCertificate",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificateName",
+ "in": "path",
+ "description": "Public certificate name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hostname binding."
+ },
+ "204": {
+ "description": "Hostname binding does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/publishxml": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the publishing profile for an app (or deployment slot, if specified).",
+ "description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListPublishingProfileXmlWithSecrets",
+ "produces": [
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publishingProfileOptions",
+ "in": "body",
+ "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingProfileOptions"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resetSlotConfig": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
+ "description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
+ "operationId": "WebApps_ResetProductionSlotConfig",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restart": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restarts an app (or deployment slot, if specified).",
+ "description": "Description for Restarts an app (or deployment slot, if specified).",
+ "operationId": "WebApps_Restart",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "softRestart",
+ "in": "query",
+ "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.",
+ "type": "boolean"
+ },
+ {
+ "name": "synchronous",
+ "in": "query",
+ "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully restarted app."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromBackupBlob": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores an app from a backup blob in Azure Storage.",
+ "description": "Description for Restores an app from a backup blob in Azure Storage.",
+ "operationId": "WebApps_RestoreFromBackupBlob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Information on restore request .",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreFromDeletedApp": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a deleted web app to this web app.",
+ "description": "Description for Restores a deleted web app to this web app.",
+ "operationId": "WebApps_RestoreFromDeletedApp",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "restoreRequest",
+ "in": "body",
+ "description": "Deleted web app restore information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeletedAppRestoreRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/restoreSnapshot": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a web app from a snapshot.",
+ "description": "Description for Restores a web app from a snapshot.",
+ "operationId": "WebApps_RestoreSnapshot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "restoreRequest",
+ "in": "body",
+ "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SnapshotRestoreRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get list of siteextensions for a web site, or a deployment slot.",
+ "description": "Description for Get list of siteextensions for a web site, or a deployment slot.",
+ "operationId": "WebApps_ListSiteExtensions",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "SiteExtension information returned.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfoCollection"
+ }
+ },
+ "404": {
+ "description": "SiteExtension not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/siteextensions/{siteExtensionId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get site extension information by its ID for a web site, or a deployment slot.",
+ "description": "Description for Get site extension information by its ID for a web site, or a deployment slot.",
+ "operationId": "WebApps_GetSiteExtension",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteExtensionId",
+ "in": "path",
+ "description": "Site extension name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "SiteExtension information returned.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "404": {
+ "description": "SiteExtension with an ID of {siteExtensionId} is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Install site extension on a web site, or a deployment slot.",
+ "description": "Description for Install site extension on a web site, or a deployment slot.",
+ "operationId": "WebApps_InstallSiteExtension",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteExtensionId",
+ "in": "path",
+ "description": "Site extension name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Site Extension created.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "200": {
+ "description": "Site Extension created.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "429": {
+ "description": "Site Extension is being installed on another request: Rejecting current request."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Remove a site extension from a web site, or a deployment slot.",
+ "description": "Description for Remove a site extension from a web site, or a deployment slot.",
+ "operationId": "WebApps_DeleteSiteExtension",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteExtensionId",
+ "in": "path",
+ "description": "Site extension name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "SiteExtension terminated."
+ },
+ "404": {
+ "description": "SiteExtension with an ID of {siteExtensionId} is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotcopy": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Copies a deployment slot to another deployment slot of an app.",
+ "description": "Description for Copies a deployment slot to another deployment slot of an app.",
+ "operationId": "WebApps_CopyProductionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "copySlotEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name and site config properties to override the source slot config. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmCopySlotEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Operation is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Copy slot": {
+ "$ref": "./examples/CopySlot.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets an app's deployment slots.",
+ "description": "Description for Gets an app's deployment slots.",
+ "operationId": "WebApps_ListSlots",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/WebAppCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the details of a web, mobile, or API app.",
+ "description": "Description for Gets the details of a web, mobile, or API app.",
+ "operationId": "WebApps_GetSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. By default, this API returns the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "404": {
+ "description": "Not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "operationId": "WebApps_CreateOrUpdateSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the app properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a web, mobile, or API app, or one of the deployment slots.",
+ "description": "Description for Deletes a web, mobile, or API app, or one of the deployment slots.",
+ "operationId": "WebApps_DeleteSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app to delete.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot to delete. By default, the API deletes the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deleteMetrics",
+ "in": "query",
+ "description": "If true, web app metrics are also deleted.",
+ "type": "boolean"
+ },
+ {
+ "name": "deleteEmptyServerFarm",
+ "in": "query",
+ "description": "Specify true if the App Service plan will be empty after app deletion and you want to delete the empty App Service plan. By default, the empty App Service plan is not deleted.",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted web app."
+ },
+ "204": {
+ "description": "Successfully deleted web app."
+ },
+ "404": {
+ "description": "Web app not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "description": "Description for Creates a new web, mobile, or API app in an existing resource group, or updates an existing app.",
+ "operationId": "WebApps_UpdateSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Unique name of the app to create or update. To create or update a deployment slot, use the {slot} parameter.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteEnvelope",
+ "in": "body",
+ "description": "A JSON representation of the app properties. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SitePatchResource"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot to create or update. By default, this API attempts to create or modify the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Site"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/analyzeCustomHostname": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Analyze a custom hostname.",
+ "description": "Description for Analyze a custom hostname.",
+ "operationId": "WebApps_AnalyzeCustomHostnameSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "query",
+ "description": "Custom hostname.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/CustomHostnameAnalysisResult"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/applySlotConfig": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Applies the configuration settings from the target slot onto the current slot.",
+ "description": "Description for Applies the configuration settings from the target slot onto the current slot.",
+ "operationId": "WebApps_ApplySlotConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotSwapEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmSlotEntity"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backup": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a backup of an app.",
+ "description": "Description for Creates a backup of an app.",
+ "operationId": "WebApps_BackupSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Backup configuration. You can use the JSON response from the POST action as input here.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will create a backup for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets existing backups of an app.",
+ "description": "Description for Gets existing backups of an app.",
+ "operationId": "WebApps_ListBackupsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItemCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a backup of an app by its ID.",
+ "description": "Description for Gets a backup of an app by its ID.",
+ "operationId": "WebApps_GetBackupStatusSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of the backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get a backup of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a backup of an app by its ID.",
+ "description": "Description for Deletes a backup of an app by its ID.",
+ "operationId": "WebApps_DeleteBackupSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of the backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete a backup of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted web app backup item."
+ },
+ "404": {
+ "description": "Web app backup item does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
+ "description": "Description for Gets status of a web app backup that may be in progress, including secrets associated with the backup, such as the Azure Storage SAS URL. Also can be used to update the SAS URL for the backup if a new URL is passed in the request body.",
+ "operationId": "WebApps_ListBackupStatusSecretsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Information on backup request.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/backups/{backupId}/restore": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a specific backup to another app (or deployment slot, if specified).",
+ "description": "Description for Restores a specific backup to another app (or deployment slot, if specified).",
+ "operationId": "WebApps_RestoreSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "backupId",
+ "in": "path",
+ "description": "ID of the backup.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Information on restore request .",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the configurations of an app",
+ "description": "Description for List the configurations of an app",
+ "operationId": "WebApps_ListConfigurationsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResourceCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Replaces the application settings of an app.",
+ "description": "Description for Replaces the application settings of an app.",
+ "operationId": "WebApps_UpdateApplicationSettingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "appSettings",
+ "in": "body",
+ "description": "Application settings of the app.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the application settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/appsettings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the application settings of an app.",
+ "description": "Description for Gets the application settings of an app.",
+ "operationId": "WebApps_ListApplicationSettingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the application settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the Authentication / Authorization settings associated with web app.",
+ "description": "Description for Updates the Authentication / Authorization settings associated with web app.",
+ "operationId": "WebApps_UpdateAuthSettingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteAuthSettings",
+ "in": "body",
+ "description": "Auth settings associated with web app.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettings"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Authentication/Authorization settings of an app.",
+ "description": "Description for Gets the Authentication/Authorization settings of an app.",
+ "operationId": "WebApps_GetAuthSettingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates site's Authentication / Authorization settings for apps via the V2 format",
+ "description": "Description for Updates site's Authentication / Authorization settings for apps via the V2 format",
+ "operationId": "WebApps_UpdateAuthSettingsV2Slot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteAuthSettingsV2",
+ "in": "body",
+ "description": "Auth settings associated with web app.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettingsV2"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettingsV2"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/authsettingsV2/list": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets site's Authentication / Authorization settings for apps via the V2 format",
+ "description": "Description for Gets site's Authentication / Authorization settings for apps via the V2 format",
+ "operationId": "WebApps_GetAuthSettingsV2Slot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteAuthSettingsV2"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the Azure storage account configurations of an app.",
+ "description": "Description for Updates the Azure storage account configurations of an app.",
+ "operationId": "WebApps_UpdateAzureStorageAccountsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "azureStorageAccounts",
+ "in": "body",
+ "description": "Azure storage accounts of the app.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/azurestorageaccounts/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Azure storage account configurations of an app.",
+ "description": "Description for Gets the Azure storage account configurations of an app.",
+ "operationId": "WebApps_ListAzureStorageAccountsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the Azure storage account configurations for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/AzureStoragePropertyDictionaryResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the backup configuration of an app.",
+ "description": "Description for Updates the backup configuration of an app.",
+ "operationId": "WebApps_UpdateBackupConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Edited backup configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the backup configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes the backup configuration of an app.",
+ "description": "Description for Deletes the backup configuration of an app.",
+ "operationId": "WebApps_DeleteBackupConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the backup configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted backup configuration."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/backup/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the backup configuration of an app.",
+ "description": "Description for Gets the backup configuration of an app.",
+ "operationId": "WebApps_GetBackupConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the backup configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Replaces the connection strings of an app.",
+ "description": "Description for Replaces the connection strings of an app.",
+ "operationId": "WebApps_UpdateConnectionStringsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionStrings",
+ "in": "body",
+ "description": "Connection strings of the app or deployment slot. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/ConnectionStringDictionary"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the connection settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ConnectionStringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/connectionstrings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the connection strings of an app.",
+ "description": "Description for Gets the connection strings of an app.",
+ "operationId": "WebApps_ListConnectionStringsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the connection settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ConnectionStringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/logs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the logging configuration of an app.",
+ "description": "Description for Gets the logging configuration of an app.",
+ "operationId": "WebApps_GetDiagnosticLogsConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the logging configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteLogsConfig"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the logging configuration of an app.",
+ "description": "Description for Updates the logging configuration of an app.",
+ "operationId": "WebApps_UpdateDiagnosticLogsConfigSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteLogsConfig",
+ "in": "body",
+ "description": "A SiteLogsConfig JSON object that contains the logging configuration to change in the \"properties\" property.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteLogsConfig"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the logging configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteLogsConfig"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Replaces the metadata of an app.",
+ "description": "Description for Replaces the metadata of an app.",
+ "operationId": "WebApps_UpdateMetadataSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "metadata",
+ "in": "body",
+ "description": "Edited metadata of the app or deployment slot. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the metadata for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/metadata/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the metadata of an app.",
+ "description": "Description for Gets the metadata of an app.",
+ "operationId": "WebApps_ListMetadataSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the metadata for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/publishingcredentials/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Git/FTP publishing credentials of an app.",
+ "description": "Description for Gets the Git/FTP publishing credentials of an app.",
+ "operationId": "WebApps_ListPublishingCredentialsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing credentials for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/User"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the Push settings associated with web app.",
+ "description": "Description for Updates the Push settings associated with web app.",
+ "operationId": "WebApps_UpdateSitePushSettingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "pushSettings",
+ "in": "body",
+ "description": "Push settings associated with web app.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/PushSettings"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/PushSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/pushsettings/list": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the Push settings associated with web app.",
+ "description": "Description for Gets the Push settings associated with web app.",
+ "operationId": "WebApps_ListSitePushSettingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/PushSettings"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
+ "description": "Description for Gets the configuration of an app, such as platform version and bitness, default documents, virtual applications, Always On, etc.",
+ "operationId": "WebApps_GetConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the configuration of an app.",
+ "description": "Description for Updates the configuration of an app.",
+ "operationId": "WebApps_CreateOrUpdateConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteConfig",
+ "in": "body",
+ "description": "JSON representation of a SiteConfig object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the configuration of an app.",
+ "description": "Description for Updates the configuration of an app.",
+ "operationId": "WebApps_UpdateConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteConfig",
+ "in": "body",
+ "description": "JSON representation of a SiteConfig object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
+ "description": "Description for Gets a list of web app configuration snapshots identifiers. Each element of the list contains a timestamp and the ID of the snapshot.",
+ "operationId": "WebApps_ListConfigurationSnapshotInfoSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigurationSnapshotInfoCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a snapshot of the configuration of an app at a previous point in time.",
+ "description": "Description for Gets a snapshot of the configuration of an app at a previous point in time.",
+ "operationId": "WebApps_GetConfigurationSnapshotSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "snapshotId",
+ "in": "path",
+ "description": "The ID of the snapshot to read.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/config/web/snapshots/{snapshotId}/recover": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Reverts the configuration of an app to a previous snapshot.",
+ "description": "Description for Reverts the configuration of an app to a previous snapshot.",
+ "operationId": "WebApps_RecoverSiteConfigurationSnapshotSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "snapshotId",
+ "in": "path",
+ "description": "The ID of the snapshot to read.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will return configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the last lines of docker logs for the given site",
+ "description": "Description for Gets the last lines of docker logs for the given site",
+ "operationId": "WebApps_GetWebSiteContainerLogsSlot",
+ "produces": [
+ "application/octet-stream"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/containerlogs/zip/download": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the ZIP archived docker log files for the given site",
+ "description": "Description for Gets the ZIP archived docker log files for the given site",
+ "operationId": "WebApps_GetContainerLogsZipSlot",
+ "produces": [
+ "application/zip"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List continuous web jobs for an app, or a deployment slot.",
+ "description": "Description for List continuous web jobs for an app, or a deployment slot.",
+ "operationId": "WebApps_ListContinuousWebJobsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/ContinuousWebJobCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a continuous web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Gets a continuous web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_GetContinuousWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/ContinuousWebJob"
+ }
+ },
+ "404": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a continuous web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Delete a continuous web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_DeleteContinuousWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted continuous web job."
+ },
+ "204": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/start": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start a continuous web job for an app, or a deployment slot.",
+ "description": "Description for Start a continuous web job for an app, or a deployment slot.",
+ "operationId": "WebApps_StartContinuousWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job."
+ },
+ "404": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/continuouswebjobs/{webJobName}/stop": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stop a continuous web job for an app, or a deployment slot.",
+ "description": "Description for Stop a continuous web job for an app, or a deployment slot.",
+ "operationId": "WebApps_StopContinuousWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job."
+ },
+ "404": {
+ "description": "Continuous web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List deployments for an app, or a deployment slot.",
+ "description": "Description for List deployments for an app, or a deployment slot.",
+ "operationId": "WebApps_ListDeploymentsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/DeploymentCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get a deployment by its ID for an app, or a deployment slot.",
+ "description": "Description for Get a deployment by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_GetDeploymentSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Deployment ID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API gets a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Create a deployment for an app, or a deployment slot.",
+ "description": "Description for Create a deployment for an app, or a deployment slot.",
+ "operationId": "WebApps_CreateDeploymentSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "ID of an existing deployment.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API creates a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "deployment",
+ "in": "body",
+ "description": "Deployment details.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a deployment by its ID for an app, or a deployment slot.",
+ "description": "Description for Delete a deployment by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_DeleteDeploymentSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "Deployment ID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted deployment."
+ },
+ "204": {
+ "description": "Deployment does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/deployments/{id}/log": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List deployment log for specific deployment for an app, or a deployment slot.",
+ "description": "Description for List deployment log for specific deployment for an app, or a deployment slot.",
+ "operationId": "WebApps_ListDeploymentLogSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "The ID of a specific deployment. This is the value of the name property in the JSON response from \"GET /api/sites/{siteName}/deployments\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/discoverbackup": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
+ "description": "Description for Discovers an existing app backup that can be restored from a blob in Azure storage. Use this to get information about the databases stored in a backup.",
+ "operationId": "WebApps_DiscoverBackupSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "A RestoreRequest object that includes Azure storage URL and blog name for discovery of backup.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will perform discovery for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Lists ownership identifiers for domain associated with web app.",
+ "description": "Description for Lists ownership identifiers for domain associated with web app.",
+ "operationId": "WebApps_ListDomainOwnershipIdentifiersSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/IdentifierCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/domainOwnershipIdentifiers/{domainOwnershipIdentifierName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get domain ownership identifier for web app.",
+ "description": "Description for Get domain ownership identifier for web app.",
+ "operationId": "WebApps_GetDomainOwnershipIdentifierSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "operationId": "WebApps_CreateOrUpdateDomainOwnershipIdentifierSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifier",
+ "in": "body",
+ "description": "A JSON representation of the domain ownership properties.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a domain ownership identifier for a web app.",
+ "description": "Description for Deletes a domain ownership identifier for a web app.",
+ "operationId": "WebApps_DeleteDomainOwnershipIdentifierSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted domain ownership identifier."
+ },
+ "204": {
+ "description": "Domain ownership identifier does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "description": "Description for Creates a domain ownership identifier for web app, or updates an existing ownership identifier.",
+ "operationId": "WebApps_UpdateDomainOwnershipIdentifierSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifierName",
+ "in": "path",
+ "description": "Name of domain ownership identifier.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "domainOwnershipIdentifier",
+ "in": "body",
+ "description": "A JSON representation of the domain ownership properties.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/Identifier"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the status of the last MSDeploy operation.",
+ "description": "Description for Get the status of the last MSDeploy operation.",
+ "operationId": "WebApps_GetMSDeployStatusSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Invoke the MSDeploy web app extension.",
+ "description": "Description for Invoke the MSDeploy web app extension.",
+ "operationId": "WebApps_CreateMSDeployOperationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "MSDeploy",
+ "in": "body",
+ "description": "Details of MSDeploy operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MSDeploy"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Deployment is scheduled.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "409": {
+ "description": "Another deployment is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/extensions/MSDeploy/log": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the MSDeploy Log for the last MSDeploy operation.",
+ "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
+ "operationId": "WebApps_GetMSDeployLogSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "MSDeploy log returned.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployLog"
+ }
+ },
+ "404": {
+ "description": "MSDeploy log not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the functions for a web site, or a deployment slot.",
+ "description": "Description for List the functions for a web site, or a deployment slot.",
+ "operationId": "WebApps_ListInstanceFunctionsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function information returned.",
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelopeCollection"
+ }
+ },
+ "404": {
+ "description": "Function with an ID of {functionName} is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/admin/token": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Fetch a short lived token that can be exchanged for a master key.",
+ "description": "Description for Fetch a short lived token that can be exchanged for a master key.",
+ "operationId": "WebApps_GetFunctionsAdminTokenSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get function information by its ID for web site, or a deployment slot.",
+ "description": "Description for Get function information by its ID for web site, or a deployment slot.",
+ "operationId": "WebApps_GetInstanceFunctionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function information returned.",
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ "404": {
+ "description": "Function with a name of {functionName} does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Create function for web site, or a deployment slot.",
+ "description": "Description for Create function for web site, or a deployment slot.",
+ "operationId": "WebApps_CreateInstanceFunctionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "function_envelope",
+ "in": "body",
+ "description": "Function details.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Function created.",
+ "schema": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a function for web site, or a deployment slot.",
+ "description": "Description for Delete a function for web site, or a deployment slot.",
+ "operationId": "WebApps_DeleteInstanceFunctionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Function deleted."
+ },
+ "404": {
+ "description": "Function does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/keys/{keyName}": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Add or update a function secret.",
+ "description": "Description for Add or update a function secret.",
+ "operationId": "WebApps_CreateOrUpdateFunctionSecretSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "The name of the function.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "key",
+ "in": "body",
+ "description": "The key to create or update",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Key was created.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "200": {
+ "description": "Key was updated.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a function secret.",
+ "description": "Description for Delete a function secret.",
+ "operationId": "WebApps_DeleteFunctionSecretSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "The name of the function.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "404": {
+ "description": "Key was not found."
+ },
+ "204": {
+ "description": "Key was deleted."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listkeys": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get function keys for a function in a web site, or a deployment slot.",
+ "description": "Description for Get function keys for a function in a web site, or a deployment slot.",
+ "operationId": "WebApps_ListFunctionKeysSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function keys returned.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/StringDictionary"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/functions/{functionName}/listsecrets": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get function secrets for a function in a web site, or a deployment slot.",
+ "description": "Description for Get function secrets for a function in a web site, or a deployment slot.",
+ "operationId": "WebApps_ListFunctionSecretsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "functionName",
+ "in": "path",
+ "description": "Function name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Function secrets returned.",
+ "schema": {
+ "$ref": "#/definitions/FunctionSecrets"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listkeys": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get host secrets for a function app.",
+ "description": "Description for Get host secrets for a function app.",
+ "operationId": "WebApps_ListHostKeysSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Host secrets returned.",
+ "schema": {
+ "$ref": "#/definitions/HostKeys"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/listsyncstatus": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "This is to allow calling via powershell and ARM template.",
+ "description": "Description for This is to allow calling via powershell and ARM template.",
+ "operationId": "WebApps_ListSyncStatusSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/sync": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Syncs function trigger metadata to the management database",
+ "description": "Description for Syncs function trigger metadata to the management database",
+ "operationId": "WebApps_SyncFunctionsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/host/default/{keyType}/{keyName}": {
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Add or update a host level secret.",
+ "description": "Description for Add or update a host level secret.",
+ "operationId": "WebApps_CreateOrUpdateHostSecretSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyType",
+ "in": "path",
+ "description": "The type of host key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "key",
+ "in": "body",
+ "description": "The key to create or update",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Key was created.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "200": {
+ "description": "Key was updated.",
+ "schema": {
+ "$ref": "#/definitions/KeyInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a host level secret.",
+ "description": "Description for Delete a host level secret.",
+ "operationId": "WebApps_DeleteHostSecretSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyType",
+ "in": "path",
+ "description": "The type of host key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "keyName",
+ "in": "path",
+ "description": "The name of the key.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "404": {
+ "description": "Key was not found."
+ },
+ "204": {
+ "description": "Key was deleted."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get hostname bindings for an app or a deployment slot.",
+ "description": "Description for Get hostname bindings for an app or a deployment slot.",
+ "operationId": "WebApps_ListHostNameBindingsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostNameBindingCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hostNameBindings/{hostName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the named hostname binding for an app (or deployment slot, if specified).",
+ "description": "Description for Get the named hostname binding for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_GetHostNameBindingSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "description": "Hostname in the hostname binding.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a hostname binding for an app.",
+ "description": "Description for Creates a hostname binding for an app.",
+ "operationId": "WebApps_CreateOrUpdateHostNameBindingSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "description": "Hostname in the hostname binding.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostNameBinding",
+ "in": "body",
+ "description": "Binding details. This is the JSON representation of a HostNameBinding object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a hostname binding for an app.",
+ "description": "Description for Deletes a hostname binding for an app.",
+ "operationId": "WebApps_DeleteHostNameBindingSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "hostName",
+ "in": "path",
+ "description": "Hostname in the hostname binding.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hostname binding."
+ },
+ "204": {
+ "description": "Hostname binding does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionNamespaces/{namespaceName}/relays/{relayName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
+ "description": "Description for Retrieves a specific Service Bus Hybrid Connection used by this Web App.",
+ "operationId": "WebApps_GetHybridConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new Hybrid Connection using a Service Bus relay.",
+ "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
+ "operationId": "WebApps_CreateOrUpdateHybridConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The details of the hybrid connection.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Removes a Hybrid Connection from this site.",
+ "description": "Description for Removes a Hybrid Connection from this site.",
+ "operationId": "WebApps_DeleteHybridConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hybrid connection."
+ },
+ "404": {
+ "description": "Hybrid connection does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new Hybrid Connection using a Service Bus relay.",
+ "description": "Description for Creates a new Hybrid Connection using a Service Bus relay.",
+ "operationId": "WebApps_UpdateHybridConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "namespaceName",
+ "in": "path",
+ "description": "The namespace for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "relayName",
+ "in": "path",
+ "description": "The relay name for this hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The details of the hybrid connection.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridConnectionRelays": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Retrieves all Service Bus Hybrid Connections used by this Web App.",
+ "description": "Description for Retrieves all Service Bus Hybrid Connections used by this Web App.",
+ "operationId": "WebApps_ListHybridConnectionsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets hybrid connections configured for an app (or deployment slot, if specified).",
+ "description": "Description for Gets hybrid connections configured for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListRelayServiceConnectionsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get hybrid connections for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/hybridconnection/{entityName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a hybrid connection configuration by its name.",
+ "description": "Description for Gets a hybrid connection configuration by its name.",
+ "operationId": "WebApps_GetRelayServiceConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get a hybrid connection for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "operationId": "WebApps_CreateOrUpdateRelayServiceConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection configuration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Details of the hybrid connection configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a relay service connection by its name.",
+ "description": "Description for Deletes a relay service connection by its name.",
+ "operationId": "WebApps_DeleteRelayServiceConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection configuration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete a hybrid connection for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted relay service connection."
+ },
+ "404": {
+ "description": "Relay service connection does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "description": "Description for Creates a new hybrid connection configuration (PUT), or updates an existing one (PATCH).",
+ "operationId": "WebApps_UpdateRelayServiceConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "entityName",
+ "in": "path",
+ "description": "Name of the hybrid connection configuration.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Details of the hybrid connection configuration.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will create or update a hybrid connection for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all scale-out instances of an app.",
+ "description": "Description for Gets all scale-out instances of an app.",
+ "operationId": "WebApps_ListInstanceIdentifiersSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebAppInstanceStatusCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all scale-out instances of an app.",
+ "description": "Description for Gets all scale-out instances of an app.",
+ "operationId": "WebApps_GetInstanceInfoSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API gets the production slot instances.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebSiteInstanceStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get site instance info": {
+ "$ref": "./examples/GetSiteInstanceInfo.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the status of the last MSDeploy operation.",
+ "description": "Description for Get the status of the last MSDeploy operation.",
+ "operationId": "WebApps_GetInstanceMsDeployStatusSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of web app instance.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Invoke the MSDeploy web app extension.",
+ "description": "Description for Invoke the MSDeploy web app extension.",
+ "operationId": "WebApps_CreateInstanceMSDeployOperationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of web app instance.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "MSDeploy",
+ "in": "body",
+ "description": "Details of MSDeploy operation",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/MSDeploy"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Deployment is scheduled.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployStatus"
+ }
+ },
+ "409": {
+ "description": "Another deployment is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/extensions/MSDeploy/log": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the MSDeploy Log for the last MSDeploy operation.",
+ "description": "Description for Get the MSDeploy Log for the last MSDeploy operation.",
+ "operationId": "WebApps_GetInstanceMSDeployLogSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of web app instance.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "MSDeploy log returned.",
+ "schema": {
+ "$ref": "#/definitions/MSDeployLog"
+ }
+ },
+ "404": {
+ "description": "MSDeploy log not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListInstanceProcessesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process terminated.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetInstanceProcessSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "operationId": "WebApps_DeleteInstanceProcessSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Process terminated."
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/dump": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetInstanceProcessDumpSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListInstanceProcessModulesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/modules/{baseAddress}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetInstanceProcessModuleSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "baseAddress",
+ "in": "path",
+ "description": "Module base address.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/instances/{instanceId}/processes/{processId}/threads": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListInstanceProcessThreadsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "instanceId",
+ "in": "path",
+ "description": "ID of a specific scaled-out instance. This is the value of the name property in the JSON response from \"GET api/sites/{siteName}/instances\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Thread information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessThreadInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/iscloneable": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Shows whether an app can be cloned to another resource group or subscription.",
+ "description": "Description for Shows whether an app can be cloned to another resource group or subscription.",
+ "operationId": "WebApps_IsCloneableSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. By default, this API returns information on the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/SiteCloneability"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listbackups": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets existing backups of an app.",
+ "description": "Description for Gets existing backups of an app.",
+ "operationId": "WebApps_ListSiteBackupsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get backups of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/BackupItemCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "List backups": {
+ "$ref": "./examples/ListSlotBackups.json"
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/listsyncfunctiontriggerstatus": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "This is to allow calling via powershell and ARM template.",
+ "description": "Description for This is to allow calling via powershell and ARM template.",
+ "operationId": "WebApps_ListSyncFunctionTriggersSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/FunctionSecrets"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/migratemysql/status": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
+ "description": "Description for Returns the status of MySql in app migration, if one is active, and whether or not MySql in app is enabled",
+ "operationId": "WebApps_GetMigrateMySqlStatusSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/MigrateMySqlStatus"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkConfig/virtualNetwork": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a Swift Virtual Network connection.",
+ "description": "Description for Gets a Swift Virtual Network connection.",
+ "operationId": "WebApps_GetSwiftVirtualNetworkConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
+ "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
+ "operationId": "WebApps_CreateOrUpdateSwiftVirtualNetworkConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a Swift Virtual Network connection from an app (or deployment slot).",
+ "description": "Description for Deletes a Swift Virtual Network connection from an app (or deployment slot).",
+ "operationId": "WebApps_DeleteSwiftVirtualNetworkSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted virtual network."
+ },
+ "404": {
+ "description": "Virtual network does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\r\nin use by another App Service Plan other than the one this App is in.",
+ "description": "Description for Integrates this Web App with a Virtual Network. This requires that 1) \"swiftSupported\" is true when doing a GET against this resource, and 2) that the target Subnet has already been delegated, and is not\nin use by another App Service Plan other than the one this App is in.",
+ "operationId": "WebApps_UpdateSwiftVirtualNetworkConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SwiftVirtualNetwork"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkFeatures/{view}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets all network features used by the app (or deployment slot, if specified).",
+ "description": "Description for Gets all network features used by the app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListNetworkFeaturesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "view",
+ "in": "path",
+ "description": "The type of view. This can either be \"summary\" or \"detailed\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get network features for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/NetworkFeatures"
+ }
+ },
+ "404": {
+ "description": "The requested view does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/operationresults/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTraceOperationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get the current status of a network trace operation for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraceOperation.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/start": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start capturing network packets for the site (To be deprecated).",
+ "description": "Description for Start capturing network packets for the site (To be deprecated).",
+ "operationId": "WebApps_StartWebSiteNetworkTraceSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "durationInSeconds",
+ "in": "query",
+ "description": "The duration to keep capturing in seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for this web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "maxFrameLength",
+ "in": "query",
+ "description": "The maximum frame length in bytes (Optional).",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "sasUrl",
+ "in": "query",
+ "description": "The Blob URL to store capture file.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/startOperation": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start capturing network packets for the site.",
+ "description": "Description for Start capturing network packets for the site.",
+ "operationId": "WebApps_StartWebSiteNetworkTraceOperationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "durationInSeconds",
+ "in": "query",
+ "description": "The duration to keep capturing in seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for this web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "maxFrameLength",
+ "in": "query",
+ "description": "The maximum frame length in bytes (Optional).",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "sasUrl",
+ "in": "query",
+ "description": "The Blob URL to store capture file.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Start a new network trace operation for a site": {
+ "$ref": "./examples/StartWebSiteNetworkTraceOperation.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/stop": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stop ongoing capturing network packets for the site.",
+ "description": "Description for Stop ongoing capturing network packets for the site.",
+ "operationId": "WebApps_StopWebSiteNetworkTraceSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for this web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Stopped."
+ },
+ "204": {
+ "description": "Stopped."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Stop a currently running network trace operation for a site": {
+ "$ref": "./examples/StopWebSiteNetworkTrace.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTrace/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTracesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get NetworkTraces for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraces.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/current/operationresults/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTraceOperationSlotV2",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get the current status of a network trace operation for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraceOperation.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/networkTraces/{operationId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "description": "Description for Gets a named operation for a network trace capturing (or deployment slot, if specified).",
+ "operationId": "WebApps_GetNetworkTracesSlotV2",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "operationId",
+ "in": "path",
+ "description": "GUID of the operation.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get an operation for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get NetworkTraces for a site": {
+ "$ref": "./examples/GetWebSiteNetworkTraces.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/newpassword": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Generates a new publishing password for an app (or deployment slot, if specified).",
+ "description": "Description for Generates a new publishing password for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_GenerateNewSitePublishingPasswordSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API generate a new publishing password for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully generate new password."
+ },
+ "204": {
+ "description": "Successfully generate new password."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/perfcounters": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets perfmon counters for web app.",
+ "description": "Description for Gets perfmon counters for web app.",
+ "operationId": "WebApps_ListPerfMonCountersSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only usages/metrics specified in the filter. Filter conforms to odata syntax. Example: $filter=(startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PerfMonCounterCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/phplogging": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets web app's event logs.",
+ "description": "Description for Gets web app's event logs.",
+ "operationId": "WebApps_GetSitePhpErrorLogFlagSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SitePhpErrorLogFlag"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the premier add-ons of an app.",
+ "description": "Description for Gets the premier add-ons of an app.",
+ "operationId": "WebApps_ListPremierAddOnsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the premier add-ons for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/premieraddons/{premierAddOnName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a named add-on of an app.",
+ "description": "Description for Gets a named add-on of an app.",
+ "operationId": "WebApps_GetPremierAddOnSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the named add-on for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates a named add-on of an app.",
+ "description": "Description for Updates a named add-on of an app.",
+ "operationId": "WebApps_AddPremierAddOnSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOn",
+ "in": "body",
+ "description": "A JSON representation of the edited premier add-on.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a premier add-on from an app.",
+ "description": "Description for Delete a premier add-on from an app.",
+ "operationId": "WebApps_DeletePremierAddOnSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the named add-on for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted premier add-on."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates a named add-on of an app.",
+ "description": "Description for Updates a named add-on of an app.",
+ "operationId": "WebApps_UpdatePremierAddOnSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOnName",
+ "in": "path",
+ "description": "Add-on name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "premierAddOn",
+ "in": "body",
+ "description": "A JSON representation of the edited premier add-on.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PremierAddOnPatchResource"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the named add-on for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PremierAddOn"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/privateAccess/virtualNetworks": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "description": "Description for Gets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "operationId": "WebApps_GetPrivateAccessSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateAccess"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "description": "Description for Sets data around private site access enablement and authorized Virtual Networks that can access the site.",
+ "operationId": "WebApps_PutPrivateAccessVnetSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "access",
+ "in": "body",
+ "description": "The information for the private access",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateAccess"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateAccess"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateEndpointConnections/{privateEndpointConnectionName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a private endpoint connection",
+ "description": "Description for Gets a private endpoint connection",
+ "operationId": "WebApps_GetPrivateEndpointConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get a private endpoint connection for a site.": {
+ "$ref": "./examples/GetSitePrivateEndpointConnection.json"
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Approves or rejects a private endpoint connection",
+ "description": "Description for Approves or rejects a private endpoint connection",
+ "operationId": "WebApps_ApproveOrRejectPrivateEndpointConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointWrapper",
+ "in": "body",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkConnectionApprovalRequestResource"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionResource"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "$ref": "#/definitions/PrivateEndpointConnectionResource"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Approves or rejects a private endpoint connection for a site.": {
+ "$ref": "./examples/ApproveRejectSitePrivateEndpointConnection.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a private endpoint connection",
+ "description": "Description for Deletes a private endpoint connection",
+ "operationId": "WebApps_DeletePrivateEndpointConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "privateEndpointConnectionName",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "type": "object"
+ }
+ },
+ "202": {
+ "description": "Asynchronous operation in progress.",
+ "schema": {
+ "type": "object"
+ }
+ },
+ "204": {
+ "description": "No content.",
+ "schema": {
+ "type": "object"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Delete a private endpoint connection for a site.": {
+ "$ref": "./examples/DeleteSitePrivateEndpointConnection.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/privateLinkResources": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the private link resources",
+ "description": "Description for Gets the private link resources",
+ "operationId": "WebApps_GetPrivateLinkResources",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the site.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PrivateLinkResourcesWrapper"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Get private link resources of a site": {
+ "$ref": "./examples/GetSitePrivateLinkResources.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "description": "Description for Get list of processes for a web site, or a deployment slot, or for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListProcessesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process terminated.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetProcessSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Process information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "description": "Description for Terminate a process by its ID for a web site, or a deployment slot, or specific scaled-out instance in a web site.",
+ "operationId": "WebApps_DeleteProcessSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "Process terminated."
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/dump": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get a memory dump of a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetProcessDumpSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List module information for a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListProcessModulesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/modules/{baseAddress}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get process information by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for Get process information by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_GetProcessModuleSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "baseAddress",
+ "in": "path",
+ "description": "Module base address.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Module information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessModuleInfo"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running, or a module with the specified baseAddress was not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/processes/{processId}/threads": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "description": "Description for List the threads in a process by its ID for a specific scaled-out instance in a web site.",
+ "operationId": "WebApps_ListProcessThreadsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "processId",
+ "in": "path",
+ "description": "PID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Thread information returned.",
+ "schema": {
+ "$ref": "#/definitions/ProcessThreadInfoCollection"
+ }
+ },
+ "404": {
+ "description": "Process with the specified ID is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get public certificates for an app or a deployment slot.",
+ "description": "Description for Get public certificates for an app or a deployment slot.",
+ "operationId": "WebApps_ListPublicCertificatesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API gets hostname bindings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublicCertificateCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publicCertificates/{publicCertificateName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the named public certificate for an app (or deployment slot, if specified).",
+ "description": "Description for Get the named public certificate for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_GetPublicCertificateSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API the named binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificateName",
+ "in": "path",
+ "description": "Public certificate name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Creates a hostname binding for an app.",
+ "description": "Description for Creates a hostname binding for an app.",
+ "operationId": "WebApps_CreateOrUpdatePublicCertificateSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificateName",
+ "in": "path",
+ "description": "Public certificate name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificate",
+ "in": "body",
+ "description": "Public certificate details. This is the JSON representation of a PublicCertificate object.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will create a binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a hostname binding for an app.",
+ "description": "Description for Deletes a hostname binding for an app.",
+ "operationId": "WebApps_DeletePublicCertificateSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the binding for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publicCertificateName",
+ "in": "path",
+ "description": "Public certificate name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted hostname binding."
+ },
+ "204": {
+ "description": "Hostname binding does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/publishxml": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the publishing profile for an app (or deployment slot, if specified).",
+ "description": "Description for Gets the publishing profile for an app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListPublishingProfileXmlWithSecretsSlot",
+ "produces": [
+ "application/xml"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "publishingProfileOptions",
+ "in": "body",
+ "description": "Specifies publishingProfileOptions for publishing profile. For example, use {\"format\": \"FileZilla3\"} to get a FileZilla publishing profile.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmPublishingProfileOptions"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the publishing profile for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "file"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resetSlotConfig": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
+ "description": "Description for Resets the configuration settings of the current slot if they were previously modified by calling the API with POST.",
+ "operationId": "WebApps_ResetSlotConfigurationSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API resets configuration settings for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restart": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restarts an app (or deployment slot, if specified).",
+ "description": "Description for Restarts an app (or deployment slot, if specified).",
+ "operationId": "WebApps_RestartSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will restart the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "softRestart",
+ "in": "query",
+ "description": "Specify true to apply the configuration settings and restarts the app only if necessary. By default, the API always restarts and reprovisions the app.",
+ "type": "boolean"
+ },
+ {
+ "name": "synchronous",
+ "in": "query",
+ "description": "Specify true to block until the app is restarted. By default, it is set to false, and the API responds immediately (asynchronous).",
+ "type": "boolean"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully restarted app."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromBackupBlob": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores an app from a backup blob in Azure Storage.",
+ "description": "Description for Restores an app from a backup blob in Azure Storage.",
+ "operationId": "WebApps_RestoreFromBackupBlobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "request",
+ "in": "body",
+ "description": "Information on restore request .",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/RestoreRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will restore a backup of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreFromDeletedApp": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a deleted web app to this web app.",
+ "description": "Description for Restores a deleted web app to this web app.",
+ "operationId": "WebApps_RestoreFromDeletedAppSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "restoreRequest",
+ "in": "body",
+ "description": "Deleted web app restore information.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/DeletedAppRestoreRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/restoreSnapshot": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Restores a web app from a snapshot.",
+ "description": "Description for Restores a web app from a snapshot.",
+ "operationId": "WebApps_RestoreSnapshotSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "restoreRequest",
+ "in": "body",
+ "description": "Snapshot restore settings. Snapshot information can be obtained by calling GetDeletedSites or GetSiteSnapshots API.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SnapshotRestoreRequest"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "202": {
+ "description": "Restore operation started."
+ },
+ "200": {
+ "description": "Restore operation started."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get list of siteextensions for a web site, or a deployment slot.",
+ "description": "Description for Get list of siteextensions for a web site, or a deployment slot.",
+ "operationId": "WebApps_ListSiteExtensionsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "SiteExtension information returned.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfoCollection"
+ }
+ },
+ "404": {
+ "description": "SiteExtension not found."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/siteextensions/{siteExtensionId}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get site extension information by its ID for a web site, or a deployment slot.",
+ "description": "Description for Get site extension information by its ID for a web site, or a deployment slot.",
+ "operationId": "WebApps_GetSiteExtensionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteExtensionId",
+ "in": "path",
+ "description": "Site extension name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "SiteExtension information returned.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "404": {
+ "description": "SiteExtension with an ID of {siteExtensionId} is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Install site extension on a web site, or a deployment slot.",
+ "description": "Description for Install site extension on a web site, or a deployment slot.",
+ "operationId": "WebApps_InstallSiteExtensionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteExtensionId",
+ "in": "path",
+ "description": "Site extension name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "201": {
+ "description": "Site Extension created.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "200": {
+ "description": "Site Extension created.",
+ "schema": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "429": {
+ "description": "Site Extension is being installed on another request: Rejecting current request."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Remove a site extension from a web site, or a deployment slot.",
+ "description": "Description for Remove a site extension from a web site, or a deployment slot.",
+ "operationId": "WebApps_DeleteSiteExtensionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteExtensionId",
+ "in": "path",
+ "description": "Site extension name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "SiteExtension terminated."
+ },
+ "404": {
+ "description": "SiteExtension with an ID of {siteExtensionId} is not running."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotcopy": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Copies a deployment slot to another deployment slot of an app.",
+ "description": "Description for Copies a deployment slot to another deployment slot of an app.",
+ "operationId": "WebApps_CopySlotSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "copySlotEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name and site config properties to override the source slot config. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmCopySlotEntity"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Operation is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Copy slot": {
+ "$ref": "./examples/CopySlot.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsdiffs": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the difference in configuration settings between two web app slots.",
+ "description": "Description for Get the difference in configuration settings between two web app slots.",
+ "operationId": "WebApps_ListSlotDifferencesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotSwapEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmSlotEntity"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SlotDifferenceCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/slotsswap": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Swaps two deployment slots of an app.",
+ "description": "Description for Swaps two deployment slots of an app.",
+ "operationId": "WebApps_SwapSlotSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotSwapEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmSlotEntity"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the source slot. If a slot is not specified, the production slot is used as the source slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Operation is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshots": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns all Snapshots to the user.",
+ "description": "Description for Returns all Snapshots to the user.",
+ "operationId": "WebApps_ListSnapshotsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Website Name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Website Slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SnapshotCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/snapshotsdr": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns all Snapshots to the user from DRSecondary endpoint.",
+ "description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.",
+ "operationId": "WebApps_ListSnapshotsFromDRSecondarySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Website Name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Website Slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SnapshotCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sourcecontrols/web": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the source control configuration of an app.",
+ "description": "Description for Gets the source control configuration of an app.",
+ "operationId": "WebApps_GetSourceControlSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the source control configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved source control for web app.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "201": {
+ "description": "Create or update source control for web app still in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "202": {
+ "description": "Create or update source control for web app still in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the source control configuration of an app.",
+ "description": "Description for Updates the source control configuration of an app.",
+ "operationId": "WebApps_CreateOrUpdateSourceControlSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteSourceControl",
+ "in": "body",
+ "description": "JSON representation of a SiteSourceControl object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated source control for web app.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "201": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "202": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes the source control configuration of an app.",
+ "description": "Description for Deletes the source control configuration of an app.",
+ "operationId": "WebApps_DeleteSourceControlSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the source control configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted source control for web app."
+ },
+ "202": {
+ "description": "Source control delete operation in progress."
+ },
+ "404": {
+ "description": "Source control does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the source control configuration of an app.",
+ "description": "Description for Updates the source control configuration of an app.",
+ "operationId": "WebApps_UpdateSourceControlSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteSourceControl",
+ "in": "body",
+ "description": "JSON representation of a SiteSourceControl object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will update the source control configuration for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated source control for web app.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "201": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "202": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/start": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Starts an app (or deployment slot, if specified).",
+ "description": "Description for Starts an app (or deployment slot, if specified).",
+ "operationId": "WebApps_StartSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will start the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully started app."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/startNetworkTrace": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start capturing network packets for the site.",
+ "description": "Description for Start capturing network packets for the site.",
+ "operationId": "WebApps_StartNetworkTraceSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "durationInSeconds",
+ "in": "query",
+ "description": "The duration to keep capturing in seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for this web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "maxFrameLength",
+ "in": "query",
+ "description": "The maximum frame length in bytes (Optional).",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "sasUrl",
+ "in": "query",
+ "description": "The Blob URL to store capture file.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Start a new network trace operation for a site": {
+ "$ref": "./examples/StartWebSiteNetworkTraceOperation.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stop": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stops an app (or deployment slot, if specified).",
+ "description": "Description for Stops an app (or deployment slot, if specified).",
+ "operationId": "WebApps_StopSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will stop the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully stopped app."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/stopNetworkTrace": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stop ongoing capturing network packets for the site.",
+ "description": "Description for Stop ongoing capturing network packets for the site.",
+ "operationId": "WebApps_StopNetworkTraceSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "The name of the slot for this web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Stopped."
+ },
+ "204": {
+ "description": "Stopped."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Stop a currently running network trace operation for a site": {
+ "$ref": "./examples/StopWebSiteNetworkTrace.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/sync": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Sync web app repository.",
+ "description": "Description for Sync web app repository.",
+ "operationId": "WebApps_SyncRepositorySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of web app slot. If not specified then will default to production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully sync source control."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/syncfunctiontriggers": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Syncs function trigger metadata to the management database",
+ "description": "Description for Syncs function trigger metadata to the management database",
+ "operationId": "WebApps_SyncFunctionTriggersSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List triggered web jobs for an app, or a deployment slot.",
+ "description": "Description for List triggered web jobs for an app, or a deployment slot.",
+ "operationId": "WebApps_ListTriggeredWebJobsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes a deployment for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TriggeredWebJobCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a triggered web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_GetTriggeredWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/TriggeredWebJob"
+ }
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a triggered web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_DeleteTriggeredWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API deletes web job for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted continuous web job."
+ },
+ "204": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List a triggered web job's history for an app, or a deployment slot.",
+ "description": "Description for List a triggered web job's history for an app, or a deployment slot.",
+ "operationId": "WebApps_ListTriggeredWebJobHistorySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/TriggeredJobHistoryCollection"
+ }
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/history/{id}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
+ "description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
+ "operationId": "WebApps_GetTriggeredWebJobHistorySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "History ID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/TriggeredJobHistory"
+ }
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/triggeredwebjobs/{webJobName}/run": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Run a triggered web job for an app, or a deployment slot.",
+ "description": "Description for Run a triggered web job for an app, or a deployment slot.",
+ "operationId": "WebApps_RunTriggeredWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API uses the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Run a triggered web job."
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/usages": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the quota usage information of an app (or deployment slot, if specified).",
+ "description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListUsagesSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get quota information of the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the virtual networks the app (or deployment slot) is connected to.",
+ "description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.",
+ "operationId": "WebApps_ListVnetConnectionsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get virtual network connections for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.",
+ "description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.",
+ "operationId": "WebApps_GetVnetConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the virtual network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get the named virtual network for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "operationId": "WebApps_CreateOrUpdateVnetConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of an existing Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.",
+ "description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.",
+ "operationId": "WebApps_DeleteVnetConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the virtual network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will delete the connection for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted virtual network."
+ },
+ "404": {
+ "description": "Virtual network does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "operationId": "WebApps_UpdateVnetConnectionSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of an existing Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will add or update connections for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets an app's Virtual Network gateway.",
+ "description": "Description for Gets an app's Virtual Network gateway.",
+ "operationId": "WebApps_GetVnetConnectionGatewaySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Currently, the only supported string is \"primary\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will get a gateway for the production slot's Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "404": {
+ "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "operationId": "WebApps_CreateOrUpdateVnetConnectionGatewaySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Currently, the only supported string is \"primary\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The properties to update this gateway with.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "operationId": "WebApps_UpdateVnetConnectionGatewaySlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Currently, the only supported string is \"primary\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The properties to update this gateway with.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API will add or update a gateway for the production slot's Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List webjobs for an app, or a deployment slot.",
+ "description": "Description for List webjobs for an app, or a deployment slot.",
+ "operationId": "WebApps_ListWebJobsSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebJobCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/webjobs/{webJobName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get webjob information for an app, or a deployment slot.",
+ "description": "Description for Get webjob information for an app, or a deployment slot.",
+ "operationId": "WebApps_GetWebJobSlot",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of the web job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slot",
+ "in": "path",
+ "description": "Name of the deployment slot. If a slot is not specified, the API returns deployments for the production slot.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebJob"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsdiffs": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get the difference in configuration settings between two web app slots.",
+ "description": "Description for Get the difference in configuration settings between two web app slots.",
+ "operationId": "WebApps_ListSlotDifferencesFromProduction",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotSwapEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmSlotEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SlotDifferenceCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slotsswap": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Swaps two deployment slots of an app.",
+ "description": "Description for Swaps two deployment slots of an app.",
+ "operationId": "WebApps_SwapSlotWithProduction",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "slotSwapEntity",
+ "in": "body",
+ "description": "JSON object that contains the target slot name. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/CsmSlotEntity"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK."
+ },
+ "202": {
+ "description": "Operation is in progress."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshots": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns all Snapshots to the user.",
+ "description": "Description for Returns all Snapshots to the user.",
+ "operationId": "WebApps_ListSnapshots",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Website Name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SnapshotCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/snapshotsdr": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Returns all Snapshots to the user from DRSecondary endpoint.",
+ "description": "Description for Returns all Snapshots to the user from DRSecondary endpoint.",
+ "operationId": "WebApps_ListSnapshotsFromDRSecondary",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Website Name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/SnapshotCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sourcecontrols/web": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the source control configuration of an app.",
+ "description": "Description for Gets the source control configuration of an app.",
+ "operationId": "WebApps_GetSourceControl",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully retrieved source control for web app.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "201": {
+ "description": "Create or update source control for web app still in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "202": {
+ "description": "Create or update source control for web app still in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the source control configuration of an app.",
+ "description": "Description for Updates the source control configuration of an app.",
+ "operationId": "WebApps_CreateOrUpdateSourceControl",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteSourceControl",
+ "in": "body",
+ "description": "JSON representation of a SiteSourceControl object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated source control for web app.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "201": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "202": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-long-running-operation": true
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes the source control configuration of an app.",
+ "description": "Description for Deletes the source control configuration of an app.",
+ "operationId": "WebApps_DeleteSourceControl",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted source control for web app."
+ },
+ "202": {
+ "description": "Source control delete operation in progress."
+ },
+ "404": {
+ "description": "Source control does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Updates the source control configuration of an app.",
+ "description": "Description for Updates the source control configuration of an app.",
+ "operationId": "WebApps_UpdateSourceControl",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "siteSourceControl",
+ "in": "body",
+ "description": "JSON representation of a SiteSourceControl object. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully created or updated source control for web app.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "201": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "202": {
+ "description": "Create or update source control for web app in progress.",
+ "schema": {
+ "$ref": "#/definitions/SiteSourceControl"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/start": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Starts an app (or deployment slot, if specified).",
+ "description": "Description for Starts an app (or deployment slot, if specified).",
+ "operationId": "WebApps_Start",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully started app."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/startNetworkTrace": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Start capturing network packets for the site.",
+ "description": "Description for Start capturing network packets for the site.",
+ "operationId": "WebApps_StartNetworkTrace",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "durationInSeconds",
+ "in": "query",
+ "description": "The duration to keep capturing in seconds.",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "maxFrameLength",
+ "in": "query",
+ "description": "The maximum frame length in bytes (Optional).",
+ "type": "integer",
+ "format": "int32"
+ },
+ {
+ "name": "sasUrl",
+ "in": "query",
+ "description": "The Blob URL to store capture file.",
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "202": {
+ "description": "Operation is in progress.",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/NetworkTrace"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Start a new network trace operation for a site": {
+ "$ref": "./examples/StartWebSiteNetworkTraceOperation.json"
+ }
+ },
+ "x-ms-long-running-operation": true
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stop": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stops an app (or deployment slot, if specified).",
+ "description": "Description for Stops an app (or deployment slot, if specified).",
+ "operationId": "WebApps_Stop",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully stopped app."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/stopNetworkTrace": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Stop ongoing capturing network packets for the site.",
+ "description": "Description for Stop ongoing capturing network packets for the site.",
+ "operationId": "WebApps_StopNetworkTrace",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "The name of the web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Stopped."
+ },
+ "204": {
+ "description": "Stopped."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-examples": {
+ "Stop a currently running network trace operation for a site": {
+ "$ref": "./examples/StopWebSiteNetworkTrace.json"
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/sync": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Sync web app repository.",
+ "description": "Description for Sync web app repository.",
+ "operationId": "WebApps_SyncRepository",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of web app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully sync source control."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/syncfunctiontriggers": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Syncs function trigger metadata to the management database",
+ "description": "Description for Syncs function trigger metadata to the management database",
+ "operationId": "WebApps_SyncFunctionTriggers",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "204": {
+ "description": "No Content"
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List triggered web jobs for an app, or a deployment slot.",
+ "description": "Description for List triggered web jobs for an app, or a deployment slot.",
+ "operationId": "WebApps_ListTriggeredWebJobs",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/TriggeredWebJobCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a triggered web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Gets a triggered web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_GetTriggeredWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/TriggeredWebJob"
+ }
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Delete a triggered web job by its ID for an app, or a deployment slot.",
+ "description": "Description for Delete a triggered web job by its ID for an app, or a deployment slot.",
+ "operationId": "WebApps_DeleteTriggeredWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted continuous web job."
+ },
+ "204": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List a triggered web job's history for an app, or a deployment slot.",
+ "description": "Description for List a triggered web job's history for an app, or a deployment slot.",
+ "operationId": "WebApps_ListTriggeredWebJobHistory",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/TriggeredJobHistoryCollection"
+ }
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/history/{id}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
+ "description": "Description for Gets a triggered web job's history by its ID for an app, , or a deployment slot.",
+ "operationId": "WebApps_GetTriggeredWebJobHistory",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "id",
+ "in": "path",
+ "description": "History ID.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Found continuous web job.",
+ "schema": {
+ "$ref": "#/definitions/TriggeredJobHistory"
+ }
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/triggeredwebjobs/{webJobName}/run": {
+ "post": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Run a triggered web job for an app, or a deployment slot.",
+ "description": "Description for Run a triggered web job for an app, or a deployment slot.",
+ "operationId": "WebApps_RunTriggeredWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of Web Job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Run a triggered web job."
+ },
+ "404": {
+ "description": "Triggered web job does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/usages": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the quota usage information of an app (or deployment slot, if specified).",
+ "description": "Description for Gets the quota usage information of an app (or deployment slot, if specified).",
+ "operationId": "WebApps_ListUsages",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "description": "Return only information specified in the filter (using OData syntax). For example: $filter=(name.value eq 'Metric1' or name.value eq 'Metric2') and startTime eq 2014-01-01T00:00:00Z and endTime eq 2014-12-31T23:59:59Z and timeGrain eq duration'[Hour|Minute|Day]'.",
+ "type": "string",
+ "x-ms-skip-url-encoding": true
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/CsmUsageQuotaCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets the virtual networks the app (or deployment slot) is connected to.",
+ "description": "Description for Gets the virtual networks the app (or deployment slot) is connected to.",
+ "operationId": "WebApps_ListVnetConnections",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets a virtual network the app (or deployment slot) is connected to by name.",
+ "description": "Description for Gets a virtual network the app (or deployment slot) is connected to by name.",
+ "operationId": "WebApps_GetVnetConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the virtual network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "operationId": "WebApps_CreateOrUpdateVnetConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of an existing Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "delete": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Deletes a connection from an app (or deployment slot to a named virtual network.",
+ "description": "Description for Deletes a connection from an app (or deployment slot to a named virtual network.",
+ "operationId": "WebApps_DeleteVnetConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the virtual network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Successfully deleted virtual network."
+ },
+ "404": {
+ "description": "Virtual network does not exist."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "description": "Description for Adds a Virtual Network connection to an app or slot (PUT) or updates the connection properties (PATCH).",
+ "operationId": "WebApps_UpdateVnetConnection",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of an existing Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "Properties of the Virtual Network connection. See example.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/virtualNetworkConnections/{vnetName}/gateways/{gatewayName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Gets an app's Virtual Network gateway.",
+ "description": "Description for Gets an app's Virtual Network gateway.",
+ "operationId": "WebApps_GetVnetConnectionGateway",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Currently, the only supported string is \"primary\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "404": {
+ "description": "Named gateway does not exist. Only the \"primary\" gateway is supported currently."
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "put": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "operationId": "WebApps_CreateOrUpdateVnetConnectionGateway",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Currently, the only supported string is \"primary\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The properties to update this gateway with.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ },
+ "patch": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "description": "Description for Adds a gateway to a connected Virtual Network (PUT) or updates it (PATCH).",
+ "operationId": "WebApps_UpdateVnetConnectionGateway",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Name of the app.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "vnetName",
+ "in": "path",
+ "description": "Name of the Virtual Network.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "gatewayName",
+ "in": "path",
+ "description": "Name of the gateway. Currently, the only supported string is \"primary\".",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "connectionEnvelope",
+ "in": "body",
+ "description": "The properties to update this gateway with.",
+ "required": true,
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetGateway"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "List webjobs for an app, or a deployment slot.",
+ "description": "Description for List webjobs for an app, or a deployment slot.",
+ "operationId": "WebApps_ListWebJobs",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebJobCollection"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ },
+ "x-ms-pageable": {
+ "nextLinkName": "nextLink"
+ }
+ }
+ },
+ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/webjobs/{webJobName}": {
+ "get": {
+ "tags": [
+ "WebApps"
+ ],
+ "summary": "Get webjob information for an app, or a deployment slot.",
+ "description": "Description for Get webjob information for an app, or a deployment slot.",
+ "operationId": "WebApps_GetWebJob",
+ "parameters": [
+ {
+ "$ref": "#/parameters/resourceGroupNameParameter"
+ },
+ {
+ "name": "name",
+ "in": "path",
+ "description": "Site name.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "webJobName",
+ "in": "path",
+ "description": "Name of the web job.",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/subscriptionIdParameter"
+ },
+ {
+ "$ref": "#/parameters/apiVersionParameter"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OK",
+ "schema": {
+ "$ref": "#/definitions/WebJob"
+ }
+ },
+ "default": {
+ "description": "App Service error response.",
+ "schema": {
+ "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
+ }
+ }
+ }
+ }
+ }
+ },
+ "definitions": {
+ "AllowedAudiencesValidation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AllowedAudiencesValidation resource specific properties",
+ "properties": {
+ "allowedAudiences": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AppRegistration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AppRegistration resource specific properties",
+ "properties": {
+ "appId": {
+ "type": "string"
+ },
+ "appSecretSettingName": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ApplicationLogsConfig": {
+ "description": "Application logs configuration.",
+ "type": "object",
+ "properties": {
+ "fileSystem": {
+ "$ref": "#/definitions/FileSystemApplicationLogsConfig",
+ "description": "Application logs to file system configuration."
+ },
+ "azureTableStorage": {
+ "$ref": "#/definitions/AzureTableStorageApplicationLogsConfig",
+ "description": "Application logs to azure table storage configuration."
+ },
+ "azureBlobStorage": {
+ "$ref": "#/definitions/AzureBlobStorageApplicationLogsConfig",
+ "description": "Application logs to blob storage configuration."
+ }
+ }
+ },
+ "AuthPlatform": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AuthPlatform resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "runtimeVersion": {
+ "type": "string"
+ },
+ "configFilePath": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AzureActiveDirectory": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AzureActiveDirectory resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "registration": {
+ "$ref": "#/definitions/AzureActiveDirectoryRegistration"
+ },
+ "login": {
+ "$ref": "#/definitions/AzureActiveDirectoryLogin"
+ },
+ "validation": {
+ "$ref": "#/definitions/AzureActiveDirectoryValidation"
+ },
+ "isAutoProvisioned": {
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AzureActiveDirectoryLogin": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AzureActiveDirectoryLogin resource specific properties",
+ "properties": {
+ "disableWWWAuthenticate": {
+ "type": "boolean"
+ },
+ "loginParameters": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AzureActiveDirectoryRegistration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AzureActiveDirectoryRegistration resource specific properties",
+ "properties": {
+ "openIdIssuer": {
+ "type": "string"
+ },
+ "clientId": {
+ "type": "string"
+ },
+ "clientSecretSettingName": {
+ "type": "string"
+ },
+ "clientSecretCertificateThumbprint": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AzureActiveDirectoryValidation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "AzureActiveDirectoryValidation resource specific properties",
+ "properties": {
+ "jwtClaimChecks": {
+ "$ref": "#/definitions/JwtClaimChecks"
+ },
+ "allowedAudiences": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ArmIdWrapper": {
+ "description": "A wrapper for an ARM resource id",
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "AzureBlobStorageApplicationLogsConfig": {
+ "description": "Application logs azure blob storage configuration.",
+ "type": "object",
+ "properties": {
+ "level": {
+ "description": "Log level.",
+ "enum": [
+ "Off",
+ "Verbose",
+ "Information",
+ "Warning",
+ "Error"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LogLevel",
+ "modelAsString": false
+ }
+ },
+ "sasUrl": {
+ "description": "SAS url to a azure blob container with read/write/list/delete permissions.",
+ "type": "string"
+ },
+ "retentionInDays": {
+ "format": "int32",
+ "description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.",
+ "type": "integer"
+ }
+ }
+ },
+ "AzureBlobStorageHttpLogsConfig": {
+ "description": "Http logs to azure blob storage configuration.",
+ "type": "object",
+ "properties": {
+ "sasUrl": {
+ "description": "SAS url to a azure blob container with read/write/list/delete permissions.",
+ "type": "string"
+ },
+ "retentionInDays": {
+ "format": "int32",
+ "description": "Retention in days.\nRemove blobs older than X days.\n0 or lower means no retention.",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.",
+ "type": "boolean"
+ }
+ }
+ },
+ "AzureStorageInfoValue": {
+ "description": "Azure Files or Blob Storage access information value for dictionary storage.",
+ "type": "object",
+ "properties": {
+ "type": {
+ "description": "Type of storage.",
+ "enum": [
+ "AzureFiles",
+ "AzureBlob"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureStorageType",
+ "modelAsString": false
+ }
+ },
+ "accountName": {
+ "description": "Name of the storage account.",
+ "type": "string"
+ },
+ "shareName": {
+ "description": "Name of the file share (container name, for Blob storage).",
+ "type": "string"
+ },
+ "accessKey": {
+ "description": "Access key for the storage account.",
+ "type": "string"
+ },
+ "mountPath": {
+ "description": "Path to mount the storage within the site's runtime environment.",
+ "type": "string"
+ },
+ "state": {
+ "description": "State of the storage account.",
+ "enum": [
+ "Ok",
+ "InvalidCredentials",
+ "InvalidShare"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "AzureStorageState",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "AzureStoragePropertyDictionaryResource": {
+ "description": "AzureStorageInfo dictionary resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Azure storage accounts.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/AzureStorageInfoValue"
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "AzureTableStorageApplicationLogsConfig": {
+ "description": "Application logs to Azure table storage configuration.",
+ "required": [
+ "sasUrl"
+ ],
+ "type": "object",
+ "properties": {
+ "level": {
+ "description": "Log level.",
+ "enum": [
+ "Off",
+ "Verbose",
+ "Information",
+ "Warning",
+ "Error"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LogLevel",
+ "modelAsString": false
+ }
+ },
+ "sasUrl": {
+ "description": "SAS URL to an Azure table with add/query/delete permissions.",
+ "type": "string"
+ }
+ }
+ },
+ "BackupItem": {
+ "description": "Backup description.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "BackupItem resource specific properties",
+ "properties": {
+ "id": {
+ "format": "int32",
+ "description": "Id of the backup.",
+ "type": "integer",
+ "readOnly": true,
+ "x-ms-client-name": "BackupId"
+ },
+ "storageAccountUrl": {
+ "description": "SAS URL for the storage account container which contains this backup.",
+ "type": "string",
+ "readOnly": true
+ },
+ "blobName": {
+ "description": "Name of the blob which contains data for this backup.",
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "description": "Name of this backup.",
+ "type": "string",
+ "readOnly": true
+ },
+ "status": {
+ "description": "Backup status.",
+ "enum": [
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "TimedOut",
+ "Created",
+ "Skipped",
+ "PartiallySucceeded",
+ "DeleteInProgress",
+ "DeleteFailed",
+ "Deleted"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "BackupItemStatus",
+ "modelAsString": false
+ }
+ },
+ "sizeInBytes": {
+ "format": "int64",
+ "description": "Size of the backup in bytes.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "created": {
+ "format": "date-time",
+ "description": "Timestamp of the backup creation.",
+ "type": "string",
+ "readOnly": true
+ },
+ "log": {
+ "description": "Details regarding this backup. Might contain an error message.",
+ "type": "string",
+ "readOnly": true
+ },
+ "databases": {
+ "description": "List of databases included in the backup.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatabaseBackupSetting"
+ },
+ "readOnly": true
+ },
+ "scheduled": {
+ "description": "True if this backup has been created due to a schedule being triggered.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "lastRestoreTimeStamp": {
+ "format": "date-time",
+ "description": "Timestamp of a last restore operation which used this backup.",
+ "type": "string",
+ "readOnly": true
+ },
+ "finishedTimeStamp": {
+ "format": "date-time",
+ "description": "Timestamp when this backup finished.",
+ "type": "string",
+ "readOnly": true
+ },
+ "correlationId": {
+ "description": "Unique correlation identifier. Please use this along with the timestamp while communicating with Azure support.",
+ "type": "string",
+ "readOnly": true
+ },
+ "websiteSizeInBytes": {
+ "format": "int64",
+ "description": "Size of the original web app which has been backed up.",
+ "type": "integer",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "BackupItemCollection": {
+ "description": "Collection of backup items.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/BackupItem"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BackupRequest": {
+ "description": "Description of a backup which will be performed.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "BackupRequest resource specific properties",
+ "required": [
+ "storageAccountUrl"
+ ],
+ "properties": {
+ "backupName": {
+ "description": "Name of the backup.",
+ "type": "string"
+ },
+ "enabled": {
+ "description": "True if the backup schedule is enabled (must be included in that case), false if the backup schedule should be disabled.",
+ "type": "boolean"
+ },
+ "storageAccountUrl": {
+ "description": "SAS URL to the container.",
+ "type": "string"
+ },
+ "backupSchedule": {
+ "$ref": "#/definitions/BackupSchedule",
+ "description": "Schedule for the backup if it is executed periodically."
+ },
+ "databases": {
+ "description": "Databases included in the backup.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/DatabaseBackupSetting"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "BackupSchedule": {
+ "description": "Description of a backup schedule. Describes how often should be the backup performed and what should be the retention policy.",
+ "required": [
+ "frequencyInterval",
+ "frequencyUnit",
+ "keepAtLeastOneBackup",
+ "retentionPeriodInDays"
+ ],
+ "type": "object",
+ "properties": {
+ "frequencyInterval": {
+ "format": "int32",
+ "description": "How often the backup should be executed (e.g. for weekly backup, this should be set to 7 and FrequencyUnit should be set to Day)",
+ "default": 7,
+ "type": "integer"
+ },
+ "frequencyUnit": {
+ "description": "The unit of time for how often the backup should be executed (e.g. for weekly backup, this should be set to Day and FrequencyInterval should be set to 7)",
+ "default": "Day",
+ "enum": [
+ "Day",
+ "Hour"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "FrequencyUnit",
+ "modelAsString": false
+ }
+ },
+ "keepAtLeastOneBackup": {
+ "description": "True if the retention policy should always keep at least one backup in the storage account, regardless how old it is; false otherwise.",
+ "default": true,
+ "type": "boolean"
+ },
+ "retentionPeriodInDays": {
+ "format": "int32",
+ "description": "After how many days backups should be deleted.",
+ "default": 30,
+ "type": "integer"
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "When the schedule should start working.",
+ "type": "string"
+ },
+ "lastExecutionTime": {
+ "format": "date-time",
+ "description": "Last time when this schedule was triggered.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "BlobStorageTokenStore": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "BlobStorageTokenStore resource specific properties",
+ "properties": {
+ "sasUrlSettingName": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ClientRegistration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ClientRegistration resource specific properties",
+ "properties": {
+ "clientId": {
+ "type": "string"
+ },
+ "clientSecretSettingName": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ConnStringValueTypePair": {
+ "description": "Database connection string value to type pair.",
+ "required": [
+ "value",
+ "type"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Value of pair.",
+ "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
+ }
+ }
+ }
+ },
+ "ConnectionStringDictionary": {
+ "description": "String dictionary resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Connection strings.",
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/ConnStringValueTypePair"
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ContainerCpuStatistics": {
+ "type": "object",
+ "properties": {
+ "cpuUsage": {
+ "$ref": "#/definitions/ContainerCpuUsage"
+ },
+ "systemCpuUsage": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "onlineCpuCount": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttlingData": {
+ "$ref": "#/definitions/ContainerThrottlingData"
+ }
+ }
+ },
+ "ContainerCpuUsage": {
+ "type": "object",
+ "properties": {
+ "totalUsage": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "perCpuUsage": {
+ "type": "array",
+ "items": {
+ "format": "int64",
+ "type": "integer"
+ }
+ },
+ "kernelModeUsage": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "userModeUsage": {
+ "format": "int64",
+ "type": "integer"
+ }
+ }
+ },
+ "ContainerInfo": {
+ "type": "object",
+ "properties": {
+ "currentTimeStamp": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "previousTimeStamp": {
+ "format": "date-time",
+ "type": "string"
+ },
+ "currentCpuStats": {
+ "$ref": "#/definitions/ContainerCpuStatistics"
+ },
+ "previousCpuStats": {
+ "$ref": "#/definitions/ContainerCpuStatistics"
+ },
+ "memoryStats": {
+ "$ref": "#/definitions/ContainerMemoryStatistics"
+ },
+ "name": {
+ "type": "string"
+ },
+ "id": {
+ "type": "string"
+ },
+ "eth0": {
+ "$ref": "#/definitions/ContainerNetworkInterfaceStatistics"
+ }
+ }
+ },
+ "ContainerMemoryStatistics": {
+ "type": "object",
+ "properties": {
+ "usage": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "maxUsage": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "limit": {
+ "format": "int64",
+ "type": "integer"
+ }
+ }
+ },
+ "ContainerNetworkInterfaceStatistics": {
+ "type": "object",
+ "properties": {
+ "rxBytes": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "rxPackets": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "rxErrors": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "rxDropped": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "txBytes": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "txPackets": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "txErrors": {
+ "format": "int64",
+ "type": "integer"
+ },
+ "txDropped": {
+ "format": "int64",
+ "type": "integer"
+ }
+ }
+ },
+ "ContainerThrottlingData": {
+ "type": "object",
+ "properties": {
+ "periods": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttledPeriods": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "throttledTime": {
+ "format": "int32",
+ "type": "integer"
+ }
+ }
+ },
+ "ContinuousWebJob": {
+ "description": "Continuous Web Job Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ContinuousWebJob resource specific properties",
+ "properties": {
+ "status": {
+ "description": "Job status.",
+ "enum": [
+ "Initializing",
+ "Starting",
+ "Running",
+ "PendingRestart",
+ "Stopped"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ContinuousWebJobStatus",
+ "modelAsString": false
+ }
+ },
+ "detailed_status": {
+ "description": "Detailed status.",
+ "type": "string"
+ },
+ "log_url": {
+ "description": "Log URL.",
+ "type": "string"
+ },
+ "run_command": {
+ "description": "Run command.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Job URL.",
+ "type": "string"
+ },
+ "extra_info_url": {
+ "description": "Extra Info URL.",
+ "type": "string"
+ },
+ "web_job_type": {
+ "description": "Job type.",
+ "enum": [
+ "Continuous",
+ "Triggered"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebJobType",
+ "modelAsString": false
+ }
+ },
+ "error": {
+ "description": "Error information.",
+ "type": "string"
+ },
+ "using_sdk": {
+ "description": "Using SDK?",
+ "type": "boolean"
+ },
+ "settings": {
+ "description": "Job settings.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ContinuousWebJobCollection": {
+ "description": "Collection of Kudu continuous web job information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ContinuousWebJob"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "CookieExpiration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CookieExpiration resource specific properties",
+ "properties": {
+ "convention": {
+ "enum": [
+ "FixedTime",
+ "IdentityProviderDerived"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CookieExpirationConvention",
+ "modelAsString": false
+ }
+ },
+ "timeToExpiration": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CsmCopySlotEntity": {
+ "description": "Copy deployment slot parameters.",
+ "required": [
+ "targetSlot",
+ "siteConfig"
+ ],
+ "type": "object",
+ "properties": {
+ "targetSlot": {
+ "description": "Destination deployment slot during copy operation.",
+ "type": "string"
+ },
+ "siteConfig": {
+ "$ref": "./CommonDefinitions.json#/definitions/SiteConfig",
+ "description": "The site object which will be merged with the source slot site\nto produce new destination slot site object.\nnull to just copy source slot content. Otherwise a Site\nobject with properties to override source slot site."
+ }
+ }
+ },
+ "CsmPublishingCredentialsPoliciesCollection": {
+ "description": "Publishing Credentials Policies collection.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CsmPublishingCredentialsPoliciesCollection resource specific properties",
+ "required": [
+ "ftp",
+ "scm"
+ ],
+ "properties": {
+ "ftp": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity",
+ "description": "Whether FTP is allowed."
+ },
+ "scm": {
+ "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity",
+ "description": "Whether Scm Basic Auth is allowed."
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CsmPublishingCredentialsPoliciesEntity": {
+ "description": "Publishing Credentials Policies parameters.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CsmPublishingCredentialsPoliciesEntity resource specific properties",
+ "required": [
+ "allow"
+ ],
+ "properties": {
+ "allow": {
+ "description": "true to allow access to a publishing method; otherwise, false.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CsmPublishingProfileOptions": {
+ "description": "Publishing options for requested profile.",
+ "type": "object",
+ "properties": {
+ "format": {
+ "description": "Name of the format. Valid values are: \nFileZilla3\nWebDeploy -- default\nFtp",
+ "enum": [
+ "FileZilla3",
+ "WebDeploy",
+ "Ftp"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublishingProfileFormat",
+ "modelAsString": true
+ }
+ },
+ "includeDisasterRecoveryEndpoints": {
+ "description": "Include the DisasterRecover endpoint if true",
+ "type": "boolean"
+ }
+ }
+ },
+ "CsmSlotEntity": {
+ "description": "Deployment slot parameters.",
+ "required": [
+ "targetSlot",
+ "preserveVnet"
+ ],
+ "type": "object",
+ "properties": {
+ "targetSlot": {
+ "description": "Destination deployment slot during swap operation.",
+ "type": "string"
+ },
+ "preserveVnet": {
+ "description": "true to preserve Virtual Network to the slot during swap; otherwise, false.",
+ "type": "boolean"
+ }
+ }
+ },
+ "CustomHostnameAnalysisResult": {
+ "description": "Custom domain analysis.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CustomHostnameAnalysisResult resource specific properties",
+ "properties": {
+ "isHostnameAlreadyVerified": {
+ "description": "true if hostname is already verified; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "customDomainVerificationTest": {
+ "description": "DNS verification test result.",
+ "enum": [
+ "Passed",
+ "Failed",
+ "Skipped"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "DnsVerificationTestResult",
+ "modelAsString": false
+ }
+ },
+ "customDomainVerificationFailureInfo": {
+ "$ref": "./CommonDefinitions.json#/definitions/ErrorEntity",
+ "description": "Raw failure information if DNS verification fails.",
+ "readOnly": true
+ },
+ "hasConflictOnScaleUnit": {
+ "description": "true if there is a conflict on a scale unit; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "hasConflictAcrossSubscription": {
+ "description": "true if there is a conflict across subscriptions; otherwise, false.",
+ "type": "boolean",
+ "readOnly": true
+ },
+ "conflictingAppResourceId": {
+ "description": "Name of the conflicting app on scale unit if it's within the same subscription.",
+ "type": "string",
+ "readOnly": true
+ },
+ "cNameRecords": {
+ "description": "CName records controller can see for this hostname.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "txtRecords": {
+ "description": "TXT records controller can see for this hostname.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "aRecords": {
+ "description": "A records controller can see for this hostname.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "alternateCNameRecords": {
+ "description": "Alternate CName records controller can see for this hostname.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "alternateTxtRecords": {
+ "description": "Alternate TXT records controller can see for this hostname.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "CustomOpenIdConnectProvider": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "CustomOpenIdConnectProvider resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "registration": {
+ "$ref": "#/definitions/OpenIdConnectRegistration"
+ },
+ "login": {
+ "$ref": "#/definitions/OpenIdConnectLogin"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DatabaseBackupSetting": {
+ "description": "Database backup settings.",
+ "required": [
+ "databaseType"
+ ],
+ "type": "object",
+ "properties": {
+ "databaseType": {
+ "description": "Database type (e.g. SqlAzure / MySql).",
+ "enum": [
+ "SqlAzure",
+ "MySql",
+ "LocalMySql",
+ "PostgreSql"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "DatabaseType",
+ "modelAsString": true
+ }
+ },
+ "name": {
+ "type": "string"
+ },
+ "connectionStringName": {
+ "description": "Contains a connection string name that is linked to the SiteConfig.ConnectionStrings.\nThis is used during restore with overwrite connection strings options.",
+ "type": "string"
+ },
+ "connectionString": {
+ "description": "Contains a connection string to a database which is being backed up or restored. If the restore should happen to a new database, the database name inside is the new one.",
+ "type": "string"
+ }
+ }
+ },
+ "DeletedAppRestoreRequest": {
+ "description": "Details about restoring a deleted app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "DeletedAppRestoreRequest resource specific properties",
+ "properties": {
+ "deletedSiteId": {
+ "description": "ARM resource ID of the deleted app. Example:\n/subscriptions/{subId}/providers/Microsoft.Web/deletedSites/{deletedSiteId}",
+ "type": "string"
+ },
+ "recoverConfiguration": {
+ "description": "If true, deleted site configuration, in addition to content, will be restored.",
+ "type": "boolean"
+ },
+ "snapshotTime": {
+ "description": "Point in time to restore the deleted app from, formatted as a DateTime string. \nIf unspecified, default value is the time that the app was deleted.",
+ "type": "string"
+ },
+ "useDRSecondary": {
+ "description": "If true, the snapshot is retrieved from DRSecondary endpoint.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "Deployment": {
+ "description": "User credentials used for publishing activity.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Deployment resource specific properties",
+ "properties": {
+ "status": {
+ "format": "int32",
+ "description": "Deployment status.",
+ "type": "integer"
+ },
+ "message": {
+ "description": "Details about deployment status.",
+ "type": "string"
+ },
+ "author": {
+ "description": "Who authored the deployment.",
+ "type": "string"
+ },
+ "deployer": {
+ "description": "Who performed the deployment.",
+ "type": "string"
+ },
+ "author_email": {
+ "description": "Author email.",
+ "type": "string"
+ },
+ "start_time": {
+ "format": "date-time",
+ "description": "Start time.",
+ "type": "string"
+ },
+ "end_time": {
+ "format": "date-time",
+ "description": "End time.",
+ "type": "string"
+ },
+ "active": {
+ "description": "True if deployment is currently active, false if completed and null if not started.",
+ "type": "boolean"
+ },
+ "details": {
+ "description": "Details on deployment.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "DeploymentCollection": {
+ "description": "Collection of app deployments.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/Deployment"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "EnabledConfig": {
+ "description": "Enabled configuration.",
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.",
+ "type": "boolean"
+ }
+ }
+ },
+ "Facebook": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Facebook resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "registration": {
+ "$ref": "#/definitions/AppRegistration"
+ },
+ "graphApiVersion": {
+ "type": "string"
+ },
+ "login": {
+ "$ref": "#/definitions/LoginScopes"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "FileSystemApplicationLogsConfig": {
+ "description": "Application logs to file system configuration.",
+ "type": "object",
+ "properties": {
+ "level": {
+ "description": "Log level.",
+ "default": "Off",
+ "enum": [
+ "Off",
+ "Verbose",
+ "Information",
+ "Warning",
+ "Error"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "LogLevel",
+ "modelAsString": false
+ }
+ }
+ }
+ },
+ "FileSystemHttpLogsConfig": {
+ "description": "Http logs to file system configuration.",
+ "type": "object",
+ "properties": {
+ "retentionInMb": {
+ "format": "int32",
+ "description": "Maximum size in megabytes that http log files can use.\nWhen reached old log files will be removed to make space for new ones.\nValue can range between 25 and 100.",
+ "maximum": 100,
+ "minimum": 25,
+ "type": "integer"
+ },
+ "retentionInDays": {
+ "format": "int32",
+ "description": "Retention in days.\nRemove files older than X days.\n0 or lower means no retention.",
+ "type": "integer"
+ },
+ "enabled": {
+ "description": "True if configuration is enabled, false if it is disabled and null if configuration is not set.",
+ "type": "boolean"
+ }
+ }
+ },
+ "FileSystemTokenStore": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "FileSystemTokenStore resource specific properties",
+ "properties": {
+ "directory": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ForwardProxy": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ForwardProxy resource specific properties",
+ "properties": {
+ "convention": {
+ "enum": [
+ "NoProxy",
+ "Standard",
+ "Custom"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ForwardProxyConvention",
+ "modelAsString": false
+ }
+ },
+ "customHostHeaderName": {
+ "type": "string"
+ },
+ "customProtoHeaderName": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "FunctionEnvelope": {
+ "description": "Function information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "FunctionEnvelope resource specific properties",
+ "properties": {
+ "function_app_id": {
+ "description": "Function App ID.",
+ "type": "string"
+ },
+ "script_root_path_href": {
+ "description": "Script root path URI.",
+ "type": "string"
+ },
+ "script_href": {
+ "description": "Script URI.",
+ "type": "string"
+ },
+ "config_href": {
+ "description": "Config URI.",
+ "type": "string"
+ },
+ "test_data_href": {
+ "description": "Test data URI.",
+ "type": "string"
+ },
+ "secrets_file_href": {
+ "description": "Secrets file URI.",
+ "type": "string"
+ },
+ "href": {
+ "description": "Function URI.",
+ "type": "string"
+ },
+ "config": {
+ "description": "Config information.",
+ "type": "object"
+ },
+ "files": {
+ "description": "File list.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "test_data": {
+ "description": "Test data used when testing via the Azure Portal.",
+ "type": "string"
+ },
+ "invoke_url_template": {
+ "description": "The invocation URL",
+ "type": "string"
+ },
+ "language": {
+ "description": "The function language",
+ "type": "string"
+ },
+ "isDisabled": {
+ "description": "Gets or sets a value indicating whether the function is disabled",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "FunctionEnvelopeCollection": {
+ "description": "Collection of Kudu function information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/FunctionEnvelope"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "FunctionSecrets": {
+ "description": "Function secrets.",
+ "type": "object",
+ "properties": {
+ "key": {
+ "description": "Secret key.",
+ "type": "string"
+ },
+ "trigger_url": {
+ "description": "Trigger URL.",
+ "type": "string"
+ }
+ }
+ },
+ "GitHub": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "GitHub resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "registration": {
+ "$ref": "#/definitions/ClientRegistration"
+ },
+ "login": {
+ "$ref": "#/definitions/LoginScopes"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "GlobalValidation": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "GlobalValidation resource specific properties",
+ "properties": {
+ "requireAuthentication": {
+ "type": "boolean"
+ },
+ "unauthenticatedClientAction": {
+ "enum": [
+ "RedirectToLoginPage",
+ "AllowAnonymous",
+ "Return401",
+ "Return403"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UnauthenticatedClientActionV2",
+ "modelAsString": false
+ }
+ },
+ "redirectToProvider": {
+ "type": "string"
+ },
+ "excludedPaths": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "Google": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Google resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "registration": {
+ "$ref": "#/definitions/ClientRegistration"
+ },
+ "login": {
+ "$ref": "#/definitions/LoginScopes"
+ },
+ "validation": {
+ "$ref": "#/definitions/AllowedAudiencesValidation"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "HostKeys": {
+ "description": "Functions host level keys.",
+ "type": "object",
+ "properties": {
+ "masterKey": {
+ "description": "Secret key.",
+ "type": "string"
+ },
+ "functionKeys": {
+ "description": "Host level function keys.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "systemKeys": {
+ "description": "System keys.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "HostNameBinding": {
+ "description": "A hostname binding object.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "HostNameBinding resource specific properties",
+ "properties": {
+ "siteName": {
+ "description": "App Service app name.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "domainId": {
+ "description": "Fully qualified ARM domain resource URI.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "azureResourceName": {
+ "description": "Azure resource name.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "azureResourceType": {
+ "description": "Azure resource type.",
+ "enum": [
+ "Website",
+ "TrafficManager"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "AzureResourceType",
+ "modelAsString": false
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "customHostNameDnsRecordType": {
+ "description": "Custom DNS record type.",
+ "enum": [
+ "CName",
+ "A"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CustomHostNameDnsRecordType",
+ "modelAsString": false
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "hostNameType": {
+ "description": "Hostname type.",
+ "enum": [
+ "Verified",
+ "Managed"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "HostNameType",
+ "modelAsString": false
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "sslState": {
+ "description": "SSL type",
+ "enum": [
+ "Disabled",
+ "SniEnabled",
+ "IpBasedEnabled"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SslState",
+ "modelAsString": false
+ },
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "thumbprint": {
+ "description": "SSL certificate thumbprint",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "virtualIP": {
+ "description": "Virtual IP address assigned to the hostname if IP based SSL is enabled.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "HostNameBindingCollection": {
+ "description": "Collection of hostname bindings.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/HostNameBinding"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "HttpLogsConfig": {
+ "description": "Http logs configuration.",
+ "type": "object",
+ "properties": {
+ "fileSystem": {
+ "$ref": "#/definitions/FileSystemHttpLogsConfig",
+ "description": "Http logs to file system configuration."
+ },
+ "azureBlobStorage": {
+ "$ref": "#/definitions/AzureBlobStorageHttpLogsConfig",
+ "description": "Http logs to azure blob storage configuration."
+ }
+ }
+ },
+ "HttpSettings": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "HttpSettings resource specific properties",
+ "properties": {
+ "requireHttps": {
+ "type": "boolean"
+ },
+ "routes": {
+ "$ref": "#/definitions/HttpSettingsRoutes"
+ },
+ "forwardProxy": {
+ "$ref": "#/definitions/ForwardProxy"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "HttpSettingsRoutes": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "HttpSettingsRoutes resource specific properties",
+ "properties": {
+ "apiPrefix": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "IdentityProviders": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "IdentityProviders resource specific properties",
+ "properties": {
+ "azureActiveDirectory": {
+ "$ref": "#/definitions/AzureActiveDirectory"
+ },
+ "facebook": {
+ "$ref": "#/definitions/Facebook"
+ },
+ "gitHub": {
+ "$ref": "#/definitions/GitHub"
+ },
+ "google": {
+ "$ref": "#/definitions/Google"
+ },
+ "twitter": {
+ "$ref": "#/definitions/Twitter"
+ },
+ "customOpenIdConnectProviders": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/CustomOpenIdConnectProvider"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "JwtClaimChecks": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "JwtClaimChecks resource specific properties",
+ "properties": {
+ "allowedGroups": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "allowedClientApplications": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "KeyInfo": {
+ "description": "Function key info.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Key name",
+ "type": "string"
+ },
+ "value": {
+ "description": "Key value",
+ "type": "string"
+ }
+ }
+ },
+ "Login": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Login resource specific properties",
+ "properties": {
+ "routes": {
+ "$ref": "#/definitions/LoginRoutes"
+ },
+ "tokenStore": {
+ "$ref": "#/definitions/TokenStore"
+ },
+ "preserveUrlFragmentsForLogins": {
+ "type": "boolean"
+ },
+ "allowedExternalRedirectUrls": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "cookieExpiration": {
+ "$ref": "#/definitions/CookieExpiration"
+ },
+ "nonce": {
+ "$ref": "#/definitions/Nonce"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "LoginRoutes": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "LoginRoutes resource specific properties",
+ "properties": {
+ "logoutEndpoint": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "LoginScopes": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "LoginScopes resource specific properties",
+ "properties": {
+ "scopes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MSDeploy": {
+ "description": "MSDeploy ARM PUT information",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/MSDeployCore",
+ "description": "Core resource properties",
+ "properties": {
+ "addOnPackages": {
+ "description": "List of Add-On packages. Add-On packages implicitly enable the Do Not Delete MSDeploy rule.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MSDeployCore"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MSDeployCore": {
+ "description": "MSDeploy ARM PUT core information",
+ "type": "object",
+ "properties": {
+ "packageUri": {
+ "description": "Package URI",
+ "type": "string"
+ },
+ "connectionString": {
+ "description": "SQL Connection String",
+ "type": "string"
+ },
+ "dbType": {
+ "description": "Database Type",
+ "type": "string"
+ },
+ "setParametersXmlFileUri": {
+ "description": "URI of MSDeploy Parameters file. Must not be set if SetParameters is used.",
+ "type": "string"
+ },
+ "setParameters": {
+ "description": "MSDeploy Parameters. Must not be set if SetParametersXmlFileUri is used.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "skipAppData": {
+ "description": "Controls whether the MSDeploy operation skips the App_Data directory.\nIf set to true, the existing App_Data directory on the destination\nwill not be deleted, and any App_Data directory in the source will be ignored.\nSetting is false by default.",
+ "type": "boolean"
+ },
+ "appOffline": {
+ "description": "Sets the AppOffline rule while the MSDeploy operation executes.\nSetting is false by default.",
+ "type": "boolean"
+ }
+ }
+ },
+ "MSDeployLog": {
+ "description": "MSDeploy log",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "MSDeployLog resource specific properties",
+ "properties": {
+ "entries": {
+ "description": "List of log entry messages",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/MSDeployLogEntry"
+ },
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MSDeployLogEntry": {
+ "description": "MSDeploy log entry",
+ "type": "object",
+ "properties": {
+ "time": {
+ "format": "date-time",
+ "description": "Timestamp of log entry",
+ "type": "string",
+ "readOnly": true
+ },
+ "type": {
+ "description": "Log entry type",
+ "enum": [
+ "Message",
+ "Warning",
+ "Error"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "MSDeployLogEntryType",
+ "modelAsString": false
+ }
+ },
+ "message": {
+ "description": "Log entry message",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "MSDeployStatus": {
+ "description": "MSDeploy ARM response",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "MSDeployStatus resource specific properties",
+ "properties": {
+ "deployer": {
+ "description": "Username of deployer",
+ "type": "string",
+ "readOnly": true
+ },
+ "provisioningState": {
+ "description": "Provisioning state",
+ "enum": [
+ "accepted",
+ "running",
+ "succeeded",
+ "failed",
+ "canceled"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "MSDeployProvisioningState",
+ "modelAsString": false
+ }
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of deploy operation",
+ "type": "string",
+ "readOnly": true
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of deploy operation",
+ "type": "string",
+ "readOnly": true
+ },
+ "complete": {
+ "description": "Whether the deployment operation has completed",
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MigrateMySqlRequest": {
+ "description": "MySQL migration request.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "MigrateMySqlRequest resource specific properties",
+ "required": [
+ "connectionString",
+ "migrationType"
+ ],
+ "properties": {
+ "connectionString": {
+ "description": "Connection string to the remote MySQL database.",
+ "type": "string"
+ },
+ "migrationType": {
+ "description": "The type of migration operation to be done",
+ "enum": [
+ "LocalToRemote",
+ "RemoteToLocal"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "MySqlMigrationType",
+ "modelAsString": false
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "MigrateMySqlStatus": {
+ "description": "MySQL migration status.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "MigrateMySqlStatus resource specific properties",
+ "properties": {
+ "migrationOperationStatus": {
+ "description": "Status of the migration task.",
+ "enum": [
+ "InProgress",
+ "Failed",
+ "Succeeded",
+ "TimedOut",
+ "Created"
+ ],
+ "type": "string",
+ "readOnly": true,
+ "x-ms-enum": {
+ "name": "OperationStatus",
+ "modelAsString": false
+ }
+ },
+ "operationId": {
+ "description": "Operation ID for the migration task.",
+ "type": "string",
+ "readOnly": true
+ },
+ "localMySqlEnabled": {
+ "description": "True if the web app has in app MySql enabled",
+ "type": "boolean",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "NetworkFeatures": {
+ "description": "Full view of network features for an app (presently VNET integration and Hybrid Connections).",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "NetworkFeatures resource specific properties",
+ "properties": {
+ "virtualNetworkName": {
+ "description": "The Virtual Network name.",
+ "type": "string",
+ "readOnly": true
+ },
+ "virtualNetworkConnection": {
+ "$ref": "./CommonDefinitions.json#/definitions/VnetInfo",
+ "description": "The Virtual Network summary view.",
+ "readOnly": true
+ },
+ "hybridConnections": {
+ "description": "The Hybrid Connections summary view.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/RelayServiceConnectionEntity"
+ },
+ "readOnly": true
+ },
+ "hybridConnectionsV2": {
+ "description": "The Hybrid Connection V2 (Service Bus) view.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/HybridConnection"
+ },
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "NetworkTrace": {
+ "description": "Network trace",
+ "type": "object",
+ "properties": {
+ "path": {
+ "description": "Local file path for the captured network trace file.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Current status of the network trace operation, same as Operation.Status (InProgress/Succeeded/Failed).",
+ "type": "string"
+ },
+ "message": {
+ "description": "Detailed message of a network trace operation, e.g. error message in case of failure.",
+ "type": "string"
+ }
+ }
+ },
+ "Nonce": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Nonce resource specific properties",
+ "properties": {
+ "validateNonce": {
+ "type": "boolean"
+ },
+ "nonceExpirationInterval": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OpenIdConnectClientCredential": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "OpenIdConnectClientCredential resource specific properties",
+ "properties": {
+ "method": {
+ "enum": [
+ "ClientSecretPost"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClientCredentialMethod",
+ "modelAsString": false
+ }
+ },
+ "clientSecretSettingName": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OpenIdConnectConfig": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "OpenIdConnectConfig resource specific properties",
+ "properties": {
+ "authorizationEndpoint": {
+ "type": "string"
+ },
+ "tokenEndpoint": {
+ "type": "string"
+ },
+ "issuer": {
+ "type": "string"
+ },
+ "certificationUri": {
+ "type": "string"
+ },
+ "wellKnownOpenIdConfiguration": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OpenIdConnectLogin": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "OpenIdConnectLogin resource specific properties",
+ "properties": {
+ "nameClaimType": {
+ "type": "string"
+ },
+ "scopes": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "OpenIdConnectRegistration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "OpenIdConnectRegistration resource specific properties",
+ "properties": {
+ "clientId": {
+ "type": "string"
+ },
+ "clientCredential": {
+ "$ref": "#/definitions/OpenIdConnectClientCredential"
+ },
+ "openIdConnectConfiguration": {
+ "$ref": "#/definitions/OpenIdConnectConfig"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PerfMonCounterCollection": {
+ "description": "Collection of performance monitor counters.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PerfMonResponse"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "PerfMonResponse": {
+ "description": "Performance monitor API response.",
+ "type": "object",
+ "properties": {
+ "code": {
+ "description": "The response code.",
+ "type": "string"
+ },
+ "message": {
+ "description": "The message.",
+ "type": "string"
+ },
+ "data": {
+ "$ref": "#/definitions/PerfMonSet",
+ "description": "The performance monitor counters."
+ }
+ }
+ },
+ "PerfMonSample": {
+ "description": "Performance monitor sample in a set.",
+ "type": "object",
+ "properties": {
+ "time": {
+ "format": "date-time",
+ "description": "Point in time for which counter was measured.",
+ "type": "string"
+ },
+ "instanceName": {
+ "description": "Name of the server on which the measurement is made.",
+ "type": "string"
+ },
+ "value": {
+ "format": "double",
+ "description": "Value of counter at a certain time.",
+ "type": "number"
+ }
+ }
+ },
+ "PerfMonSet": {
+ "description": "Metric information.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Unique key name of the counter.",
+ "type": "string"
+ },
+ "startTime": {
+ "format": "date-time",
+ "description": "Start time of the period.",
+ "type": "string"
+ },
+ "endTime": {
+ "format": "date-time",
+ "description": "End time of the period.",
+ "type": "string"
+ },
+ "timeGrain": {
+ "description": "Presented time grain.",
+ "type": "string"
+ },
+ "values": {
+ "description": "Collection of workers that are active during this time.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PerfMonSample"
+ }
+ }
+ }
+ },
+ "PremierAddOn": {
+ "description": "Premier add-on.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/Resource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "PremierAddOn resource specific properties",
+ "properties": {
+ "sku": {
+ "description": "Premier add on SKU.",
+ "type": "string"
+ },
+ "product": {
+ "description": "Premier add on Product.",
+ "type": "string"
+ },
+ "vendor": {
+ "description": "Premier add on Vendor.",
+ "type": "string"
+ },
+ "marketplacePublisher": {
+ "description": "Premier add on Marketplace publisher.",
+ "type": "string"
+ },
+ "marketplaceOffer": {
+ "description": "Premier add on Marketplace offer.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PremierAddOnPatchResource": {
+ "description": "ARM resource for a PremierAddOn.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "PremierAddOnPatchResource resource specific properties",
+ "properties": {
+ "sku": {
+ "description": "Premier add on SKU.",
+ "type": "string"
+ },
+ "product": {
+ "description": "Premier add on Product.",
+ "type": "string"
+ },
+ "vendor": {
+ "description": "Premier add on Vendor.",
+ "type": "string"
+ },
+ "marketplacePublisher": {
+ "description": "Premier add on Marketplace publisher.",
+ "type": "string"
+ },
+ "marketplaceOffer": {
+ "description": "Premier add on Marketplace offer.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateAccess": {
+ "description": "Description of the parameters of Private Access for a Web Site.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "PrivateAccess resource specific properties",
+ "properties": {
+ "enabled": {
+ "description": "Whether private access is enabled or not.",
+ "type": "boolean"
+ },
+ "virtualNetworks": {
+ "description": "The Virtual Networks (and subnets) allowed to access the site privately.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateAccessVirtualNetwork"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateAccessSubnet": {
+ "description": "Description of a Virtual Network subnet that is useable for private site access.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the subnet.",
+ "type": "string"
+ },
+ "key": {
+ "format": "int32",
+ "description": "The key (ID) of the subnet.",
+ "type": "integer"
+ }
+ }
+ },
+ "PrivateAccessVirtualNetwork": {
+ "description": "Description of a Virtual Network that is useable for private site access.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "The name of the Virtual Network.",
+ "type": "string"
+ },
+ "key": {
+ "format": "int32",
+ "description": "The key (ID) of the Virtual Network.",
+ "type": "integer"
+ },
+ "resourceId": {
+ "description": "The ARM uri of the Virtual Network",
+ "type": "string"
+ },
+ "subnets": {
+ "description": "A List of subnets that access is allowed to on this Virtual Network. An empty array (but not null) is interpreted to mean that all subnets are allowed within this Virtual Network.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateAccessSubnet"
+ }
+ }
+ }
+ },
+ "PrivateEndpointConnectionResource": {
+ "description": "Private Endpoint Connection ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/RemotePrivateEndpointConnection",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateLinkConnectionApprovalRequest": {
+ "description": "A request to approve or reject a private endpoint connection",
+ "type": "object",
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkConnectionState"
+ }
+ }
+ },
+ "PrivateLinkConnectionApprovalRequestResource": {
+ "description": "Private Endpoint Connection Approval ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkConnectionApprovalRequest",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PrivateLinkConnectionState": {
+ "description": "The state of a private link connection",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Status of a private link connection",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of a private link connection",
+ "type": "string"
+ },
+ "actionsRequired": {
+ "description": "ActionsRequired for a private link connection",
+ "type": "string"
+ }
+ }
+ },
+ "PrivateLinkResource": {
+ "description": "A private link resource",
+ "required": [
+ "id",
+ "name",
+ "type",
+ "properties"
+ ],
+ "type": "object",
+ "properties": {
+ "id": {
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of a private link resource",
+ "type": "string"
+ },
+ "type": {
+ "type": "string"
+ },
+ "properties": {
+ "$ref": "#/definitions/PrivateLinkResourceProperties",
+ "description": "Properties of a private link resource"
+ }
+ }
+ },
+ "PrivateLinkResourceProperties": {
+ "description": "Properties of a private link resource",
+ "type": "object",
+ "properties": {
+ "groupId": {
+ "description": "GroupId of a private link resource",
+ "type": "string",
+ "readOnly": true
+ },
+ "requiredMembers": {
+ "description": "RequiredMembers of a private link resource",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ },
+ "requiredZoneNames": {
+ "description": "RequiredZoneNames of a private link resource",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "readOnly": true
+ }
+ }
+ },
+ "PrivateLinkResourcesWrapper": {
+ "description": "Wrapper for a collection of private link resources",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PrivateLinkResource"
+ }
+ }
+ }
+ },
+ "ProcessInfo": {
+ "description": "Process Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ProcessInfo resource specific properties",
+ "properties": {
+ "identifier": {
+ "format": "int32",
+ "description": "ARM Identifier for deployment.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "deployment_name": {
+ "description": "Deployment name.",
+ "type": "string"
+ },
+ "href": {
+ "description": "HRef URI.",
+ "type": "string"
+ },
+ "minidump": {
+ "description": "Minidump URI.",
+ "type": "string"
+ },
+ "is_profile_running": {
+ "description": "Is profile running?",
+ "type": "boolean"
+ },
+ "is_iis_profile_running": {
+ "description": "Is the IIS Profile running?",
+ "type": "boolean"
+ },
+ "iis_profile_timeout_in_seconds": {
+ "format": "double",
+ "description": "IIS Profile timeout (seconds).",
+ "type": "number"
+ },
+ "parent": {
+ "description": "Parent process.",
+ "type": "string"
+ },
+ "children": {
+ "description": "Child process list.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "threads": {
+ "description": "Thread list.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProcessThreadInfo"
+ }
+ },
+ "open_file_handles": {
+ "description": "List of open files.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "modules": {
+ "description": "List of modules.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProcessModuleInfo"
+ }
+ },
+ "file_name": {
+ "description": "File name of this process.",
+ "type": "string"
+ },
+ "command_line": {
+ "description": "Command line.",
+ "type": "string"
+ },
+ "user_name": {
+ "description": "User name.",
+ "type": "string"
+ },
+ "handle_count": {
+ "format": "int32",
+ "description": "Handle count.",
+ "type": "integer"
+ },
+ "module_count": {
+ "format": "int32",
+ "description": "Module count.",
+ "type": "integer"
+ },
+ "thread_count": {
+ "format": "int32",
+ "description": "Thread count.",
+ "type": "integer"
+ },
+ "start_time": {
+ "format": "date-time",
+ "description": "Start time.",
+ "type": "string"
+ },
+ "total_cpu_time": {
+ "description": "Total CPU time.",
+ "type": "string"
+ },
+ "user_cpu_time": {
+ "description": "User CPU time.",
+ "type": "string"
+ },
+ "privileged_cpu_time": {
+ "description": "Privileged CPU time.",
+ "type": "string"
+ },
+ "working_set": {
+ "format": "int64",
+ "description": "Working set.",
+ "type": "integer"
+ },
+ "peak_working_set": {
+ "format": "int64",
+ "description": "Peak working set.",
+ "type": "integer"
+ },
+ "private_memory": {
+ "format": "int64",
+ "description": "Private memory size.",
+ "type": "integer"
+ },
+ "virtual_memory": {
+ "format": "int64",
+ "description": "Virtual memory size.",
+ "type": "integer"
+ },
+ "peak_virtual_memory": {
+ "format": "int64",
+ "description": "Peak virtual memory usage.",
+ "type": "integer"
+ },
+ "paged_system_memory": {
+ "format": "int64",
+ "description": "Paged system memory.",
+ "type": "integer"
+ },
+ "non_paged_system_memory": {
+ "format": "int64",
+ "description": "Non-paged system memory.",
+ "type": "integer"
+ },
+ "paged_memory": {
+ "format": "int64",
+ "description": "Paged memory.",
+ "type": "integer"
+ },
+ "peak_paged_memory": {
+ "format": "int64",
+ "description": "Peak paged memory.",
+ "type": "integer"
+ },
+ "time_stamp": {
+ "format": "date-time",
+ "description": "Time stamp.",
+ "type": "string"
+ },
+ "environment_variables": {
+ "description": "List of environment variables.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "string"
+ }
+ },
+ "is_scm_site": {
+ "description": "Is this the SCM site?",
+ "type": "boolean"
+ },
+ "is_webjob": {
+ "description": "Is this a Web Job?",
+ "type": "boolean"
+ },
+ "description": {
+ "description": "Description of process.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ProcessInfoCollection": {
+ "description": "Collection of Kudu process information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProcessInfo"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ProcessModuleInfo": {
+ "description": "Process Module Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ProcessModuleInfo resource specific properties",
+ "properties": {
+ "base_address": {
+ "description": "Base address. Used as module identifier in ARM resource URI.",
+ "type": "string"
+ },
+ "file_name": {
+ "description": "File name.",
+ "type": "string"
+ },
+ "href": {
+ "description": "HRef URI.",
+ "type": "string"
+ },
+ "file_path": {
+ "description": "File path.",
+ "type": "string"
+ },
+ "module_memory_size": {
+ "format": "int32",
+ "description": "Module memory size.",
+ "type": "integer"
+ },
+ "file_version": {
+ "description": "File version.",
+ "type": "string"
+ },
+ "file_description": {
+ "description": "File description.",
+ "type": "string"
+ },
+ "product": {
+ "description": "Product name.",
+ "type": "string"
+ },
+ "product_version": {
+ "description": "Product version.",
+ "type": "string"
+ },
+ "is_debug": {
+ "description": "Is debug?",
+ "type": "boolean"
+ },
+ "language": {
+ "description": "Module language (locale).",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ProcessModuleInfoCollection": {
+ "description": "Collection of Kudu thread information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProcessModuleInfo"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "ProcessThreadInfo": {
+ "description": "Process Thread Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "ProcessThreadInfo resource specific properties",
+ "properties": {
+ "identifier": {
+ "format": "int32",
+ "description": "Site extension ID.",
+ "type": "integer",
+ "readOnly": true
+ },
+ "href": {
+ "description": "HRef URI.",
+ "type": "string"
+ },
+ "process": {
+ "description": "Process URI.",
+ "type": "string"
+ },
+ "start_address": {
+ "description": "Start address.",
+ "type": "string"
+ },
+ "current_priority": {
+ "format": "int32",
+ "description": "Current thread priority.",
+ "type": "integer"
+ },
+ "priority_level": {
+ "description": "Thread priority level.",
+ "type": "string"
+ },
+ "base_priority": {
+ "format": "int32",
+ "description": "Base priority.",
+ "type": "integer"
+ },
+ "start_time": {
+ "format": "date-time",
+ "description": "Start time.",
+ "type": "string"
+ },
+ "total_processor_time": {
+ "description": "Total processor time.",
+ "type": "string"
+ },
+ "user_processor_time": {
+ "description": "User processor time.",
+ "type": "string"
+ },
+ "state": {
+ "description": "Thread state.",
+ "type": "string"
+ },
+ "wait_reason": {
+ "description": "Wait reason.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "ProcessThreadInfoCollection": {
+ "description": "Collection of Kudu thread information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/ProcessThreadInfo"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "PublicCertificate": {
+ "description": "Public certificate object",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "PublicCertificate resource specific properties",
+ "properties": {
+ "blob": {
+ "format": "byte",
+ "description": "Public Certificate byte array",
+ "type": "string"
+ },
+ "publicCertificateLocation": {
+ "description": "Public Certificate Location",
+ "enum": [
+ "CurrentUserMy",
+ "LocalMachineMy",
+ "Unknown"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "PublicCertificateLocation",
+ "modelAsString": false
+ }
+ },
+ "thumbprint": {
+ "description": "Certificate Thumbprint",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "PublicCertificateCollection": {
+ "description": "Collection of public certificates",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/PublicCertificate"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "RelayServiceConnectionEntity": {
+ "description": "Hybrid Connection for an App Service app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "RelayServiceConnectionEntity resource specific properties",
+ "properties": {
+ "entityName": {
+ "type": "string"
+ },
+ "entityConnectionString": {
+ "type": "string"
+ },
+ "resourceType": {
+ "type": "string"
+ },
+ "resourceConnectionString": {
+ "type": "string"
+ },
+ "hostname": {
+ "type": "string"
+ },
+ "port": {
+ "format": "int32",
+ "type": "integer"
+ },
+ "biztalkUri": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "RemotePrivateEndpointConnection": {
+ "description": "A remote private endpoint connection",
+ "type": "object",
+ "properties": {
+ "provisioningState": {
+ "type": "string",
+ "readOnly": true
+ },
+ "privateEndpoint": {
+ "$ref": "#/definitions/ArmIdWrapper",
+ "description": "PrivateEndpoint of a remote private endpoint connection"
+ },
+ "privateLinkServiceConnectionState": {
+ "$ref": "#/definitions/PrivateLinkConnectionState"
+ }
+ }
+ },
+ "RestoreRequest": {
+ "description": "Description of a restore request.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/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",
+ "CloudFS"
+ ],
+ "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
+ }
+ }
+ },
+ "SiteAuthSettings": {
+ "description": "Configuration settings for the Azure App Service Authentication / Authorization feature.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SiteAuthSettings resource specific properties",
+ "properties": {
+ "enabled": {
+ "description": "true if the Authentication / Authorization feature is enabled for the current app; otherwise, false.",
+ "type": "boolean"
+ },
+ "runtimeVersion": {
+ "description": "The RuntimeVersion of the Authentication / Authorization feature in use for the current app.\nThe setting in this value can control the behavior of certain features in the Authentication / Authorization module.",
+ "type": "string"
+ },
+ "unauthenticatedClientAction": {
+ "description": "The action to take when an unauthenticated client attempts to access the app.",
+ "enum": [
+ "RedirectToLoginPage",
+ "AllowAnonymous"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "UnauthenticatedClientAction",
+ "modelAsString": false
+ }
+ },
+ "tokenStoreEnabled": {
+ "description": "true to durably store platform-specific security tokens that are obtained during login flows; otherwise, false.\n The default is false.",
+ "type": "boolean"
+ },
+ "allowedExternalRedirectUrls": {
+ "description": "External URLs that can be redirected to as part of logging in or logging out of the app. Note that the query string part of the URL is ignored.\nThis is an advanced setting typically only needed by Windows Store application backends.\nNote that URLs within the current domain are always implicitly allowed.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "defaultProvider": {
+ "description": "The default authentication provider to use when multiple providers are configured.\nThis setting is only needed if multiple providers are configured and the unauthenticated client\naction is set to \"RedirectToLoginPage\".",
+ "enum": [
+ "AzureActiveDirectory",
+ "Facebook",
+ "Google",
+ "MicrosoftAccount",
+ "Twitter",
+ "Github"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "BuiltInAuthenticationProvider",
+ "modelAsString": false
+ }
+ },
+ "tokenRefreshExtensionHours": {
+ "format": "double",
+ "description": "The number of hours after session token expiration that a session token can be used to\ncall the token refresh API. The default is 72 hours.",
+ "type": "number"
+ },
+ "clientId": {
+ "description": "The Client ID of this relying party application, known as the client_id.\nThis setting is required for enabling OpenID Connection authentication with Azure Active Directory or \nother 3rd party OpenID Connect providers.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html",
+ "type": "string"
+ },
+ "clientSecret": {
+ "description": "The Client Secret of this relying party application (in Azure Active Directory, this is also referred to as the Key).\nThis setting is optional. If no client secret is configured, the OpenID Connect implicit auth flow is used to authenticate end users.\nOtherwise, the OpenID Connect Authorization Code Flow is used to authenticate end users.\nMore information on OpenID Connect: http://openid.net/specs/openid-connect-core-1_0.html",
+ "type": "string"
+ },
+ "clientSecretSettingName": {
+ "description": "The app setting name that contains the client secret of the relying party application.",
+ "type": "string"
+ },
+ "clientSecretCertificateThumbprint": {
+ "description": "An alternative to the client secret, that is the thumbprint of a certificate used for signing purposes. This property acts as\na replacement for the Client Secret. It is also optional.",
+ "type": "string"
+ },
+ "issuer": {
+ "description": "The OpenID Connect Issuer URI that represents the entity which issues access tokens for this application.\nWhen using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.\nThis URI is a case-sensitive identifier for the token issuer.\nMore information on OpenID Connect Discovery: http://openid.net/specs/openid-connect-discovery-1_0.html",
+ "type": "string"
+ },
+ "validateIssuer": {
+ "description": "Gets a value indicating whether the issuer should be a valid HTTPS url and be validated as such.",
+ "type": "boolean"
+ },
+ "allowedAudiences": {
+ "description": "Allowed audience values to consider when validating JWTs issued by \nAzure Active Directory. Note that the ClientID value is always considered an\nallowed audience, regardless of this setting.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "additionalLoginParams": {
+ "description": "Login parameters to send to the OpenID Connect authorization endpoint when\na user logs in. Each parameter must be in the form \"key=value\".",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "aadClaimsAuthorization": {
+ "description": "Gets a JSON string containing the Azure AD Acl settings.",
+ "type": "string"
+ },
+ "googleClientId": {
+ "description": "The OpenID Connect Client ID for the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
+ "type": "string"
+ },
+ "googleClientSecret": {
+ "description": "The client secret associated with the Google web application.\nThis setting is required for enabling Google Sign-In.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
+ "type": "string"
+ },
+ "googleClientSecretSettingName": {
+ "description": "The app setting name that contains the client secret associated with \nthe Google web application.",
+ "type": "string"
+ },
+ "googleOAuthScopes": {
+ "description": "The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication.\nThis setting is optional. If not specified, \"openid\", \"profile\", and \"email\" are used as default scopes.\nGoogle Sign-In documentation: https://developers.google.com/identity/sign-in/web/",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "facebookAppId": {
+ "description": "The App ID of the Facebook app used for login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
+ "type": "string"
+ },
+ "facebookAppSecret": {
+ "description": "The App Secret of the Facebook app used for Facebook Login.\nThis setting is required for enabling Facebook Login.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
+ "type": "string"
+ },
+ "facebookAppSecretSettingName": {
+ "description": "The app setting name that contains the app secret used for Facebook Login.",
+ "type": "string"
+ },
+ "facebookOAuthScopes": {
+ "description": "The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication.\nThis setting is optional.\nFacebook Login documentation: https://developers.facebook.com/docs/facebook-login",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "gitHubClientId": {
+ "description": "The Client Id of the GitHub app used for login.\nThis setting is required for enabling Github login",
+ "type": "string"
+ },
+ "gitHubClientSecret": {
+ "description": "The Client Secret of the GitHub app used for Github Login.\nThis setting is required for enabling Github login.",
+ "type": "string"
+ },
+ "gitHubClientSecretSettingName": {
+ "description": "The app setting name that contains the client secret of the Github\napp used for GitHub Login.",
+ "type": "string"
+ },
+ "gitHubOAuthScopes": {
+ "description": "The OAuth 2.0 scopes that will be requested as part of GitHub Login authentication.\nThis setting is optional",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "twitterConsumerKey": {
+ "description": "The OAuth 1.0a consumer key of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in",
+ "type": "string"
+ },
+ "twitterConsumerSecret": {
+ "description": "The OAuth 1.0a consumer secret of the Twitter application used for sign-in.\nThis setting is required for enabling Twitter Sign-In.\nTwitter Sign-In documentation: https://dev.twitter.com/web/sign-in",
+ "type": "string"
+ },
+ "twitterConsumerSecretSettingName": {
+ "description": "The app setting name that contains the OAuth 1.0a consumer secret of the Twitter\napplication used for sign-in.",
+ "type": "string"
+ },
+ "microsoftAccountClientId": {
+ "description": "The OAuth 2.0 client ID that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm",
+ "type": "string"
+ },
+ "microsoftAccountClientSecret": {
+ "description": "The OAuth 2.0 client secret that was created for the app used for authentication.\nThis setting is required for enabling Microsoft Account authentication.\nMicrosoft Account OAuth documentation: https://dev.onedrive.com/auth/msa_oauth.htm",
+ "type": "string"
+ },
+ "microsoftAccountClientSecretSettingName": {
+ "description": "The app setting name containing the OAuth 2.0 client secret that was created for the\napp used for authentication.",
+ "type": "string"
+ },
+ "microsoftAccountOAuthScopes": {
+ "description": "The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication.\nThis setting is optional. If not specified, \"wl.basic\" is used as the default scope.\nMicrosoft Account Scopes and permissions documentation: https://msdn.microsoft.com/en-us/library/dn631845.aspx",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "isAuthFromFile": {
+ "description": "\"true\" if the auth config settings should be read from a file,\n\"false\" otherwise",
+ "type": "string"
+ },
+ "authFilePath": {
+ "description": "The path of the config file containing auth settings.\nIf the path is relative, base will the site's root directory.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteAuthSettingsV2": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SiteAuthSettingsV2 resource specific properties",
+ "properties": {
+ "platform": {
+ "$ref": "#/definitions/AuthPlatform"
+ },
+ "globalValidation": {
+ "$ref": "#/definitions/GlobalValidation"
+ },
+ "identityProviders": {
+ "$ref": "#/definitions/IdentityProviders"
+ },
+ "login": {
+ "$ref": "#/definitions/Login"
+ },
+ "httpSettings": {
+ "$ref": "#/definitions/HttpSettings"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteCloneability": {
+ "description": "Represents whether or not an app is cloneable.",
+ "type": "object",
+ "properties": {
+ "result": {
+ "description": "Name of app.",
+ "enum": [
+ "Cloneable",
+ "PartiallyCloneable",
+ "NotCloneable"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "CloneAbilityResult",
+ "modelAsString": false
+ }
+ },
+ "blockingFeatures": {
+ "description": "List of features enabled on app that prevent cloning.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SiteCloneabilityCriterion"
+ }
+ },
+ "unsupportedFeatures": {
+ "description": "List of features enabled on app that are non-blocking but cannot be cloned. The app can still be cloned\nbut the features in this list will not be set up on cloned app.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SiteCloneabilityCriterion"
+ }
+ },
+ "blockingCharacteristics": {
+ "description": "List of blocking application characteristics.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SiteCloneabilityCriterion"
+ }
+ }
+ }
+ },
+ "SiteCloneabilityCriterion": {
+ "description": "An app cloneability criterion.",
+ "type": "object",
+ "properties": {
+ "name": {
+ "description": "Name of criterion.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Description of criterion.",
+ "type": "string"
+ }
+ }
+ },
+ "SiteConfigResource": {
+ "description": "Web app configuration ARM resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "./CommonDefinitions.json#/definitions/SiteConfig",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteConfigResourceCollection": {
+ "description": "Collection of site configurations.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SiteConfigResource"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SiteConfigurationSnapshotInfo": {
+ "description": "A snapshot of a web app configuration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SiteConfigurationSnapshotInfo resource specific properties",
+ "properties": {
+ "time": {
+ "format": "date-time",
+ "description": "The time the snapshot was taken.",
+ "type": "string",
+ "readOnly": true
+ },
+ "snapshotId": {
+ "format": "int32",
+ "description": "The id of the snapshot",
+ "type": "integer",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteConfigurationSnapshotInfoCollection": {
+ "description": "Collection of metadata for the app configuration snapshots that can be restored.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SiteConfigurationSnapshotInfo"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SiteExtensionInfo": {
+ "description": "Site Extension Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SiteExtensionInfo resource specific properties",
+ "properties": {
+ "extension_id": {
+ "description": "Site extension ID.",
+ "type": "string"
+ },
+ "title": {
+ "type": "string"
+ },
+ "extension_type": {
+ "description": "Site extension type.",
+ "enum": [
+ "Gallery",
+ "WebRoot"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SiteExtensionType",
+ "modelAsString": false
+ }
+ },
+ "summary": {
+ "description": "Summary description.",
+ "type": "string"
+ },
+ "description": {
+ "description": "Detailed description.",
+ "type": "string"
+ },
+ "version": {
+ "description": "Version information.",
+ "type": "string"
+ },
+ "extension_url": {
+ "description": "Extension URL.",
+ "type": "string"
+ },
+ "project_url": {
+ "description": "Project URL.",
+ "type": "string"
+ },
+ "icon_url": {
+ "description": "Icon URL.",
+ "type": "string"
+ },
+ "license_url": {
+ "description": "License URL.",
+ "type": "string"
+ },
+ "feed_url": {
+ "description": "Feed URL.",
+ "type": "string"
+ },
+ "authors": {
+ "description": "List of authors.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "installer_command_line_params": {
+ "description": "Installer command line parameters.",
+ "type": "string"
+ },
+ "published_date_time": {
+ "format": "date-time",
+ "description": "Published timestamp.",
+ "type": "string"
+ },
+ "download_count": {
+ "format": "int32",
+ "description": "Count of downloads.",
+ "type": "integer"
+ },
+ "local_is_latest_version": {
+ "description": "true if the local version is the latest version; false otherwise.",
+ "type": "boolean"
+ },
+ "local_path": {
+ "description": "Local path.",
+ "type": "string"
+ },
+ "installed_date_time": {
+ "format": "date-time",
+ "description": "Installed timestamp.",
+ "type": "string"
+ },
+ "provisioningState": {
+ "description": "Provisioning state.",
+ "type": "string"
+ },
+ "comment": {
+ "description": "Site Extension comment.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteExtensionInfoCollection": {
+ "description": "Collection of Kudu site extension information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SiteExtensionInfo"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SiteLogsConfig": {
+ "description": "Configuration of App Service site logs.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SiteLogsConfig resource specific properties",
+ "properties": {
+ "applicationLogs": {
+ "$ref": "#/definitions/ApplicationLogsConfig",
+ "description": "Application logs configuration."
+ },
+ "httpLogs": {
+ "$ref": "#/definitions/HttpLogsConfig",
+ "description": "HTTP logs configuration."
+ },
+ "failedRequestsTracing": {
+ "$ref": "#/definitions/EnabledConfig",
+ "description": "Failed requests tracing configuration."
+ },
+ "detailedErrorMessages": {
+ "$ref": "#/definitions/EnabledConfig",
+ "description": "Detailed error messages configuration."
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SitePatchResource": {
+ "description": "ARM resource for a site.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SitePatchResource 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": "./CommonDefinitions.json#/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"
+ ]
+ },
+ "isXenon": {
+ "description": "Obsolete: Hyper-V sandbox.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "hyperV": {
+ "description": "Hyper-V sandbox.",
+ "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": "./CommonDefinitions.json#/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": "./CommonDefinitions.json#/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"
+ },
+ "clientCertMode": {
+ "description": "This composes with ClientCertEnabled setting.\n- ClientCertEnabled: false means ClientCert is ignored.\n- ClientCertEnabled: true and ClientCertMode: Required means ClientCert is required.\n- ClientCertEnabled: true and ClientCertMode: Optional means ClientCert is optional or accepted.",
+ "enum": [
+ "Required",
+ "Optional"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "ClientCertMode",
+ "modelAsString": false
+ }
+ },
+ "clientCertExclusionPaths": {
+ "description": "client certificate authentication comma-separated exclusion paths",
+ "type": "string"
+ },
+ "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"
+ },
+ "customDomainVerificationId": {
+ "description": "Unique identifier that verifies the custom domains assigned to the app. Customer will add this id to a txt record for verification.",
+ "type": "string"
+ },
+ "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 except dataComponent. 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": "./CommonDefinitions.json#/definitions/CloningInfo",
+ "description": "If specified during app creation, the app is cloned from a source app.",
+ "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": "./CommonDefinitions.json#/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"
+ },
+ "redundancyMode": {
+ "description": "Site redundancy mode",
+ "enum": [
+ "None",
+ "Manual",
+ "Failover",
+ "ActiveActive",
+ "GeoRedundant"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "RedundancyMode",
+ "modelAsString": false
+ }
+ },
+ "inProgressOperationId": {
+ "format": "uuid",
+ "description": "Specifies an operation id if this site has a pending operation.",
+ "type": "string",
+ "readOnly": true,
+ "example": "00000000-0000-0000-0000-000000000000"
+ }
+ },
+ "x-ms-client-flatten": true
+ },
+ "identity": {
+ "$ref": "./CommonDefinitions.json#/definitions/ManagedServiceIdentity"
+ }
+ }
+ },
+ "SitePhpErrorLogFlag": {
+ "description": "Used for getting PHP error logging flag.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SitePhpErrorLogFlag resource specific properties",
+ "properties": {
+ "localLogErrors": {
+ "description": "Local log_errors setting.",
+ "type": "string"
+ },
+ "masterLogErrors": {
+ "description": "Master log_errors setting.",
+ "type": "string"
+ },
+ "localLogErrorsMaxLength": {
+ "description": "Local log_errors_max_len setting.",
+ "type": "string"
+ },
+ "masterLogErrorsMaxLength": {
+ "description": "Master log_errors_max_len setting.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SiteSourceControl": {
+ "description": "Source control configuration for an app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SiteSourceControl resource specific properties",
+ "properties": {
+ "repoUrl": {
+ "description": "Repository or source control URL.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "branch": {
+ "description": "Name of branch to use for deployment.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "isManualIntegration": {
+ "description": "true to limit to manual integration; false to enable continuous integration (which configures webhooks into online repos like GitHub).",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "isGitHubAction": {
+ "description": "true if this is deployed via GitHub action.",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "deploymentRollbackEnabled": {
+ "description": "true to enable deployment rollback; otherwise, false.",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ },
+ "isMercurial": {
+ "description": "true for a Mercurial repository; false for a Git repository.",
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create",
+ "read"
+ ]
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SlotConfigNames": {
+ "description": "Names for connection strings, application settings, and external Azure storage account configuration\nidentifiers to be marked as sticky to the deployment slot and not moved during a swap operation.\nThis is valid for all deployment slots in an app.",
+ "type": "object",
+ "properties": {
+ "connectionStringNames": {
+ "description": "List of connection string names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "appSettingNames": {
+ "description": "List of application settings names.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ },
+ "azureStorageConfigNames": {
+ "description": "List of external Azure storage account identifiers.",
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "SlotConfigNamesResource": {
+ "description": "Slot Config names azure resource.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "$ref": "#/definitions/SlotConfigNames",
+ "description": "Core resource properties",
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SlotDifference": {
+ "description": "A setting difference between two deployment slots of an app.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SlotDifference resource specific properties",
+ "properties": {
+ "level": {
+ "description": "Level of the difference: Information, Warning or Error.",
+ "type": "string",
+ "readOnly": true
+ },
+ "settingType": {
+ "description": "The type of the setting: General, AppSetting or ConnectionString.",
+ "type": "string",
+ "readOnly": true
+ },
+ "diffRule": {
+ "description": "Rule that describes how to process the setting difference during a slot swap.",
+ "type": "string",
+ "readOnly": true
+ },
+ "settingName": {
+ "description": "Name of the setting.",
+ "type": "string",
+ "readOnly": true
+ },
+ "valueInCurrentSlot": {
+ "description": "Value of the setting in the current slot.",
+ "type": "string",
+ "readOnly": true
+ },
+ "valueInTargetSlot": {
+ "description": "Value of the setting in the target slot.",
+ "type": "string",
+ "readOnly": true
+ },
+ "description": {
+ "description": "Description of the setting difference.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SlotDifferenceCollection": {
+ "description": "Collection of slot differences.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SlotDifference"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SnapshotCollection": {
+ "description": "Collection of snapshots which can be used to revert an app to a previous time.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "./CommonDefinitions.json#/definitions/Snapshot"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "SnapshotRecoverySource": {
+ "description": "Specifies the web app that snapshot contents will be retrieved from.",
+ "type": "object",
+ "properties": {
+ "location": {
+ "description": "Geographical location of the source web app, e.g. SouthEastAsia, SouthCentralUS",
+ "type": "string"
+ },
+ "id": {
+ "description": "ARM resource ID of the source app. \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName} for production slots and \n/subscriptions/{subId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{siteName}/slots/{slotName} for other slots.",
+ "type": "string"
+ }
+ }
+ },
+ "SnapshotRestoreRequest": {
+ "description": "Details about app recovery operation.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SnapshotRestoreRequest resource specific properties",
+ "required": [
+ "overwrite"
+ ],
+ "properties": {
+ "snapshotTime": {
+ "description": "Point in time in which the app restore should be done, formatted as a DateTime string.",
+ "type": "string"
+ },
+ "recoverySource": {
+ "$ref": "#/definitions/SnapshotRecoverySource",
+ "description": "Optional. Specifies the web app that snapshot contents will be retrieved from.\nIf empty, the targeted web app will be used as the source."
+ },
+ "overwrite": {
+ "description": "If true the restore 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"
+ },
+ "useDRSecondary": {
+ "description": "If true, the snapshot is retrieved from DRSecondary endpoint.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StorageMigrationOptions": {
+ "description": "Options for app content migration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StorageMigrationOptions resource specific properties",
+ "required": [
+ "azurefilesConnectionString",
+ "azurefilesShare"
+ ],
+ "properties": {
+ "azurefilesConnectionString": {
+ "description": "AzureFiles connection string.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "azurefilesShare": {
+ "description": "AzureFiles share.",
+ "type": "string",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "switchSiteAfterMigration": {
+ "description": "trueif the app should be switched over; otherwise, false.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create"
+ ]
+ },
+ "blockWriteAccessToSite": {
+ "description": "true if the app should be read only during copy operation; otherwise, false.",
+ "default": false,
+ "type": "boolean",
+ "x-ms-mutability": [
+ "create"
+ ]
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "StorageMigrationResponse": {
+ "description": "Response for a migration of app content request.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "StorageMigrationResponse resource specific properties",
+ "properties": {
+ "operationId": {
+ "description": "When server starts the migration process, it will return an operation ID identifying that particular migration operation.",
+ "type": "string",
+ "readOnly": true
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "SwiftVirtualNetwork": {
+ "description": "Swift Virtual Network Contract. This is used to enable the new Swift way of doing virtual network integration.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "SwiftVirtualNetwork resource specific properties",
+ "properties": {
+ "subnetResourceId": {
+ "description": "The Virtual Network subnet's resource ID. This is the subnet that this Web App will join. This subnet must have a delegation to Microsoft.Web/serverFarms defined first.",
+ "type": "string"
+ },
+ "swiftSupported": {
+ "description": "A flag that specifies if the scale unit this Web App is on supports Swift integration.",
+ "type": "boolean"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TokenStore": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "TokenStore resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "tokenRefreshExtensionHours": {
+ "format": "double",
+ "type": "number"
+ },
+ "fileSystem": {
+ "$ref": "#/definitions/FileSystemTokenStore"
+ },
+ "azureBlobStorage": {
+ "$ref": "#/definitions/BlobStorageTokenStore"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TriggeredJobHistory": {
+ "description": "Triggered Web Job History. List of Triggered Web Job Run Information elements.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "TriggeredJobHistory resource specific properties",
+ "properties": {
+ "runs": {
+ "description": "List of triggered web job runs.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TriggeredJobRun"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TriggeredJobHistoryCollection": {
+ "description": "Collection of Kudu continuous web job information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TriggeredJobHistory"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "TriggeredJobRun": {
+ "description": "Triggered Web Job Run Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "TriggeredJobRun resource specific properties",
+ "properties": {
+ "web_job_id": {
+ "description": "Job ID.",
+ "type": "string"
+ },
+ "web_job_name": {
+ "description": "Job name.",
+ "type": "string"
+ },
+ "status": {
+ "description": "Job status.",
+ "enum": [
+ "Success",
+ "Failed",
+ "Error"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "TriggeredWebJobStatus",
+ "modelAsString": false
+ }
+ },
+ "start_time": {
+ "format": "date-time",
+ "description": "Start time.",
+ "type": "string"
+ },
+ "end_time": {
+ "format": "date-time",
+ "description": "End time.",
+ "type": "string"
+ },
+ "duration": {
+ "description": "Job duration.",
+ "type": "string"
+ },
+ "output_url": {
+ "description": "Output URL.",
+ "type": "string"
+ },
+ "error_url": {
+ "description": "Error URL.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Job URL.",
+ "type": "string"
+ },
+ "job_name": {
+ "description": "Job name.",
+ "type": "string"
+ },
+ "trigger": {
+ "description": "Job trigger.",
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TriggeredWebJob": {
+ "description": "Triggered Web Job Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "TriggeredWebJob resource specific properties",
+ "properties": {
+ "latest_run": {
+ "$ref": "#/definitions/TriggeredJobRun",
+ "description": "Latest job run information."
+ },
+ "history_url": {
+ "description": "History URL.",
+ "type": "string"
+ },
+ "scheduler_logs_url": {
+ "description": "Scheduler Logs URL.",
+ "type": "string"
+ },
+ "run_command": {
+ "description": "Run command.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Job URL.",
+ "type": "string"
+ },
+ "extra_info_url": {
+ "description": "Extra Info URL.",
+ "type": "string"
+ },
+ "web_job_type": {
+ "description": "Job type.",
+ "enum": [
+ "Continuous",
+ "Triggered"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebJobType",
+ "modelAsString": false
+ }
+ },
+ "error": {
+ "description": "Error information.",
+ "type": "string"
+ },
+ "using_sdk": {
+ "description": "Using SDK?",
+ "type": "boolean"
+ },
+ "settings": {
+ "description": "Job settings.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TriggeredWebJobCollection": {
+ "description": "Collection of Kudu continuous web job information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/TriggeredWebJob"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "Twitter": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "Twitter resource specific properties",
+ "properties": {
+ "enabled": {
+ "type": "boolean"
+ },
+ "registration": {
+ "$ref": "#/definitions/TwitterRegistration"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "TwitterRegistration": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "TwitterRegistration resource specific properties",
+ "properties": {
+ "consumerKey": {
+ "type": "string"
+ },
+ "consumerSecretSettingName": {
+ "type": "string"
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebAppInstanceStatusCollection": {
+ "description": "Collection of app instances.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WebSiteInstanceStatus"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "WebJob": {
+ "description": "Web Job Information.",
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "WebJob resource specific properties",
+ "properties": {
+ "run_command": {
+ "description": "Run command.",
+ "type": "string"
+ },
+ "url": {
+ "description": "Job URL.",
+ "type": "string"
+ },
+ "extra_info_url": {
+ "description": "Extra Info URL.",
+ "type": "string"
+ },
+ "web_job_type": {
+ "description": "Job type.",
+ "enum": [
+ "Continuous",
+ "Triggered"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "WebJobType",
+ "modelAsString": false
+ }
+ },
+ "error": {
+ "description": "Error information.",
+ "type": "string"
+ },
+ "using_sdk": {
+ "description": "Using SDK?",
+ "type": "boolean"
+ },
+ "settings": {
+ "description": "Job settings.",
+ "type": "object",
+ "additionalProperties": {
+ "type": "object"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ },
+ "WebJobCollection": {
+ "description": "Collection of Kudu web job information elements.",
+ "required": [
+ "value"
+ ],
+ "type": "object",
+ "properties": {
+ "value": {
+ "description": "Collection of resources.",
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/WebJob"
+ }
+ },
+ "nextLink": {
+ "description": "Link to next page of resources.",
+ "type": "string",
+ "readOnly": true
+ }
+ }
+ },
+ "WebSiteInstanceStatus": {
+ "type": "object",
+ "allOf": [
+ {
+ "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource"
+ }
+ ],
+ "properties": {
+ "properties": {
+ "description": "WebSiteInstanceStatus resource specific properties",
+ "properties": {
+ "state": {
+ "enum": [
+ "READY",
+ "STOPPED",
+ "UNKNOWN"
+ ],
+ "type": "string",
+ "x-ms-enum": {
+ "name": "SiteRuntimeState",
+ "modelAsString": false
+ }
+ },
+ "statusUrl": {
+ "description": "Link to the GetStatusApi in Kudu",
+ "type": "string"
+ },
+ "detectorUrl": {
+ "description": "Link to the Diagnose and Solve Portal",
+ "type": "string"
+ },
+ "consoleUrl": {
+ "description": "Link to the console to web app instance",
+ "type": "string"
+ },
+ "healthCheckUrl": {
+ "description": "Link to the console to web app instance",
+ "type": "string"
+ },
+ "containers": {
+ "type": "object",
+ "additionalProperties": {
+ "$ref": "#/definitions/ContainerInfo"
+ }
+ }
+ },
+ "x-ms-client-flatten": true
+ }
+ }
+ }
+ },
+ "parameters": {
+ "subscriptionIdParameter": {
+ "name": "subscriptionId",
+ "in": "path",
+ "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).",
+ "required": true,
+ "type": "string"
+ },
+ "resourceGroupNameParameter": {
+ "name": "resourceGroupName",
+ "in": "path",
+ "description": "Name of the resource group to which the resource belongs.",
+ "required": true,
+ "type": "string",
+ "maxLength": 90,
+ "minLength": 1,
+ "pattern": "^[-\\w\\._\\(\\)]+[^\\.]$",
+ "x-ms-parameter-location": "method"
+ },
+ "apiVersionParameter": {
+ "name": "api-version",
+ "in": "query",
+ "description": "API Version",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "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"
+ ]
+ }
+ ]
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/ApproveRejectSitePrivateEndpointConnection.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/ApproveRejectSitePrivateEndpointConnection.json
new file mode 100644
index 000000000000..15f749f41d8b
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/ApproveRejectSitePrivateEndpointConnection.json
@@ -0,0 +1,54 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "rg",
+ "name": "testSite",
+ "privateEndpointConnectionName": "connection",
+ "api-version": "2020-10-01",
+ "privateEndpointWrapper": {
+ "properties": {
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by admin.",
+ "actionsRequired": ""
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by admin.",
+ "actionsRequired": ""
+ }
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/providers/Microsoft.Web/locations/westus2/operationResults/62e4d893-d233-4005-988e-a428d9f77076?api-version=2019-01-01"
+ },
+ "body": {
+ "properties": {
+ "provisioningState": "Succeeded",
+ "privateEndpoint": {
+ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint"
+ },
+ "privateLinkServiceConnectionState": {
+ "status": "Approved",
+ "description": "Approved by admin.",
+ "actionsRequired": ""
+ }
+ }
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CopySlot.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CopySlot.json
new file mode 100644
index 000000000000..2446b68b4cc4
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CopySlot.json
@@ -0,0 +1,24 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "name": "tests346",
+ "slot": "staging",
+ "api-version": "2020-10-01",
+ "copySlotEntity": {
+ "targetSlot": "staging",
+ "siteConfig": {
+ "numberOfWorkers": 1,
+ "httpLoggingEnabled": true
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {}
+ },
+ "202": {
+ "headers": {}
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CreateOrUpdateAppServicePlan.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CreateOrUpdateAppServicePlan.json
new file mode 100644
index 000000000000..0aeaf3d07cbd
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CreateOrUpdateAppServicePlan.json
@@ -0,0 +1,80 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "name": "testsf6141",
+ "api-version": "2020-10-01",
+ "appServicePlan": {
+ "kind": "app",
+ "location": "East US",
+ "properties": {},
+ "sku": {
+ "name": "P1",
+ "tier": "Premium",
+ "size": "P1",
+ "family": "P",
+ "capacity": 1
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "headers": {},
+ "body": {
+ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
+ "name": "testsf6141",
+ "type": "Microsoft.Web/serverfarms",
+ "kind": "app",
+ "location": "East US",
+ "properties": {
+ "status": "Ready",
+ "maximumNumberOfWorkers": 20,
+ "geoRegion": "East US",
+ "numberOfSites": 4,
+ "reserved": false,
+ "targetWorkerCount": 0,
+ "targetWorkerSizeId": 0,
+ "provisioningState": "Succeeded"
+ },
+ "sku": {
+ "name": "P1",
+ "tier": "Premium",
+ "size": "P1",
+ "family": "P",
+ "capacity": 1
+ }
+ }
+ },
+ "202": {
+ "headers": {
+ "location": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141/operationresults/F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0",
+ "azure-asyncoperation": "https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141/operationresults/F0C6B8EC-0D53-432C-913B-1CD9E8CDE3A0"
+ },
+ "body": {
+ "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.Web/serverfarms/testsf6141",
+ "name": "testsf6141",
+ "type": "Microsoft.Web/serverfarms",
+ "kind": "app",
+ "location": "East US",
+ "properties": {
+ "status": "Ready",
+ "maximumNumberOfWorkers": 20,
+ "geoRegion": "East US",
+ "numberOfSites": 4,
+ "isSpot": false,
+ "reserved": false,
+ "targetWorkerCount": 0,
+ "targetWorkerSizeId": 0,
+ "provisioningState": "Succeeded"
+ },
+ "sku": {
+ "name": "P1",
+ "tier": "Premium",
+ "size": "P1",
+ "family": "P",
+ "capacity": 1
+ }
+ }
+ }
+ }
+}
diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CreateOrUpdateCertificate.json b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CreateOrUpdateCertificate.json
new file mode 100644
index 000000000000..53c14f52327f
--- /dev/null
+++ b/specification/web/resource-manager/Microsoft.Web/stable/2020-10-01/examples/CreateOrUpdateCertificate.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
+ "resourceGroupName": "testrg123",
+ "name": "testc6282",
+ "api-version": "2020-10-01",
+ "certificateEnvelope": {
+ "location": "East US",
+ "properties": {
+ "hostNames": [
+ "ServerCert"
+ ],
+ "password": "